search

rudderlabs / rudder-sdk-js

JavaScript SDK for RudderStack - the Customer Data Platform for Developers.
https://www.rudderstack.com
Other
141 stars 82 forks source link

chore: unit test cases for error reporting plugin #1813

Closed MoumitaM closed 1 month ago

MoumitaM commented 1 month ago

PR Description

Linear task (optional)

Linear task link

Cross Browser Tests

Please confirm you have tested for the following browsers:

Sanity Suite

Security

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The recent changes enhance the error reporting functionality within the `ErrorReporting` plugin by refining the control flow and expanding test coverage. Key updates include improved initialization checks to ensure the plugin activates appropriately, nuanced error notification logic that distinguishes between available resources, and enhanced breadcrumb handling. These modifications ensure the plugin operates correctly across various scenarios, leading to more robust error reporting. ## Changes | File Path | Change Summary | |------------------------------------------------|-----------------------------------------------------------------------------------------------------| | `packages/analytics-js-plugins/__tests__/errorReporting/index.test.ts` | Updated test cases for the `ErrorReporting` plugin to improve initialization checks, refine error notification logic, and enhance breadcrumb handling. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Client participant ErrorReportingPlugin participant MetricsService Client->>ErrorReportingPlugin: Initialize with sourceConfig alt Valid Initialization ErrorReportingPlugin->>MetricsService: Report error (if conditions met) else Invalid Initialization ErrorReportingPlugin->>Client: Do not report error end Client->>ErrorReportingPlugin: Trigger error notification alt httpClient not provided ErrorReportingPlugin-->>MetricsService: Report error else httpClient provided alt Specific error message ErrorReportingPlugin-->>Client: No report sent else Other conditions ErrorReportingPlugin-->>MetricsService: Report error end end Client->>ErrorReportingPlugin: Create breadcrumb ErrorReportingPlugin->>MetricsService: Handle breadcrumb ```

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 56.67%. Comparing base (7b83e16) to head (bce74d7).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1813 +/- ## =========================================== + Coverage 56.63% 56.67% +0.04% =========================================== Files 473 473 Lines 16108 16108 Branches 3228 3216 -12 =========================================== + Hits 9122 9129 +7 - Misses 5737 5745 +8 + Partials 1249 1234 -15 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 1 month ago

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.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 ✅
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B ✅
Plugins - Legacy - CDN 15.88 KB 15.88 KB (0%) 16 KB ✅
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B ✅
Plugins - Modern - CDN 7.19 KB 7.19 KB (0%) 7.5 KB ✅
Common - No bundling 15.89 KB 15.89 KB (0%) 16.5 KB ✅
Service Worker - Legacy - NPM (ESM) 29.46 KB 29.46 KB (0%) 30 KB ✅
Service Worker - Legacy - NPM (CJS) 29.61 KB 29.61 KB (0%) 30 KB ✅
Service Worker - Legacy - NPM (UMD) 29.44 KB 29.44 KB (0%) 30 KB ✅
Service Worker - Modern - NPM (ESM) 24.59 KB 24.59 KB (0%) 25 KB ✅
Service Worker - Modern - NPM (CJS) 24.88 KB 24.88 KB (0%) 25 KB ✅
Service Worker - Modern - NPM (UMD) 24.67 KB 24.67 KB (0%) 25 KB ✅
Core (v1.1) - NPM (ESM) 29.81 KB 29.81 KB (0%) 32 KB ✅
Core (v1.1) - NPM (CJS) 29.97 KB 29.97 KB (0%) 32 KB ✅
Core (v1.1) - NPM (UMD) 29.89 KB 29.89 KB (0%) 32 KB ✅
Core (Content Script - v1.1) - NPM (ESM) 29.33 KB 29.33 KB (0%) 30 KB ✅
Core (Content Script - v1.1) - NPM (CJS) 29.54 KB 29.54 KB (0%) 30 KB ✅
Core (Content Script - v1.1) - NPM (UMD) 29.42 KB 29.42 KB (0%) 30 KB ✅
Core - Legacy - CDN 47.4 KB 47.4 KB (0%) 48 KB ✅
Core - Modern - CDN 24.09 KB 24.09 KB (0%) 24.5 KB ✅
Load Snippet 724 B 724 B (0%) 1 KB ✅
Core - Legacy - NPM (ESM) 47.29 KB 47.29 KB (0%) 47.5 KB ✅
Core - Legacy - NPM (CJS) 47.5 KB 47.5 KB (0%) 48 KB ✅
Core - Legacy - NPM (UMD) 47.28 KB 47.28 KB (0%) 47.5 KB ✅
Core - Modern - NPM (ESM) 23.83 KB 23.83 KB (0%) 24.5 KB ✅
Core - Modern - NPM (CJS) 24.06 KB 24.06 KB (0%) 24.5 KB ✅
Core - Modern - NPM (UMD) 23.86 KB 23.86 KB (0%) 24.5 KB ✅
Core (Bundled) - Legacy - NPM (ESM) 47.29 KB 47.29 KB (0%) 47.5 KB ✅
Core (Bundled) - Legacy - NPM (CJS) 47.53 KB 47.53 KB (0%) 48 KB ✅
Core (Bundled) - Legacy - NPM (UMD) 47.28 KB 47.28 KB (0%) 47.5 KB ✅
Core (Bundled) - Modern - NPM (ESM) 38.54 KB 38.54 KB (0%) 39 KB ✅
Core (Bundled) - Modern - NPM (CJS) 38.8 KB 38.8 KB (0%) 39 KB ✅
Core (Bundled) - Modern - NPM (UMD) 38.53 KB 38.53 KB (0%) 39 KB ✅
Core (Content Script) - Legacy - NPM (ESM) 46.75 KB 46.75 KB (0%) 47 KB ✅
Core (Content Script) - Legacy - NPM (CJS) 47.01 KB 47.01 KB (0%) 47.5 KB ✅
Core (Content Script) - Legacy - NPM (UMD) 46.77 KB 46.77 KB (0%) 47 KB ✅
Core (Content Script) - Modern - NPM (ESM) 38.01 KB 38.01 KB (0%) 38.5 KB ✅
Core (Content Script) - Modern - NPM (CJS) 38.3 KB 38.3 KB (0%) 38.5 KB ✅
Core (Content Script) - Modern - NPM (UMD) 37.99 KB 37.99 KB (0%) 38.5 KB ✅
All Integrations - Legacy - CDN 93.68 KB 93.68 KB (0%) 95.3 KB ✅
All Integrations - Modern - CDN 88.71 KB 88.71 KB (0%) 91 KB ✅