Switch auto constants to object for extensibility

Author: andrewbrook

packages/telemetry/rollup.config.js

@@ -25,7 +25,7 @@ import { emitModulePackageFile } from '../../scripts/build/rollup_emit_module_pa
 
 const deps = [
   ...Object.keys(Object.assign({}, pkg.peerDependencies, pkg.dependencies)),
-  './constants/auto-constants',
+  './constants/auto-constants'
 ];
 
 function replaceSource(path) {
@@ -37,10 +37,7 @@ function replaceSource(path) {
   });
 }
 
-const buildPlugins = [
-  typescriptPlugin({ typescript }),
-  json(),
-];
+const buildPlugins = [typescriptPlugin({ typescript }), json()];
 
 const browserBuilds = [
   {
@@ -83,7 +80,11 @@ const nodeBuilds = [
       format: 'es',
       sourcemap: true
     },
-    plugins: [...buildPlugins, emitModulePackageFile(), replaceSource('../auto-constants.js')],
+    plugins: [
+      ...buildPlugins,
+      emitModulePackageFile(),
+      replaceSource('../auto-constants.js')
+    ],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   }
 ];
@@ -196,7 +197,7 @@ const autoinitBuild = [
       format: 'cjs'
     },
     plugins: buildPlugins
-  },
+  }
 ];
 
 export default [

packages/telemetry/src/api.test.ts

@@ -42,6 +42,7 @@ import {
 import { TelemetryService } from './service';
 import { registerTelemetry } from './register';
 import { _FirebaseInstallationsInternal } from '@firebase/installations';
+import { AUTO_CONSTANTS } from './constants/auto-constants';
 
 const PROJECT_ID = 'my-project';
 const APP_ID = 'my-appid';
@@ -278,6 +279,7 @@ describe('Top level API', () => {
     });
 
     it('should use explicit app version when provided', () => {
+      AUTO_CONSTANTS.appVersion = '1.2.3'; // Unused
       const telemetry = new TelemetryService(
         fakeTelemetry.app,
         fakeTelemetry.loggerProvider
@@ -296,6 +298,19 @@ describe('Top level API', () => {
       });
     });
 
+    it('should use auto constants if available', () => {
+      AUTO_CONSTANTS.appVersion = '1.2.3';
+
+      captureError(fakeTelemetry, 'a string error');
+
+      expect(emittedLogs.length).to.equal(1);
+      const log = emittedLogs[0];
+      expect(log.attributes).to.deep.equal({
+        [LOG_ENTRY_ATTRIBUTE_KEYS.APP_VERSION]: '1.2.3',
+        [LOG_ENTRY_ATTRIBUTE_KEYS.SESSION_ID]: MOCK_SESSION_ID
+      });
+    });
+
     describe('Session Metadata', () => {
       it('should generate and store a new session ID if none exists', () => {
         captureError(fakeTelemetry, 'error');

packages/telemetry/src/constants/auto-constants.ts

@@ -1 +1,19 @@
-export const AUTO_APP_VERSION = '';
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const AUTO_CONSTANTS: any = {};

packages/telemetry/src/helpers.ts

@@ -1,12 +1,29 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import * as constants from './constants/auto-constants';
 import { Telemetry } from './public-types';
 import { TelemetryService } from './service';
 
 export function getAppVersion(telemetry: Telemetry): string {
   if ((telemetry as TelemetryService).options?.appVersion) {
     return (telemetry as TelemetryService).options!.appVersion!;
-  } else if (constants.AUTO_APP_VERSION) {
-    return constants.AUTO_APP_VERSION;
+  } else if (constants.AUTO_CONSTANTS?.appVersion) {
+    return constants.AUTO_CONSTANTS.appVersion;
   }
   return 'unset';
-}
+}