Add support for running the emulators in Cloud Workstation (#8968)

Author: maneesht

.changeset/nine-pugs-crash.md

@@ -0,0 +1,11 @@
+---
+"@firebase/auth": patch
+"@firebase/data-connect": patch
+"@firebase/database-compat": patch
+"@firebase/database": patch
+"@firebase/firestore": patch
+"@firebase/storage": patch
+"@firebase/util": patch
+---
+
+Fix Auth Redirects on Firebase Studio

common/api-review/storage.api.md

@@ -58,7 +58,7 @@ export class _FirebaseStorageImpl implements FirebaseStorage {
     constructor(
     app: FirebaseApp, _authProvider: Provider<FirebaseAuthInternalName>,
     _appCheckProvider: Provider<AppCheckInternalComponentName>,
-    _url?: string | undefined, _firebaseVersion?: string | undefined);
+    _url?: string | undefined, _firebaseVersion?: string | undefined, _isUsingEmulator?: boolean);
     readonly app: FirebaseApp;
     // (undocumented)
     readonly _appCheckProvider: Provider<AppCheckInternalComponentName>;
@@ -77,6 +77,8 @@ export class _FirebaseStorageImpl implements FirebaseStorage {
     _getAuthToken(): Promise<string | null>;
     get host(): string;
     set host(host: string);
+    // (undocumented)
+    _isUsingEmulator: boolean;
     // Warning: (ae-forgotten-export) The symbol "ConnectionType" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "RequestInfo" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "Connection" needs to be exported by the entry point index.d.ts

packages/auth/src/api/index.test.ts

@@ -60,6 +60,10 @@ describe('api/_performApiRequest', () => {
     auth = await testAuth();
   });
 
+  afterEach(() => {
+    sinon.restore();
+  });
+
   context('with regular requests', () => {
     beforeEach(mockFetch.setUp);
     afterEach(mockFetch.tearDown);
@@ -80,6 +84,26 @@ describe('api/_performApiRequest', () => {
       expect(mock.calls[0].headers!.get(HttpHeader.X_CLIENT_VERSION)).to.eq(
         'testSDK/0.0.0'
       );
+      expect(mock.calls[0].fullRequest?.credentials).to.be.undefined;
+    });
+
+    it('should set credentials to "include" when using IDX and emulator', async () => {
+      const mock = mockEndpoint(Endpoint.SIGN_UP, serverResponse);
+      auth.emulatorConfig = {
+        host: 'https://something.cloudworkstations.dev',
+        protocol: '',
+        port: 8,
+        options: {
+          disableWarnings: false
+        }
+      };
+      await _performApiRequest<typeof request, typeof serverResponse>(
+        auth,
+        HttpMethod.POST,
+        Endpoint.SIGN_UP,
+        request
+      );
+      expect(mock.calls[0].fullRequest?.credentials).to.eq('include');
     });
 
     it('should set the device language if available', async () => {

packages/auth/src/api/index.ts

@@ -15,7 +15,12 @@
  * limitations under the License.
  */
 
-import { FirebaseError, isCloudflareWorker, querystring } from '@firebase/util';
+import {
+  FirebaseError,
+  isCloudflareWorker,
+  isCloudWorkstation,
+  querystring
+} from '@firebase/util';
 
 import { AuthErrorCode, NamedErrorParams } from '../core/errors';
 import {
@@ -177,6 +182,10 @@ export async function _performApiRequest<T, V>(
       fetchArgs.referrerPolicy = 'no-referrer';
     }
 
+    if (auth.emulatorConfig && isCloudWorkstation(auth.emulatorConfig.host)) {
+      fetchArgs.credentials = 'include';
+    }
+
     return FetchProvider.fetch()(
       await _getFinalTarget(auth, auth.config.apiHost, path, query),
       fetchArgs

packages/auth/test/helpers/mock_fetch.ts

@@ -22,6 +22,7 @@ export interface Call {
   request?: object | string;
   method?: string;
   headers: Headers;
+  fullRequest?: RequestInit;
 }
 
 export interface Route {
@@ -59,7 +60,8 @@ const fakeFetch: typeof fetch = (
   calls.push({
     request: requestBody,
     method: request?.method,
-    headers
+    headers,
+    fullRequest: request
   });
 
   return Promise.resolve(

packages/data-connect/src/network/fetch.ts

@@ -15,14 +15,16 @@
  * limitations under the License.
  */
 
+import { isCloudWorkstation } from '@firebase/util';
+
 import {
   Code,
   DataConnectError,
   DataConnectOperationError,
   DataConnectOperationFailureResponse
 } from '../core/error';
 import { SDK_VERSION } from '../core/version';
-import { logDebug, logError } from '../logger';
+import { logError } from '../logger';
 
 import { CallerSdkType, CallerSdkTypeEnum } from './transport';
 
@@ -58,7 +60,8 @@ export function dcFetch<T, U>(
   accessToken: string | null,
   appCheckToken: string | null,
   _isUsingGen: boolean,
-  _callerSdkType: CallerSdkType
+  _callerSdkType: CallerSdkType,
+  _isUsingEmulator: boolean
 ): Promise<{ data: T; errors: Error[] }> {
   if (!connectFetch) {
     throw new DataConnectError(Code.OTHER, 'No Fetch Implementation detected!');
@@ -77,14 +80,17 @@ export function dcFetch<T, U>(
     headers['X-Firebase-AppCheck'] = appCheckToken;
   }
   const bodyStr = JSON.stringify(body);
-  logDebug(`Making request out to ${url} with body: ${bodyStr}`);
-
-  return connectFetch(url, {
+  const fetchOptions: RequestInit = {
     body: bodyStr,
     method: 'POST',
     headers,
     signal
-  })
+  };
+  if (isCloudWorkstation(url) && _isUsingEmulator) {
+    fetchOptions.credentials = 'include';
+  }
+
+  return connectFetch(url, fetchOptions)
     .catch(err => {
       throw new DataConnectError(
         Code.OTHER,

packages/data-connect/src/network/transport/rest.ts

@@ -36,6 +36,7 @@ export class RESTTransport implements DataConnectTransport {
   private _accessToken: string | null = null;
   private _appCheckToken: string | null = null;
   private _lastToken: string | null = null;
+  private _isUsingEmulator = false;
   constructor(
     options: DataConnectOptions,
     private apiKey?: string | undefined,
@@ -93,6 +94,7 @@ export class RESTTransport implements DataConnectTransport {
   }
   useEmulator(host: string, port?: number, isSecure?: boolean): void {
     this._host = host;
+    this._isUsingEmulator = true;
     if (typeof port === 'number') {
       this._port = port;
     }
@@ -182,7 +184,8 @@ export class RESTTransport implements DataConnectTransport {
         this._accessToken,
         this._appCheckToken,
         this._isUsingGen,
-        this._callerSdkType
+        this._callerSdkType,
+        this._isUsingEmulator
       )
     );
     return withAuth;
@@ -208,7 +211,8 @@ export class RESTTransport implements DataConnectTransport {
         this._accessToken,
         this._appCheckToken,
         this._isUsingGen,
-        this._callerSdkType
+        this._callerSdkType,
+        this._isUsingEmulator
       );
     });
     return taskResult;

packages/data-connect/test/unit/fetch.test.ts

@@ -18,10 +18,12 @@
 import { expect, use } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import * as sinon from 'sinon';
+import sinonChai from 'sinon-chai';
 
 import { dcFetch, initializeFetch } from '../../src/network/fetch';
 import { CallerSdkType, CallerSdkTypeEnum } from '../../src/network/transport';
 use(chaiAsPromised);
+use(sinonChai);
 function mockFetch(json: object, reject: boolean): sinon.SinonStub {
   const fakeFetchImpl = sinon.stub().returns(
     Promise.resolve({
@@ -57,7 +59,8 @@ describe('fetch', () => {
         null,
         null,
         false,
-        CallerSdkTypeEnum.Base
+        CallerSdkTypeEnum.Base,
+        false
       )
     ).to.eventually.be.rejectedWith(message);
   });
@@ -81,7 +84,8 @@ describe('fetch', () => {
         null,
         null,
         false,
-        CallerSdkTypeEnum.Base
+        CallerSdkTypeEnum.Base,
+        false
       )
     ).to.eventually.be.rejectedWith(JSON.stringify(json));
   });
@@ -112,7 +116,8 @@ describe('fetch', () => {
         null,
         null,
         false,
-        CallerSdkTypeEnum.Base
+        CallerSdkTypeEnum.Base,
+        false
       )
     ).to.eventually.be.rejected.then(error => {
       expect(error.response.data).to.eq(json.data);
@@ -143,7 +148,8 @@ describe('fetch', () => {
           null,
           null,
           false, // _isUsingGen is false
-          callerSdkType as CallerSdkType
+          callerSdkType as CallerSdkType,
+          false
         );
 
         let expectedHeaderRegex: RegExp;
@@ -191,7 +197,8 @@ describe('fetch', () => {
           null,
           null,
           true, // _isUsingGen is true
-          callerSdkType as CallerSdkType
+          callerSdkType as CallerSdkType,
+          false
         );
 
         let expectedHeaderRegex: RegExp;
@@ -215,4 +222,30 @@ describe('fetch', () => {
       }
     }
   });
+  it('should call credentials include if using emulator on cloud workstation', async () => {
+    const json = {
+      code: 200,
+      message1: 'success'
+    };
+    const fakeFetchImpl = mockFetch(json, false);
+    await dcFetch(
+      'https://abc.cloudworkstations.dev',
+      {
+        name: 'n',
+        operationName: 'n',
+        variables: {}
+      },
+      {} as AbortController,
+      null,
+      null,
+      null,
+      true, // _isUsingGen is true
+      CallerSdkTypeEnum.Base,
+      true
+    );
+    expect(fakeFetchImpl).to.have.been.calledWithMatch(
+      'https://abc.cloudworkstations.dev',
+      { credentials: 'include' }
+    );
+  });
 });

packages/firestore/externs.json

@@ -30,6 +30,7 @@
     "packages/util/dist/src/defaults.d.ts",
     "packages/util/dist/src/emulator.d.ts",
     "packages/util/dist/src/environment.d.ts",
+    "packages/util/dist/src/url.d.ts",
     "packages/util/dist/src/compat.d.ts",
     "packages/util/dist/src/global.d.ts",
     "packages/util/dist/src/obj.d.ts",

packages/firestore/src/core/database_info.ts

@@ -48,7 +48,8 @@ export class DatabaseInfo {
     readonly forceLongPolling: boolean,
     readonly autoDetectLongPolling: boolean,
     readonly longPollingOptions: ExperimentalLongPollingOptions,
-    readonly useFetchStreams: boolean
+    readonly useFetchStreams: boolean,
+    readonly isUsingEmulator: boolean
   ) {}
 }