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

chore: add event name in breadcrumb #1912

Merged
merged 4 commits into from
Nov 8, 2024

Conversation

MoumitaM
Copy link
Contributor

@MoumitaM MoumitaM commented Nov 8, 2024

PR Description

Add event name in the breadcrumb

Linear task (optional)

Linear task link

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

    • Enhanced error logging in the Analytics tracking method to include event names for improved debugging.
  • Chores

    • Updated size limits for specific builds in the analytics configuration, ensuring better performance tracking.

@MoumitaM MoumitaM requested a review from a team as a code owner November 8, 2024 07:18
Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the size limits in the configuration file packages/analytics-js/.size-limit.mjs, specifically adjusting the limits for two entries: increasing the limit for "Core (Bundled) - Modern - NPM (UMD)" from 39.5 KiB to 40 KiB, and updating "Core (Content Script) - Modern - NPM (ESM)" from 39 KiB to 39.5 KiB. Additionally, the track method in the Analytics class within packages/analytics-js/src/components/core/Analytics.ts has been updated to enhance error logging by including the payload.name in the breadcrumb message.

Changes

File Path Change Summary
packages/analytics-js/.size-limit.mjs Updated size limits: "Core (Bundled) - Modern - NPM (UMD)" from 39.5 KiB to 40 KiB; "Core (Content Script) - Modern - NPM (ESM)" from 39 KiB to 39.5 KiB.
packages/analytics-js/src/components/core/Analytics.ts Modified the track method to enhance error logging by including payload.name in the breadcrumb message.

Possibly related PRs

  • feat: track time spent on a page #1876: The changes in this PR also modify the size limits in packages/analytics-js/.size-limit.mjs, specifically updating limits for several entries, including those related to Core (Bundled) - Modern - NPM (CJS) and Core (Content Script) - Modern - NPM (ESM), which are directly relevant to the size limit adjustments made in the main PR.

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

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.69%. Comparing base (9fbaf81) to head (72e1df5).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1912   +/-   ##
========================================
  Coverage    57.69%   57.69%           
========================================
  Files          485      485           
  Lines        16569    16569           
  Branches      3335     3325   -10     
========================================
  Hits          9560     9560           
- Misses        5712     5740   +28     
+ Partials      1297     1269   -28     

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

saikumarrs
saikumarrs previously approved these changes Nov 8, 2024
coderabbitai[bot]
coderabbitai bot previously approved these changes Nov 8, 2024
Copy link

github-actions bot commented Nov 8, 2024

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.49 KB 15.49 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.45 KB 1.45 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.65 KB 1.65 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.43 KB 1.43 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.11 KB 1.11 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.34 KB 1.34 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.08 KB 1.08 KB (0%) 1.5 KB
Load Snippet 757 B 757 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.33 KB 30.33 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.57 KB 30.57 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.36 KB 30.36 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.9 KB 29.9 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 30.1 KB 30.1 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.56 KB 48.54 KB (-0.04% ▼) 49 KB
Core - Modern - CDN 24.87 KB 24.9 KB (+0.13% ▲) 25 KB
Core - Legacy - NPM (ESM) 48.39 KB 48.4 KB (+0.04% ▲) 48.5 KB
Core - Legacy - NPM (CJS) 48.63 KB 48.6 KB (-0.07% ▼) 49 KB
Core - Legacy - NPM (UMD) 48.37 KB 48.38 KB (+0.02% ▲) 48.5 KB
Core - Modern - NPM (ESM) 24.69 KB 24.65 KB (-0.14% ▼) 25 KB
Core - Modern - NPM (CJS) 24.84 KB 24.87 KB (+0.12% ▲) 25 KB
Core - Modern - NPM (UMD) 24.66 KB 24.7 KB (+0.17% ▲) 25 KB
Core (Bundled) - Legacy - NPM (ESM) 48.39 KB 48.4 KB (+0.04% ▲) 48.5 KB
Core (Bundled) - Legacy - NPM (CJS) 48.65 KB 48.66 KB (+0.03% ▲) 49 KB
Core (Bundled) - Legacy - NPM (UMD) 48.37 KB 48.38 KB (+0.02% ▲) 48.5 KB
Core (Bundled) - Modern - NPM (ESM) 39.48 KB 39.46 KB (-0.06% ▼) 39.5 KB
Core (Bundled) - Modern - NPM (CJS) 39.66 KB 39.78 KB (+0.31% ▲) 40 KB
Core (Bundled) - Modern - NPM (UMD) 39.52 KB 39.51 KB (-0.02% ▼) 40 KB
Core (Content Script) - Legacy - NPM (ESM) 47.84 KB 47.86 KB (+0.05% ▲) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 48.09 KB 48.07 KB (-0.05% ▼) 48.5 KB
Core (Content Script) - Legacy - NPM (UMD) 47.85 KB 47.88 KB (+0.07% ▲) 48 KB
Core (Content Script) - Modern - NPM (ESM) 38.95 KB 39 KB (+0.14% ▲) 39.5 KB
Core (Content Script) - Modern - NPM (CJS) 39.23 KB 39.16 KB (-0.2% ▼) 40 KB
Core (Content Script) - Modern - NPM (UMD) 38.9 KB 38.89 KB (-0.02% ▼) 39 KB
Service Worker - Legacy - NPM (ESM) 30.6 KB 30.6 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.9 KB 30.9 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.63 KB 30.63 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.75 KB 25.75 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26 KB 26 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.79 KB 25.79 KB (0%) 26 KB
All Integrations - Legacy - CDN 94.83 KB 94.83 KB (0%) 95.3 KB
All Integrations - Modern - CDN 89.92 KB 89.92 KB (0%) 91 KB

Copy link

sonarcloud bot commented Nov 8, 2024

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9fbaf81 and 72e1df5.

📒 Files selected for processing (2)
  • packages/analytics-js/.size-limit.mjs (2 hunks)
  • packages/analytics-js/src/components/core/Analytics.ts (1 hunks)
🔇 Additional comments (2)
packages/analytics-js/.size-limit.mjs (1)

110-110: Verify size limit increase with CODEOWNERS

The size limit for "Core (Content Script) - Modern - NPM (ESM)" has been increased by 0.5 KiB. While this increase aligns with the enhanced error logging changes, CODEOWNER approval is required as per the file header.

packages/analytics-js/src/components/core/Analytics.ts (1)

537-537: LGTM! Enhanced breadcrumb logging.

The addition of the event name in the breadcrumb message improves debugging capabilities while maintaining consistency with other event logging patterns in the codebase.

packages/analytics-js/.size-limit.mjs Show resolved Hide resolved
@MoumitaM MoumitaM merged commit 3f877ee into develop Nov 8, 2024
13 checks passed
@MoumitaM MoumitaM deleted the feat/SDK-2592-add-event-name-in-breadcrumb branch November 8, 2024 09:27
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.

2 participants