Add Cookie Support For Firebase Studio (#8986)

Author: maneesht

common/api-review/util.api.md

@@ -398,6 +398,9 @@ export function ordinal(i: number): string;
 // @public (undocumented)
 export type PartialObserver<T> = Partial<Observer<T>>;
 
+// @public
+export function pingServer(endpoint: string): Promise<boolean>;
+
 // Warning: (ae-internal-missing-underscore) The name "promiseWithTimeout" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal

packages/auth/src/core/auth/emulator.ts

@@ -18,7 +18,7 @@ import { Auth } from '../../model/public_types';
 import { AuthErrorCode } from '../errors';
 import { _assert } from '../util/assert';
 import { _castAuth } from './auth_impl';
-import { deepEqual } from '@firebase/util';
+import { deepEqual, isCloudWorkstation, pingServer } from '@firebase/util';
 
 /**
  * Changes the {@link Auth} instance to communicate with the Firebase Auth Emulator, instead of production
@@ -100,6 +100,11 @@ export function connectAuthEmulator(
   if (!disableWarnings) {
     emitEmulatorWarning();
   }
+
+  // Workaround to get cookies in Firebase Studio
+  if (isCloudWorkstation(host)) {
+    void pingServer(`${protocol}//${host}:${port}`);
+  }
 }
 
 function extractProtocol(url: string): string {

packages/data-connect/src/api/DataConnect.ts

@@ -24,6 +24,7 @@ import {
 import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
+import { isCloudWorkstation, pingServer } from '@firebase/util';
 
 import { AppCheckTokenProvider } from '../core/AppCheckTokenProvider';
 import { Code, DataConnectError } from '../core/error';
@@ -237,6 +238,10 @@ export function connectDataConnectEmulator(
   port?: number,
   sslEnabled = false
 ): void {
+  // Workaround to get cookies in Firebase Studio
+  if (isCloudWorkstation(host)) {
+    void pingServer(`https://${host}${port ? `:${port}` : ''}`);
+  }
   dc.enableEmulator({ host, port, sslEnabled });
 }
 

packages/database/src/api/Database.ts

@@ -30,7 +30,8 @@ import {
   deepEqual,
   EmulatorMockTokenOptions,
   getDefaultEmulatorHostnameAndPort,
-  isCloudWorkstation
+  isCloudWorkstation,
+  pingServer
 } from '@firebase/util';
 
 import { AppCheckTokenProvider } from '../core/AppCheckTokenProvider';
@@ -389,6 +390,11 @@ export function connectDatabaseEmulator(
     tokenProvider = new EmulatorTokenProvider(token);
   }
 
+  // Workaround to get cookies in Firebase Studio
+  if (isCloudWorkstation(host)) {
+    void pingServer(host);
+  }
+
   // Modify the repo to apply emulator settings
   repoManagerApplyEmulatorSettings(repo, hostAndPort, options, tokenProvider);
 }

packages/firestore/src/api/database.ts

@@ -21,7 +21,12 @@ import {
   FirebaseApp,
   getApp
 } from '@firebase/app';
-import { deepEqual, getDefaultEmulatorHostnameAndPort } from '@firebase/util';
+import {
+  deepEqual,
+  getDefaultEmulatorHostnameAndPort,
+  isCloudWorkstation,
+  pingServer
+} from '@firebase/util';
 
 import { User } from '../auth/user';
 import {
@@ -194,6 +199,11 @@ export function initializeFirestore(
     );
   }
 
+  // Workaround to get cookies in Firebase Studio
+  if (settings.host && isCloudWorkstation(settings.host)) {
+    void pingServer(settings.host);
+  }
+
   return provider.initialize({
     options: settings,
     instanceIdentifier: databaseId

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

@@ -27,7 +27,8 @@ import {
   deepEqual,
   EmulatorMockTokenOptions,
   getDefaultEmulatorHostnameAndPort,
-  isCloudWorkstation
+  isCloudWorkstation,
+  pingServer
 } from '@firebase/util';
 
 import {
@@ -333,6 +334,9 @@ export function connectFirestoreEmulator(
     emulatorOptions: firestore._getEmulatorOptions()
   };
   const newHostSetting = `${host}:${port}`;
+  if (useSsl) {
+    void pingServer(`https://${newHostSetting}`);
+  }
   if (settings.host !== DEFAULT_HOST && settings.host !== newHostSetting) {
     logWarn(
       'Host has been set in both settings() and connectFirestoreEmulator(), emulator host ' +

packages/functions/src/service.ts

@@ -30,7 +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';
+import { isCloudWorkstation, pingServer } from '@firebase/util';
 
 export const DEFAULT_REGION = 'us-central1';
 
@@ -179,6 +179,10 @@ export function connectFunctionsEmulator(
   functionsInstance.emulatorOrigin = `http${
     useSsl ? 's' : ''
   }://${host}:${port}`;
+  // Workaround to get cookies in Firebase Studio
+  if (useSsl) {
+    void pingServer(functionsInstance.emulatorOrigin);
+  }
 }
 
 /**

packages/storage/src/service.ts

@@ -45,7 +45,8 @@ import { FirebaseStorage } from './public-types';
 import {
   createMockUserToken,
   EmulatorMockTokenOptions,
-  isCloudWorkstation
+  isCloudWorkstation,
+  pingServer
 } from '@firebase/util';
 import { Connection, ConnectionType } from './implementation/connection';
 
@@ -146,6 +147,10 @@ export function connectStorageEmulator(
 ): void {
   storage.host = `${host}:${port}`;
   const useSsl = isCloudWorkstation(host);
+  // Workaround to get cookies in Firebase Studio
+  if (useSsl) {
+    void pingServer(`https://${storage.host}`);
+  }
   storage._isUsingEmulator = true;
   storage._protocol = useSsl ? 'https' : 'http';
   const { mockUserToken } = options;

packages/util/src/url.ts

@@ -22,3 +22,15 @@
 export function isCloudWorkstation(host: string): boolean {
   return host.endsWith('.cloudworkstations.dev');
 }
+
+/**
+ * Makes a fetch request to the given server.
+ * Mostly used for forwarding cookies in Firebase Studio.
+ * @public
+ */
+export async function pingServer(endpoint: string): Promise<boolean> {
+  const result = await fetch(endpoint, {
+    credentials: 'include'
+  });
+  return result.ok;
+}