Release/4.0.0 - #1364
Merged
Merged
Conversation
Matus Tomlein (matus-tomlein)
requested review from
Jack Keene (Jack-Keene),
Greg Leonard (greg-el) and
Jethro Nederhof (jethron)
October 25, 2024 13:48
BundleMonFiles added (6)
Total files change +105.36KB 0% Final result: ✅ View report in BundleMon website ➡️ |
(close #1138)
Add deprecation warning on ecommerce, enhanced ecommerce, consent, optimizely and browser-features packages
* link-click-tracking: event delegation - Global event listeners are now used instead of per-element listeners - `refreshLinkClickTracking` is now deprecated and does nothing as it should no longer be required (but still exists for API compatibility) - There is now a `disableLinkClickTracking` method to balance `enableLinkClickTracking` - `trackLinkClick` can now optionally be passed a link element directly, rather than requiring manual construction of the event payload - Event listeners now use the capture phase instead of bubble - Link URIs are no longer unescaped - Additional unit tests for link click tracking
- Global event listeners are now used instead of per-element listeners - Event listeners now use the capture phase instead of bubble - Forms added after the initial `enableFormTracking` call should automatically be tracked without needing additional calls - Field value transform functions can now return `null` for all events - Add unit tests for form tracking - The new `targets` parameter allows listening for forms in only a subset of the document tree, or across multiple same-origin documents (e.g. iframes)
The `addGlobalContexts` API now accepts an `object` mapping "names" to context primitives or context generators, rather than just an array of "unnamed" global entities/generators. Calling `addGlobalContexts` multiple times with values of the same "name" will overwrite the previous value for subsequent events, allowing "upserting" or updating of global context without having to remove the previous version first and introducing duplicates. `removeGlobalContexts` can now also accept plain strings which are handled as names, so primitives/generators can be removed by name without having to own a reference to the generating function or an object that serializes to the same string.
The `error` event fires on the `window` both when an unhandled JavaScript exception is thrown or a resource fails to load. Rather than track a message presuming the former, attempt to detect the latter and specify the failed resource. See also: - https://developer.mozilla.org/en-US/docs/Web/API/Window/error_event - https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event
…eprecate enhanced ecommerce and performance timing plugins and add web vitals by default (#1345) Removed plugins - browser-features - optimizely - ecommerce - consent Deprecated plugins - enhanced ecommerce - performance timing Added default plugins in sp.js - web vitals (needs configuration to be enabled) Removed default plugins in sp.js - optimizely-x - timezone Other changes - Add an option to enable performance navigation timing
In v3, `discoverRootDomain` was disabled by default, and enabling it meant ignoring the `cookieDomain` configuration. If neither were set, cookies would have no `Domain` attribute attached and would bind to the current domain; cookies with no domain are unique in that they do not get shared to subdomains. In 257ddb3 we updated the `discoverRootDomain` setting to default to enabled, and changed how it interacted with the `cookieDomain` setting so that `discoverRootDomain` is essentially always enabled, but gets ignored if `cookieDomain` is also specified. This however made it impossible to use the 'no domain' behaviour available in v3, because disabling `discoverRootDomain` would have no effect without specifying `cookieDomain` as well. This can be slightly confusing, so instead, this change allows explicitly disabling `discoverRootDomain` even if no `cookieDomain` is specified, allowing the same behaviour as all configurations available in v3.
…1352) In POST requests this usually results in a smaller payload size, and is easier to debug. The node tracker shares this setting across multiple emitters that may not all use POST so we can't make this assumption there.
This changes the default behaviour of the GA Cookies plugin to look for GA4 cookies instead of Universal Analytics cookies. This uses the iglu:com.google.ga4/cookies/jsonschema/1-0-0 schema instead of iglu:com.google.analytics/cookies/jsonschema/1-0-0, so it is a breaking change.
In v4 we switched the Form Tracking (#1329) and Link Click Tracking (#1325) plugins to using capture-phase event listeners instead of bubble-phase. This makes the same change for the Button Click Tracking plugin to make it consistent. This has caused issues for some clients historically, e.g. BCPF-1421 where pages stopping propagation of event bubbling prevented buttons being tracked.
* Support clicks on buttons/links in ShadowDOMs * Detect form events within ShadowRoots
* Migrate to v2 schemas for youtube-tracking plugin See PE-5753. * Run rush change * Remove unneeded license headers * Add return type for buildYouTubeEntity * Change evaluation of paused state * Add (start/end)YouTubeTracking APIs * Always poll and call updateMediaTracking * Fix seek timestamps * Fix YT e2e tests * rush update * Fix build * Make default ping state explicit
…r size if maxPostBytes setting is followed (#1356)
…iled events and output a warning (#1360)
Matus Tomlein (matus-tomlein)
force-pushed
the
release/4.0.0
branch
from
October 28, 2024 10:56
d609987 to
fe2126f
Compare
Greg Leonard (greg-el)
approved these changes
Oct 28, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The release adopts the fetch API for making requests to the Snowplow collector which provides the keepalive option that enables requests to outlive the webpage they were made from.
Performance of the track calls has been improved by making cookie writes async. Our benchmarks show this improves the time it takes to track 100 events to a third of what it was in v3.
The tracker APIs have been significantly improved and simplified:
filterfunction to enable skipping events.Other changes include the YouTube and HTML5 media plugins adopting new media schemas, upgrades to the UUID package, revised defaults, and removal and deprecation of older plugins.
Enhancements
Removed deprecated functionality
Upgraded internals
Other improvements and fixes
newTracker()function within the "@snowplow/browser-tracker" package #1167)