Add logging of entry point type

Author: hsubox76

packages/app-types/index.d.ts

@@ -118,5 +118,6 @@ declare module '@firebase/component' {
   interface NameServiceMapping {
     'app': FirebaseApp;
     'app-version': VersionService;
+    'platform-identifier': VersionService;
   }
 }

packages/app/src/constants.ts

@@ -18,7 +18,6 @@
 export const DEFAULT_ENTRY_NAME = '[DEFAULT]';
 
 export const PLATFORM_LOG_STRING = {
-  'firebase': 'fire-js',
   'app': 'fire-core',
   'analytics': 'fire-analytics',
   'auth': 'fire-auth',
@@ -28,5 +27,12 @@ export const PLATFORM_LOG_STRING = {
   'performance': 'fire-perf',
   'remote-config': 'fire-rc',
   'storage': 'fire-gcs',
-  'firestore': 'fire-fst'
+  'firestore': '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'
 } as const;

packages/app/src/firebaseApp.ts

@@ -78,6 +78,14 @@ export class FirebaseAppImpl implements FirebaseApp {
         ComponentType.VERSION
       )
     );
+    this._addComponent(
+      new Component(
+        'platform-identifier',
+        // Adds a string identifying version header as belonging to JS SDK
+        () => new VersionService('fire-js', ''),
+        ComponentType.VERSION
+      )
+    );
     // populate ComponentContainer with existing components
     for (const component of this.firebase_.INTERNAL.components.values()) {
       this._addComponent(component);

packages/app/src/platformLoggerService.ts

@@ -31,10 +31,12 @@ export class PlatformLoggerService {
       .map(provider => {
         const service = provider.getImmediate() as VersionService;
         const component = provider.getComponent();
-        if (service && component && component.type === ComponentType.VERSION) {
+        if (service && component?.type === ComponentType.VERSION) {
+          // TODO: We can use this check to whitelist strings when/if we set up
+          // a good whitelist system.
           const platformString =
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            (PLATFORM_LOG_STRING as any)[service.library] || service.library;
+            (PLATFORM_LOG_STRING as any)[service.library] ?? service.library;
           return `${platformString}/${service.version}`;
         } else {
           return null;

packages/app/test/platformLogger.test.ts

@@ -79,7 +79,8 @@ describe('Platform Logger Service', () => {
             );
             const platformLogger = (await platformLoggerProvider.get()) as PlatformLoggerService;
             const platformInfoString = platformLogger.getPlatformInfoString();
-            expect(platformInfoString).to.include('fire-core');
+            expect(platformInfoString).to.include('fire-core/');
+            expect(platformInfoString).to.include('fire-js/ ');
           },
           ComponentType.PUBLIC
         )
@@ -100,6 +101,7 @@ describe('Platform Logger Service', () => {
             const platformLogger = (await platformLoggerProvider.get()) as PlatformLoggerService;
             const platformInfoString = platformLogger.getPlatformInfoString();
             expect(platformInfoString).to.include('fire-analytics/1.2.3');
+            expect(platformInfoString).to.include('fire-js/ ');
           },
           ComponentType.PUBLIC
         )

packages/firebase/app/index.ts

@@ -19,7 +19,7 @@ import firebase from '@firebase/app';
 import { _FirebaseNamespace } from '@firebase/app-types/private';
 
 (firebase as _FirebaseNamespace).registerVersion(
-  'firebase',
+  'fire-js-all-app',
   firebase.SDK_VERSION
 );
 

packages/firebase/src/index.cdn.ts

@@ -39,4 +39,9 @@ import '../performance';
 import '../analytics';
 import '../remote-config';
 
+firebase.registerVersion(
+  'fire-js-all-cdn',
+  firebase.SDK_VERSION
+);
+
 export default firebase;

packages/firebase/src/index.node.ts

@@ -22,4 +22,9 @@ import '../database';
 import '../firestore';
 import '../functions';
 
+firebase.registerVersion(
+  'fire-js-all-node',
+  firebase.SDK_VERSION
+);
+
 export default firebase;

packages/firebase/src/index.perf.ts

@@ -18,4 +18,9 @@
 import firebase from '@firebase/app';
 import '@firebase/performance';
 
+firebase.registerVersion(
+  'fire-js-all-lite',
+  firebase.SDK_VERSION
+);
+
 export default firebase;

packages/firebase/src/index.rn.ts

@@ -21,4 +21,9 @@ import '../auth';
 import '../database';
 import '../storage';
 
+firebase.registerVersion(
+  'fire-js-all-rn',
+  firebase.SDK_VERSION
+);
+
 export default firebase;

packages/firebase/src/index.ts

@@ -48,4 +48,9 @@ import '../performance';
 import '../analytics';
 import '../remote-config';
 
+firebase.registerVersion(
+  'fire-js-all',
+  firebase.SDK_VERSION
+);
+
 export default firebase;