change: [M3-9159] - Enable Pendo based on OneTrust cookie consent #11564
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
mjac0bs
added
the
Analytics
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
mjac0bs
force-pushed
the
M3-9159-pendo-one-trust
branch
from
d64b33d to
0222cae
Compare
This comment was marked as off-topic.
This comment was marked as off-topic.
mjac0bs
requested review from
bnussman-akamai and
coliu-akamai
and removed request for
a team
|
Coverage Report: ✅ |
coliu-akamai
approved these changes
Jan 27, 2025
There was a problem hiding this comment.
ty for the instructions to test - super helpful!
✅ performance cookies disabled - confirmed pendo has not loaded (all three methods ✅)
✅ performance cookies enabled - confirmed pendo has loaded (all three methods ✅)
✅ yarn test analytics/utils
some optional nitpicks below
coliu-akamai
added
Add'tl Approval Needed
bnussman-akamai
approved these changes
Jan 27, 2025
bnussman-akamai
added
Approved
Cloud Manager UI test results🎉 482 passing tests on test run #7 ↗︎
|
Cloud Manager E2E
|
||||||||||||||||||||||||||||
| Project |
Cloud Manager E2E
|
| Branch Review |
develop
|
| Run status |
|
| Run duration | 30m 09s |
| Commit |
|
| Committer | Mariah Jacobs |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
4
|
Pending
|
2
|
Skipped
|
0
|
Passing
|
488
|
| View all changes introduced in this branch ↗︎ | |
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.
Description 📝
This PR enables the Pendo analytics script based on the OneTrust cookie consent granted by the user in their cookie preferences. If users disable performance cookies, the Pendo script will not load.
Once we release this change to production, we should be able to change a setting in our Pendo app subscription that has disabled cookies and client side storage use. The Login team needs cookies enabled on our subscription to allow for journey tracking between the anonymous users on Login and Cloud Manager's users.
Note
Confirming one thing with MADS about OneTrust and default opt-ins vs. opt-outs by geolocation (to make sure I don't have to handle anything else here) before I merge.
✅ Confirmed: For non GDPR countries, the user is opted in via OneTrust unless they choose to opt out. For GDPR, they get the option to choose in OneTrust and have to opt in as first time visitor.
Changes 🔄
usePendo.jshook to check for consent enablement before loading the scriptgetCookie,checkOptanonConsent) to handle this inanalytics/utils.tsanalytics/utils.test.tsTarget release date 🗓️
2/11/25
How to test 🧪
Verification steps
(How to verify changes)
Check out this PR and go to http://localhost:3000
Log out of whatever account you're in. At login.linode.com, select Cookie Preferences at the bottom of the screen
Disable the Performance Cookies setting by toggling it off
In your code editor, go to L80 of
usePendo.jsand change the condition forconst hasConsentEnabled = APP_ROOT.includes('localhost')to add a!. In this PR, we want to confirm that the OneTrust cookie works locally, but normally we don't want to have to do these steps to enable Pendo for local development.Open the browser dev tools and go to Application > Cookies and view the table of cookies
Find the
OptanonConsentcookie and copy its value to your clipboard. Be sure to uncheck theShow URL decodedoptionAdd a new OptanonConsent cookie for localhost for testing purposes. We can't read cookies with a different domain with
document.cookie. To add a new cookie, click an empty cell at the bottom of the table. Name itOptanonConsentand copy the value from the linode.com cookie into the localhostOptanonConsentcookie.If you want to confirm that OptanonConsent is now being returned in
document.cookie, use the browser console to log the value fordocument.cookie.Refresh the page and confirm that Pendo has respected your cookie setting and NOT loaded, which you can do via any of the following:
<head>tag (it's the script withcontent.psp.cloud.linode.com)psp.and confirm there are no requestspendo.validateEnvironment()and confirm the command failsRepeat the steps above, but with an Enabled Performance Cookie setting to confirm Pendo is loaded and sending data
OptanonConsentcookie value so thatC0002%3A0isC0002%3A1. C0002 is the 'Performance Cookie' group; 0 is disabled, 1 is enabledEnsure tests pass:
Author Checklists
As an Author, to speed up the review process, I considered 🤔
👀 Doing a self review
❔ Our contribution guidelines
🤏 Splitting feature into small PRs
➕ Adding a changeset
🧪 Providing/improving test coverage
🔐 Removing all sensitive information from the code and PR description
🚩 Using a feature flag to protect the release
👣 Providing comprehensive reproduction steps
📑 Providing or updating our documentation
🕛 Scheduling a pair reviewing session
📱 Providing mobile support
♿ Providing accessibility support
As an Author, before moving this PR from Draft to Open, I confirmed ✅