Use Dynamic Measurement ID in Analytics #2800

hsubox76 · 2020-03-25T20:56:30Z

Switch Analytics to using dynamic measurement ID fetched from REST endpoint. Previously it was using the ID provided in the user's config object. Measurement ID may change so we are switching to fetching it dynamically.

google-oss-bot · 2020-03-25T21:04:53Z

Binary Size Report

Affected SDKs

@firebase/analytics

Type Base (d347c6c) Head (47deaa9) Diff

esm2017 9.89 kB 18.4 kB +8.47 kB (+85.7%)

main 11.2 kB 23.3 kB +12.1 kB (+108.8%)

module 10.8 kB 22.8 kB +12.0 kB (+111.1%)

`@firebase/remote-config`

Type	Base (`d347c6c`)	Head (`47deaa9`)	Diff
browser	23.2 kB	22.8 kB	-347 B (-1.5%)
esm2017	17.7 kB	17.4 kB	-341 B (-1.9%)
main	23.2 kB	22.8 kB	-347 B (-1.5%)
module	22.7 kB	22.4 kB	-329 B (-1.4%)

`@firebase/util`

Type	Base (`d347c6c`)	Head (`47deaa9`)	Diff
browser	20.5 kB	21.1 kB	+657 B (+3.2%)
esm2017	18.3 kB	18.8 kB	+507 B (+2.8%)
main	20.5 kB	21.2 kB	+657 B (+3.2%)
module	19.5 kB	20.1 kB	+579 B (+3.0%)

`firebase`

Type	Base (`d347c6c`)	Head (`47deaa9`)	Diff
firebase-analytics.js	28.3 kB	35.9 kB	+7.52 kB (+26.5%)
firebase-performance-standalone.es2017.js	71.3 kB	71.3 kB	-1 B (-0.0%)
firebase-performance-standalone.js	48.0 kB	48.0 kB	-1 B (-0.0%)
firebase-performance.js	38.4 kB	38.4 kB	-1 B (-0.0%)
firebase-remote-config.js	37.1 kB	37.1 kB	+59 B (+0.2%)
firebase.js	822 kB	829 kB	+7.45 kB (+0.9%)

Test Logs

Base (d347c6ca): https://github.com/firebase/firebase-js-sdk/actions/runs/244897022
Head (47deaa92): https://github.com/firebase/firebase-js-sdk/actions/runs/244975272

packages/analytics/src/get-config.ts

packages/analytics/src/helpers.ts

packages/analytics/index.test.ts

packages/analytics/src/errors.ts

packages/analytics/src/exponential_backoff.ts

packages/analytics/src/functions.ts

packages/analytics/src/factory.ts

packages/analytics/src/get-config.test.ts

packages/analytics/src/helpers.ts

changeset-bot · 2020-07-20T20:18:06Z

🦋 Changeset is good to go

Latest commit: 1933243

We got this.

This PR includes changesets to release 25 packages

Name	Type
@firebase/remote-config	Patch
@firebase/util	Patch
@firebase/analytics	Minor
@firebase/analytics-types	Minor
firebase	Patch
@firebase/app	Patch
@firebase/component	Patch
@firebase/database	Patch
@firebase/firestore	Patch
@firebase/installations	Patch
@firebase/messaging	Patch
@firebase/performance	Patch
@firebase/rules-unit-testing	Patch
@firebase/storage	Patch
@firebase/testing	Patch
@firebase/app-compat	Patch
@firebase/app-exp	Patch
@firebase/functions-exp	Patch
@firebase/installations-exp	Patch
firebase-size-analysis	Patch
firebase-namespace-integration-test	Patch
firebase-messaging-integration-test	Patch
firebase-firestore-integration-test	Patch
@firebase/functions	Patch
firebase-exp	Patch

Not sure what this means? Click here to learn what changesets are.

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

packages/analytics/src/get-config.ts

packages/analytics/index.ts

packages/analytics/src/functions.ts

Feiyang1 · 2020-07-23T00:43:19Z

packages/analytics/src/functions.ts

@@ -30,23 +30,27 @@ import { GtagCommand } from './constants';
 * @param eventName Google Analytics event name, choose from standard list or use a custom string.
 * @param eventParams Analytics event parameters.
 */
-export function logEvent(
+export async function logEvent(


The other functions are not async. Should we make all of them the same?

Does it make a difference as they all have to return a promise anyway? Changed them all for consistency in any case.

No, it is only about consistency. You changed the signature of the functions to async but still use then instead of await. We should change them to use await

packages/analytics/src/get-config.ts

packages/analytics/src/helpers.ts

packages/analytics/src/factory.ts

packages/remote-config/test/remote_config.test.ts

Feiyang1 · 2020-07-30T23:03:46Z

packages/analytics/package.json

@@ -37,7 +39,7 @@
    "rollup-plugin-commonjs": "10.1.0",
    "rollup-plugin-json": "4.0.0",
    "rollup-plugin-node-resolve": "5.2.0",
-    "rollup-plugin-typescript2": "0.27.1",
+    "rollup-plugin-typescript2": "0.27.0",


We should upgrade to 0.27.1 which is the current version.

Something always seems to go wrong with the rebasing. Fixed.

rachelsaunders · 2020-08-03T20:50:39Z

packages/analytics/src/factory.ts

+        `"apiKey" field is empty in Firebase config. This is needed to fetch the latest` +
+          ` measurement id for this Firebase app. Falling back to measurement id ${app.options.measurementId}` +
+          ` provided in "measurementId" field.`


Suggested change

`"apiKey" field is empty in Firebase config. This is needed to fetch the latest` +

` measurement id for this Firebase app. Falling back to measurement id ${app.options.measurementId}` +

` provided in "measurementId" field.`

`The "apiKey" field is empty in the local Firebase config. This is needed to fetch the latest` +

` measurement ID for this Firebase app. Falling back to the measurement ID ${app.options.measurementId}` +

` provided in the "measurementId" field in the local Firebase config.`

rachelsaunders · 2020-08-03T20:53:45Z

packages/analytics/src/get-config.ts

+        `Timed out fetching this Firebase app's measurement id from the server.` +
+          ` Falling back to measurement id ${measurementId}` +
+          ` provided in "measurementId" field. [${e.message}]`


Suggested change

`Timed out fetching this Firebase app's measurement id from the server.` +

` Falling back to measurement id ${measurementId}` +

` provided in "measurementId" field. [${e.message}]`

`Timed out fetching this Firebase app's measurement ID from the server.` +

` Falling back to the measurement ID ${measurementId}` +

` provided in the "measurementId" field in the local Firebase config. [${e.message}]`

rachelsaunders · 2020-08-03T20:54:21Z

packages/analytics/src/get-config.ts

+          `Failed to fetch this Firebase app's measurement id from the server.` +
+            ` Falling back to measurement id ${measurementId}` +
+            ` provided in "measurementId" field. [${e.message}]`


Suggested change

`Failed to fetch this Firebase app's measurement id from the server.` +

` Falling back to measurement id ${measurementId}` +

` provided in "measurementId" field. [${e.message}]`

`Failed to fetch this Firebase app's measurement ID from the server.` +

` Falling back to the measurement ID ${measurementId}` +

` provided in the "measurementId" field in the local Firebase config. [${e.message}]`

rachelsaunders · 2020-08-03T21:01:05Z

packages/analytics/src/initialize-ids.ts

+          `Measurement ID in local firebase config (${app.options.measurementId})` +
+            ` does not match measurement ID fetched from server (${config.measurementId}).` +
+            ` To avoid analytics events being sent to the wrong measurement ID, update the` +
+            ` measurement ID field in the local config or remove it.`


Suggested change

`Measurement ID in local firebase config (${app.options.measurementId})` +

` does not match measurement ID fetched from server (${config.measurementId}).` +

` To avoid analytics events being sent to the wrong measurement ID, update the` +

` measurement ID field in the local config or remove it.`

`The measurement ID in the local Firebase config (${app.options.measurementId})` +

` does not match the measurement ID fetched from the server (${config.measurementId}).` +

` To avoid analytics events being sent to the wrong measurement ID, update the` +

` measurement ID field in the local config or remove it from the local config.`

rachelsaunders · 2020-08-03T21:34:00Z

packages/analytics/src/errors.ts

+    '"apiKey" field is empty in Firebase config. Firebase Analytics requires this field to' +
+    'contain a valid API key.',


Suggested change

'"apiKey" field is empty in Firebase config. Firebase Analytics requires this field to' +

'contain a valid API key.',

'The "apiKey" field is empty in the local Firebase config. Firebase Analytics requires this field to' +

'contain a valid API key.',

rachelsaunders · 2020-08-03T21:34:15Z

packages/analytics/src/errors.ts

+    '"appId" field is empty in Firebase config. Firebase Analytics requires this field to' +
+    'contain a valid app ID.',


Suggested change

'"appId" field is empty in Firebase config. Firebase Analytics requires this field to' +

'contain a valid app ID.',

'The "appId" field is empty in the local Firebase config. Firebase Analytics requires this field to' +

'contain a valid app ID.',

rachelsaunders · 2020-08-04T00:11:08Z

packages/analytics/src/initialize-ids.ts

+        logger.warn(
+          `The measurement ID in the local Firebase config (${app.options.measurementId})` +
+            ` does not match the measurement ID fetched from the server (${config.measurementId}).` +
+            ` To avoid analytics events being sent to the wrong measurement ID, update the` +


Question - is it that the events would be sent to the "wrong Analytics property", rather than the "wrong measurement ID". IIUC, the measurement ID is how the Web App is associated with its Analytics property, i.e., the actual entity that logs the events is the "Analytics property". Can anybody confirm this?

It would be the wrong property. I suppose it could also be no property if it's an invalid measurement ID so I guess I was just trying to be very literal and not go any farther than saying it would make the gtag call using the wrong measurement ID as a parameter, which could cause it to either be sent to the wrong property or no property at all if it's not a valid measurement ID (the previous expired one?).

I'm not sure if that distinction is important but I guess I imagined people not finding it in any of their properties and then saying they were misled or something.

Maybe we can flip this statement and say:

To ensure analytics events are always sent to the correct Analytics property, update....

Sounds good! Changed.

rachelsaunders

Approving error message copy only.

google-oss-bot · 2020-08-24T18:57:32Z

Size Analysis Report

Affected Products

No changes between base commit (d347c6c) and head commit (47deaa9).

Test Logs

Base (d347c6ca): https://github.com/firebase/firebase-js-sdk/actions/runs/244897022
Head (47deaa92): https://github.com/firebase/firebase-js-sdk/actions/runs/244975272

googlebot · 2020-09-08T17:29:23Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

hsubox76 requested a review from Feiyang1 as a code owner March 25, 2020 20:56

Feiyang1 reviewed Mar 26, 2020

View reviewed changes

packages/analytics/src/get-config.ts Outdated Show resolved Hide resolved

packages/analytics/src/helpers.ts Outdated Show resolved Hide resolved

hsubox76 force-pushed the ch-measurementid branch from dba9ebe to 65d673e Compare April 4, 2020 01:03

hsubox76 requested a review from egilmorez as a code owner April 7, 2020 00:33

hsubox76 changed the title ~~WIP: Use Dynamic Measurement ID in Analytics~~ Use Dynamic Measurement ID in Analytics Apr 8, 2020

hsubox76 removed the request for review from egilmorez April 9, 2020 20:33

hsubox76 changed the title ~~Use Dynamic Measurement ID in Analytics~~ DO NOT MERGE: Use Dynamic Measurement ID in Analytics Apr 13, 2020

Feiyang1 reviewed Apr 13, 2020

View reviewed changes

hsubox76 force-pushed the ch-measurementid branch from aed7e76 to 3890a69 Compare April 24, 2020 19:55

hsubox76 requested review from erikeldridge and hiranya911 as code owners April 24, 2020 19:55

hsubox76 force-pushed the ch-measurementid branch from 1a55827 to 1ae1412 Compare May 18, 2020 19:14

hsubox76 force-pushed the ch-measurementid branch from 1ae1412 to dd8c994 Compare July 20, 2020 20:18

hsubox76 force-pushed the ch-measurementid branch from fb62230 to 027600b Compare July 22, 2020 22:14

hsubox76 assigned Feiyang1 Jul 22, 2020

Feiyang1 reviewed Jul 23, 2020

View reviewed changes

hsubox76 force-pushed the ch-measurementid branch from 7931db6 to 4a8e6b6 Compare July 29, 2020 17:45

hsubox76 requested a review from rachelsaunders July 30, 2020 18:57

hsubox76 force-pushed the ch-measurementid branch from 8c382ef to 6d369c1 Compare July 30, 2020 19:53

Feiyang1 reviewed Jul 30, 2020

View reviewed changes

rachelsaunders requested changes Aug 3, 2020

View reviewed changes

rachelsaunders requested changes Aug 4, 2020

View reviewed changes

rachelsaunders approved these changes Aug 5, 2020

View reviewed changes

hsubox76 force-pushed the ch-measurementid branch from b0119d2 to 9556daf Compare August 10, 2020 19:23

hsubox76 force-pushed the ch-measurementid branch from 9556daf to 27bb8c5 Compare August 24, 2020 18:41

hsubox76 force-pushed the ch-measurementid branch 2 times, most recently from 0ccfaba to ad2d2ed Compare August 31, 2020 20:00

hsubox76 added 21 commits September 8, 2020 10:27

Address PR comments

d515194

Add measurement ID mismatch warning

388b6a3

Fix formatting of message

f8c2966

Fix typo

ed8b636

Try to fix fetch stubs

1ba4800

Fix warning messages.

569a0ca

Remove .only in test!

42819b5

Fix error/warn messages per PR comments.

ebeba07

Update warning message

9b67dba

Fix rebase conflicts

6fd2cf7

Change test to timeout

10668c9

Improve tests

b65fbce

Improve tests more

6fb315b

Remove leftover lines

25067ec

Add delete() method

53024df

Try to fix indexeddb test

97aced3

Try to directly stub indexedDB.open?

b1b7f11

Analytics integration tests (#3687)

d997801

Address PR comments

8af8057

Remove automatic afterEach restore, restore clock

ac38516

Get rid of async in before blocks

1933243

hsubox76 force-pushed the ch-measurementid branch from b570e16 to 1933243 Compare September 8, 2020 17:28

hsubox76 requested review from a team as code owners September 8, 2020 17:28

hsubox76 merged commit fb3b095 into master Sep 8, 2020

google-oss-bot mentioned this pull request Sep 8, 2020

Version Packages #3746

Merged

hsubox76 deleted the ch-measurementid branch September 15, 2020 16:44

firebase locked and limited conversation to collaborators Oct 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Dynamic Measurement ID in Analytics #2800

Use Dynamic Measurement ID in Analytics #2800

hsubox76 commented Mar 25, 2020 •

edited

Loading

google-oss-bot commented Mar 25, 2020 •

edited

Loading

`@firebase/analytics`

`@firebase/remote-config`

`@firebase/util`

`firebase`

changeset-bot bot commented Jul 20, 2020 •

edited

Loading

Feiyang1 Jul 23, 2020

hsubox76 Jul 23, 2020

Feiyang1 Jul 30, 2020

hsubox76 Jul 31, 2020

Feiyang1 Jul 30, 2020

hsubox76 Jul 31, 2020

rachelsaunders Aug 3, 2020

hsubox76 Aug 4, 2020

rachelsaunders Aug 3, 2020

hsubox76 Aug 4, 2020

rachelsaunders Aug 3, 2020

hsubox76 Aug 4, 2020

rachelsaunders Aug 3, 2020

hsubox76 Aug 4, 2020

rachelsaunders Aug 3, 2020

hsubox76 Aug 4, 2020

rachelsaunders Aug 3, 2020

hsubox76 Aug 4, 2020

rachelsaunders Aug 4, 2020

hsubox76 Aug 4, 2020

rachelsaunders Aug 4, 2020

hsubox76 Aug 4, 2020

rachelsaunders left a comment

google-oss-bot commented Aug 24, 2020 •

edited

Loading

googlebot commented Sep 8, 2020

		'"apiKey" field is empty in Firebase config. Firebase Analytics requires this field to' +
		'contain a valid API key.',

		'"appId" field is empty in Firebase config. Firebase Analytics requires this field to' +
		'contain a valid app ID.',

Use Dynamic Measurement ID in Analytics #2800

Use Dynamic Measurement ID in Analytics #2800

Conversation

hsubox76 commented Mar 25, 2020 • edited Loading

google-oss-bot commented Mar 25, 2020 • edited Loading

Binary Size Report

Affected SDKs

@firebase/analytics

@firebase/remote-config

@firebase/util

firebase

Test Logs

changeset-bot bot commented Jul 20, 2020 • edited Loading

🦋 Changeset is good to go

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rachelsaunders left a comment

Choose a reason for hiding this comment

google-oss-bot commented Aug 24, 2020 • edited Loading

Size Analysis Report

Affected Products

Test Logs

googlebot commented Sep 8, 2020

hsubox76 commented Mar 25, 2020 •

edited

Loading

google-oss-bot commented Mar 25, 2020 •

edited

Loading

`@firebase/analytics`

`@firebase/remote-config`

`@firebase/util`

`firebase`

changeset-bot bot commented Jul 20, 2020 •

edited

Loading

google-oss-bot commented Aug 24, 2020 •

edited

Loading