feat(cdp): allow disabling site destinations

[MarconLP]

Changes

• Only load site_destination's if isOptedOut is false
• site destinations will be loaded if .opt_in_capturing() is being called at a later point.
• Updated the nextjs example to call opt_in_capturing & opt_out_capturing based on the cookie banner (link)

TODOs:

• add tests

Checklist

• Tests for new code (see advice on the tests we use)
• Accounted for the impact of any changes across different browsers
• Accounted for backwards compatibility of any changes (no breaking changes in posthog-js!)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
posthog-js	✅ Ready (Inspect)	Visit Preview	Dec 5, 2024 11:26pm

[github-actions]

Size Change: +3.99 kB (+0.13%)

Total Size: 3.19 MB

Filename	Size	Change
dist/array.full.es5.js	258 kB	+418 B (+0.16%)
dist/array.full.js	361 kB	+398 B (+0.11%)
dist/array.full.no-external.js	360 kB	+398 B (+0.11%)
dist/array.js	176 kB	+396 B (+0.23%)
dist/array.no-external.js	175 kB	+396 B (+0.23%)
dist/main.js	176 kB	+396 B (+0.22%)
dist/module.full.js	362 kB	+398 B (+0.11%)
dist/module.full.no-external.js	361 kB	+398 B (+0.11%)
dist/module.js	176 kB	+396 B (+0.23%)
dist/module.no-external.js	175 kB	+396 B (+0.23%)

ℹ️ View Unchanged

Filename	Size
dist/all-external-dependencies.js	206 kB
dist/customizations.full.js	12.5 kB
dist/dead-clicks-autocapture.js	14.3 kB
dist/exception-autocapture.js	9.37 kB
dist/external-scripts-loader.js	2.29 kB
dist/recorder-v2.js	115 kB
dist/recorder.js	115 kB
dist/surveys-preview.js	57.6 kB
dist/surveys.js	63.2 kB
dist/tracing-headers.js	1.75 kB
dist/web-vitals.js	10.3 kB

_{compressed-size-action}

[mariusandra]

The variable _decideServerResponse makes me think this contains the whole response, not just the siteApps key

[MarconLP]

renamed to "_decideServerSiteAppsResponse"

[mariusandra]

So... I finally had a look, and I think we're most of the way there.

One more thing: there's a chance if you don't opt in, that the event collector will collect forever. Is there ever a "definitely opted out" event to hook into, which would stop it?

[MarconLP]

One more thing: there's a chance if you don't opt in, that the event collector will collect forever. Is there ever a "definitely opted out" event to hook into, which would stop it?

That is not a thing. It's either user is opted in/out by default and consent has been toggled.

Currently, we'll clear the missedInvocations queue after we've loaded all of the site_app's and set loaded to true (this will include cases where consent wasn't given and site_destination's haven't been loaded yet), which will disable the eventCollector.

We could reuse the missedInvocations queue to only clear after all site_destination's have been loaded and consentIsGiven, since it's already configured to only hold 1000 events at a time?

if (this.missedInvocations.length > 1000) {
    this.missedInvocations = this.missedInvocations.slice(10)
}

[mariusandra]

Wait... so what happens if:

• User clicks on an ad and lands on a site
• Waits 30seconds before clicking "agree to cookies and stuff" (all JS loads within the first 5sec)
• what happens now?

They way I understand the last comment, is that they won't count as a converted user (we drop all events captured, as when site apps finished loading, we didn't have consent yet). Is that how it works, or did I misunderstand something again? If that is how it works though, it's definitely far from ideal and needs fixing.

[benjackwhite]

Sorry to be a pain but I will really want to get this in first

[MarconLP]

I updated the code to save initial campaign/referrer props parameters to this.storage.

1. persistence: 'memory' & isOptedOut: true
2. User visits posthog.com?gclid=ad_click_1
   • We won't capture a $pageview event, but we'll store gclid: 'ad_click_1' in memory
3. User visits the pricing page
   • URL changes to posthog.com/pricing
4. User accepts the cookie banner (posthog.opt_in_capturing() & posthog.set_config({ persistence: 'localStorage+cookie' }))
   • We'll send an initial $pageview event and since the gclid is stored in this.storage we'll append that as an event property. Will also be included as an $initial_ person property.
5. User visits the signup page - we capture a $pageview event
   • This event will be captured normally

If the user reloads the page between step 2 - 4 we'll lose the gclid property.

[posthog-bot]

This PR hasn't seen activity in a week! Should it be merged, closed, or further worked on? If you want to keep it open, post a comment or remove the stale label – otherwise this will be closed in another week.

[benjackwhite]

This likely needs a rebase on top of the current changes

[MarconLP]

closing in favor of #1619