Skip to content
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

fix: microsoft clarity identify error handling #1948

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

sanpj2292
Copy link
Contributor

@sanpj2292 sanpj2292 commented Nov 25, 2024

PR Description

Adding error handling for microsoft clarity destination

Linear task (optional)

Resolves INT-2937

Cross Browser Tests

Please confirm you have tested for the following browsers:

  • Chrome
  • Firefox
  • IE11

Sanity Suite

  • All sanity suite test cases pass locally

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

  • New Features

    • Improved error handling for user identification in Microsoft Clarity integration.
    • Asynchronous processing for the identification method enhances performance and reliability.
  • Bug Fixes

    • Enhanced logging for identification failures to provide better feedback.

@sanpj2292 sanpj2292 requested a review from a team as a code owner November 25, 2024 11:13
Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request modify the identify method of the MicrosoftClarity class in the browser.js file. The identify method's invocation of window.clarity('identify', ...) has been updated from a synchronous to a promise-based approach. This allows for better error handling through the use of .then() and .catch(), where successful calls proceed to set user traits, and failures are logged for debugging.

Changes

File Path Change Summary
packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js Modified the identify method to use promise-based handling for window.clarity('identify', ...) and added error logging.

Suggested reviewers

  • saikumarrs

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)
packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js (1)

58-68: Consider race conditions in concurrent identify calls

The current implementation might lead to race conditions if multiple identify calls are made in quick succession, as trait setting operations could get interleaved.

Consider implementing a queue mechanism or adding a lock to ensure sequential processing of identify calls. Would you like me to provide an example implementation?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 134d779 and 4e02266.

📒 Files selected for processing (1)
  • packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js (1 hunks)
🔇 Additional comments (1)
packages/analytics-js-integrations/src/integrations/MicrosoftClarity/browser.js (1)

58-68: Verify Microsoft Clarity SDK's promise support

The code assumes that window.clarity('identify', ...) returns a Promise, but this should be verified with Microsoft Clarity's documentation.

Copy link

codecov bot commented Nov 25, 2024

Codecov Report

Attention: Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.

Project coverage is 58.29%. Comparing base (134d779) to head (4e02266).
Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
...tions/src/integrations/MicrosoftClarity/browser.js 0.00% 6 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1948      +/-   ##
===========================================
- Coverage    58.30%   58.29%   -0.01%     
===========================================
  Files          485      485              
  Lines        16614    16615       +1     
  Branches      3351     3349       -2     
===========================================
  Hits          9686     9686              
- Misses        5683     5702      +19     
+ Partials      1245     1227      -18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

sonarcloud bot commented Nov 25, 2024

@koladilip
Copy link
Contributor

Basically we need to set traits call after the identify call, right?

@sanpj2292
Copy link
Contributor Author

sanpj2292 commented Nov 25, 2024

Basically we need to set traits call after the identify call, right?

Yes. The previous code was written that way, we are sticking with that approach

Copy link

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.69 KB 15.69 KB (0%) 16 KB
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Modern - CDN 7.2 KB 7.2 KB (0%) 7.5 KB
Common - No bundling 16.27 KB 16.27 KB (0%) 16.5 KB
Cookies Utils - Legacy - NPM (ESM) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.75 KB 1.75 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.53 KB 1.53 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.17 KB 1.17 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.4 KB 1.4 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.16 KB 1.16 KB (0%) 1.5 KB
Load Snippet 758 B 758 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.38 KB 30.38 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.53 KB 30.53 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.34 KB 30.34 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.88 KB 29.88 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 30.09 KB 30.09 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.92 KB 29.92 KB (0%) 30 KB
Core - Legacy - CDN 48.78 KB 48.78 KB (0%) 49 KB
Core - Modern - CDN 25.01 KB 25.01 KB (0%) 25.5 KB
Core - Legacy - NPM (ESM) 48.65 KB 48.65 KB (0%) 49 KB
Core - Legacy - NPM (CJS) 48.95 KB 48.95 KB (0%) 49 KB
Core - Legacy - NPM (UMD) 48.69 KB 48.69 KB (0%) 49 KB
Core - Modern - NPM (ESM) 24.75 KB 24.75 KB (0%) 25 KB
Core - Modern - NPM (CJS) 24.96 KB 24.96 KB (0%) 25.5 KB
Core - Modern - NPM (UMD) 24.81 KB 24.81 KB (0%) 25 KB
Core (Bundled) - Legacy - NPM (ESM) 48.65 KB 48.65 KB (0%) 49 KB
Core (Bundled) - Legacy - NPM (CJS) 48.93 KB 48.93 KB (0%) 49 KB
Core (Bundled) - Legacy - NPM (UMD) 48.69 KB 48.69 KB (0%) 49 KB
Core (Bundled) - Modern - NPM (ESM) 39.75 KB 39.75 KB (0%) 40 KB
Core (Bundled) - Modern - NPM (CJS) 39.93 KB 39.93 KB (0%) 40.5 KB
Core (Bundled) - Modern - NPM (UMD) 39.74 KB 39.74 KB (0%) 40 KB
Core (Content Script) - Legacy - NPM (ESM) 48.13 KB 48.13 KB (0%) 48.5 KB
Core (Content Script) - Legacy - NPM (CJS) 48.38 KB 48.38 KB (0%) 48.5 KB
Core (Content Script) - Legacy - NPM (UMD) 48.14 KB 48.14 KB (0%) 48.5 KB
Core (Content Script) - Modern - NPM (ESM) 39.19 KB 39.19 KB (0%) 39.5 KB
Core (Content Script) - Modern - NPM (CJS) 39.44 KB 39.44 KB (0%) 40 KB
Core (Content Script) - Modern - NPM (UMD) 39.2 KB 39.2 KB (0%) 39.5 KB
Service Worker - Legacy - NPM (ESM) 30.61 KB 30.61 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.85 KB 30.85 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.65 KB 30.65 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.77 KB 25.77 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26.03 KB 26.03 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.74 KB 25.74 KB (0%) 26 KB
All Integrations - Legacy - CDN 95.06 KB 95.15 KB (+0.1% ▲) 95.3 KB
All Integrations - Modern - CDN 90.32 KB 90.48 KB (+0.18% ▲) 91 KB

@sanpj2292 sanpj2292 self-assigned this Nov 25, 2024
@sanpj2292 sanpj2292 merged commit 33ac767 into develop Nov 27, 2024
13 checks passed
@sanpj2292 sanpj2292 deleted the fix.ms-clarity-err-handling branch November 27, 2024 05:12
sanpj2292 added a commit that referenced this pull request Dec 9, 2024
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