feat: error reporting plugin #1601
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1601 +/- ##
===========================================
+ Coverage 56.44% 56.61% +0.16%
===========================================
Files 467 471 +4
Lines 15967 16079 +112
Branches 3189 3209 +20
===========================================
+ Hits 9013 9103 +90
- Misses 5727 5761 +34
+ Partials 1227 1215 -12 ☔ View full report in Codecov by Sentry. |
size-limit report 📦
|
packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
Outdated
Show resolved
Hide resolved
packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
Outdated
Show resolved
Hide resolved
packages/analytics-js/src/services/ErrorHandler/processError.ts
Outdated
Show resolved
Hide resolved
packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
Outdated
Show resolved
Hide resolved
|
@saikumarrs all your comments are addressed |
packages/analytics-js/src/components/pluginsManager/PluginsManager.ts
Outdated
Show resolved
Hide resolved
packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
Outdated
Show resolved
Hide resolved
packages/analytics-js/src/services/ErrorHandler/processError.ts
Outdated
Show resolved
Hide resolved
packages/analytics-js/src/components/pluginsManager/PluginsManager.ts
Outdated
Show resolved
Hide resolved
![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
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (3)
package-lock.jsonis excluded by!**/package-lock.json,!**/*.jsonpackage.jsonis excluded by!**/*.jsonpackages/analytics-js-plugins/package.jsonis excluded by!**/*.json
Files selected for processing (5)
- packages/analytics-js-plugins/.size-limit.mjs (1 hunks)
- packages/analytics-js-plugins/rollup.config.mjs (4 hunks)
- packages/analytics-js/.size-limit.mjs (1 hunks)
- packages/analytics-js/rollup.config.mjs (9 hunks)
- sonar-project.properties (1 hunks)
Files skipped from review as they are similar to previous changes (5)
- packages/analytics-js-plugins/.size-limit.mjs
- packages/analytics-js-plugins/rollup.config.mjs
- packages/analytics-js/.size-limit.mjs
- packages/analytics-js/rollup.config.mjs
- sonar-project.properties
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- packages/analytics-js-plugins/.size-limit.mjs (2 hunks)
- packages/analytics-js-plugins/rollup.config.mjs (5 hunks)
- packages/analytics-js/.size-limit.mjs (2 hunks)
Files skipped from review as they are similar to previous changes (3)
- packages/analytics-js-plugins/.size-limit.mjs
- packages/analytics-js-plugins/rollup.config.mjs
- packages/analytics-js/.size-limit.mjs
packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- packages/analytics-js-plugins/tests/errorReporting/index.test.ts (5 hunks)
- packages/analytics-js-plugins/src/errorReporting/index.ts (3 hunks)
- packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts (8 hunks)
Files skipped from review as they are similar to previous changes (3)
- packages/analytics-js-plugins/tests/errorReporting/index.test.ts
- packages/analytics-js-plugins/src/errorReporting/index.ts
- packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- packages/analytics-js-plugins/tests/errorReporting/index.test.ts (5 hunks)
- packages/analytics-js-plugins/src/errorReporting/index.ts (3 hunks)
Files skipped from review as they are similar to previous changes (2)
- packages/analytics-js-plugins/tests/errorReporting/index.test.ts
- packages/analytics-js-plugins/src/errorReporting/index.ts
packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (8)
- packages/analytics-js-common/src/types/ApplicationState.ts (2 hunks)
- packages/analytics-js-plugins/tests/errorReporting/index.test.ts (5 hunks)
- packages/analytics-js-plugins/src/errorReporting/index.ts (3 hunks)
- packages/analytics-js/tests/services/ErrorHandler/ErrorHandler.test.ts (10 hunks)
- packages/analytics-js/src/components/configManager/ConfigManager.ts (3 hunks)
- packages/analytics-js/src/components/configManager/constants.ts (3 hunks)
- packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts (8 hunks)
- packages/analytics-js/src/state/slices/metrics.ts (1 hunks)
Files skipped from review as they are similar to previous changes (6)
- packages/analytics-js-common/src/types/ApplicationState.ts
- packages/analytics-js-plugins/tests/errorReporting/index.test.ts
- packages/analytics-js-plugins/src/errorReporting/index.ts
- packages/analytics-js/tests/services/ErrorHandler/ErrorHandler.test.ts
- packages/analytics-js/src/components/configManager/constants.ts
- packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts
Additional comments not posted (4)
packages/analytics-js/src/state/slices/metrics.ts (1)
10-10: LGTM! Ensure the correct usage ofmetricsServiceUrl.The addition of
metricsServiceUrllooks good.Verify its usage across the codebase to ensure it is utilized correctly.
Verification successful
Verified: Proper usage of
metricsServiceUrlThe addition and usage of
metricsServiceUrlacross the codebase have been verified and are consistent with its intended purpose.
metrics.ts: Initialized withundefined.ConfigManager.ts: Assigned a URL.ApplicationState.ts: Type definition.index.tsandindex.test.ts: Used in error reporting and testing.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of `metricsServiceUrl` in the codebase. # Test: Search for the usage of `metricsServiceUrl`. Expect: Proper usage across the codebase. rg --type python -A 5 $'metricsServiceUrl'Length of output: 72
Script:
#!/bin/bash # Description: Verify the usage of `metricsServiceUrl` in the codebase. # Test: Search for the usage of `metricsServiceUrl`. Expect: Proper usage across the codebase. rg --type ts -A 5 'metricsServiceUrl'Length of output: 2599
packages/analytics-js/src/components/configManager/ConfigManager.ts (3)
33-33: LGTM!The import of
METRICS_SERVICE_ENDPOINTlooks good.
112-112: LGTM! Ensure the correct definitions ofactiveDataplaneUrlandMETRICS_SERVICE_ENDPOINT.The assignment of
metricsServiceUrllooks good.Verify the definitions of
activeDataplaneUrlandMETRICS_SERVICE_ENDPOINTto ensure they are correctly defined and used.Verification successful
LGTM! Ensure the correct definitions of
activeDataplaneUrlandMETRICS_SERVICE_ENDPOINT.The assignment of
metricsServiceUrllooks good. The definitions and usage ofactiveDataplaneUrlandMETRICS_SERVICE_ENDPOINTare correct.
activeDataplaneUrlis defined as aSignal<string | undefined>and is used consistently across the codebase.METRICS_SERVICE_ENDPOINTis defined as 'rsaMetrics' inconstants.tsand is imported correctly inConfigManager.ts.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the definitions of `activeDataplaneUrl` and `METRICS_SERVICE_ENDPOINT`. # Test: Search for the definitions of `activeDataplaneUrl` and `METRICS_SERVICE_ENDPOINT`. Expect: Proper definitions and usage. rg --type python -A 5 $'activeDataplaneUrl' rg --type python -A 5 $'METRICS_SERVICE_ENDPOINT'Length of output: 153
Script:
#!/bin/bash # Description: Verify the definitions of `activeDataplaneUrl` and `METRICS_SERVICE_ENDPOINT`. # Test: Search for the definitions of `activeDataplaneUrl` and `METRICS_SERVICE_ENDPOINT` in TypeScript files. Expect: Proper definitions and usage. rg --type typescript -A 5 'activeDataplaneUrl' rg --type typescript -A 5 'METRICS_SERVICE_ENDPOINT'Length of output: 169
Script:
#!/bin/bash # Description: Verify the definitions of `activeDataplaneUrl` and `METRICS_SERVICE_ENDPOINT`. # Test: Search for the definitions of `activeDataplaneUrl` and `METRICS_SERVICE_ENDPOINT` in TypeScript files. Expect: Proper definitions and usage. rg --type ts -A 5 'activeDataplaneUrl' rg --type ts -A 5 'METRICS_SERVICE_ENDPOINT'Length of output: 8860
165-165: LGTM! Ensure theupdateReportingStatefunction no longer requires theloggerparameter.The removal of
this.loggerfrom theupdateReportingStatefunction call looks good.Verify the
updateReportingStatefunction to ensure it no longer requires theloggerparameter.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts (8 hunks)
Additional comments not posted (17)
packages/analytics-js/src/services/ErrorHandler/ErrorHandler.ts (17)
4-9: Imports ReviewThe new imports for
ErrorType,ErrorState,IHttpClient, and error processing functions are appropriate and necessary for the changes made in the file.Also applies to: 15-15, 24-28
36-36: Initialization ofhttpClientThe
httpClientproperty is correctly initialized in the constructor.
55-55: Call tonotifyErrorwitherrorStateThe call to
notifyErrorwith the newerrorStateparameter is correct and aligns with the new error handling logic.
64-64: Call toonErrorwitherrorTypeThe calls to
onErrorwith the newerrorTypeparameter are correct and align with the new error type system.Also applies to: 70-70
78-79: Initialization ofhttpClientininitThe
httpClientproperty is correctly initialized in theinitmethod.
94-94: Ensure proper error handlingThe
initmethod correctly handles the initialization of the error reporting plugin and catches any errors that occur during the process.
115-115: Addition oferrorTypeparameterThe addition of the
errorTypeparameter to theonErrormethod is correct and aligns with the new error type system.
119-119: Use ofprocessErrorThe use of
processErrorto handle handled exceptions is correct and ensures that errors are properly processed.Also applies to: 120-121
127-136: Normalization of error messageThe normalization of the error message using
removeDoubleSpacesand the creation of a newErrorobject with the normalized message are correct.
138-138: Use ofgetNormalizedErrorForUnhandledErrorThe use of
getNormalizedErrorForUnhandledErrorto handle unhandled exceptions is correct and ensures that errors are properly normalized.
141-141: Check for error reporting enabledThe check for whether error reporting is enabled is correct and ensures that errors are only reported when error reporting is enabled.
151-157: Buffering of errorsThe buffering of errors when the error reporting plugin is not loaded is correct and ensures that errors are not lost.
158-159: Call tonotifyErrorThe call to
notifyErrorwhen the error reporting plugin is loaded is correct and ensures that errors are reported immediately.
162-162: Error handling inonErrorThe error handling in the
onErrormethod ensures that any errors that occur during error reporting are logged.
165-165: Logging of handled exceptionsThe logging of handled exceptions is correct and ensures that handled exceptions are logged appropriately.
189-193: Call toinvokeSinglewith new parametersThe call to
invokeSinglewith the new parameters in theleaveBreadcrumbmethod is correct and aligns with the new error reporting logic.
206-217: Implementation ofnotifyErrorThe
notifyErrormethod is correctly implemented and ensures that errors are notified to the error reporting plugin.
|
PR Description
Error reporting Plugin:
Linear task (optional)
https://linear.app/rudderstack/issue/SDK-1096/error-reporting-plugin
Cross Browser Tests
Please confirm you have tested for the following browsers:
Sanity Suite
Security
Summary by CodeRabbit
New Features
ErrorTypeenumeration.Bug Fixes
Refactor
Chores