Support null value in makeDataSnapshot and update dependencies (#53)

Author: laurenzlong

README.md

@@ -2,7 +2,7 @@
 
 The `firebase-functions-test` is unit testing library for Cloud Functions for Firebase. It is a companion to [firebase-functions](https://github.com/Firebase/firebase-functions).
 
-_NOTE: This library can only be used with `firebase-functions` v1.0.0 or above._
+_NOTE: This library can only be used with `firebase-functions` v2.0.0 or above._
 
 ## Learn more
 

package.json

@@ -37,16 +37,16 @@
     "@types/chai": "~4.2.4",
     "@types/mocha": "^5.2.7",
     "chai": "^4.2.0",
-    "firebase-admin": "~8.6.1",
+    "firebase-admin": "~8.9.0",
     "firebase-functions": "^3.3.0",
     "mocha": "^6.2.2",
     "sinon": "^7.5.0",
     "tslint": "^5.20.0",
     "typescript": "^3.6.4"
   },
   "peerDependencies": {
-    "firebase-functions": ">1.0.1",
-    "firebase-admin": ">5.12.0"
+    "firebase-functions": ">=2.0.0",
+    "firebase-admin": ">=6.0.0"
   },
   "engines": {
     "node": ">=6.0.0"

spec/index.spec.ts

@@ -25,7 +25,7 @@ import { expect } from 'chai';
 
 describe('index', () => {
   /* tslint:disable-next-line:no-var-requires */
-  const indexExport = require('../src')({ projectId: 'fakeProject' }, 'fakeServiceAccount');
+  const indexExport = require('../src')({projectId: 'fakeProject'}, 'fakeServiceAccount');
   after(() => {
     // Call cleanup (handles case of cleanup function not existing)
     indexExport.cleanup && indexExport.cleanup();
@@ -48,7 +48,7 @@ describe('index', () => {
   });
 
   it('should set env variables based parameters SDK was initialized with', () => {
-    expect(process.env.FIREBASE_CONFIG).to.equal(JSON.stringify({ projectId: 'fakeProject' }));
+    expect(process.env.FIREBASE_CONFIG).to.equal(JSON.stringify({projectId: 'fakeProject'}));
     expect(process.env.GOOGLE_APPLICATION_CREDENTIALS).to.equal('fakeServiceAccount');
   });
 
@@ -63,10 +63,10 @@ import './lifecycle.spec';
 import './main.spec';
 import './app.spec';
 import './providers/https.spec';
+import './providers/firestore.spec';
+import './providers/database.spec';
 // import './providers/analytics.spec';
 // import './providers/auth.spec';
-// import './providers/database.spec';
-// import './providers/firestore.spec';
 // import './providers/https.spec';
 // import './providers/pubsub.spec';
 // import './providers/storage.spec';

spec/providers/database.spec.ts

@@ -0,0 +1,32 @@
+import { expect } from 'chai';
+import { FirebaseFunctionsTest } from '../../src/lifecycle';
+import { makeDataSnapshot } from '../../src/providers/database';
+
+describe('providers/database', () => {
+  let test;
+
+  before(() => {
+    test = new FirebaseFunctionsTest();
+    test.init();
+  });
+
+  after(() => {
+    test.cleanup();
+  });
+
+  it('produces the right snapshot with makeDataSnapshot', async () => {
+    const snapshot = makeDataSnapshot({
+      foo: 'bar',
+    }, 'path');
+
+    expect(snapshot.val()).to.deep.equal({foo: 'bar'});
+    expect(snapshot.ref.key).to.equal('path');
+  });
+
+  it('should allow null value in makeDataSnapshot', async () => {
+    const snapshot = makeDataSnapshot(null, 'path');
+
+    expect(snapshot.val()).to.deep.equal(null);
+    expect(snapshot.ref.key).to.equal('path');
+  });
+});

spec/providers/firestore.spec.ts

@@ -0,0 +1,26 @@
+import { expect } from 'chai';
+import fft = require('../../src/index');
+
+describe('providers/firestore', () => {
+  it('produces the right snapshot with makeDocumentSnapshot', async () => {
+    const test = fft();
+
+    const snapshot = test.firestore.makeDocumentSnapshot({
+      email_address: '[email protected]',
+    }, 'collection/doc-id');
+
+    expect(snapshot.data()).to.deep.equal({
+      email_address: '[email protected]',
+    });
+    expect(snapshot.id).to.equal('doc-id');
+  });
+
+  it('should allow empty document in makeDocumentSnapshot', async () => {
+    const test = fft();
+
+    const snapshot = test.firestore.makeDocumentSnapshot({}, 'collection/doc-id');
+
+    expect(snapshot.data()).to.deep.equal(undefined);
+    expect(snapshot.id).to.equal('doc-id');
+  });
+});

src/providers/database.ts

@@ -28,7 +28,7 @@ import { testApp } from '../app';
 /** Create a DataSnapshot. */
 export function makeDataSnapshot(
   /** Value of data for the snapshot. */
-  val: string | number | boolean | any[] | object,
+  val: string | number | boolean | any[] | object | null,
   /** Full path of the reference (e.g. 'users/alovelace'). */
   refPath: string,
   /** The Firebase app that the database belongs to.