Added code to pass on credentials if using a cloud workstation

Author: maneesht

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 (undocumented)
+export function isCloudWorkstation(url: 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

packages/app-check/src/client.ts

@@ -25,6 +25,7 @@ import { FirebaseApp } from '@firebase/app';
 import { ERROR_FACTORY, AppCheckError } from './errors';
 import { Provider } from '@firebase/component';
 import { AppCheckTokenInternal } from './types';
+import { isCloudWorkstation } from '@firebase/util';
 
 /**
  * Response JSON returned from AppCheck server endpoint.
@@ -62,6 +63,9 @@ export async function exchangeToken(
     body: JSON.stringify(body),
     headers
   };
+  if (isCloudWorkstation(url)) {
+    options.credentials = 'include';
+  }
   let response;
   try {
     response = await fetch(url, options);

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 {
@@ -33,6 +38,7 @@ import { IdTokenMfaResponse } from './authentication/mfa';
 import { SERVER_ERROR_MAP, ServerError, ServerErrorMap } from './errors';
 import { PersistenceType } from '../core/persistence';
 import { CookiePersistence } from '../platform_browser/persistence/cookie_storage';
+import { FirebaseAuth } from '@firebase/auth-types';
 
 export const enum HttpMethod {
   POST = 'POST',
@@ -177,6 +183,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/data-connect/src/network/fetch.ts

@@ -25,6 +25,7 @@ import { SDK_VERSION } from '../core/version';
 import { logDebug, logError } from '../logger';
 
 import { CallerSdkType, CallerSdkTypeEnum } from './transport';
+import { isCloudWorkstation } from '@firebase/util';
 
 let connectFetch: typeof fetch | null = globalThis.fetch;
 export function initializeFetch(fetchImpl: typeof fetch): void {
@@ -77,14 +78,18 @@ 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)) {
+    fetchOptions.credentials = 'include';
+  }
+  logDebug(`Making request out to ${url} with body: ${bodyStr}`);
+
+  return connectFetch(url, fetchOptions)
     .catch(err => {
       throw new DataConnectError(
         Code.OTHER,

packages/firestore/src/platform/browser/webchannel_connection.ts

@@ -46,6 +46,7 @@ import { Code, FirestoreError } from '../../util/error';
 import { logDebug, logWarn } from '../../util/log';
 import { Rejecter, Resolver } from '../../util/promise';
 import { StringMap } from '../../util/types';
+import { isCloudWorkstation } from '@firebase/util';
 
 const LOG_TAG = 'WebChannelConnection';
 

packages/firestore/src/platform/browser_lite/fetch_connection.ts

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import { isCloudWorkstation } from '@firebase/util';
 import { Token } from '../../api/credentials';
 import { Stream } from '../../remote/connection';
 import { RestConnection } from '../../remote/rest_connection';
@@ -44,11 +45,15 @@ export class FetchConnection extends RestConnection {
     let response: Response;
 
     try {
-      response = await fetch(url, {
+      const fetchArgs: RequestInit = {
         method: 'POST',
         headers,
         body: requestJson
-      });
+      };
+      if (isCloudWorkstation(url)) {
+        fetchArgs.credentials = 'include';
+      }
+      response = await fetch(url, fetchArgs);
     } catch (e) {
       const err = e as { status: number | undefined; statusText: string };
       throw new FirestoreError(

packages/storage/src/platform/node/connection.ts

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import { isCloudWorkstation } from '@firebase/util';
 import {
   Connection,
   ConnectionType,
@@ -57,11 +58,7 @@ abstract class FetchConnection<T extends ConnectionType>
     this.sent_ = true;
 
     try {
-      const response = await fetch(url, {
-        method,
-        headers: headers || {},
-        body: body as NodeJS.ArrayBufferView | string
-      });
+      const response = await newFetch(url, method, headers, body);
       this.headers_ = response.headers;
       this.statusCode_ = response.status;
       this.errorCode_ = ErrorCode.NO_ERROR;
@@ -161,11 +158,7 @@ export class FetchStreamConnection extends FetchConnection<
     this.sent_ = true;
 
     try {
-      const response = await fetch(url, {
-        method,
-        headers: headers || {},
-        body: body as NodeJS.ArrayBufferView | string
-      });
+      const response = await newFetch(url, method, headers, body);
       this.headers_ = response.headers;
       this.statusCode_ = response.status;
       this.errorCode_ = ErrorCode.NO_ERROR;
@@ -186,6 +179,23 @@ export class FetchStreamConnection extends FetchConnection<
   }
 }
 
+function newFetch(
+  url: string,
+  method: string,
+  headers?: Record<string, string>,
+  body?: NodeJS.ArrayBufferView | Blob | string
+) {
+  const fetchArgs: RequestInit = {
+    method,
+    headers: headers || {},
+    body: body as NodeJS.ArrayBufferView | string
+  };
+  if (isCloudWorkstation(url)) {
+    fetchArgs.credentials = 'include';
+  }
+  return fetch(url, fetchArgs);
+}
+
 export function newStreamConnection(): Connection<ReadableStream<Uint8Array>> {
   return new FetchStreamConnection();
 }

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';

packages/util/src/url.ts

@@ -0,0 +1,3 @@
+export function isCloudWorkstation(url: string) {
+  return url.endsWith('cloudworkstations.dev');
+}