Add logging capability to track whether the user is using Core or Gen SDK (#8385)

* Wrote tests for user agent

* Added another test

* Update API reports

* Fixed linting errors

* Fixed tests

* Updated changelog

* Updated changelog again

* Updated formatting

* Updated docgen

Author: maneesht

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

@@ -283,7 +283,7 @@ export function terminate(dataConnect: DataConnect): Promise<void>;
 export function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
 
 // @public (undocumented)
-export type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+export type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
 
 // @public
 export interface TransportOptions {

docs-devsite/data-connect.md

@@ -532,5 +532,5 @@ export declare type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR;
 <b>Signature:</b>
 
 ```typescript
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
 ```

packages/data-connect/CHANGELOG.md

@@ -1,6 +1,7 @@
 # @firebase/data-connect
 ## UNRELEASED
-* Updated reporting to use @firebase/data-connect instead of @firebase/connect
+* Updated reporting to use @firebase/data-connect instead of @firebase/connect.
 * Added functionality to retry queries and mutations if the server responds with UNAUTHENTICATED.
-* Moved `validateArgs` to core SDK
+* Moved `validateArgs` to core SDK.
 * Updated errors to only show relevant details to the user.
+* Added ability to track whether user is calling core sdk or generated sdk.

packages/data-connect/rollup.config.react.js

@@ -89,6 +89,7 @@ export class DataConnect {
   private _transportClass: TransportClass | undefined;
   private _transportOptions?: TransportOptions;
   private _authTokenProvider?: AuthTokenProvider;
+  _isUsingGeneratedSdk: boolean = false;
   constructor(
     public readonly app: FirebaseApp,
     // TODO(mtewani): Replace with _dataConnectOptions in the future
@@ -104,6 +105,14 @@ export class DataConnect {
       }
     }
   }
+  /*
+    @internal
+  */
+  _useGeneratedSdk(): void {
+    if (!this._isUsingGeneratedSdk) {
+      this._isUsingGeneratedSdk = true;
+    }
+  }
   _delete(): Promise<void> {
     _removeServiceInstance(
       this.app,
@@ -140,7 +149,9 @@ export class DataConnect {
     this._transport = new this._transportClass(
       this.dataConnectOptions,
       this.app.options.apiKey,
-      this._authTokenProvider
+      this._authTokenProvider,
+      undefined,
+      this._isUsingGeneratedSdk
     );
     if (this._transportOptions) {
       this._transport.useEmulator(

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

@@ -23,21 +23,26 @@ let connectFetch: typeof fetch | null = globalThis.fetch;
 export function initializeFetch(fetchImpl: typeof fetch): void {
   connectFetch = fetchImpl;
 }
-function getGoogApiClientValue(): string {
-  return 'gl-js/ fire/' + SDK_VERSION;
+function getGoogApiClientValue(_isUsingGen: boolean): string {
+  let str = 'gl-js/ fire/' + SDK_VERSION;
+  if (_isUsingGen) {
+    str += ' web/gen';
+  }
+  return str;
 }
 export function dcFetch<T, U>(
   url: string,
   body: U,
   { signal }: AbortController,
-  accessToken: string | null
+  accessToken: string | null,
+  _isUsingGen: boolean
 ): 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()
+    'X-Goog-Api-Client': getGoogApiClientValue(_isUsingGen)
   };
   if (accessToken) {
     headers['X-Firebase-Auth-Token'] = accessToken;

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

@@ -52,6 +52,7 @@ export type TransportClass = new (
   options: DataConnectOptions,
   apiKey?: string,
   authProvider?: AuthTokenProvider,
-  transportOptions?: TransportOptions
+  transportOptions?: TransportOptions,
+  _isUsingGen?: boolean
 ) => DataConnectTransport;
 export * from '../../core/FirebaseAuthProvider';

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

@@ -39,7 +39,8 @@ export class RESTTransport implements DataConnectTransport {
     options: DataConnectOptions,
     private apiKey?: string | undefined,
     private authProvider?: AuthTokenProvider | undefined,
-    transportOptions?: TransportOptions | undefined
+    transportOptions?: TransportOptions | undefined,
+    private _isUsingGen = false
   ) {
     if (transportOptions) {
       if (typeof transportOptions.port === 'number') {
@@ -166,12 +167,14 @@ export class RESTTransport implements DataConnectTransport {
           variables: body
         } as unknown as U, // TODO(mtewani): This is a patch, fix this.
         abortController,
-        this._accessToken
+        this._accessToken,
+        this._isUsingGen
       )
     );
 
     return {
-      then: withAuth.then.bind(withAuth)
+      then: withAuth.then.bind(withAuth),
+      catch: withAuth.catch.bind(withAuth)
     };
   };
   invokeMutation: <T, U>(
@@ -191,7 +194,8 @@ export class RESTTransport implements DataConnectTransport {
           variables: body
         } as unknown as U,
         abortController,
-        this._accessToken
+        this._accessToken,
+        this._isUsingGen
       );
     });
 

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

@@ -40,7 +40,7 @@ describe('fetch', () => {
       message
     });
     await expect(
-      dcFetch('http://localhost', {}, {} as AbortController, null)
+      dcFetch('http://localhost', {}, {} as AbortController, null, false)
     ).to.eventually.be.rejectedWith(message);
   });
   it('should throw a stringified message when the server responds with an error without a message property in the body', async () => {
@@ -51,7 +51,7 @@ describe('fetch', () => {
     };
     mockFetch(json);
     await expect(
-      dcFetch('http://localhost', {}, {} as AbortController, null)
+      dcFetch('http://localhost', {}, {} as AbortController, null, false)
     ).to.eventually.be.rejectedWith(JSON.stringify(json));
   });
 });