fix: microsoft clarity load and handle promise for identify #1964
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
📝 Walkthrough📝 WalkthroughWalkthroughThe changes in this pull request focus on the Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js (1)
58-68: Consider propagating the Promise rejectionThe Promise handling looks good overall - it ensures traits are set only after successful identification and includes error logging. However, the error is caught and logged but not propagated, which might hide issues from the application.
Consider propagating the error:
- window.clarity('identify', userId, sessionId, customPageId).then(() => { - if (context?.traits) { - const { traits } = context; - const keys = Object.keys(traits); - keys.forEach(key => { - window.clarity('set', key, traits[key]); - }); - } - }).catch(error => { - logger.error('[MicrosoftClarity] Error in identify call', error); - }); + return window.clarity('identify', userId, sessionId, customPageId) + .then(() => { + if (context?.traits) { + const { traits } = context; + const keys = Object.keys(traits); + keys.forEach(key => { + window.clarity('set', key, traits[key]); + }); + } + }) + .catch(error => { + logger.error('[MicrosoftClarity] Error in identify call', error); + throw error; // Propagate the error + });The trait handling implementation aligns with the previous learnings that validation/sanitization isn't required and
clarity('set')doesn't return a Promise.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js(2 hunks)
🧰 Additional context used
📓 Learnings (1)
packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js (2)
Learnt from: sanpj2292
PR: rudderlabs/rudder-sdk-js#1948
File: packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js:59-65
Timestamp: 2024-11-25T11:33:39.706Z
Learning: In the Microsoft Clarity integration (`packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js`), adding validation or sanitization of trait values before sending them to Microsoft Clarity's SDK is not required at this time.
Learnt from: sanpj2292
PR: rudderlabs/rudder-sdk-js#1948
File: packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js:58-68
Timestamp: 2024-11-25T11:21:01.798Z
Learning: In the MicrosoftClarity integration (`packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js`), the `window.clarity('set', key, value)` method does not return a Promise and does not require error handling.
🔇 Additional comments (1)
packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js (1)
36-36:
Reconsider the SDK loading check implementation
The current implementation calls clarity('identify') to verify SDK loading, which could have unintended consequences:
- It might trigger unnecessary identify events
- It's inefficient as this check may be called frequently
- It could interfere with actual identify calls
Consider this alternative implementation that checks for the function's existence without calling it:
- return !!window.clarity && window.clarity('identify') instanceof Promise;
+ return typeof window.clarity === 'function';Let's verify if clarity is always a function when loaded:
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1964 +/- ##
===========================================
- Coverage 61.89% 61.88% -0.01%
===========================================
Files 484 484
Lines 16610 16611 +1
Branches 3351 3337 -14
===========================================
Hits 10280 10280
- Misses 5083 5113 +30
+ Partials 1247 1218 -29 ☔ View full report in Codecov by Sentry. |
size-limit report 📦
|
|
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.
PR Description
Microsoft Clarity destination in Rudderstack only supports
identifyevent & when we try to sendidentifyevent to Clarity would return a PromiseBut while SDK is upgrading/loading, seems like the current logic of validating if the SDK has been loaded is not complete & caused unhandled exceptions(here)
Through this PR, we are planning to fix the issue
Linear task (optional)
Resolves INT-2937
Cross Browser Tests
Please confirm you have tested for the following browsers:
Sanity Suite
Security
Summary by CodeRabbit
New Features
Bug Fixes