Create overridable constants file

[andrewbrook]

Discussion

Adds a new "auto-constants" file that is not bundled into the index.js output. It can optionally be overwritten during the application's build process to automatically set "app version" based on context (eg. git commit hash, deployment id, etc.).

Testing

Unit tested, manually tested

API Changes

n/a

[changeset-bot]

⚠️ No Changeset found

Latest commit: ad7a709

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[google-oss-bot]

Size Report ¹

Affected Products

• @firebase/telemetry

  Type	Base (ad0366b)	Merge (92e7f03)	Diff
  browser	8.61 kB	8.80 kB	+192 B (+2.2%)
  main	7.99 kB	8.74 kB	+755 B (+9.5%)
  module	8.61 kB	8.80 kB	+192 B (+2.2%)

• firebase

  Type	Base (ad0366b)	Merge (92e7f03)	Diff
  firebase-telemetry.js	88.1 kB	88.2 kB	+103 B (+0.1%)

Test Logs

• Base (ad0366b): https://github.com/firebase/firebase-js-sdk/actions/runs/19544904562
• Merge (92e7f03): https://github.com/firebase/firebase-js-sdk/actions/runs/19547508277

1. https://storage.googleapis.com/firebase-sdk-metric-reports/o0pW5HQOQE.html

[google-oss-bot]

Size Analysis Report ¹

Affected Products

• @firebase/telemetry

  • captureError

    Size

    Type	Base (ad0366b)	Merge (92e7f03)	Diff
    size	5.17 kB	5.29 kB	+117 B (+2.3%)
    size-with-ext-deps	64.5 kB	64.7 kB	+123 B (+0.2%)

    Dependency

    Type	Base (ad0366b)	Merge (92e7f03)	Diff
    functions	captureError createLoggerProvider isExportRetryable parseRetryAfterToMills registerTelemetry	captureError createLoggerProvider getAppVersion getSessionId isExportRetryable parseRetryAfterToMills registerTelemetry	+ getAppVersion + getSessionId
    variables	LOG_ENTRY_ATTRIBUTE_KEYS TELEMETRY_SESSION_ID_KEY TELEMETRY_TYPE name version	AUTO_CONSTANTS LOG_ENTRY_ATTRIBUTE_KEYS TELEMETRY_SESSION_ID_KEY TELEMETRY_TYPE name version	+ AUTO_CONSTANTS

  • nextOnRequestError

    Size

    Type	Base (ad0366b)	Merge (92e7f03)	Diff
    size	5.54 kB	5.66 kB	+117 B (+2.1%)
    size-with-ext-deps	71.9 kB	72.0 kB	+123 B (+0.2%)

    Dependency

    Type	Base (ad0366b)	Merge (92e7f03)	Diff
    functions	captureError createLoggerProvider getTelemetry isExportRetryable nextOnRequestError parseRetryAfterToMills registerTelemetry	captureError createLoggerProvider getAppVersion getSessionId getTelemetry isExportRetryable nextOnRequestError parseRetryAfterToMills registerTelemetry	+ getAppVersion + getSessionId
    variables	LOG_ENTRY_ATTRIBUTE_KEYS TELEMETRY_SESSION_ID_KEY TELEMETRY_TYPE name version	AUTO_CONSTANTS LOG_ENTRY_ATTRIBUTE_KEYS TELEMETRY_SESSION_ID_KEY TELEMETRY_TYPE name version	+ AUTO_CONSTANTS

Test Logs

• Base (ad0366b): https://github.com/firebase/firebase-js-sdk/actions/runs/19544904562
• Merge (92e7f03): https://github.com/firebase/firebase-js-sdk/actions/runs/19547508277

1. https://storage.googleapis.com/firebase-sdk-metric-reports/F0QfXdMYO0.html

[hsubox76]

Might be overcautious with that comment but worth a double check. I think almost all build pipelines can process CJS but not sure if there are problems when both CJS and ESM files come from the same dependency.

Also this won't be available for CDN users: https://firebase.google.com/docs/web/alt-setup so that's something to keep in mind - I think it's fine, but we need to document it and tell CDN users to just hardcode it into the init options, and this autoconstants route won't be an option for them.