Implement useEmulator for Functions

.changeset/silver-books-reply.md

@@ -0,0 +1,8 @@
+---
+'firebase': minor
+'@firebase/functions-exp': minor
+'@firebase/functions': minor
+'@firebase/functions-types': minor
+---
+
+Add a useEmulator(host, port) method to Cloud Functions

packages-exp/functions-exp/src/api.ts

@@ -29,6 +29,7 @@ import {
   FunctionsService,
   DEFAULT_REGION,
   useFunctionsEmulator as _useFunctionsEmulator,
+  useEmulator as _useEmulator,
   httpsCallable as _httpsCallable
 } from './service';
 
@@ -55,6 +56,23 @@ export function getFunctions(
   return functionsInstance;
 }
 
+/**
+ * Modify this instance to communicate with the Cloudd Functions emulator.
+ *
+ * <p> Note: this must be called before this instance has been used to do any operations.
+ *
+ * @param host the emulator host (ex: localhost)
+ * @param port the emulator port (ex: 5001)
+ * @public
+ */
+export function useEmulator(
+  functionsInstance: Functions,
+  host: string,
+  port: number
+): void {
+  _useEmulator(functionsInstance as FunctionsService, host, port);
+}
+
 /**
  * Changes this instance to point to a Cloud Functions emulator running
  * locally. See https://firebase.google.com/docs/functions/local-emulator

packages-exp/functions-exp/src/service.test.ts

@@ -16,7 +16,7 @@
  */
 import { assert } from 'chai';
 import { createTestService } from '../test/utils';
-import { FunctionsService, useFunctionsEmulator } from './service';
+import { FunctionsService, useFunctionsEmulator, useEmulator } from './service';
 
 describe('Firebase Functions > Service', () => {
   describe('simple constructor', () => {
@@ -39,7 +39,7 @@ describe('Firebase Functions > Service', () => {
       );
     });
 
-    it('can use emulator', () => {
+    it('can use emulator (deprecated)', () => {
       service = createTestService(app);
       useFunctionsEmulator(service, 'http://localhost:5005');
       assert.equal(
@@ -48,6 +48,15 @@ describe('Firebase Functions > Service', () => {
       );
     });
 
+    it('can use emulator', () => {
+      service = createTestService(app);
+      useEmulator(service, 'localhost', 5005);
+      assert.equal(
+        service._url('foo'),
+        'http://localhost:5005/my-project/us-central1/foo'
+      );
+    });
+
     it('correctly sets region', () => {
       service = createTestService(app, 'my-region');
       assert.equal(
@@ -70,13 +79,22 @@ describe('Firebase Functions > Service', () => {
       assert.equal(service._url('foo'), 'https://mydomain.com/foo');
     });
 
-    it('prefers emulator to custom domain', () => {
+    it('prefers emulator to custom domain (deprecated)', () => {
       const service = createTestService(app, 'https://mydomain.com');
       useFunctionsEmulator(service, 'http://localhost:5005');
       assert.equal(
         service._url('foo'),
         'http://localhost:5005/my-project/us-central1/foo'
       );
     });
+
+    it('prefers emulator to custom domain', () => {
+      const service = createTestService(app, 'https://mydomain.com');
+      useEmulator(service, 'localhost', 5005);
+      assert.equal(
+        service._url('foo'),
+        'http://localhost:5005/my-project/us-central1/foo'
+      );
+    });
   });
 });

packages-exp/functions-exp/src/service.ts

@@ -132,10 +132,28 @@ export class FunctionsService implements _FirebaseService {
   }
 }
 
+/**
+ * Modify this instance to communicate with the Cloudd Functions emulator.
+ *
+ * <p> Note: this must be called before this instance has been used to do any operations.
+ *
+ * @param host the emulator host (ex: localhost)
+ * @param port the emulator port (ex: 5001)
+ * @public
+ */
+export function useEmulator(
+  functionsInstance: FunctionsService,
+  host: string,
+  port: number
+): void {
+  functionsInstance.emulatorOrigin = `http://${host}:${port}`;
+}
+
 /**
  * Changes this instance to point to a Cloud Functions emulator running
  * locally. See https://firebase.google.com/docs/functions/local-emulator
  *
+ * @deprecated prefer the useEmulator(host, port) method.
  * @param origin - The origin of the local emulator, such as
  * "http://localhost:5005".
  * @public

packages/firebase/index.d.ts

@@ -1799,10 +1799,22 @@ declare namespace firebase.functions {
    */
   export class Functions {
     private constructor();
+
+    /**
+     * Modify this instance to communicate with the Cloudd Functions emulator.
+     *
+     * <p>Note: this must be called before this instance has been used to do any operations.
+     *
+     * @param host the emulator host (ex: localhost)
+     * @param port the emulator port (ex: 5001)
+     */
+    useEmulator(host: string, port: number): void;
+
     /**
      * Changes this instance to point to a Cloud Functions emulator running
      * locally. See https://firebase.google.com/docs/functions/local-emulator
-     *
+     * 
+     * @deprecated prefer the useEmulator(host, port) method.
      * @param origin The origin of the local emulator, such as
      * "http://localhost:5005".
      */

packages/functions-types/index.d.ts

@@ -53,10 +53,21 @@ export class FirebaseFunctions {
    */
   httpsCallable(name: string, options?: HttpsCallableOptions): HttpsCallable;
 
+  /**
+   * Modify this instance to communicate with the Cloudd Functions emulator.
+   *
+   * <p> Note: this must be called before this instance has been used to do any operations.
+   *
+   * @param host the emulator host (ex: localhost)
+   * @param port the emulator port (ex: 5001)
+   */
+  useEmulator(host: string, port: number): void;
+
   /**
    * Changes this instance to point to a Cloud Functions emulator running
    * locally. See https://firebase.google.com/docs/functions/local-emulator
    *
+   * @deprecated prefer the useEmulator(host, port) method.
    * @param origin The origin of the local emulator, such as
    * "http://localhost:5005".
    */

packages/functions/src/api/service.ts

@@ -150,10 +150,23 @@ export class Service implements FirebaseFunctions, FirebaseService {
     return `https://${this.region}-${projectId}.cloudfunctions.net/${name}`;
   }
 
+  /**
+   * Modify this instance to communicate with the Cloudd Functions emulator.
+   *
+   * <p>Note: this must be called before this instance has been used to do any operations.
+   *
+   * @param host the emulator host (ex: localhost)
+   * @param port the emulator port (ex: 5001)
+   */
+  useEmulator(host: string, port: number): void {
+    this.emulatorOrigin = `http://${host}:${port}`;
+  }
+
   /**
    * Changes this instance to point to a Cloud Functions emulator running
    * locally. See https://firebase.google.com/docs/functions/local-emulator
    *
+   * @deprecated prefer the useEmulator(host, port) method.
    * @param origin The origin of the local emulator, such as
    * "http://localhost:5005".
    */

packages/functions/test/service.test.ts

@@ -33,13 +33,21 @@ describe('Firebase Functions > Service', () => {
       );
     });
 
-    it('can use emulator', () => {
+    it('can use emulator (deprecated)', () => {
       service.useFunctionsEmulator('http://localhost:5005');
       assert.equal(
         service._url('foo'),
         'http://localhost:5005/my-project/us-central1/foo'
       );
     });
+
+    it('can use emulator', () => {
+      service.useEmulator('localhost', 5005);
+      assert.equal(
+        service._url('foo'),
+        'http://localhost:5005/my-project/us-central1/foo'
+      );
+    });
   });
 
   describe('custom region/domain constructor', () => {
@@ -62,13 +70,22 @@ describe('Firebase Functions > Service', () => {
       assert.equal(service._url('foo'), 'https://mydomain.com/foo');
     });
 
-    it('prefers emulator to custom domain', () => {
+    it('prefers emulator to custom domain (deprecated)', () => {
       const service = createTestService(app, 'https://mydomain.com');
       service.useFunctionsEmulator('http://localhost:5005');
       assert.equal(
         service._url('foo'),
         'http://localhost:5005/my-project/us-central1/foo'
       );
     });
+
+    it('prefers emulator to custom domain', () => {
+      const service = createTestService(app, 'https://mydomain.com');
+      service.useEmulator('localhost', 5005);
+      assert.equal(
+        service._url('foo'),
+        'http://localhost:5005/my-project/us-central1/foo'
+      );
+    });
   });
 });