firebase-js-sdk icon indicating copy to clipboard operation
firebase-js-sdk copied to clipboard

Analytics Consent not sent on update

Open megamisan opened this issue 9 months ago • 2 comments

Operating System

Windows 11 23H2

Browser Version

Edge 124.0.2478.51

Firebase SDK Version

10.11.0

Firebase SDK Product:

Analytics, AppCheck, Auth, Firestore, Functions, Storage

Describe your project's tooling

Vue.js app.

Describe the problem

I'm trying to get analytics to work with consent banner and sending advanced consent information with the setConsent method.

Steps and code to reproduce issue

In the projet, initialize Firebase first. I consider app to be a constant containing the firebase application instance in the following snippet:

import { setAnalyticsCollectionEnabled, setConsent } from 'firebase/analytics'

const analytics = app.analytics()
// Add some delay to wait for gtag loading
setTimeout(() => {
  console.log('Called')
  setAnalyticsCollectionEnabled(this._analytics, consent)
  setConsent({
    ad_personalization: 'denied',
    ad_storage: 'denied',
    ad_user_data: 'denied',
    analytics_storage: 'granted',
    functionality_storage: 'granted',
    personalization_storage: 'denied',
    security_storage: 'granted',
  })}, 5000)

Using Tag Assitant, I can see the tag events. However, I get this result: image

The granted value is missing and there is strange numbered items.

Doing a some step-by-step debugging, I found the call to gtag. The third parameter which should be the ConsentSettings (see Set up consent mode on websites is set to the second parameter update instead of the third. Debug screenshot

The setConsent method code is here packages/analytics/src/api.ts#L768. It trigger the call to the gtagWrapper function with this line:

wrappedGtagFunction(GtagCommand.CONSENT, 'update', consentSettings);

The wrappedGtagFunction is an instance of the gtagWrapper function found in packages/analytics/src/helpers.ts#L279.

When the method is called before initialization of gtag, the call is made correctly. setContent sends the settings to _setConsentDefaultForInit and the packages/analytics/src/initialize-analytics.t:_initializeAnalyticss#L129 function use these settings correctly.

I see two possible fixes:

  • Removing the 'update' parameter in setConsent, thus the diff:
    @@ -766,5 +766,5 @@
      // Check if reference to existing gtag function on window object exists
      if (wrappedGtagFunction) {
    -    wrappedGtagFunction(GtagCommand.CONSENT, 'update', consentSettings);
    +    wrappedGtagFunction(GtagCommand.CONSENT, consentSettings);
      } else {
        _setConsentDefaultForInit(consentSettings);
    
  • Retrieves the second argument from the args array.

I recommend the first option.

Original commits:

megamisan avatar Apr 27 '24 18:04 megamisan

I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.

google-oss-bot avatar Apr 27 '24 18:04 google-oss-bot

@megamisan, thanks for reaching out to us. I was able to replicate the behavior you've mentioned. Also, thanks for sending a PR for a possible fix. I'll raise this to our engineering team or bring someone here that can provide more context about it. I’ll update this thread if I have any information to share.

jbalidiong avatar May 01 '24 11:05 jbalidiong

Can confirm the same issue on our site: image

vytautas-vitkus-tg avatar May 14 '24 16:05 vytautas-vitkus-tg

This fix should be in our next release. If you find that there's still an issue, or a new one, then please open a new support issue and feel free to link to this issue for context. Thanks!

DellaBitta avatar May 15 '24 18:05 DellaBitta