Add version reporting for all packages (#2405)

Add version reporting for all packages plus bundle variant suffix
firebase · Dec 10, 2019 · 33388ae · 33388ae
1 parent 85c9f48
commit 33388ae
Show file tree

Hide file tree

Showing 37 changed files with 147 additions and 37 deletions.
diff --git a/packages/app-types/index.d.ts b/packages/app-types/index.d.ts
@@ -103,7 +103,7 @@ export interface FirebaseNamespace {
    * @param library Name of 1p or 3p library (e.g. firestore, angularfire)
    * @param version Current version of that library.
    */
-  registerVersion(library: string, version: string): void;
+  registerVersion(library: string, version: string, variant?: string): void;
 
   // The current SDK version.
   SDK_VERSION: string;

diff --git a/packages/app/index.lite.ts b/packages/app/index.lite.ts
@@ -20,7 +20,7 @@ import { registerCoreComponents } from './src/registerCoreComponents';
 
 export const firebase = createFirebaseNamespaceLite();
 
-registerCoreComponents(firebase);
+registerCoreComponents(firebase, 'lite');
 
 // eslint-disable-next-line import/no-default-export
 export default firebase;
diff --git a/packages/app/index.node.ts b/packages/app/index.node.ts
@@ -37,7 +37,7 @@ import { registerCoreComponents } from './src/registerCoreComponents';
 
 export const firebase = _firebase as FirebaseNamespace;
 
-registerCoreComponents(firebase);
+registerCoreComponents(firebase, 'node');
 
 // eslint-disable-next-line import/no-default-export
 export default firebase;
diff --git a/packages/app/index.rn.ts b/packages/app/index.rn.ts
@@ -38,7 +38,7 @@ const { AsyncStorage } = require('react-native');
 
 export const firebase = _firebase as FirebaseNamespace;
 
-registerCoreComponents(firebase);
+registerCoreComponents(firebase, 'rn');
 
 // eslint-disable-next-line import/no-default-export
 export default firebase;
diff --git a/packages/app/package.json b/packages/app/package.json
@@ -49,7 +49,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/app/index.d.ts",
+  "typings": "dist/packages/app/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"

diff --git a/packages/app/src/constants.ts b/packages/app/src/constants.ts
@@ -26,6 +26,7 @@ import { name as performanceName } from '../../performance/package.json';
 import { name as remoteConfigName } from '../../remote-config/package.json';
 import { name as storageName } from '../../storage/package.json';
 import { name as firestoreName } from '../../firestore/package.json';
+import { name as packageName } from '../../../package.json';
 
 export const PLATFORM_LOG_STRING = {
   [appName]: 'fire-core',
@@ -39,10 +40,5 @@ export const PLATFORM_LOG_STRING = {
   [storageName]: 'fire-gcs',
   [firestoreName]: 'fire-fst',
   'fire-js': 'fire-js', // Platform identifier for JS SDK.
-  'fire-js-all-app': 'fire-js-all-app', // firebase/app import
-  'fire-js-all': 'fire-js-all', // 'firebase' import
-  'fire-js-all-node': 'fire-js-all-node',
-  'fire-js-all-rn': 'fire-js-all-rn',
-  'fire-js-all-lite': 'fire-js-all-lite',
-  'fire-js-all-cdn': 'fire-js-all-cdn'
+  [packageName]: 'fire-js-all'
 } as const;
diff --git a/packages/app/src/firebaseNamespaceCore.ts b/packages/app/src/firebaseNamespaceCore.ts
@@ -235,10 +235,17 @@ export function createFirebaseNamespaceCore(
       : null;
   }
 
-  function registerVersion(libraryKeyOrName: string, version: string): void {
+  function registerVersion(
+    libraryKeyOrName: string,
+    version: string,
+    variant?: string
+  ): void {
     // TODO: We can use this check to whitelist strings when/if we set up
     // a good whitelist system.
-    const library = PLATFORM_LOG_STRING[libraryKeyOrName] ?? libraryKeyOrName;
+    let library = PLATFORM_LOG_STRING[libraryKeyOrName] ?? libraryKeyOrName;
+    if (variant) {
+      library += `-${variant}`;
+    }
     const libraryMismatch = library.match(/\s|\//);
     const versionMismatch = version.match(/\s|\//);
     if (libraryMismatch || versionMismatch) {

diff --git a/packages/app/src/registerCoreComponents.ts b/packages/app/src/registerCoreComponents.ts
@@ -21,7 +21,10 @@ import { Component, ComponentType } from '@firebase/component';
 import { PlatformLoggerService } from './platformLoggerService';
 import { name, version } from '../package.json';
 
-export function registerCoreComponents(firebase: FirebaseNamespace): void {
+export function registerCoreComponents(
+  firebase: FirebaseNamespace,
+  variant?: string
+): void {
   (firebase as _FirebaseNamespace).INTERNAL.registerComponent(
     new Component(
       'platform-logger',
@@ -30,7 +33,7 @@ export function registerCoreComponents(firebase: FirebaseNamespace): void {
     )
   );
   // Register `app` package.
-  firebase.registerVersion(name, version);
+  firebase.registerVersion(name, version, variant);
   // Register platform SDK identifier (no version).
   firebase.registerVersion('fire-js', '');
 }
diff --git a/packages/app/test/platformLogger.test.ts b/packages/app/test/platformLogger.test.ts
@@ -90,6 +90,29 @@ describe('Platform Logger Service', () => {
       return (firebase as any)['test-shell']();
     });
 
+    it(`logs core version with bundle variant`, () => {
+      firebase.initializeApp({});
+      registerCoreComponents(firebase, 'node');
+      (firebase as _FirebaseNamespace).INTERNAL.registerComponent(
+        new Component(
+          'test-shell',
+          async (container: ComponentContainer) => {
+            const platformLoggerProvider = container.getProvider(
+              'platform-logger'
+            );
+            const platformLogger = (await platformLoggerProvider.get()) as PlatformLoggerService;
+            const platformInfoString = platformLogger.getPlatformInfoString();
+            expect(platformInfoString).to.include(
+              `fire-core-node/${appVersion}`
+            );
+            expect(platformInfoString).to.include('fire-js/');
+          },
+          ComponentType.PUBLIC
+        )
+      );
+      return (firebase as any)['test-shell']();
+    });
+
     it(`logs other components' versions`, () => {
       firebase.initializeApp({});
       registerCoreComponents(firebase);

diff --git a/packages/auth/gulpfile.js b/packages/auth/gulpfile.js
@@ -21,6 +21,7 @@ const del = require('del');
 const express = require('express');
 const path = require('path');
 const sourcemaps = require('gulp-sourcemaps');
+const pkg = require('./package.json');
 
 // The optimization level for the JS compiler.
 // Valid levels: WHITESPACE_ONLY, SIMPLE_OPTIMIZATIONS, ADVANCED_OPTIMIZATIONS.
@@ -79,7 +80,9 @@ function createBuildTask(filename, prefix, suffix) {
             )
           ],
           language_out: 'ES5',
-          only_closure_dependencies: true
+          only_closure_dependencies: true,
+          // Insert current package.json version into registerVersion call.
+          define: `AUTH_NPM_PACKAGE_VERSION=${pkg.version}`
         })
       )
       .pipe(sourcemaps.write('.'))

diff --git a/packages/auth/src/exports_auth.js b/packages/auth/src/exports_auth.js
@@ -48,6 +48,8 @@ goog.require('fireauth.grecaptcha');
 goog.require('fireauth.idp.ProviderId');
 goog.require('goog.Promise');
 
+/** @define {string} */
+const AUTH_NPM_PACKAGE_VERSION = '';
 
 fireauth.exportlib.exportPrototypeMethods(
     fireauth.Auth.prototype, {
@@ -705,6 +707,7 @@ fireauth.exportlib.exportFunction(
 
     firebase.INTERNAL.registerComponent(authComponent);
     firebase.INTERNAL.registerComponent(authInteropComponent);
+    firebase.registerVersion('@firebase/auth', AUTH_NPM_PACKAGE_VERSION);
 
     // Expose User as firebase.User.
     firebase.INTERNAL.extendNamespace({

diff --git a/packages/database/index.node.ts b/packages/database/index.node.ts
@@ -38,6 +38,8 @@ import {
 } from '@firebase/component';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 
+import { name, version } from './package.json';
+
 setWebSocketImpl(Client);
 
 const ServerValue = Database.ServerValue;
@@ -131,6 +133,8 @@ export function registerDatabase(instance: FirebaseNamespace) {
       .setMultipleInstances(true)
   );
 
+  instance.registerVersion(name, version, 'node');
+
   if (isNodeSdk()) {
     module.exports = Object.assign({}, namespace, { initStandalone });
   }

diff --git a/packages/database/index.ts b/packages/database/index.ts
@@ -31,6 +31,8 @@ import * as types from '@firebase/database-types';
 import { setSDKVersion } from './src/core/version';
 import { Component, ComponentType } from '@firebase/component';
 
+import { name, version } from './package.json';
+
 const ServerValue = Database.ServerValue;
 
 export function registerDatabase(instance: FirebaseNamespace) {
@@ -71,6 +73,8 @@ export function registerDatabase(instance: FirebaseNamespace) {
       .setMultipleInstances(true)
   );
 
+  instance.registerVersion(name, version);
+
   if (isNodeSdk()) {
     module.exports = namespace;
   }

diff --git a/packages/database/rollup.config.js b/packages/database/rollup.config.js
@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import json from 'rollup-plugin-json';
 import typescriptPlugin from 'rollup-plugin-typescript2';
 import typescript from 'typescript';
 import pkg from './package.json';
@@ -29,7 +30,8 @@ const deps = Object.keys(
 const es5BuildPlugins = [
   typescriptPlugin({
     typescript
-  })
+  }),
+  json()
 ];
 
 const es5Builds = [
@@ -67,7 +69,8 @@ const es2017BuildPlugins = [
         target: 'es2017'
       }
     }
-  })
+  }),
+  json({ preferConst: true })
 ];
 
 const es2017Builds = [

diff --git a/packages/firebase/app/index.ts b/packages/firebase/app/index.ts
@@ -16,7 +16,8 @@
  */
 
 import firebase from '@firebase/app';
+import { name, version } from '../package.json';
 
-firebase.registerVersion('fire-js-all-app', firebase.SDK_VERSION);
+firebase.registerVersion(name, version, 'app');
 
 export default firebase;
diff --git a/packages/firebase/externs/firebase-app-externs.js b/packages/firebase/externs/firebase-app-externs.js
@@ -284,3 +284,10 @@ firebase.CompleteFn;
 
 /** @typedef {function(): void} */
 firebase.Unsubscribe;
+
+/**
+ * @param {string} name
+ * @param {string} version
+ * @param {?string} variant
+ */
+firebase.registerVersion = function(name, version, variant) {};
diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts
@@ -87,8 +87,13 @@ declare namespace firebase {
    * Registers a library's name and version for platform logging purposes.
    * @param library Name of 1p or 3p library (e.g. firestore, angularfire)
    * @param version Current version of that library.
+   * @param variant Bundle variant, e.g., node, rn, etc.
    */
-  function registerVersion(library: string, version: string): void;
+  function registerVersion(
+    library: string,
+    version: string,
+    variant?: string
+  ): void;
 
   /**
    * @hidden

diff --git a/packages/firebase/rollup.config.js b/packages/firebase/rollup.config.js
@@ -23,6 +23,7 @@ import typescriptPlugin from 'rollup-plugin-typescript2';
 import typescript from 'typescript';
 import { uglify } from 'rollup-plugin-uglify';
 import { terser } from 'rollup-plugin-terser';
+import json from 'rollup-plugin-json';
 import pkg from './package.json';
 
 import appPkg from './app/package.json';
@@ -33,6 +34,7 @@ const plugins = [
   typescriptPlugin({
     typescript
   }),
+  json(),
   commonjs()
 ];
 
@@ -199,6 +201,7 @@ const completeBuilds = [
       typescriptPlugin({
         typescript
       }),
+      json(),
       commonjs(),
       uglify()
     ]
@@ -227,6 +230,9 @@ const completeBuilds = [
           }
         }
       }),
+      json({
+        preferConst: true
+      }),
       commonjs(),
       terser()
     ]

diff --git a/packages/firebase/src/index.cdn.ts b/packages/firebase/src/index.cdn.ts
@@ -28,6 +28,7 @@ https://www.gstatic.com/firebasejs/5.0.0/firebase-<PACKAGE>.js
 
 import '@firebase/polyfill';
 import firebase from '../app';
+import { name, version } from '../package.json';
 
 import '../auth';
 import '../database';
@@ -39,6 +40,6 @@ import '../performance';
 import '../analytics';
 import '../remote-config';
 
-firebase.registerVersion('fire-js-all-cdn', firebase.SDK_VERSION);
+firebase.registerVersion(name, version, 'cdn');
 
 export default firebase;
diff --git a/packages/firebase/src/index.node.ts b/packages/firebase/src/index.node.ts
@@ -16,12 +16,13 @@
  */
 
 import firebase from '../app';
+import { name, version } from '../package.json';
 
 import '../auth';
 import '../database';
 import '../firestore';
 import '../functions';
 
-firebase.registerVersion('fire-js-all-node', firebase.SDK_VERSION);
+firebase.registerVersion(name, version, 'node');
 
 export default firebase;
diff --git a/packages/firebase/src/index.perf.ts b/packages/firebase/src/index.perf.ts
@@ -17,7 +17,8 @@
 
 import firebase from '@firebase/app';
 import '@firebase/performance';
+import { name, version } from '../package.json';
 
-firebase.registerVersion('fire-js-all-lite', firebase.SDK_VERSION);
+firebase.registerVersion(name, version, 'lite');
 
 export default firebase;
diff --git a/packages/firebase/src/index.rn.ts b/packages/firebase/src/index.rn.ts
@@ -16,11 +16,12 @@
  */
 
 import firebase from '../app';
+import { name, version } from '../package.json';
 
 import '../auth';
 import '../database';
 import '../storage';
 
-firebase.registerVersion('fire-js-all-rn', firebase.SDK_VERSION);
+firebase.registerVersion(name, version, 'rn');
 
 export default firebase;
diff --git a/packages/firebase/src/index.ts b/packages/firebase/src/index.ts
@@ -37,6 +37,7 @@ import 'firebase/<PACKAGE>';
 `);
 
 import firebase from '../app';
+import { name, version } from '../package.json';
 
 import '../auth';
 import '../database';
@@ -48,6 +49,6 @@ import '../performance';
 import '../analytics';
 import '../remote-config';
 
-firebase.registerVersion('fire-js-all', firebase.SDK_VERSION);
+firebase.registerVersion(name, version);
 
 export default firebase;
diff --git a/packages/firestore/index.node.ts b/packages/firestore/index.node.ts
@@ -20,8 +20,11 @@ import { configureForFirebase } from './src/platform/config';
 import './src/platform_node/node_init';
 import { FirebaseNamespace } from '@firebase/app-types';
 
+import { name, version } from './package.json';
+
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(instance);
+  instance.registerVersion(name, version, 'node');
 }
 
 registerFirestore(firebase);