Merge branch 'master' into @invertase/code-adjustments

Author: CorieW

.github/workflows/test.yaml

@@ -13,11 +13,11 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 14.x
-          - 16.x
+          - 20.x
+          - 22.x
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -36,11 +36,11 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 14.x
-          - 16.x
+          - 20.x
+          - 22.x
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions-test",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "A testing companion to firebase-functions.",
   "main": "lib/index.js",
   "scripts": {

package.json

@@ -1,13 +1,29 @@
 import { expect } from 'chai';
 import * as firebase from 'firebase-admin';
+import * as sinon from 'sinon';
+import * as http from 'http';
 import { FeaturesList } from '../../src/types/commonTypes';
 import fft = require('../../src/index');
 
 describe('providers/firestore', () => {
   let test: FeaturesList;
+  let fakeHttpRequestMethod;
+  let fakeHttpResponse;
 
   beforeEach(() => {
     test = fft();
+    fakeHttpResponse = {
+      statusCode: 200,
+      on: (event, cb) => cb(),
+    };
+    fakeHttpRequestMethod = sinon.fake((config, cb) => {
+      cb(fakeHttpResponse);
+    });
+    sinon.replace(http, 'request', fakeHttpRequestMethod);
+  });
+
+  afterEach(() => {
+    sinon.restore();
   });
 
   it('produces the right snapshot with makeDocumentSnapshot', async () => {
@@ -71,4 +87,36 @@ describe('providers/firestore', () => {
     );
     expect(snapshot.data().ref.toString()).to.equal(ref.toString());
   });
+
+  it('should use host name from FIRESTORE_EMULATOR_HOST env in clearFirestoreData', async () => {
+    process.env.FIRESTORE_EMULATOR_HOST = 'not-local-host:8080';
+
+    await test.firestore.clearFirestoreData({ projectId: 'not-a-project' });
+
+    expect(
+      fakeHttpRequestMethod.calledOnceWith({
+        hostname: 'not-local-host',
+        method: 'DELETE',
+        path:
+          '/emulator/v1/projects/not-a-project/databases/(default)/documents',
+        port: '8080',
+      })
+    ).to.be.true;
+  });
+
+  it('should use host name from FIREBASE_FIRESTORE_EMULATOR_ADDRESS env in clearFirestoreData', async () => {
+    process.env.FIREBASE_FIRESTORE_EMULATOR_ADDRESS = 'custom-host:9090';
+
+    await test.firestore.clearFirestoreData({ projectId: 'not-a-project' });
+
+    expect(
+      fakeHttpRequestMethod.calledOnceWith({
+        hostname: 'custom-host',
+        method: 'DELETE',
+        path:
+          '/emulator/v1/projects/not-a-project/databases/(default)/documents',
+        port: '9090',
+      })
+    ).to.be.true;
+  });
 });

spec/providers/firestore.spec.ts

@@ -249,15 +249,14 @@ const FIRESTORE_ADDRESS_ENVS = [
   'FIREBASE_FIRESTORE_EMULATOR_ADDRESS',
 ];
 
-const FIRESTORE_ADDRESS = FIRESTORE_ADDRESS_ENVS.reduce(
-  (addr, name) => process.env[name] || addr,
-  'localhost:8080'
-);
-const FIRESTORE_PORT = FIRESTORE_ADDRESS.split(':')[1];
-
 /** Clears all data in firestore. Works only in offline mode.
  */
 export function clearFirestoreData(options: { projectId: string } | string) {
+  const FIRESTORE_ADDRESS = FIRESTORE_ADDRESS_ENVS.reduce(
+    (addr, name) => process.env[name] || addr,
+    'localhost:8080'
+  );
+
   return new Promise((resolve, reject) => {
     let projectId;
 
@@ -271,8 +270,8 @@ export function clearFirestoreData(options: { projectId: string } | string) {
 
     const config = {
       method: 'DELETE',
-      hostname: 'localhost',
-      port: FIRESTORE_PORT,
+      hostname: FIRESTORE_ADDRESS.split(':')[0],
+      port: FIRESTORE_ADDRESS.split(':')[1],
       path: `/emulator/v1/projects/${projectId}/databases/(default)/documents`,
     };