Create overridable constants file

Author: andrewbrook

packages/telemetry/package.json

@@ -110,6 +110,7 @@
     "@firebase/app": "0.14.6",
     "@opentelemetry/sdk-trace-web": "2.1.0",
     "@rollup/plugin-json": "6.1.0",
+    "@rollup/plugin-replace": "6.0.2",
     "@testing-library/dom": "10.4.1",
     "@testing-library/react": "16.3.0",
     "@types/react": "19.1.13",

packages/telemetry/rollup.config.js

@@ -17,16 +17,30 @@
 
 import json from '@rollup/plugin-json';
 import copy from 'rollup-plugin-copy';
+import replacePlugin from '@rollup/plugin-replace';
 import typescriptPlugin from 'rollup-plugin-typescript2';
 import typescript from 'typescript';
 import pkg from './package.json';
 import { emitModulePackageFile } from '../../scripts/build/rollup_emit_module_package_file';
 
-const deps = Object.keys(
-  Object.assign({}, pkg.peerDependencies, pkg.dependencies)
-);
+const deps = [
+  ...Object.keys(Object.assign({}, pkg.peerDependencies, pkg.dependencies)),
+  './constants/auto-constants',
+];
+
+function replaceSource(path) {
+  return replacePlugin({
+    './src/constants/auto-constants': `'${path}'`,
+    '../constants/auto-constants': `'${path}'`,
+    delimiters: ["'", "'"],
+    preventAssignment: true
+  });
+}
 
-const buildPlugins = [typescriptPlugin({ typescript }), json()];
+const buildPlugins = [
+  typescriptPlugin({ typescript }),
+  json(),
+];
 
 const browserBuilds = [
   {
@@ -36,7 +50,7 @@ const browserBuilds = [
       format: 'es',
       sourcemap: true
     },
-    plugins: buildPlugins,
+    plugins: [...buildPlugins, replaceSource('./auto-constants.js')],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
   {
@@ -46,7 +60,7 @@ const browserBuilds = [
       format: 'cjs',
       sourcemap: true
     },
-    plugins: buildPlugins,
+    plugins: [...buildPlugins, replaceSource('./auto-constants.js')],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   }
 ];
@@ -59,7 +73,7 @@ const nodeBuilds = [
       format: 'cjs',
       sourcemap: true
     },
-    plugins: buildPlugins,
+    plugins: [...buildPlugins, replaceSource('./auto-constants.js')],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
   {
@@ -69,7 +83,7 @@ const nodeBuilds = [
       format: 'es',
       sourcemap: true
     },
-    plugins: [...buildPlugins, emitModulePackageFile()],
+    plugins: [...buildPlugins, emitModulePackageFile(), replaceSource('../auto-constants.js')],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   }
 ];
@@ -100,7 +114,8 @@ const reactBuilds = [
             dest: 'dist'
           }
         ]
-      })
+      }),
+      replaceSource('../auto-constants.js')
     ],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
@@ -117,7 +132,8 @@ const reactBuilds = [
         typescript,
         tsconfig: 'tsconfig.react.json'
       }),
-      json()
+      json(),
+      replaceSource('../auto-constants.js')
     ],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   }
@@ -148,7 +164,8 @@ const angularBuilds = [
             dest: 'dist'
           }
         ]
-      })
+      }),
+      replaceSource('../auto-constants.js')
     ],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
@@ -164,15 +181,28 @@ const angularBuilds = [
         typescript,
         tsconfig: 'tsconfig.angular.json'
       }),
-      json()
+      json(),
+      replaceSource('../auto-constants.js')
     ],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   }
 ];
 
+const autoinitBuild = [
+  {
+    input: './src/constants/auto-constants.ts',
+    output: {
+      file: './dist/auto-constants.js',
+      format: 'cjs'
+    },
+    plugins: buildPlugins
+  },
+];
+
 export default [
   ...browserBuilds,
   ...nodeBuilds,
   ...reactBuilds,
-  ...angularBuilds
+  ...angularBuilds,
+  ...autoinitBuild
 ];

packages/telemetry/src/api.ts

@@ -22,6 +22,7 @@ import { Provider } from '@firebase/component';
 import { AnyValueMap, SeverityNumber } from '@opentelemetry/api-logs';
 import { trace } from '@opentelemetry/api';
 import { TelemetryService } from './service';
+import { getAppVersion } from './helpers';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
@@ -93,12 +94,7 @@ export function captureError(
   }
 
   // Add app version metadata
-  let appVersion = 'unset';
-  // TODO: implement app version fallback logic
-  if ((telemetry as TelemetryService).options?.appVersion) {
-    appVersion = (telemetry as TelemetryService).options!.appVersion!;
-  }
-  customAttributes['app.version'] = appVersion;
+  customAttributes['app.version'] = getAppVersion(telemetry);
 
   if (error instanceof Error) {
     logger.emit({

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

@@ -0,0 +1 @@
+export const AUTO_APP_VERSION = '';

packages/telemetry/src/helpers.ts

@@ -0,0 +1,12 @@
+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;
+  }
+  return 'unset';
+}