feat: add error handling to all public apis (#1907)

* feat: add error handling to all public apis * chore: address ai bot review comments * test: add unit tests for RudderAnalytics class * fix: buble up error to handle * fix: error handling in analytics * test: address ai bot review comments * test: add unit tests for error utilities * test: clean up test suite * chore: revert size limit changes * chore: update code owners and slack group for integrations * fix: log manually raised unhandled errors * fix: improve stack mutation logic
rudderlabs · Nov 8, 2024 · 9fbaf81 · 9fbaf81
1 parent 79cad80
commit 9fbaf81
Show file tree

Hide file tree

Showing 16 changed files with 995 additions and 432 deletions.
diff --git a/.github/workflows/deploy-npm.yml b/.github/workflows/deploy-npm.yml
@@ -155,7 +155,7 @@ jobs:
           channel-id: ${{ secrets.SLACK_RELEASE_CHANNEL_ID }}
           payload: |
             {
-              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.NPM_PACKAGE_URL }}|${{ env.CURRENT_VERSION_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>",
+              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.NPM_PACKAGE_URL }}|${{ env.CURRENT_VERSION_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>",
               "blocks": [
                 {
                   "type": "header",
@@ -171,7 +171,7 @@ jobs:
                   "type": "section",
                   "text": {
                     "type": "mrkdwn",
-                    "text": "*<${{ env.NPM_PACKAGE_URL }}|v${{ env.CURRENT_VERSION_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T> <!subteam^S07CCQ05F2T>"
+                    "text": "*<${{ env.NPM_PACKAGE_URL }}|v${{ env.CURRENT_VERSION_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350> <!subteam^S03SHJ20350>"
                   },
                   "accessory": {
                     "type": "image",
@@ -205,7 +205,7 @@ jobs:
           channel-id: ${{ secrets.SLACK_RELEASE_CHANNEL_ID }}
           payload: |
             {
-              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.NPM_PACKAGE_URL }}|${{ env.CURRENT_VERSION_SW_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>",
+              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.NPM_PACKAGE_URL }}|${{ env.CURRENT_VERSION_SW_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>",
               "blocks": [
                 {
                   "type": "header",
@@ -221,7 +221,7 @@ jobs:
                   "type": "section",
                   "text": {
                     "type": "mrkdwn",
-                    "text": "*<${{ env.NPM_PACKAGE_URL }}|v${{ env.CURRENT_VERSION_SW_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>"
+                    "text": "*<${{ env.NPM_PACKAGE_URL }}|v${{ env.CURRENT_VERSION_SW_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>"
                   },
                   "accessory": {
                     "type": "image",
@@ -255,7 +255,7 @@ jobs:
           channel-id: ${{ secrets.SLACK_RELEASE_CHANNEL_ID }}
           payload: |
             {
-              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.NPM_PACKAGE_URL }}|${{ env.CURRENT_VERSION_COOKIE_UTILS_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>",
+              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.NPM_PACKAGE_URL }}|${{ env.CURRENT_VERSION_COOKIE_UTILS_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>",
               "blocks": [
                 {
                   "type": "header",
@@ -271,7 +271,7 @@ jobs:
                   "type": "section",
                   "text": {
                     "type": "mrkdwn",
-                    "text": "*<${{ env.NPM_PACKAGE_URL }}|v${{ env.CURRENT_VERSION_COOKIE_UTILS_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>"
+                    "text": "*<${{ env.NPM_PACKAGE_URL }}|v${{ env.CURRENT_VERSION_COOKIE_UTILS_VALUE }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>"
                   },
                   "accessory": {
                     "type": "image",

diff --git a/.github/workflows/deploy-sanity-suite.yml b/.github/workflows/deploy-sanity-suite.yml
@@ -153,7 +153,7 @@ jobs:
           channel-id: ${{ secrets.SLACK_RELEASE_CHANNEL_ID }}
           payload: |
             {
-              "text": "*New Deployment: ${{ env.PROJECT_NAME }} - <${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>",
+              "text": "*New Deployment: ${{ env.PROJECT_NAME }} - <${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>",
               "blocks": [
                 {
                   "type": "header",
@@ -169,7 +169,7 @@ jobs:
                   "type": "section",
                   "text": {
                     "type": "mrkdwn",
-                    "text": "*<${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>"
+                    "text": "*<${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>"
                   },
                   "accessory": {
                     "type": "image",

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -233,7 +233,7 @@ jobs:
           channel-id: ${{ secrets.SLACK_RELEASE_CHANNEL_ID }}
           payload: |
             {
-              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>",
+              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>",
               "blocks": [
                 {
                   "type": "header",
@@ -249,7 +249,7 @@ jobs:
                   "type": "section",
                   "text": {
                     "type": "mrkdwn",
-                    "text": "*<${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>"
+                    "text": "*<${{ env.CDN_URL }}|${{ env.LINK_TEXT }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>"
                   },
                   "accessory": {
                     "type": "image",

diff --git a/.github/workflows/publish-new-release.yml b/.github/workflows/publish-new-release.yml
@@ -117,7 +117,7 @@ jobs:
           channel-id: ${{ secrets.SLACK_RELEASE_CHANNEL_ID }}
           payload: |
             {
-              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.TAG_COMPARE_URL }}${{ env.last_monorepo_version }}...v${{ steps.extract-version.outputs.release_version }}|v${{ steps.extract-version.outputs.release_version }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>",
+              "text": "*New Release: ${{ env.PROJECT_NAME }} - <${{ env.TAG_COMPARE_URL }}${{ env.last_monorepo_version }}...v${{ steps.extract-version.outputs.release_version }}|v${{ steps.extract-version.outputs.release_version }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>",
               "blocks": [
                 {
                   "type": "header",
@@ -133,7 +133,7 @@ jobs:
                   "type": "section",
                   "text": {
                     "type": "mrkdwn",
-                    "text": "*<${{ env.TAG_COMPARE_URL }}${{ env.last_monorepo_version }}...v${{ steps.extract-version.outputs.release_version }}|v${{ steps.extract-version.outputs.release_version }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S07CCQ05F2T>"
+                    "text": "*<${{ env.TAG_COMPARE_URL }}${{ env.last_monorepo_version }}...v${{ steps.extract-version.outputs.release_version }}|v${{ steps.extract-version.outputs.release_version }}>*\n${{ env.DATE }}\nCC: <!subteam^S0555JBV36D> <!subteam^S03SHJ20350>"
                   },
                   "accessory": {
                     "type": "image",

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,12 +1,12 @@
 * @rudderlabs/js-sdk
 
-/packages/analytics-js-integrations/src/ @rudderlabs/js-sdk-dm-intg-eng
-/packages/analytics-js-integrations/__fixtures__/ @rudderlabs/js-sdk-dm-intg-eng
-/packages/analytics-js-integrations/__tests__/ @rudderlabs/js-sdk-dm-intg-eng
-/packages/analytics-js-integrations/__mocks__/ @rudderlabs/js-sdk-dm-intg-eng
-/packages/analytics-js-integrations/README.md @rudderlabs/js-sdk-dm-intg-eng
-/packages/analytics-js-integrations/.size-limit.js @rudderlabs/js-sdk-dm-intg-eng
+/packages/analytics-js-integrations/src/ @rudderlabs/integrations
+/packages/analytics-js-integrations/__fixtures__/ @rudderlabs/integrations
+/packages/analytics-js-integrations/__tests__/ @rudderlabs/integrations
+/packages/analytics-js-integrations/__mocks__/ @rudderlabs/integrations
+/packages/analytics-js-integrations/README.md @rudderlabs/integrations
+/packages/analytics-js-integrations/.size-limit.js @rudderlabs/integrations
 
-/packages/analytics-js-common/src/constants/integrations/ @rudderlabs/js-sdk-dm-intg-eng
-/assets/integrations/AdobeAnalytics/ @rudderlabs/js-sdk-dm-intg-eng
-/examples/integrations/ @rudderlabs/js-sdk-dm-intg-eng
+/packages/analytics-js-common/src/constants/integrations/ @rudderlabs/integrations
+/assets/integrations/AdobeAnalytics/ @rudderlabs/integrations
+/examples/integrations/ @rudderlabs/integrations
diff --git a/packages/analytics-js-common/__tests__/utilities/errors.test.ts b/packages/analytics-js-common/__tests__/utilities/errors.test.ts
@@ -0,0 +1,18 @@
+import { dispatchErrorEvent } from '../../src/utilities/errors';
+
+describe('Errors - utilities', () => {
+  describe('dispatchErrorEvent', () => {
+    it('should dispatch an error event', () => {
+      const dispatchEvent = jest.fn();
+      const originalDispatchEvent = globalThis.dispatchEvent;
+
+      globalThis.dispatchEvent = dispatchEvent;
+      const error = new Error('Test error');
+      dispatchErrorEvent(error);
+      expect(dispatchEvent).toHaveBeenCalledWith(new ErrorEvent('error', { error }));
+
+      // Cleanup
+      globalThis.dispatchEvent = originalDispatchEvent;
+    });
+  });
+});
diff --git a/packages/analytics-js-common/src/constants/loggerContexts.ts b/packages/analytics-js-common/src/constants/loggerContexts.ts
@@ -11,7 +11,7 @@ const LOAD_CONFIGURATION = 'LoadConfiguration';
 const EVENT_REPOSITORY = 'EventRepository';
 const EXTERNAL_SRC_LOADER = 'ExternalSrcLoader';
 const HTTP_CLIENT = 'HttpClient';
-const RS_APP = 'RudderStackApplication';
+const RSA = 'RudderStackAnalytics';
 const ANALYTICS_CORE = 'AnalyticsCore';
 
 export {
@@ -28,6 +28,6 @@ export {
   EVENT_REPOSITORY,
   EXTERNAL_SRC_LOADER,
   HTTP_CLIENT,
-  RS_APP,
+  RSA,
   ANALYTICS_CORE,
 };
diff --git a/packages/analytics-js-common/src/types/ApiObject.ts b/packages/analytics-js-common/src/types/ApiObject.ts
@@ -10,6 +10,6 @@ export type ApiObject = {
     | ApiObject
     | null
     | Date
-    | (string | number | boolean | null | Date | ApiObject)[]
+    | (string | number | boolean | null | Date | ApiObject | undefined)[]
     | undefined;
 };
diff --git a/packages/analytics-js-common/src/types/IRudderAnalytics.ts b/packages/analytics-js-common/src/types/IRudderAnalytics.ts
@@ -85,7 +85,7 @@ export interface IRudderAnalytics<T = any> {
   /**
    * Get the instance of Analytics that is set as default
    */
-  getAnalyticsInstance(writeKey?: string): T;
+  getAnalyticsInstance(writeKey?: string): T | undefined;
 
   /**
    * Trigger load event in buffer queue if exists
@@ -188,7 +188,7 @@ export interface IRudderAnalytics<T = any> {
   /**
    * To fetch the current sessionId
    */
-  getSessionId(): Nullable<number>;
+  getSessionId(): Nullable<number> | undefined;
 
   /**
    * To provide consent

diff --git a/packages/analytics-js-common/src/utilities/errors.ts b/packages/analytics-js-common/src/utilities/errors.ts
@@ -1,6 +1,8 @@
 import { isTypeOfError } from './checks';
 import { stringifyData } from './json';
 
+const MANUAL_ERROR_IDENTIFIER = '[MANUAL ERROR]';
+
 /**
  * Get mutated error with issue prepended to error message
  * @param err Original error
@@ -17,4 +19,11 @@ const getMutatedError = (err: any, issue: string): Error => {
   return finalError;
 };
 
-export { getMutatedError };
+const dispatchErrorEvent = (error: any) => {
+  if (isTypeOfError(error)) {
+    error.stack = `${error.stack ?? ''}\n${MANUAL_ERROR_IDENTIFIER}`;
+  }
+  (globalThis as typeof window).dispatchEvent(new ErrorEvent('error', { error }));
+};
+
+export { getMutatedError, dispatchErrorEvent, MANUAL_ERROR_IDENTIFIER };