Inject SDK_VERSION into request

Author: hsubox76

common/api-review/storage.api.md

@@ -4,10 +4,10 @@
 
 ```ts
 
-import { FirebaseApp } from '@firebase/app-types';
+import { FirebaseApp } from '@firebase/app-types-exp';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { FirebaseError } from '@firebase/util';
-import { _FirebaseService } from '@firebase/app-types';
+import { _FirebaseService } from '@firebase/app-types-exp';
 import { Provider } from '@firebase/component';
 import * as types from '@firebase/storage-types';
 

packages/storage/compat/index.ts

@@ -51,7 +51,13 @@ function factory(
   // of creating a new one.
   const storageServiceCompat: StorageServiceCompat = new StorageServiceCompat(
     app,
-    new StorageService(app, authProvider, new XhrIoPool(), url)
+    new StorageService(
+      app,
+      authProvider,
+      new XhrIoPool(),
+      url,
+      firebase.SDK_VERSION
+    )
   );
   return storageServiceCompat;
 }

packages/storage/exp/index.ts

@@ -18,7 +18,8 @@
 import {
   _registerComponent,
   registerVersion,
-  _getProvider
+  _getProvider,
+  SDK_VERSION
   // eslint-disable-next-line import/no-extraneous-dependencies
 } from '@firebase/app-exp';
 
@@ -76,7 +77,8 @@ function factory(container: ComponentContainer, url?: string): StorageService {
     app,
     authProvider,
     new XhrIoPool(),
-    url
+    url,
+    SDK_VERSION
   ) as unknown) as StorageService;
 }
 

packages/storage/index.ts

@@ -33,8 +33,6 @@ import * as type from './type';
 import * as UrlUtils from './url';
 import { Headers, XhrIo, ErrorCode } from './xhrio';
 import { XhrIoPool } from './xhriopool';
-// Firebase SDK version
-import { version } from '../../../../package.json';
 
 export interface Request<T> {
   getPromise(): Promise<T>;
@@ -268,8 +266,12 @@ export function addAuthHeader_(
   }
 }
 
-export function addVersionHeader_(headers: Headers): void {
-  headers['X-Firebase-Storage-Version'] = 'webjs/' + (version ?? 'AppManager');
+export function addVersionHeader_(
+  headers: Headers,
+  firebaseVersion?: string
+): void {
+  headers['X-Firebase-Storage-Version'] =
+    'webjs/' + (firebaseVersion ?? 'AppManager');
 }
 
 export function addGmpidHeader_(headers: Headers, appId: string | null): void {
@@ -282,14 +284,15 @@ export function makeRequest<T>(
   requestInfo: RequestInfo<T>,
   appId: string | null,
   authToken: string | null,
-  pool: XhrIoPool
+  pool: XhrIoPool,
+  firebaseVersion?: string
 ): Request<T> {
   const queryPart = UrlUtils.makeQueryString(requestInfo.urlParams);
   const url = requestInfo.url + queryPart;
   const headers = Object.assign({}, requestInfo.headers);
   addGmpidHeader_(headers, appId);
   addAuthHeader_(headers, authToken);
-  addVersionHeader_(headers);
+  addVersionHeader_(headers, firebaseVersion);
   return new NetworkRequest<T>(
     url,
     requestInfo.method,

packages/storage/rollup.config.js

@@ -151,7 +151,11 @@ export class StorageService implements _FirebaseService {
     /**
      * @internal
      */
-    readonly _url?: string
+    readonly _url?: string,
+    /**
+     * @internal
+     */
+    readonly _firebaseVersion?: string
   ) {
     this._maxOperationRetryTime = constants.DEFAULT_MAX_OPERATION_RETRY_TIME;
     this._maxUploadRetryTime = constants.DEFAULT_MAX_UPLOAD_RETRY_TIME;
@@ -235,7 +239,8 @@ export class StorageService implements _FirebaseService {
         requestInfo,
         this._appId,
         authToken,
-        this._pool
+        this._pool,
+        this._firebaseVersion
       );
       this._requests.add(request);
       // Request removes itself from set when complete.

packages/storage/src/implementation/request.ts

@@ -21,11 +21,12 @@ import { RequestInfo } from '../../src/implementation/requestinfo';
 import { XhrIo } from '../../src/implementation/xhrio';
 import { makePool } from './testshared';
 import { TestingXhrIo } from './xhrio';
-import { version } from '../../../../package.json';
+
+const TEST_VERSION = '1.2.3';
 
 describe('Firebase Storage > Request', () => {
   const versionHeaderName = 'X-Firebase-Storage-Version';
-  const versionHeaderValue = 'webjs/' + version;
+  const versionHeaderValue = 'webjs/' + TEST_VERSION;
   const timeout = 60 * 1000;
 
   it('Simple success request works', () => {
@@ -58,7 +59,13 @@ describe('Firebase Storage > Request', () => {
     requestInfo.headers[requestHeader] = requestValue;
     requestInfo.successCodes = [200, 234];
 
-    return makeRequest(requestInfo, null, null, makePool(spiedSend))
+    return makeRequest(
+      requestInfo,
+      null,
+      null,
+      makePool(spiedSend),
+      TEST_VERSION
+    )
       .getPromise()
       .then(
         result => {
@@ -196,7 +203,8 @@ describe('Firebase Storage > Request', () => {
       requestInfo,
       /* appId= */ null,
       authToken,
-      makePool(spiedSend)
+      makePool(spiedSend),
+      TEST_VERSION
     );
     return request.getPromise().then(
       () => {
@@ -231,7 +239,13 @@ describe('Firebase Storage > Request', () => {
       handler,
       timeout
     );
-    const request = makeRequest(requestInfo, appId, null, makePool(spiedSend));
+    const request = makeRequest(
+      requestInfo,
+      appId,
+      null,
+      makePool(spiedSend),
+      TEST_VERSION
+    );
     return request.getPromise().then(
       () => {
         assert.isTrue(spiedSend.calledOnce);