fix: Fix redaction of credentials in Firestore settings (#1989)

MarkDuckworth · web-flow · commit 98e668bb9ce7 · 2024-01-25T09:46:12.000-07:00
* Revert "fix: Remove incorrect,unreachable and unused code (#1983)" This reverts commit 133f4da. * fix: Fix redaction of credentials in Firestore settings.
diff --git a/dev/src/index.ts b/dev/src/index.ts
@@ -745,6 +745,13 @@ export class Firestore implements firestore.Firestore {
     }
 
     this._settings = settings;
+    this._settings.toJSON = function () {
+      const temp = Object.assign({}, this);
+      if (temp.credentials) {
+        temp.credentials = {private_key: '***', client_email: '***'};
+      }
+      return temp;
+    };
     this._serializer = new Serializer(this);
   }
 
diff --git a/dev/test/index.ts b/dev/test/index.ts
@@ -1372,3 +1372,38 @@ describe('getAll() method', () => {
     });
   });
 });
+
+describe('toJSON', () => {
+  it('Serializing Firestore settings redacts credentials', () => {
+    const firestore = new Firestore.Firestore({
+      projectId: 'myProjectId',
+      credentials: {client_email: 'foo@bar', private_key: 'asdf1234'},
+    });
+
+    const serializedSettings = JSON.stringify(firestore._settings);
+
+    // Instead of validating the serialized string for redacted credentials,
+    // parse the settings and check the credential values.
+    const parsedSettings = JSON.parse(serializedSettings);
+    expect(parsedSettings.credentials.client_email).to.equal('***');
+    expect(parsedSettings.credentials.private_key).to.equal('***');
+  });
+
+  it('Serializing Firestore instance', () => {
+    const firestore = new Firestore.Firestore({
+      projectId: 'myProjectId',
+      credentials: {client_email: 'foo@bar', private_key: 'asdf1234'},
+    });
+
+    const serializedFirestore = JSON.stringify(firestore);
+
+    // Instead of validating the serialized string,
+    // parse the JSON back to an object and check the properties.
+    const expectedParsedFirestore = {
+      projectId: 'myProjectId',
+    };
+
+    const parsedFirestore = JSON.parse(serializedFirestore);
+    expect(parsedFirestore).to.deep.equal(expectedParsedFirestore);
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -745,6 +745,13 @@ export class Firestore implements firestore.Firestore {`
`745`	`745`	`}`
`746`	`746`
`747`	`747`	`this._settings = settings;`
	`748`	`+ this._settings.toJSON = function () {`
	`749`	`+ const temp = Object.assign({}, this);`
	`750`	`+ if (temp.credentials) {`
	`751`	`+ temp.credentials = {private_key: '*', client_email: '*'};`
	`752`	`+ }`
	`753`	`+ return temp;`
	`754`	`+ };`
`748`	`755`	`this._serializer = new Serializer(this);`
`749`	`756`	`}`
`750`	`757`