Fix setConsent to properly use the `update` gtag command #8243

DellaBitta · 2024-05-13T15:22:30Z

Discussion

We wrap the gtag function internally and pass setConsent calls through the wrapper function, which in turn calls the gtag SDK. While we invoke the wrapped function with parameters identical to those listed in the gtag functions, we were dropping the update string on the floor inside the wrapped function. Additionally, we were feeding the consentSettings as the second parameter to gag, which should have been the update string parameter.

This ended up clobbering the data, and not send update commands properly.

This change fixes our wrappedGtag func impl to properly pass update to gtag, along with the provided ConsentSettings argument.

Closes #8210

Testing

Added a higher level of fidelity to our unit tests by testing the values set in window['dataLayer'].
CI passes.

API Changes

N/A

Include the consent string ('update') in gtagCore calls that update consent.

changeset-bot · 2024-05-13T15:22:34Z

🦋 Changeset detected

Latest commit: 5e07a73

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@firebase/analytics	Patch
@firebase/analytics-compat	Patch
firebase	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

github-actions · 2024-05-13T15:26:06Z

Changeset File Check ✅

No modified packages are missing from the changeset file.
No changeset formatting errors detected.

google-oss-bot · 2024-05-13T15:37:44Z

Size Report ¹

Affected Products

@firebase/analytics
Type Base (9cbb184) Merge (f7c9e13) Diff
browser 21.8 kB 21.8 kB +19 B (+0.1%)
esm5 26.9 kB 27.0 kB +41 B (+0.2%)
main 28.4 kB 28.4 kB +41 B (+0.1%)
module 21.8 kB 21.8 kB +19 B (+0.1%)
@firebase/firestore
Type Base (9cbb184) Merge (f7c9e13) Diff
esm5 363 kB 363 kB -2 B (-0.0%)
main 582 kB 582 kB -11 B (-0.0%)
bundle
Type Base (9cbb184) Merge (f7c9e13) Diff
analytics (logEvent) 44.5 kB 44.5 kB -5 B (-0.0%)

`firebase`

Type	Base (`9cbb184`)	Merge (`f7c9e13`)	Diff
firebase-analytics-compat.js	26.5 kB	26.5 kB	-3 B (-0.0%)
firebase-analytics.js	29.7 kB	29.7 kB	-5 B (-0.0%)
firebase-compat.js	786 kB	786 kB	-2 B (-0.0%)
firebase-firestore-compat.js	341 kB	341 kB	+1 B (+0.0%)

Test Logs

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

google-oss-bot · 2024-05-13T15:49:33Z

Size Analysis Report ¹

Affected Products

@firebase/analytics
- getAnalytics
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.6 kB 10.6 kB -5 B (-0.0%)
  size-with-ext-deps 44.4 kB 44.4 kB -5 B (-0.0%)
- getGoogleAnalyticsClientId
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.5 kB 10.5 kB -5 B (-0.0%)
  size-with-ext-deps 37.2 kB 37.2 kB -5 B (-0.0%)
- initializeAnalytics
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.5 kB 10.5 kB -5 B (-0.0%)
  size-with-ext-deps 37.5 kB 37.5 kB -5 B (-0.0%)
- isSupported
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.4 kB 10.4 kB -5 B (-0.0%)
  size-with-ext-deps 37.1 kB 37.1 kB -5 B (-0.0%)
- logEvent
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.2 kB 10.2 kB -5 B (-0.0%)
  size-with-ext-deps 37.0 kB 37.0 kB -5 B (-0.0%)
- setAnalyticsCollectionEnabled
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.4 kB 10.4 kB -5 B (-0.0%)
  size-with-ext-deps 37.1 kB 37.1 kB -5 B (-0.0%)
- setConsent
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.4 kB 10.4 kB -5 B (-0.0%)
  size-with-ext-deps 37.1 kB 37.1 kB -5 B (-0.0%)
- setCurrentScreen
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.5 kB 10.5 kB -5 B (-0.0%)
  size-with-ext-deps 37.2 kB 37.2 kB -5 B (-0.0%)
- setDefaultEventParameters
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.4 kB 10.4 kB -5 B (-0.0%)
  size-with-ext-deps 37.1 kB 37.1 kB -5 B (-0.0%)
- setUserId
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.5 kB 10.5 kB -5 B (-0.0%)
  size-with-ext-deps 37.2 kB 37.2 kB -5 B (-0.0%)
- setUserProperties
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.6 kB 10.5 kB -5 B (-0.0%)
  size-with-ext-deps 37.3 kB 37.3 kB -5 B (-0.0%)
- settings
  Size
  Type Base (9cbb184) Merge (f7c9e13) Diff
  size 10.4 kB 10.4 kB -5 B (-0.0%)
  size-with-ext-deps 37.1 kB 37.1 kB -5 B (-0.0%)

Test Logs

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

packages/analytics/src/helpers.ts

packages/analytics/src/helpers.test.ts

Ensure 'update' string reaches gtagCore.

a10daf1

Include the consent string ('update') in gtagCore calls that update consent.

Changeset

6b09d6b

DellaBitta and others added 2 commits May 13, 2024 11:29

format.

3f20114

patch, not minor

60ddfd5

DellaBitta requested a review from hsubox76 May 13, 2024 18:06

DellaBitta marked this pull request as ready for review May 13, 2024 18:06

DellaBitta requested review from a team as code owners May 13, 2024 18:06

Merge branch 'master' into ddb-analytics-set-consent

e17d7f2

hsubox76 reviewed May 14, 2024

View reviewed changes

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

DellaBitta added 3 commits May 14, 2024 18:54

added higher fidelity tests to helpers.test.ts

6e63d10

two more tests.

5ea2989

renamed consentString to consentAction.

8d25c98

DellaBitta requested a review from hsubox76 May 15, 2024 15:00

hsubox76 reviewed May 15, 2024

View reviewed changes

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

hsubox76 approved these changes May 15, 2024

View reviewed changes

Index by number not string

5e07a73

DellaBitta merged commit f66769c into master May 15, 2024

DellaBitta deleted the ddb-analytics-set-consent branch May 15, 2024 18:11

DellaBitta mentioned this pull request May 15, 2024

Fix analytics consent updating (#8210) #8211

Closed

google-oss-bot mentioned this pull request May 20, 2024

Version Packages #8254

Merged

sswietoniowski mentioned this pull request Jun 10, 2024

[Snyk] Upgrade firebase from 10.12.0 to 10.12.1 sswietoniowski/learning-html-css-javascript#383

Closed

Abellache-Rabah mentioned this pull request Jun 10, 2024

[Snyk] Upgrade firebase from 10.0.0 to 10.12.1 Abellache-Rabah/backend-hawasli#52

Open

leoo1992 mentioned this pull request Jun 10, 2024

[Snyk] Upgrade firebase from 10.12.0 to 10.12.1 leoo1992/next-tailwind-firebase#16

Merged

surajit03 mentioned this pull request Jun 10, 2024

[Snyk] Upgrade firebase from 10.1.0 to 10.12.1 surajit03/accounting#160

Open

aswanthchandran0 mentioned this pull request Jun 11, 2024

[Snyk] Upgrade firebase from 10.12.0 to 10.12.1 aswanthchandran0/User-Management#5

Open

surajit03 mentioned this pull request Jun 11, 2024

[Snyk] Upgrade firebase from 10.1.0 to 10.12.1 surajit03/accounting#162

Open

nejidevelops mentioned this pull request Jun 11, 2024

[Snyk] Upgrade firebase from 10.10.0 to 10.12.1 nejidevelops/kanban-app-tutorial#17

Open

admin-token-bot mentioned this pull request Jun 11, 2024

[Snyk] Upgrade firebase from 10.12.0 to 10.12.1 mongodb/docs-realm#3295

Closed

lydmoon mentioned this pull request Jun 11, 2024

[Snyk] Upgrade firebase from 10.5.2 to 10.12.1 lydmoon/Lydia-MoonFullStackBankingApplication#50

Open

kushalsdesk mentioned this pull request Jun 12, 2024

[Snyk] Upgrade firebase from 10.4.0 to 10.12.1 kushalsdesk/Operax-front#33

Open

sswietoniowski mentioned this pull request Jun 12, 2024

[Snyk] Upgrade firebase from 10.12.0 to 10.12.1 sswietoniowski/learning-html-css-javascript#389

Merged

Abellache-Rabah mentioned this pull request Jun 12, 2024

[Snyk] Upgrade firebase from 10.0.0 to 10.12.1 Abellache-Rabah/backend-hawasli#53

Open

kushalsdesk mentioned this pull request Jun 12, 2024

[Snyk] Upgrade firebase from 10.4.0 to 10.12.1 kushalsdesk/Operax-front#34

Open

DevJPCosta mentioned this pull request Jun 12, 2024

[Snyk] Upgrade firebase from 10.4.0 to 10.12.1 DevJPCosta/EienOtakuv1#17

Open

surajit03 mentioned this pull request Jun 13, 2024

[Snyk] Upgrade firebase from 10.1.0 to 10.12.1 surajit03/accounting#165

Open

kenn7575 mentioned this pull request Jun 13, 2024

[Snyk] Upgrade firebase from 10.12.0 to 10.12.1 kenn7575/kenni-kollemorten-v2#56

Merged

abjerry97 mentioned this pull request Jun 13, 2024

[Snyk] Upgrade firebase from 10.7.2 to 10.12.1 abjerry97/nextjs-app#5

Open

lydmoon mentioned this pull request Jun 13, 2024

[Snyk] Upgrade firebase from 10.5.2 to 10.12.1 lydmoon/Lydia-MoonFullStackBankingApplication#51

Open

jordiverbeek mentioned this pull request Jun 13, 2024

[Snyk] Upgrade firebase from 10.11.0 to 10.12.1 finnjosten/FE-J2-P4#12

Merged

firebase locked and limited conversation to collaborators Jun 15, 2024

Fix setConsent to properly use the update gtag command #8243

Fix setConsent to properly use the update gtag command #8243

Uh oh!

Conversation

DellaBitta commented May 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Discussion

Testing

API Changes

Uh oh!

changeset-bot bot commented May 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented May 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changeset File Check ✅

Uh oh!

google-oss-bot commented May 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

@firebase/analytics

@firebase/firestore

bundle

firebase

Test Logs

Uh oh!

google-oss-bot commented May 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Analysis Report 1

Affected Products

@firebase/analytics

getAnalytics

getGoogleAnalyticsClientId

initializeAnalytics

isSupported

logEvent

setAnalyticsCollectionEnabled

setConsent

setCurrentScreen

setDefaultEventParameters

setUserId

setUserProperties

settings

Test Logs

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix setConsent to properly use the `update` gtag command #8243

Fix setConsent to properly use the `update` gtag command #8243

DellaBitta commented May 13, 2024 •

edited

Loading

changeset-bot bot commented May 13, 2024 •

edited

Loading

github-actions bot commented May 13, 2024 •

edited

Loading

google-oss-bot commented May 13, 2024 •

edited

Loading

Size Report ¹

`@firebase/analytics`

`@firebase/firestore`

`bundle`

`firebase`

google-oss-bot commented May 13, 2024 •

edited

Loading

Size Analysis Report ¹

`@firebase/analytics`

`getAnalytics`

`getGoogleAnalyticsClientId`

`initializeAnalytics`

`isSupported`

`logEvent`

`setAnalyticsCollectionEnabled`

`setConsent`

`setCurrentScreen`

`setDefaultEventParameters`

`setUserId`

`setUserProperties`

`settings`