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

feat: move error reporting functionality to the core module #2011

Merged
merged 9 commits into from
Jan 24, 2025

Conversation

saikumarrs
Copy link
Member

PR Description

I've moved the error reporting functionality to the core SDK and deleted the ErrorReporting and Bugsnag plugins.
The SDK can report errors as soon as it loads and don't have to wait for plugins to finish loading.

Now, there are no parts in the SDK that throw errors left to be handled by the global exception handlers.

Additional updates:

  • The payload we send to Bugsnag has been enriched:
    • The payload version is correctly positioned.
    • SDK installation type and snippet version are set in the app object.
    • Screen and timezone fields are added in the device object.
    • Source name is added in the user object.
  • HTTPClient instance is created by the core and passed to all the needed modules.
  • The error handler and logger instances are no longer optional in various SDK modules.
  • User provided callback execution errors are no longer reported as they are purely instrumentation issues.
    • Additional some more instrumentation errors are suppressed.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2826/move-error-reporting-functionality-to-the-core-sdk

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.

* feat: delete error reporting plugins and deprecate them

* refactor: pluginsmanager test suite
* feat: delete error reporting plugins and deprecate them

* chore: add bugsnag dev dependency

* feat: implement error reporting in core

* chore: use bugsnag types

* fix: resolve circular dependency in httpclient

* refactor: remove unused compare function

* fix: stackframe types
* feat: improve user callback execution

* fix: error message for callback parameter validation
* feat: improve user callback execution

* feat: make error handler and logger mandatory in all components
@saikumarrs saikumarrs self-assigned this Jan 21, 2025
@saikumarrs saikumarrs requested a review from a team as a code owner January 21, 2025 07:52
Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

31 files out of 113 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 Jan 21, 2025

Codecov Report

Attention: Patch coverage is 98.15385% with 6 lines in your changes missing coverage. Please review.

Project coverage is 61.29%. Comparing base (dc7062a) to head (80b2215).
Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
...tics-js-plugins/src/iubendaConsentManager/utils.ts 0.00% 0 Missing and 2 partials ⚠️
...lytics-js-plugins/src/ketchConsentManager/utils.ts 0.00% 0 Missing and 2 partials ⚠️
...ponents/capabilitiesManager/CapabilitiesManager.ts 85.71% 1 Missing ⚠️
...omponents/userSessionManager/UserSessionManager.ts 83.33% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2011      +/-   ##
===========================================
- Coverage    61.30%   61.29%   -0.02%     
===========================================
  Files          484      478       -6     
  Lines        16626    16394     -232     
  Branches      3340     3257      -83     
===========================================
- Hits         10192    10048     -144     
+ Misses        5213     5113     -100     
- Partials      1221     1233      +12     

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

Copy link

github-actions bot commented Jan 21, 2025

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
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.54 KB 1.54 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
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.75 KB 13.66 KB (-13.25% ▼) 14 KB
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Modern - CDN 7.2 KB 5.64 KB (-21.76% ▼) 6 KB
Common - No bundling 17.8 KB 17.8 KB (0%) 18.4 KB
Load Snippet 762 B 762 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.25 KB 30.25 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.47 KB 30.47 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.29 KB 30.29 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.81 KB 29.81 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 29.97 KB 29.97 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.81 KB 29.81 KB (0%) 30 KB
Core - Legacy - CDN 48.99 KB 47.28 KB (-3.48% ▼) 47.5 KB
Core - Modern - CDN 24.98 KB 26.92 KB (+7.76% ▲) 27.5 KB
Service Worker - Legacy - NPM (ESM) 30.62 KB 30.62 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.85 KB 30.85 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.58 KB 30.58 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.71 KB 25.71 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26 KB 26 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.75 KB 25.75 KB (0%) 26 KB
Core - Legacy - NPM (ESM) 48.79 KB 47.18 KB (-3.3% ▼) 48 KB
Core - Legacy - NPM (CJS) 49.05 KB 47.47 KB (-3.23% ▼) 48 KB
Core - Legacy - NPM (UMD) 48.84 KB 47.21 KB (-3.35% ▼) 48 KB
Core - Modern - NPM (ESM) 24.76 KB 26.71 KB (+7.87% ▲) 27 KB
Core - Modern - NPM (CJS) 24.96 KB 26.92 KB (+7.87% ▲) 27 KB
Core - Modern - NPM (UMD) 24.75 KB 26.72 KB (+7.96% ▲) 27 KB
Core (Bundled) - Legacy - NPM (ESM) 48.79 KB 47.18 KB (-3.3% ▼) 48 KB
Core (Bundled) - Legacy - NPM (CJS) 49.11 KB 47.44 KB (-3.4% ▼) 48 KB
Core (Bundled) - Legacy - NPM (UMD) 48.84 KB 47.21 KB (-3.35% ▼) 48 KB
Core (Bundled) - Modern - NPM (ESM) 39.77 KB 38.41 KB (-3.42% ▼) 39 KB
Core (Bundled) - Modern - NPM (CJS) 39.98 KB 38.64 KB (-3.36% ▼) 39 KB
Core (Bundled) - Modern - NPM (UMD) 39.82 KB 38.37 KB (-3.64% ▼) 39 KB
Core (Content Script) - Legacy - NPM (ESM) 48.29 KB 47.17 KB (-2.34% ▼) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 48.52 KB 47.39 KB (-2.34% ▼) 48 KB
Core (Content Script) - Legacy - NPM (UMD) 48.25 KB 47.17 KB (-2.24% ▼) 48 KB
Core (Content Script) - Modern - NPM (ESM) 39.27 KB 38.36 KB (-2.33% ▼) 39 KB
Core (Content Script) - Modern - NPM (CJS) 39.5 KB 38.61 KB (-2.24% ▼) 39 KB
Core (Content Script) - Modern - NPM (UMD) 39.22 KB 38.36 KB (-2.21% ▼) 39 KB
All Integrations - Legacy - CDN 94.93 KB 94.93 KB (0%) 95.3 KB
All Integrations - Modern - CDN 90.38 KB 90.38 KB (0%) 91 KB
Core (v1.1) - Legacy - CDN 0 B 32.2 KB (+100% ▲) 32.5 KB
Core (v1.1) - Modern - CDN 0 B 30.19 KB (+100% ▲) 32 KB

@saikumarrs saikumarrs merged commit 78c50c7 into develop Jan 24, 2025
12 checks passed
@saikumarrs saikumarrs deleted the feat.move-error-reporting-to-core-sdk-2826-new branch January 24, 2025 07:41
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