firebase · yuchenshi · Apr 2, 2021 · Mar 31, 2021 · Mar 31, 2021 · Mar 31, 2021
diff --git a/packages-exp/auth-compat-exp/src/auth.test.ts b/packages-exp/auth-compat-exp/src/auth.test.ts
@@ -38,7 +38,7 @@ describe('auth compat', () => {
       app = { options: { apiKey: 'api-key' } } as FirebaseApp;
       underlyingAuth = new exp.AuthImpl(app, {
         apiKey: 'api-key'
-      } as exp.Config);
+      } as exp.ConfigInternal);
       sinon.stub(underlyingAuth, '_initializeWithPersistence');
 
       providerStub = sinon.createStubInstance(Provider);

diff --git a/packages-exp/auth-compat-exp/src/popup_redirect.test.ts b/packages-exp/auth-compat-exp/src/popup_redirect.test.ts
@@ -34,7 +34,7 @@ describe('popup_redirect/CompatPopupRedirectResolver', () => {
     const app = { options: { apiKey: 'api-key' } } as FirebaseApp;
     auth = new exp.AuthImpl(app, {
       apiKey: 'api-key'
-    } as exp.Config);
+    } as exp.ConfigInternal);
   });
 
   afterEach(() => {

diff --git a/packages-exp/auth-exp/internal/index.ts b/packages-exp/auth-exp/internal/index.ts
@@ -32,7 +32,7 @@ export {
   AuthEventType
 } from '../src/model/popup_redirect';
 export { UserCredentialInternal, UserParameters } from '../src/model/user';
-export { AuthInternal } from '../src/model/auth';
+export { AuthInternal, ConfigInternal } from '../src/model/auth';
 export { DefaultConfig, AuthImpl, _castAuth } from '../src/core/auth/auth_impl';
 
 export { ClientPlatform, _getClientVersion } from '../src/core/util/version';

diff --git a/packages-exp/auth-exp/src/api/authentication/token.test.ts b/packages-exp/auth-exp/src/api/authentication/token.test.ts
@@ -18,13 +18,15 @@
 import { expect, use } from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 
-import { FirebaseError, querystringDecode } from '@firebase/util';
+import { FirebaseError, getUA, querystringDecode } from '@firebase/util';
 
 import { HttpHeader } from '../';
 import { testAuth, TestAuth } from '../../../test/helpers/mock_auth';
 import * as fetch from '../../../test/helpers/mock_fetch';
 import { ServerError } from '../errors';
 import { Endpoint, requestStsToken } from './token';
+import { SDK_VERSION } from '@firebase/app-exp';
+import { _getBrowserName } from '../../core/util/browser';
 
 use(chaiAsPromised);
 
@@ -66,6 +68,28 @@ describe('requestStsToken', () => {
     );
   });
 
+  it('should set the framework in clientVersion if logged', async () => {
+    const mock = fetch.mock(endpoint, {
+      'access_token': 'new-access-token',
+      'expires_in': '3600',
+      'refresh_token': 'new-refresh-token'
+    });
+
+    auth._logFramework('Mythical');
+    await requestStsToken(auth, 'old-refresh-token');
+    expect(mock.calls[0].headers!.get(HttpHeader.X_CLIENT_VERSION)).to.eq(
+      `${_getBrowserName(getUA())}/JsCore/${SDK_VERSION}/Mythical`
+    );
+
+    // If a new framework is logged, the client version header should change as well.
+    auth._logFramework('Magical');
+    await requestStsToken(auth, 'old-refresh-token');
+    expect(mock.calls[1].headers!.get(HttpHeader.X_CLIENT_VERSION)).to.eq(
+      // frameworks should be sorted alphabetically
+      `${_getBrowserName(getUA())}/JsCore/${SDK_VERSION}/Magical,Mythical`
+    );
+  });
+
   it('should handle errors', async () => {
     const mock = fetch.mock(
       endpoint,

diff --git a/packages-exp/auth-exp/src/api/authentication/token.ts b/packages-exp/auth-exp/src/api/authentication/token.ts
@@ -26,6 +26,7 @@ import {
 } from '../index';
 import { FetchProvider } from '../../core/util/fetch_provider';
 import { Auth } from '../../model/public_types';
+import { AuthInternal } from '../../model/auth';
 
 export const enum Endpoint {
   TOKEN = '/v1/token'
@@ -56,7 +57,7 @@ export async function requestStsToken(
         'grant_type': 'refresh_token',
         'refresh_token': refreshToken
       }).slice(1);
-      const { tokenApiHost, apiKey, sdkClientVersion } = auth.config;
+      const { tokenApiHost, apiKey } = auth.config;
       const url = _getFinalTarget(
         auth,
         tokenApiHost,
@@ -67,7 +68,7 @@ export async function requestStsToken(
       return FetchProvider.fetch()(url, {
         method: HttpMethod.POST,
         headers: {
-          'X-Client-Version': sdkClientVersion,
+          'X-Client-Version': (auth as AuthInternal)._getSdkClientVersion(),
           'Content-Type': 'application/x-www-form-urlencoded'
         },
         body

diff --git a/packages-exp/auth-exp/src/api/index.test.ts b/packages-exp/auth-exp/src/api/index.test.ts
@@ -21,7 +21,7 @@ import * as sinon from 'sinon';
 import { useFakeTimers } from 'sinon';
 import * as sinonChai from 'sinon-chai';
 
-import { FirebaseError } from '@firebase/util';
+import { FirebaseError, getUA } from '@firebase/util';
 
 import { mockEndpoint } from '../../test/helpers/api/helper';
 import { testAuth, TestAuth } from '../../test/helpers/mock_auth';
@@ -38,6 +38,8 @@ import {
   _addTidIfNecessary
 } from './';
 import { ServerError } from './errors';
+import { SDK_VERSION } from '@firebase/app-exp';
+import { _getBrowserName } from '../core/util/browser';
 
 use(sinonChai);
 use(chaiAsPromised);
@@ -92,6 +94,31 @@ describe('api/_performApiRequest', () => {
       );
     });
 
+    it('should set the framework in clientVersion if logged', async () => {
+      auth._logFramework('Mythical');
+      const mock = mockEndpoint(Endpoint.SIGN_UP, serverResponse);
+      const response = await _performApiRequest<
+        typeof request,
+        typeof serverResponse
+      >(auth, HttpMethod.POST, Endpoint.SIGN_UP, request);
+      expect(response).to.eql(serverResponse);
+      expect(mock.calls[0].headers!.get(HttpHeader.X_CLIENT_VERSION)).to.eq(
+        `${_getBrowserName(getUA())}/JsCore/${SDK_VERSION}/Mythical`
+      );
+
+      // If a new framework is logged, the client version header should change as well.
+      auth._logFramework('Magical');
+      const response2 = await _performApiRequest<
+        typeof request,
+        typeof serverResponse
+      >(auth, HttpMethod.POST, Endpoint.SIGN_UP, request);
+      expect(response2).to.eql(serverResponse);
+      expect(mock.calls[1].headers!.get(HttpHeader.X_CLIENT_VERSION)).to.eq(
+        // frameworks should be sorted alphabetically
+        `${_getBrowserName(getUA())}/JsCore/${SDK_VERSION}/Magical,Mythical`
+      );
+    });
+
     it('should translate server errors to auth errors', async () => {
       const mock = mockEndpoint(
         Endpoint.SIGN_UP,

diff --git a/packages-exp/auth-exp/src/api/index.ts b/packages-exp/auth-exp/src/api/index.ts
@@ -23,7 +23,7 @@ import { Delay } from '../core/util/delay';
 import { _emulatorUrl } from '../core/util/emulator';
 import { FetchProvider } from '../core/util/fetch_provider';
 import { Auth } from '../model/public_types';
-import { AuthInternal } from '../model/auth';
+import { AuthInternal, ConfigInternal } from '../model/auth';
 import { IdTokenResponse, TaggedWithTokenResponse } from '../model/id_token';
 import { IdTokenMfaResponse } from './authentication/mfa';
 import { SERVER_ERROR_MAP, ServerError, ServerErrorMap } from './errors';
@@ -104,7 +104,10 @@ export async function _performApiRequest<T, V>(
 
     const headers = new (FetchProvider.headers())();
     headers.set(HttpHeader.CONTENT_TYPE, 'application/json');
-    headers.set(HttpHeader.X_CLIENT_VERSION, auth.config.sdkClientVersion);
+    headers.set(
+      HttpHeader.X_CLIENT_VERSION,
+      (auth as AuthInternal)._getSdkClientVersion()
+    );
 
     if (auth.languageCode) {
       headers.set(HttpHeader.X_FIREBASE_LOCALE, auth.languageCode);
@@ -209,7 +212,7 @@ export function _getFinalTarget(
     return `${auth.config.apiScheme}://${base}`;
   }
 
-  return _emulatorUrl(auth.config, base);
+  return _emulatorUrl(auth.config as ConfigInternal, base);
 }
 
 class NetworkTimeout<T> {

diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts
@@ -33,6 +33,7 @@ import * as navigator from '../util/navigator';
 import * as reload from '../user/reload';
 import { AuthImpl, DefaultConfig } from './auth_impl';
 import { _initializeAuthInstance } from './initialize';
+import { ClientPlatform } from '../util/version';
 
 use(sinonChai);
 use(chaiAsPromised);
@@ -57,6 +58,7 @@ describe('core/auth/auth_impl', () => {
       apiHost: DefaultConfig.API_HOST,
       apiScheme: DefaultConfig.API_SCHEME,
       tokenApiHost: DefaultConfig.TOKEN_API_HOST,
+      clientPlatform: ClientPlatform.BROWSER,
       sdkClientVersion: 'v'
     });
 
@@ -434,6 +436,7 @@ describe('core/auth/auth_impl', () => {
         apiHost: DefaultConfig.API_HOST,
         apiScheme: DefaultConfig.API_SCHEME,
         tokenApiHost: DefaultConfig.TOKEN_API_HOST,
+        clientPlatform: ClientPlatform.BROWSER,
         sdkClientVersion: 'v'
       });
 

diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.ts
@@ -57,6 +57,7 @@ import { _reloadWithoutSaving } from '../user/reload';
 import { _assert } from '../util/assert';
 import { _getInstance } from '../util/instantiator';
 import { _getUserLanguage } from '../util/navigator';
+import { _getClientVersion } from '../util/version';
 
 interface AsyncAction {
   (): Promise<void>;
@@ -107,6 +108,7 @@ export class AuthImpl implements AuthInternal, _FirebaseService {
     public readonly config: ConfigInternal
   ) {
     this.name = app.name;
+    this.clientVersion = config.sdkClientVersion;
   }
 
   _initializeWithPersistence(
@@ -556,6 +558,29 @@ export class AuthImpl implements AuthInternal, _FirebaseService {
     _assert(this.persistenceManager, this, AuthErrorCode.INTERNAL_ERROR);
     return this.persistenceManager;
   }
+
+  private frameworks: string[] = [];
+  private clientVersion: string;
+  _logFramework(framework: string): void {
+    if (this.frameworks.includes(framework)) {
+      return;
+    }
+    this.frameworks.push(framework);
+
+    // Sort alphabetically so that "FirebaseCore-web,FirebaseUI-web" and
+    // "FirebaseUI-web,FirebaseCore-web" aren't viewed as different.
+    this.frameworks.sort();
+    this.clientVersion = _getClientVersion(
+      this.config.clientPlatform,
+      this._getFrameworks()
+    );
+  }
+  _getFrameworks(): readonly string[] {
+    return this.frameworks;
+  }
+  _getSdkClientVersion(): string {
+    return this.clientVersion;
+  }
 }
 
 /**

diff --git a/packages-exp/auth-exp/src/core/auth/initialize.test.ts b/packages-exp/auth-exp/src/core/auth/initialize.test.ts
@@ -151,15 +151,19 @@ describe('core/auth/initialize', () => {
       await auth._initializationPromise;
 
       expect(auth.name).to.eq(fakeApp.name);
+      const expectedClientPlatform = isNode()
+        ? ClientPlatform.NODE
+        : ClientPlatform.BROWSER;
       const expectedSdkClientVersion = _getClientVersion(
-        isNode() ? ClientPlatform.NODE : ClientPlatform.BROWSER
+        expectedClientPlatform
       );
 
       expect(auth.config).to.eql({
         apiHost: 'identitytoolkit.googleapis.com',
         apiKey: 'fake-key',
         apiScheme: 'https',
         authDomain: 'fake-auth-domain',
+        clientPlatform: expectedClientPlatform,
         sdkClientVersion: expectedSdkClientVersion,
         tokenApiHost: 'securetoken.googleapis.com'
       });

diff --git a/packages-exp/auth-exp/src/core/auth/register.ts b/packages-exp/auth-exp/src/core/auth/register.ts
@@ -16,7 +16,6 @@
  */
 
 import { _registerComponent, registerVersion } from '@firebase/app-exp';
-import { Config, Dependencies } from '../../model/public_types';
 import { Component, ComponentType } from '@firebase/component';
 
 import { version } from '../../../package.json';
@@ -25,6 +24,8 @@ import { _assert } from '../util/assert';
 import { _getClientVersion, ClientPlatform } from '../util/version';
 import { _castAuth, AuthImpl, DefaultConfig } from './auth_impl';
 import { AuthInterop } from './firebase_internal';
+import { ConfigInternal } from '../../model/auth';
+import { Dependencies } from '../../model/public_types';
 import { _initializeAuthInstance } from './initialize';
 
 export const enum _ComponentName {
@@ -59,9 +60,10 @@ export function registerAuth(clientPlatform: ClientPlatform): void {
         const { apiKey, authDomain } = app.options;
         return (app => {
           _assert(apiKey, AuthErrorCode.INVALID_API_KEY, { appName: app.name });
-          const config: Config = {
+          const config: ConfigInternal = {
             apiKey,
             authDomain,
+            clientPlatform,
             apiHost: DefaultConfig.API_HOST,
             tokenApiHost: DefaultConfig.TOKEN_API_HOST,
             apiScheme: DefaultConfig.API_SCHEME,

diff --git a/packages-exp/auth-exp/src/core/util/version.ts b/packages-exp/auth-exp/src/core/util/version.ts
@@ -44,7 +44,10 @@ const enum ClientFramework {
  *
  * TODO: This should be set on the Auth object during initialization
  */
-export function _getClientVersion(clientPlatform: ClientPlatform): string {
+export function _getClientVersion(
+  clientPlatform: ClientPlatform,
+  frameworks: readonly string[] = []
+): string {
   let reportedPlatform: string;
   switch (clientPlatform) {
     case ClientPlatform.BROWSER:
@@ -60,5 +63,8 @@ export function _getClientVersion(clientPlatform: ClientPlatform): string {
     default:
       reportedPlatform = clientPlatform;
   }
-  return `${reportedPlatform}/${ClientImplementation.CORE}/${SDK_VERSION}/${ClientFramework.DEFAULT}`;
+  const reportedFrameworks = frameworks.length
+    ? frameworks.join(',')
+    : ClientFramework.DEFAULT;
+  return `${reportedPlatform}/${ClientImplementation.CORE}/${SDK_VERSION}/${reportedFrameworks}`;
 }
diff --git a/packages-exp/auth-exp/src/model/auth.ts b/packages-exp/auth-exp/src/model/auth.ts
@@ -28,6 +28,7 @@ import { AuthErrorCode, AuthErrorParams } from '../core/errors';
 
 import { PopupRedirectResolverInternal } from './popup_redirect';
 import { UserInternal } from './user';
+import { ClientPlatform } from '../core/util/version';
 
 export type AppName = string;
 export type ApiKey = string;
@@ -40,6 +41,11 @@ export interface ConfigInternal extends Config {
   emulator?: {
     url: string;
   };
+
+  /**
+   * @readonly
+   */
+  clientPlatform: ClientPlatform;
 }
 
 export interface AuthInternal extends Auth {
@@ -64,6 +70,9 @@ export interface AuthInternal extends Auth {
   _startProactiveRefresh(): void;
   _stopProactiveRefresh(): void;
   _getPersistence(): string;
+  _logFramework(framework: string): void;
+  _getFrameworks(): readonly string[];
+  _getSdkClientVersion(): string;
 
   readonly name: AppName;
   readonly config: ConfigInternal;

diff --git a/packages-exp/auth-exp/src/platform_browser/iframe/iframe.test.ts b/packages-exp/auth-exp/src/platform_browser/iframe/iframe.test.ts
@@ -89,6 +89,25 @@ describe('platform_browser/iframe/iframe', () => {
     expect(iframeSettings.dontclear).to.be.true;
   });
 
+  it('sets a single framework if logged', async () => {
+    auth._logFramework('Magical');
+    await _openIframe(auth);
+    expect(iframeSettings.url).to.eq(
+      `https://${TEST_AUTH_DOMAIN}/__/auth/iframe?apiKey=${TEST_KEY}&appName=test-app&v=${SDK_VERSION}&fw=Magical`
+    );
+  });
+
+  it('sets multiple frameworks comma-separated if logged', async () => {
+    auth._logFramework('Mythical');
+    auth._logFramework('Magical');
+    auth._logFramework('Magical'); // Duplicate, should be ignored
+    await _openIframe(auth);
+    expect(iframeSettings.url).to.eq(
+      // fw should be a comma-separated list sorted alphabetically:
+      `https://${TEST_AUTH_DOMAIN}/__/auth/iframe?apiKey=${TEST_KEY}&appName=test-app&v=${SDK_VERSION}&fw=Magical%2CMythical`
+    );
+  });
+
   context('on load callback', () => {
     let iframe: sinon.SinonStubbedInstance<gapi.iframes.Iframe>;
     let clearTimeoutStub: sinon.SinonStub;