Only checked if user is on cloudworkstation for ssl

maneesht · maneesht · commit d305dec092a3 · 2025-04-28T17:05:29.000-07:00
diff --git a/common/api-review/firestore-lite.api.md b/common/api-review/firestore-lite.api.md
@@ -103,7 +103,6 @@ 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
diff --git a/common/api-review/firestore.api.md b/common/api-review/firestore.api.md
@@ -109,7 +109,6 @@ 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
diff --git a/common/api-review/functions.api.md b/common/api-review/functions.api.md
@@ -8,7 +8,7 @@ import { FirebaseApp } from '@firebase/app';
 import { FirebaseError } from '@firebase/util';
 
 // @public
-export function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number, ssl?: boolean): void;
+export function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
 
 // @public
 export interface Functions {
diff --git a/common/api-review/storage.api.md b/common/api-review/storage.api.md
@@ -19,7 +19,6 @@ import { Unsubscribe } from '@firebase/util';
 // @public
 export function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
     mockUserToken?: EmulatorMockTokenOptions | string;
-    ssl?: boolean;
 }): void;
 
 // Warning: (ae-forgotten-export) The symbol "StringData" needs to be exported by the entry point index.d.ts
diff --git a/common/api-review/util.api.md b/common/api-review/util.api.md
@@ -269,6 +269,11 @@ export function isBrowserExtension(): boolean;
 // @public
 export function isCloudflareWorker(): boolean;
 
+// Warning: (ae-missing-release-tag) "isCloudWorkstation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function isCloudWorkstation(host: string): boolean;
+
 // Warning: (ae-missing-release-tag) "isElectron" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
diff --git a/packages/database-compat/src/api/Database.ts b/packages/database-compat/src/api/Database.ts
@@ -72,7 +72,6 @@ export class Database implements FirebaseService, Compat<ModularDatabase> {
     port: number,
     options: {
       mockUserToken?: EmulatorMockTokenOptions;
-      ssl?: boolean;
     } = {}
   ): void {
     connectDatabaseEmulator(this._delegate, host, port, options);
diff --git a/packages/database-types/index.d.ts b/packages/database-types/index.d.ts
@@ -47,7 +47,6 @@ export interface Database {
     port: number,
     options?: {
       mockUserToken?: EmulatorMockTokenOptions | string;
-      ssl?: boolean;
     }
   ): void;
   goOffline(): void;
@@ -64,7 +63,6 @@ export class FirebaseDatabase implements Database {
     port: number,
     options?: {
       mockUserToken?: EmulatorMockTokenOptions | string;
-      ssl?: boolean;
     }
   ): void;
   goOffline(): void;
diff --git a/packages/database/src/api/Database.ts b/packages/database/src/api/Database.ts
@@ -29,7 +29,8 @@ import {
   createMockUserToken,
   deepEqual,
   EmulatorMockTokenOptions,
-  getDefaultEmulatorHostnameAndPort
+  getDefaultEmulatorHostnameAndPort,
+  isCloudWorkstation
 } from '@firebase/util';
 
 import { AppCheckTokenProvider } from '../core/AppCheckTokenProvider';
@@ -89,9 +90,12 @@ function repoManagerApplyEmulatorSettings(
   emulatorOptions: RepoInfoEmulatorOptions,
   tokenProvider?: AuthTokenProvider
 ): void {
+  const portIndex = hostAndPort.lastIndexOf(':');
+  const host = hostAndPort.substring(portIndex);
+  const useSsl = isCloudWorkstation(host);
   repo.repoInfo_ = new RepoInfo(
     hostAndPort,
-    /* secure= */ emulatorOptions?.ssl ?? false,
+    /* secure= */ useSsl,
     repo.repoInfo_.namespace,
     repo.repoInfo_.webSocketOnly,
     repo.repoInfo_.nodeAdmin,
@@ -348,7 +352,6 @@ export function connectDatabaseEmulator(
   port: number,
   options: {
     mockUserToken?: EmulatorMockTokenOptions | string;
-    ssl?: boolean;
   } = {}
 ): void {
   db = getModularInstance(db);
diff --git a/packages/database/src/core/RepoInfo.ts b/packages/database/src/core/RepoInfo.ts
@@ -24,7 +24,6 @@ import { each } from './util/util';
 
 export interface RepoInfoEmulatorOptions {
   mockUserToken?: string | EmulatorMockTokenOptions;
-  ssl?: boolean;
 }
 
 /**
diff --git a/packages/firestore/externs.json b/packages/firestore/externs.json
@@ -33,6 +33,7 @@
     "packages/util/dist/src/compat.d.ts",
     "packages/util/dist/src/global.d.ts",
     "packages/util/dist/src/obj.d.ts",
+    "packages/util/dist/src/url.d.ts",
     "packages/firestore/src/protos/firestore_bundle_proto.ts",
     "packages/firestore/src/protos/firestore_proto_api.ts",
     "packages/firestore/src/util/error.ts",
diff --git a/packages/firestore/src/lite-api/database.ts b/packages/firestore/src/lite-api/database.ts
@@ -26,7 +26,8 @@ import {
   createMockUserToken,
   deepEqual,
   EmulatorMockTokenOptions,
-  getDefaultEmulatorHostnameAndPort
+  getDefaultEmulatorHostnameAndPort,
+  isCloudWorkstation
 } from '@firebase/util';
 
 import {
@@ -322,11 +323,10 @@ export function connectFirestoreEmulator(
   port: number,
   options: {
     mockUserToken?: EmulatorMockTokenOptions | string;
-    ssl?: boolean;
   } = {}
 ): void {
   firestore = cast(firestore, Firestore);
-  const ssl = options.ssl ?? false;
+  const useSsl = isCloudWorkstation(host);
   const settings = firestore._getSettings();
   const existingConfig = {
     ...settings,
@@ -342,7 +342,7 @@ export function connectFirestoreEmulator(
   const newConfig = {
     ...settings,
     host: newHostSetting,
-    ssl,
+    ssl: useSsl,
     emulatorOptions: options
   };
   // No-op if the new configuration matches the current configuration. This supports SSR
diff --git a/packages/firestore/test/unit/api/database.test.ts b/packages/firestore/test/unit/api/database.test.ts
@@ -564,13 +564,16 @@ describe('Settings', () => {
     expect(db._getEmulatorOptions()).to.equal(emulatorOptions);
   });
 
-  it('sets ssl to true if set in options', () => {
+  it('sets ssl to true if cloud workstation host', () => {
     // 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);
+    const emulatorOptions = { mockUserToken: 'test' };
+    const workstationHost = 'abc.workstations.dev';
+    connectFirestoreEmulator(db, workstationHost, 9000, emulatorOptions);
 
-    expect(db._getSettings().host).to.exist.and.to.equal('127.0.0.1:9000');
+    expect(db._getSettings().host).to.exist.and.to.equal(
+      `${workstationHost}:9000`
+    );
     expect(db._getSettings().ssl).to.exist.and.to.be.true;
     expect(db._getEmulatorOptions()).to.equal(emulatorOptions);
   });
diff --git a/packages/functions/src/api.ts b/packages/functions/src/api.ts
@@ -75,13 +75,11 @@ export function connectFunctionsEmulator(
   functionsInstance: Functions,
   host: string,
   port: number,
-  ssl?: boolean
 ): void {
   _connectFunctionsEmulator(
     getModularInstance<FunctionsService>(functionsInstance as FunctionsService),
     host,
-    port,
-    ssl
+    port
   );
 }
 
diff --git a/packages/functions/src/service.test.ts b/packages/functions/src/service.test.ts
@@ -49,10 +49,11 @@ describe('Firebase Functions > Service', () => {
     });
     it('can use emulator with SSL', () => {
       service = createTestService(app);
-      connectFunctionsEmulator(service, 'localhost', 5005, true);
+      const workstationHost = 'abc.cloudworkstations.dev';
+      connectFunctionsEmulator(service, workstationHost, 5005);
       assert.equal(
         service._url('foo'),
-        'https://localhost:5005/my-project/us-central1/foo'
+        `https://${workstationHost}:5005/my-project/us-central1/foo`
       );
     });
 
diff --git a/packages/functions/src/service.ts b/packages/functions/src/service.ts
@@ -30,6 +30,7 @@ import { Provider } from '@firebase/component';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { MessagingInternalComponentName } from '@firebase/messaging-interop-types';
 import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { isCloudWorkstation } from '@firebase/util';
 
 export const DEFAULT_REGION = 'us-central1';
 
@@ -172,10 +173,12 @@ export class FunctionsService implements _FirebaseService {
 export function connectFunctionsEmulator(
   functionsInstance: FunctionsService,
   host: string,
-  port: number,
-  ssl?: boolean
+  port: number
 ): void {
-  functionsInstance.emulatorOrigin = `http${ssl ? 's' : ''}://${host}:${port}`;
+  const useSsl = isCloudWorkstation(host);
+  functionsInstance.emulatorOrigin = `http${
+    useSsl ? 's' : ''
+  }://${host}:${port}`;
 }
 
 /**
diff --git a/packages/storage/src/api.ts b/packages/storage/src/api.ts
@@ -359,7 +359,6 @@ export function connectStorageEmulator(
   port: number,
   options: {
     mockUserToken?: EmulatorMockTokenOptions | string;
-    ssl?: boolean;
   } = {}
 ): void {
   connectEmulatorInternal(storage as FirebaseStorageImpl, host, port, options);
diff --git a/packages/storage/src/service.ts b/packages/storage/src/service.ts
@@ -42,7 +42,11 @@ import {
 } from './implementation/error';
 import { validateNumber } from './implementation/type';
 import { FirebaseStorage } from './public-types';
-import { createMockUserToken, EmulatorMockTokenOptions } from '@firebase/util';
+import {
+  createMockUserToken,
+  EmulatorMockTokenOptions,
+  isCloudWorkstation
+} from '@firebase/util';
 import { Connection, ConnectionType } from './implementation/connection';
 
 export function isUrl(path?: string): boolean {
@@ -138,11 +142,11 @@ export function connectStorageEmulator(
   port: number,
   options: {
     mockUserToken?: EmulatorMockTokenOptions | string;
-    ssl?: boolean;
   } = {}
 ): void {
   storage.host = `${host}:${port}`;
-  storage._protocol = options.ssl ? 'https' : 'http';
+  const useSsl = isCloudWorkstation(host);
+  storage._protocol = useSsl ? 'https' : 'http';
   const { mockUserToken } = options;
   if (mockUserToken) {
     storage._overrideAuthToken =
diff --git a/packages/storage/test/unit/service.test.ts b/packages/storage/test/unit/service.test.ts
@@ -264,8 +264,9 @@ GOOG4-RSA-SHA256`
         testShared.fakeAuthProvider,
         testShared.fakeAppCheckTokenProvider
       );
-      connectStorageEmulator(service, 'test.host.org', 1234, { ssl: true });
-      expect(service.host).to.equal('test.host.org:1234');
+      const workstationHost = 'test.cloudworkations.dev';
+      connectStorageEmulator(service, workstationHost, 1234);
+      expect(service.host).to.equal(`${workstationHost}:1234`);
       expect(service._protocol).to.equal('https');
       void getDownloadURL(ref(service, 'test.png'));
     });
diff --git a/packages/util/index.node.ts b/packages/util/index.node.ts
@@ -42,3 +42,4 @@ export * from './src/exponential_backoff';
 export * from './src/formatters';
 export * from './src/compat';
 export * from './src/global';
+export * from './src/url';
diff --git a/packages/util/index.ts b/packages/util/index.ts
@@ -37,3 +37,4 @@ export * from './src/exponential_backoff';
 export * from './src/formatters';
 export * from './src/compat';
 export * from './src/global';
+export * from './src/url';
diff --git a/packages/util/src/url.ts b/packages/util/src/url.ts
@@ -0,0 +1,6 @@
+/**
+ * Checks whether host is a cloud workstation or not.
+ */
+export function isCloudWorkstation(host: string) {
+    return host.endsWith('.cloudworkstations.dev');
+}

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@ import { each } from './util/util';`
`24`	`24`
`25`	`25`	`export interface RepoInfoEmulatorOptions {`
`26`	`26`	`mockUserToken?: string \| EmulatorMockTokenOptions;`
`27`		`- ssl?: boolean;`
`28`	`27`	`}`
`29`	`28`
`30`	`29`	`/**`