Capture page context as early as possible if initialPageview = true#1009
Merged
Capture page context as early as possible if initialPageview = true#1009
initialPageview = true#1009Conversation
🦋 Changeset detectedLatest commit: 58310d6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 |
silesky
changed the title
silesky
force-pushed
the
fix-initial-pageview
branch
from
10e2fb9 to
cd3d1ca
Compare
silesky
changed the title
silesky
changed the title
initialPageview setting is true
silesky
changed the title
initialPageview setting is trueinitialPageview = true
silesky
force-pushed
the
fix-initial-pageview
branch
2 times, most recently
from
b4010c1 to
0649fdf
Compare
oscb
reviewed
Dec 7, 2023
Comment on lines
13
to
17
| export interface InitOptions { | ||
| updateCDNSettings?(cdnSettings: CDNSettings): CDNSettings | ||
| disable?: boolean | ((cdnSettings: CDNSettings) => boolean) | ||
| initialPageview?: boolean | ||
| } |
Contributor
There was a problem hiding this comment.
why is this object completely detached from the interface of the options of the analytics client? shouldn't they be the same?
Contributor
Author
There was a problem hiding this comment.
Here's my original reasoning:
- Owning all our own interface forces us to be explicit about what features of the analytics client we are actually depending on, which helps with mocking / clarity (obviously you could use pick to grab fields -- but like that breaks down when you have say functions with callbacks that are typed. For example, we don't need all of the cdnSettings interface-- just a piece).
- We have both e2e and typedef tests to ensure that the real analytics types do not get out of sync with those defined here (that's why analytics-next is a dev dependency).
- avoiding a hard dependency on analytics-next means users who use the snippet but still build their application with npm don't get the large dependency tree. Also simplifies releasing via changeset (ie, ajs releases won't trigger a consent release by default), possible internal library compilation errors for those with skipLib check false etc. Just simplifies things generally 😄
chrisradek
reviewed
Dec 11, 2023
silesky
force-pushed
the
fix-initial-pageview
branch
from
e31b042 to
58310d6
Compare
chrisradek
reviewed
Jan 3, 2024
|
|
||
| if (options.initialPageview) { | ||
| // capture the page context early, so it's always up-to-date | ||
| preInitBuffer.push(new PreInitMethodCall('page', [])) |
Contributor
There was a problem hiding this comment.
This doesn't store all the page context like the snippet does...does it? My understanding is that this would queue a page call that will be invoked after some async work has been completed (which gives the address of the page time to change)
Contributor
Author
There was a problem hiding this comment.
Yes, it stores the page context at insertion!
Contributor
There was a problem hiding this comment.
Ah right, forgot preInitBuffer isn't a regular array.
chrisradek
approved these changes
Jan 3, 2024
Merged
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
3 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.
Uh oh!
There was an error while loading. Please reload this page.