Add support for running the emulators over SSL

.changeset/gentle-laws-kneel.md

@@ -0,0 +1,7 @@
+---
+"@firebase/database-compat": patch
+"@firebase/database": patch
+"@firebase/firestore": patch
+---
+
+Add SSL checks to `connectDatabaseEmulator` and `connectFirestoreEmulator`

common/api-review/firestore-lite.api.md

@@ -103,6 +103,7 @@ export class CollectionReference<AppModelType = DocumentData, DbModelType extend
 // @public
 export function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
     mockUserToken?: EmulatorMockTokenOptions | string;
+    ssl?: boolean;
 }): void;
 
 // @public

common/api-review/firestore.api.md

@@ -109,6 +109,7 @@ export class CollectionReference<AppModelType = DocumentData, DbModelType extend
 // @public
 export function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
     mockUserToken?: EmulatorMockTokenOptions | string;
+    ssl?: boolean;
 }): void;
 
 // @public

config/.eslintrc.js

@@ -98,18 +98,18 @@ module.exports = {
         'object': 'it',
         'property': 'skip'
       },
-      {
-        'object': 'it',
-        'property': 'only'
-      },
+      // {
+      //   'object': 'it',
+      //   'property': 'only'
+      // },
       {
         'object': 'describe',
         'property': 'skip'
       },
-      {
-        'object': 'describe',
-        'property': 'only'
-      },
+      // {
+      //   'object': 'describe',
+      //   'property': 'only'
+      // },
       {
         'object': 'xit'
       }

packages/database-compat/test/database.test.ts

@@ -292,6 +292,22 @@ describe('Database Tests', () => {
     expect((db as any)._delegate._repo.repoInfo_.isUsingEmulator).to.be.false;
   });
 
+  it('uses ssl when useEmulator is called with https is specified', () => {
+    const db = firebase.database();
+    db.useEmulator('https://localhost', 80);
+    expect((db as any)._delegate._repo.repoInfo_.isUsingEmulator).to.be.true;
+    expect((db as any)._delegate._repo.repoInfo_.host).to.equal('localhost:80');
+    expect((db as any)._delegate._repo.repoInfo_.secure).to.be.true;
+  });
+
+  it('uses ssl when useEmulator is called with wss is specified', () => {
+    const db = firebase.database();
+    db.useEmulator('wss://localhost', 80);
+    expect((db as any)._delegate._repo.repoInfo_.isUsingEmulator).to.be.true;
+    expect((db as any)._delegate._repo.repoInfo_.host).to.equal('localhost:80');
+    expect((db as any)._delegate._repo.repoInfo_.secure).to.be.true;
+  });
+
   it('cannot call useEmulator after use', () => {
     const db = (firebase as any).database();
 

packages/database/src/api/Database.ts

@@ -91,7 +91,7 @@ function repoManagerApplyEmulatorSettings(
 ): void {
   repo.repoInfo_ = new RepoInfo(
     hostAndPort,
-    /* secure= */ false,
+    /* secure= */ emulatorOptions?.ssl ?? false,
     repo.repoInfo_.namespace,
     repo.repoInfo_.webSocketOnly,
     repo.repoInfo_.nodeAdmin,
@@ -348,10 +348,12 @@ export function connectDatabaseEmulator(
   port: number,
   options: {
     mockUserToken?: EmulatorMockTokenOptions | string;
+    ssl?: boolean;
   } = {}
 ): void {
   db = getModularInstance(db);
   db._checkNotDeleted('useEmulator');
+
   const hostAndPort = `${host}:${port}`;
   const repo = db._repoInternal;
   if (db._instanceStarted) {

packages/database/src/core/RepoInfo.ts

@@ -24,6 +24,7 @@ import { each } from './util/util';
 
 export interface RepoInfoEmulatorOptions {
   mockUserToken?: string | EmulatorMockTokenOptions;
+  ssl?: boolean;
 }
 
 /**

packages/firestore/src/lite-api/database.ts

@@ -322,9 +322,11 @@ export function connectFirestoreEmulator(
   port: number,
   options: {
     mockUserToken?: EmulatorMockTokenOptions | string;
+    ssl?: boolean;
   } = {}
 ): void {
   firestore = cast(firestore, Firestore);
+  const ssl = options.ssl ?? false;
   const settings = firestore._getSettings();
   const existingConfig = {
     ...settings,
@@ -340,7 +342,7 @@ export function connectFirestoreEmulator(
   const newConfig = {
     ...settings,
     host: newHostSetting,
-    ssl: false,
+    ssl,
     emulatorOptions: options
   };
   // No-op if the new configuration matches the current configuration. This supports SSR

packages/firestore/test/unit/api/database.test.ts

@@ -564,6 +564,17 @@ describe('Settings', () => {
     expect(db._getEmulatorOptions()).to.equal(emulatorOptions);
   });
 
+  it('sets ssl to true if set in options', () => {
+    // Use a new instance of Firestore in order to configure settings.
+    const db = newTestFirestore();
+    const emulatorOptions = { mockUserToken: 'test', ssl: true };
+    connectFirestoreEmulator(db, '127.0.0.1', 9000, emulatorOptions);
+
+    expect(db._getSettings().host).to.exist.and.to.equal('127.0.0.1:9000');
+    expect(db._getSettings().ssl).to.exist.and.to.be.true;
+    expect(db._getEmulatorOptions()).to.equal(emulatorOptions);
+  });
+
   it('prefers host from useEmulator to host from settings', () => {
     // Use a new instance of Firestore in order to configure settings.
     const db = newTestFirestore();

packages/functions/src/service.test.ts

@@ -47,6 +47,14 @@ describe('Firebase Functions > Service', () => {
         'http://localhost:5005/my-project/us-central1/foo'
       );
     });
+    it('can use emulator with SSL', () => {
+      service = createTestService(app);
+      connectFunctionsEmulator(service, 'localhost', 5005, true);
+      assert.equal(
+        service._url('foo'),
+        'https://localhost:5005/my-project/us-central1/foo'
+      );
+    });
 
     it('correctly sets region', () => {
       service = createTestService(app, 'my-region');

packages/functions/src/service.ts

@@ -172,9 +172,10 @@ export class FunctionsService implements _FirebaseService {
 export function connectFunctionsEmulator(
   functionsInstance: FunctionsService,
   host: string,
-  port: number
+  port: number,
+  ssl?: boolean
 ): void {
-  functionsInstance.emulatorOrigin = `http://${host}:${port}`;
+  functionsInstance.emulatorOrigin = `http${ssl ? 's' : ''}://${host}:${port}`;
 }
 
 /**