[PA-4600] feat(heap): update browser destination code to load heap js v5 script #19
+213
−59
Conversation
This file contains 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
jessi-heap
reviewed
Jan 2, 2025
| await deps.loadScript(`https://${settings.hostname}/config/${settings.appId}/heap_config.js`) | ||
| } catch { | ||
| // fall back to loading from Heap's CDN if self-hosted script is not found | ||
| await deps.loadScript(`https://cdn.us.heap-api.com/config/${settings.appId}/heap_config.js`) |
There was a problem hiding this comment.
For security purposes (as in they are specifically avoiding pulling from our cdn if they are self-hosting), do we actually want to fallback on the cdn?
There was a problem hiding this comment.
Good point. Removed the try/catch with the fallback
jessi-heap
approved these changes
Jan 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Update the Heap browser destination to use v5 of Heap's javascript snippet.
The Problem
Customers are running into issues with TikTok. We've seen that TT browser web views will strip duplicate key/value pairs on
GETrequests as an "optimization". Our request schema uses an arbitrary key for custom properties. For example, we'll have the query params:k=name1&k=false&k=name2&k=false&k=name3&k=true, but because of the way TT "optimizes", it will intercept the request before firing off and remove any duplicate query param values, leading to the request being fired having:k=name1&k=false&k=name2&k=name3&k=true, which ends up causing mismatched k/v pairing on the custom properties when we parse the request on the server-side.The Solution
By upgrading to v5, we replace GET requests with POST so this fixes the issue.
Visuals
Segment dev center actions tester network tab
Hjsv5 being loaded and sending POST requests:
Heap live event view
Testing
Include any additional information about the testing you have completed to
ensure your changes behave as expected. For a speedy review, please check
any of the tasks you completed below during your testing.