redesign framework/gen flags into CallerSdkType enum

Author: stephenarosaj

common/api-review/data-connect.api.md

@@ -11,6 +11,19 @@ import { FirebaseError } from '@firebase/util';
 import { LogLevelString } from '@firebase/logger';
 import { Provider } from '@firebase/component';
 
+// @public
+export type CallerSdkType = 'Base' | 'Generated' | 'TanstackReactCore' | 'GeneratedReact' | 'TanstackAngularCore' | 'GeneratedAngular';
+
+// @public (undocumented)
+export const CallerSdkTypeEnum: Readonly<{
+    readonly Base: "Base";
+    readonly Generated: "Generated";
+    readonly TanstackReactCore: "TanstackReactCore";
+    readonly GeneratedReact: "GeneratedReact";
+    readonly TanstackAngularCore: "TanstackAngularCore";
+    readonly GeneratedAngular: "GeneratedAngular";
+}>;
+
 // @public
 export function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
 

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

@@ -33,7 +33,7 @@ import {
 } from '../core/FirebaseAuthProvider';
 import { QueryManager } from '../core/QueryManager';
 import { logDebug, logError } from '../logger';
-import { DataConnectTransport, TransportClass } from '../network';
+import { CallerSdkType, CallerSdkTypeEnum, DataConnectTransport, TransportClass } from '../network';
 import { RESTTransport } from '../network/transport/rest';
 
 import { MutationManager } from './Mutation';
@@ -91,10 +91,7 @@ export class DataConnect {
   private _transportClass: TransportClass | undefined;
   private _transportOptions?: TransportOptions;
   private _authTokenProvider?: AuthTokenProvider;
-  _isUsingGeneratedSdk: boolean = false;
-  _isUsingTanStackSdk: boolean = false;
-  _isUsingReactSdk: boolean = false;
-  _isUsingAngularSdk: boolean = false;
+  _callerSdkType: CallerSdkType = CallerSdkTypeEnum.Base;
   private _appCheckTokenProvider?: AppCheckTokenProvider;
   // @internal
   constructor(
@@ -114,37 +111,8 @@ export class DataConnect {
     }
   }
   // @internal
-  _useGeneratedSdk(): void {
-    if (!this._isUsingGeneratedSdk) {
-      this._isUsingGeneratedSdk = true;
-    }
-  }
-  // @internal
-  _useTanStackSdk(): void {
-    if (!this._isUsingTanStackSdk) {
-      this._isUsingTanStackSdk = true;
-    }
-    if (this._transport) {
-      this._transport._useTanStack();
-    }
-  }
-  // @internal
-  _useReactSdk(): void {
-    if (!this._isUsingReactSdk) {
-      this._isUsingReactSdk = true;
-    }
-    if (this._transport) {
-      this._transport._useReact();
-    }
-  }
-  // @internal
-  _useAngularSdk(): void {
-    if (!this._isUsingAngularSdk) {
-      this._isUsingAngularSdk = true;
-    }
-    if (this._transport) {
-      this._transport._useAngular();
-    }
+  _setCallerSdkType(callerSdkType: CallerSdkType): void {
+    this._callerSdkType = callerSdkType;
   }
   _delete(): Promise<void> {
     _removeServiceInstance(
@@ -194,10 +162,7 @@ export class DataConnect {
       this._authTokenProvider,
       this._appCheckTokenProvider,
       undefined,
-      this._isUsingGeneratedSdk,
-      this._isUsingTanStackSdk,
-      this._isUsingReactSdk,
-      this._isUsingAngularSdk
+      this._callerSdkType
     );
     if (this._transportOptions) {
       this._transport.useEmulator(

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

@@ -19,37 +19,23 @@ import { Code, DataConnectError } from '../core/error';
 import { SDK_VERSION } from '../core/version';
 import { logDebug, logError } from '../logger';
 
+import { CallerSdkType, CallerSdkTypeEnum } from './transport';
+
 let connectFetch: typeof fetch | null = globalThis.fetch;
 export function initializeFetch(fetchImpl: typeof fetch): void {
   connectFetch = fetchImpl;
 }
-function getGoogApiClientValue(_isUsingGen: boolean): string {
+function getGoogApiClientValue(_callerSdkType: CallerSdkType): string {
   let str = 'gl-js/ fire/' + SDK_VERSION;
-  if (_isUsingGen) {
+  if (_callerSdkType !== CallerSdkTypeEnum.Base) {
     str += ' js/gen';
   }
   return str;
 }
 function getWebFrameworkValue(
-  _isUsingTanStack: boolean,
-  _isUsingReact: boolean,
-  _isUsingAngular: boolean
+  _callerSdkType: CallerSdkType
 ): string {
-  let str = '';
-  if (_isUsingTanStack) {
-    str += ' tanstack/';
-  }
-  if (_isUsingReact) {
-    str += ' react/';
-  }
-  if (_isUsingAngular) {
-    str += ' angular/';
-  }
-  // no framework SDK used
-  if (str === '') {
-    str = 'vanilla/';
-  }
-  return str.trim();
+  return _callerSdkType + "/";
 }
 export interface DataConnectFetchBody<T> {
   name: string;
@@ -63,22 +49,16 @@ export function dcFetch<T, U>(
   appId: string | null,
   accessToken: string | null,
   appCheckToken: string | null,
-  _isUsingGen: boolean,
-  _isUsingTanStack: boolean,
-  _isUsingReact: boolean,
-  _isUsingAngular: boolean
+  _callerSdkType: CallerSdkType
 ): Promise<{ data: T; errors: Error[] }> {
   if (!connectFetch) {
     throw new DataConnectError(Code.OTHER, 'No Fetch Implementation detected!');
   }
   const headers: HeadersInit = {
     'Content-Type': 'application/json',
-    'X-Goog-Api-Client': getGoogApiClientValue(_isUsingGen),
-    'X-Firebase-DataConnect-Web-Frameworks': getWebFrameworkValue(
-      _isUsingTanStack,
-      _isUsingReact,
-      _isUsingAngular
-    )
+    'X-Goog-Api-Client': getGoogApiClientValue(_callerSdkType),
+    'X-Firebase-DataConnect-Web-Frameworks':
+      getWebFrameworkValue(_callerSdkType)
   };
   if (accessToken) {
     headers['X-Firebase-Auth-Token'] = accessToken;

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

@@ -19,6 +19,26 @@ import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
 import { AppCheckTokenProvider } from '../../core/AppCheckTokenProvider';
 import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
 
+/**
+ * enum representing different flavors of the SDK used by developers
+ * use the CallerSdkType for type-checking, and the CallerSdkTypeEnum for value-checking/assigning
+ */
+export type CallerSdkType =
+  | 'Base' // Core JS SDK
+  | 'Generated' // Generated JS SDK
+  | 'TanstackReactCore' // Tanstack non-generated React SDK
+  | 'GeneratedReact' // Generated React SDK
+  | 'TanstackAngularCore' // Tanstack non-generated Angular SDK
+  | 'GeneratedAngular'; // Generated Angular SDK
+export const CallerSdkTypeEnum = Object.freeze({
+  Base: 'Base', // Core JS SDK
+  Generated: 'Generated', // Generated JS SDK
+  TanstackReactCore: 'TanstackReactCore', // Tanstack non-generated React SDK
+  GeneratedReact: 'GeneratedReact', // Tanstack non-generated Angular SDK
+  TanstackAngularCore: 'TanstackAngularCore', // Tanstack non-generated Angular SDK
+  GeneratedAngular: 'GeneratedAngular' // Generated Angular SDK
+} as const);
+
 /**
  * @internal
  */
@@ -33,9 +53,8 @@ export interface DataConnectTransport {
   ): Promise<{ data: T; errors: Error[] }>;
   useEmulator(host: string, port?: number, sslEnabled?: boolean): void;
   onTokenChanged: (token: string | null) => void;
-  _useTanStack(): void;
-  _useReact(): void;
-  _useAngular(): void;
+  // @internal
+  _setCallerSdkType(callerSdkType: CallerSdkType): void;
 }
 
 /**
@@ -48,8 +67,5 @@ export type TransportClass = new (
   authProvider?: AuthTokenProvider,
   appCheckProvider?: AppCheckTokenProvider,
   transportOptions?: TransportOptions,
-  _isUsingGen?: boolean,
-  _isUsingTanStack?: boolean,
-  _isUsingReact?: boolean,
-  _isUsingAngular?: boolean
+  _callerSdkType?: CallerSdkType
 ) => DataConnectTransport;

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

@@ -23,7 +23,7 @@ import { logDebug } from '../../logger';
 import { addToken, urlBuilder } from '../../util/url';
 import { dcFetch } from '../fetch';
 
-import { DataConnectTransport } from '.';
+import { CallerSdkType, CallerSdkTypeEnum, DataConnectTransport } from '.';
 
 export class RESTTransport implements DataConnectTransport {
   private _host = '';
@@ -43,10 +43,7 @@ export class RESTTransport implements DataConnectTransport {
     private authProvider?: AuthTokenProvider | undefined,
     private appCheckProvider?: AppCheckTokenProvider | undefined,
     transportOptions?: TransportOptions | undefined,
-    private _isUsingGen = false,
-    private _isUsingReact = false,
-    private _isUsingAngular = false,
-    private _isUsingTanStack = false
+    private _callerSdkType: CallerSdkType = CallerSdkTypeEnum.Base,
   ) {
     if (transportOptions) {
       if (typeof transportOptions.port === 'number') {
@@ -183,10 +180,7 @@ export class RESTTransport implements DataConnectTransport {
         this.appId,
         this._accessToken,
         this._appCheckToken,
-        this._isUsingGen,
-        this._isUsingTanStack,
-        this._isUsingReact,
-        this._isUsingAngular
+        this._callerSdkType
       )
     );
     return withAuth;
@@ -211,28 +205,14 @@ export class RESTTransport implements DataConnectTransport {
         this.appId,
         this._accessToken,
         this._appCheckToken,
-        this._isUsingGen,
-        this._isUsingTanStack,
-        this._isUsingReact,
-        this._isUsingAngular
+        this._callerSdkType
       );
     });
     return taskResult;
   };
 
-  _useTanStack(): void {
-    if (!this._isUsingTanStack) {
-      this._isUsingTanStack = true;
-    }
-  }
-  _useReact(): void {
-    if (!this._isUsingReact) {
-      this._isUsingReact = true;
-    }
-  }
-  _useAngular(): void {
-    if (!this._isUsingAngular) {
-      this._isUsingAngular = true;
-    }
+  // @internal
+  _setCallerSdkType(callerSdkType: CallerSdkType): void {
+    this._callerSdkType = callerSdkType;
   }
 }

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

@@ -20,6 +20,7 @@ import chaiAsPromised from 'chai-as-promised';
 import * as sinon from 'sinon';
 
 import { dcFetch, initializeFetch } from '../../src/network/fetch';
+import { CallerSdkTypeEnum } from '../../src/network/transport';
 use(chaiAsPromised);
 function mockFetch(json: object): void {
   const fakeFetchImpl = sinon.stub().returns(
@@ -51,10 +52,7 @@ describe('fetch', () => {
         null,
         null,
         null,
-        false,
-        false,
-        false,
-        false
+        CallerSdkTypeEnum.Base
       )
     ).to.eventually.be.rejectedWith(message);
   });
@@ -77,10 +75,7 @@ describe('fetch', () => {
         null,
         null,
         null,
-        false,
-        false,
-        false,
-        false
+        CallerSdkTypeEnum.Base
       )
     ).to.eventually.be.rejectedWith(JSON.stringify(json));
   });