Update FullStory with current snippet and new API usage #544
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.
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.