Skip to content

Update FullStory with current snippet and new API usage #544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 29, 2021

Conversation

djwhatley-fs
Copy link
Contributor

What does this PR do?
Updates the FullStory snippet to be in parity with the version currently available in the app. This includes the new setVars API, and implements a new default way of tracking pages using that API.

Are there breaking changes in this PR?
Yes; pages are now tracked via the setVars API by default, which may interrupt some users' custom metrics if they are currently depending on custom events for page tracking. However we have added a new option, trackPagesWithEvents that re-enables this behavior. If the option is enabled, pages will be sent to FullStory as custom events, in addition to the new method using page variables, which is the recommended option. This is mainly to allow customers who are referencing the custom events some time to transition to the new method.

Testing
Testing completed successfully using local Segment test environment. Values were inspected and verified in the browser, and results have been verified in FullStory.

Any background context you want to provide?
This snippet is long overdue for an update, and we had some customers asking for the setVars functionality, so we are doing that in addition to getting the snippet up to date, which is a pretty small change by itself.

Is there parity with the server-side/android/iOS integration components (if applicable)?
N/A

Does this require a new integration setting? If so, please explain how the new setting works
The new setting is described above in the section on breaking changes.

Links to helpful docs and other external resources
The FS.setVars API is not yet publicly documented, but it is available to everyone. The docs will be made available publicly once it is all formally released, but until then you can reference this doc.

@danielstjules
Copy link
Contributor

For this to be a non-breaking change for customers, could we consider making trackPagesWithEvents default to true?

@djwhatley-fs
Copy link
Contributor Author

For this to be a non-breaking change for customers, could we consider making trackPagesWithEvents default to true?

Sure. After discussing with the team we've agreed that this makes sense.

@pooyaj pooyaj self-requested a review April 29, 2021 16:20
@pooyaj pooyaj merged commit e275cba into segmentio:master Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants