Address PR comments, make version registration public

Author: hsubox76

packages/analytics/index.ts

@@ -59,7 +59,7 @@ export function registerAnalytics(instance: _FirebaseNamespace): void {
     new Component('analytics-internal', internalFactory, ComponentType.PRIVATE)
   );
 
-  instance.INTERNAL.registerVersionComponent(ANALYTICS_TYPE, version);
+  instance.registerVersion('ANALYTICS_TYPE', version);
 
   function internalFactory(
     container: ComponentContainer

packages/app-types/index.d.ts

@@ -98,6 +98,16 @@ export interface FirebaseNamespace {
    */
   apps: FirebaseApp[];
 
+  /**
+   * 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.
+   */
+  registerVersion(
+    library: string,
+    version: string
+  ): void
+
   // The current SDK version.
   SDK_VERSION: string;
 }

packages/app/src/constants.ts

@@ -17,7 +17,7 @@
 
 export const DEFAULT_ENTRY_NAME = '[DEFAULT]';
 
-export const platformLogString: { [key: string]: string } = {
+export const PLATFORM_LOG_STRING = {
   'firebase': 'fire-js',
   'app': 'fire-core',
   'analytics': 'fire-analytics',
@@ -29,4 +29,4 @@ export const platformLogString: { [key: string]: string } = {
   'remote-config': 'fire-rc',
   'storage': 'fire-gcs',
   'firestore': 'fire-fst'
-};
+} as const;

packages/app/src/firebaseNamespaceCore.ts

@@ -60,12 +60,12 @@ export function createFirebaseNamespaceCore(
     initializeApp,
     // @ts-ignore
     app,
+    registerVersion,
     // @ts-ignore
     apps: null,
     SDK_VERSION: version,
     INTERNAL: {
       registerComponent,
-      registerVersionComponent,
       removeApp,
       components,
       useAsService
@@ -236,16 +236,18 @@ export function createFirebaseNamespaceCore(
       : null;
   }
 
-  function registerVersionComponent(
+  function registerVersion(
     library: string,
     version: string
-  ): FirebaseServiceNamespace<FirebaseService> | null {
-    return registerComponent(
+  ): void {
+    if (library.match(/\s|\//)) {
+      logger.warn(`Could not register ${library}: it contains illegal characters.`);
+      return;
+    }
+    registerComponent(
       new Component(
         `${library}-version` as Name,
-        () => {
-          return new VersionService(library, version);
-        },
+        () => new VersionService(library, version),
         ComponentType.VERSION
       )
     );

packages/app/src/platformLoggerService.ts

@@ -17,10 +17,10 @@
 
 import { ComponentContainer, ComponentType } from '@firebase/component';
 import { VersionService } from './version-service';
-import { platformLogString } from './constants';
+import { PLATFORM_LOG_STRING } from './constants';
 
 export class PlatformLoggerService {
-  constructor(private container: ComponentContainer) {}
+  constructor(private readonly container: ComponentContainer) {}
   // In initial implementation, this will be called by installations on
   // auth token refresh, and installations will send this string.
   getPlatformInfoString(): string {
@@ -29,18 +29,19 @@ export class PlatformLoggerService {
     // version components.
     return providers
       .map(provider => {
-        const service = provider.getImmediate();
+        const service = provider.getImmediate() as VersionService;
         const component = provider.getComponent();
         if (service && component && component.type === ComponentType.VERSION) {
           const platformString =
-            platformLogString[(service as VersionService).library] ||
-            (service as VersionService).library;
-          return `${platformString}/${(service as VersionService).version}`;
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            (PLATFORM_LOG_STRING as any)[service.library] ||
+            service.library;
+          return `${platformString}/${service.version}`; 
         } else {
           return null;
         }
       })
-      .filter((logString: string | null) => logString)
+      .filter(logString => logString)
       .join(' ');
   }
 }

packages/firebase/app/index.ts

@@ -18,7 +18,7 @@
 import firebase from '@firebase/app';
 import { _FirebaseNamespace } from '@firebase/app-types/private';
 
-(firebase as _FirebaseNamespace).INTERNAL.registerVersionComponent(
+(firebase as _FirebaseNamespace).registerVersion(
   'firebase',
   firebase.SDK_VERSION
 );

packages/firebase/index.d.ts

@@ -83,6 +83,16 @@ declare namespace firebase {
    */
   var SDK_VERSION: string;
 
+  /**
+   * 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.
+   */
+  function registerVersion(
+    library: string,
+    version: string
+  ): void
+
   /**
    * @hidden
    */

packages/functions/src/config.ts

@@ -50,5 +50,5 @@ export function registerFunctions(instance: _FirebaseNamespace): void {
       .setServiceProps(namespaceExports)
       .setMultipleInstances(true)
   );
-  instance.INTERNAL.registerVersionComponent('functions', version);
+  instance.registerVersion('functions', version);
 }