fix: Fix redaction of credentials in Firestore settings

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);
   }
 

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);
+  });
+});