@exodus/error-tracking 1.1.3 → 1.2.1

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@1.2.0...@exodus/error-tracking@1.2.1) (2024-08-13)
+
+**Note:** Version bump only for package @exodus/error-tracking
+
+## [1.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@1.1.3...@exodus/error-tracking@1.2.0) (2024-08-08)
+
+### Features
+
+- **error-tracking:** add remote error tracking api node ([#8169](https://github.com/ExodusMovement/exodus-hydra/issues/8169)) ([5a2d702](https://github.com/ExodusMovement/exodus-hydra/commit/5a2d702126d81bfb934c2598b732e62d23370f03))
+
 ## [1.1.3](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@1.1.2...@exodus/error-tracking@1.1.3) (2024-07-25)
 
 ### Bug Fixes

package/api/index.js

@@ -1,22 +1,38 @@
 import { createErrorTracking } from '../module/create-error-tracking.js'
 
-// Implementation Note: It would have made more sense to add the `errorTracking` module as a dependency instead of
-// just its factory function. However, the issue is that adding errorTracking as a dependency to this API node
-// will cause the error-tracking-preprocessor to change the track function definition, which is not what we require here.
-
-const errorTrackingApiDefinition = {
+export const errorTrackingApiDefinition = {
   id: 'errorTrackingApi',
   type: 'api',
-  factory: ({ errorsAtom, config }) => {
+  factory: ({ errorsAtom, config, logger, remoteErrorTracking }) => {
     const { track } = createErrorTracking({ errorsAtom, config })
 
+    let trackRemote
+    if (remoteErrorTracking) {
+      trackRemote = async ({ error }) => {
+        try {
+          await remoteErrorTracking.captureError({
+            error,
+          })
+        } catch (err) {
+          logger.error('failed to remote track error', err)
+        }
+      }
+    } else {
+      trackRemote = async ({ error }) => {
+        logger.debug('remote error tracking is disabled', error)
+      }
+    }
+
     return {
       errors: {
         track,
+        trackRemote,
       },
     }
   },
-  dependencies: ['config', 'errorsAtom'],
+  dependencies: ['config', 'errorsAtom', 'logger', 'remoteErrorTracking?'],
 }
 
-export default errorTrackingApiDefinition
+// Implementation Note: It would have made more sense to add the `errorTracking` module as a dependency instead of
+// just its factory function. However, the issue is that adding errorTracking as a dependency to this API node
+// will cause the error-tracking-preprocessor to change the track function definition, which is not what we require here.

package/index.js

@@ -1,33 +1,47 @@
-import { isEmpty } from './is-empty.js'
+import typeforce from '@exodus/typeforce'
 
-import errorTrackingApiDefinition from './api/index.js'
+import { isEmpty } from './is-empty.js'
+import { errorTrackingApiDefinition } from './api/index.js'
 import errorTrackingAtomDefinition from './atoms/index.js'
 import errorTrackingReportDefinition from './report/index.js'
 import { errorTrackingDefinition, remoteErrorTrackingDefinition } from './module/index.js'
 
-const errorTracking = ({ maxErrorsCount = 100, sentryConfig } = Object.create(null)) => ({
-  id: 'errorTracking',
-  definitions: [
-    {
-      definition: errorTrackingAtomDefinition,
-    },
-    {
-      definition: errorTrackingApiDefinition,
-      config: { maxErrorsCount },
-    },
-    {
-      definition: errorTrackingDefinition,
-      config: { maxErrorsCount },
-    },
-    {
-      if: sentryConfig !== undefined && sentryConfig !== null && !isEmpty(sentryConfig),
-      definition: remoteErrorTrackingDefinition,
-      config: sentryConfig,
-    },
-    {
-      definition: errorTrackingReportDefinition,
-    },
-  ],
-})
+const defaultConfig = { maxErrorsCount: 100 }
+
+const configSchema = {
+  maxErrorsCount: (value) => typeof value === 'number' && value > 0 && value <= 9999,
+  sentryConfig: '?Object',
+}
+
+const errorTracking = (config = Object.create(null)) => {
+  config = { ...defaultConfig, ...config }
+
+  const { maxErrorsCount, sentryConfig } = typeforce.parse(configSchema, config)
+
+  return {
+    id: 'errorTracking',
+    definitions: [
+      {
+        definition: errorTrackingAtomDefinition,
+      },
+      {
+        definition: errorTrackingApiDefinition,
+        config: { maxErrorsCount },
+      },
+      {
+        definition: errorTrackingDefinition,
+        config: { maxErrorsCount },
+      },
+      {
+        if: sentryConfig !== undefined && sentryConfig !== null && !isEmpty(sentryConfig),
+        definition: remoteErrorTrackingDefinition,
+        config: sentryConfig,
+      },
+      {
+        definition: errorTrackingReportDefinition,
+      },
+    ],
+  }
+}
 
 export default errorTracking

package/module/create-error-tracking.js

@@ -1,13 +1,4 @@
-import typeforce from '@exodus/typeforce'
-
 export const createErrorTracking = ({ errorsAtom, config }) => {
-  const { maxErrorsCount } = typeforce.parse(
-    {
-      maxErrorsCount: (value) => typeof value === 'number' && value > 0 && value <= 9999,
-    },
-    config
-  )
-
   const track = async ({ error, context, namespace }) => {
     if (!namespace) {
       throw new Error('no namespace provided')
@@ -21,7 +12,7 @@ export const createErrorTracking = ({ errorsAtom, config }) => {
         errors: [{ namespace, error, context, time: Date.now() }]
           // eslint-disable-next-line unicorn/prefer-spread
           .concat(errors)
-          .slice(0, maxErrorsCount),
+          .slice(0, config.maxErrorsCount),
       }
     })
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/error-tracking",
-  "version": "1.1.3",
+  "version": "1.2.1",
   "type": "module",
   "description": "A simple error tracking package to let any feature collect errors and create the report",
   "author": "Exodus Movement, Inc.",
@@ -38,5 +38,5 @@
     "@exodus/sentry-client": "^3.2.0",
     "@exodus/typeforce": "^1.19.0"
   },
-  "gitHead": "3995391eb48639b2d60ced5224a6a8f4902a2466"
+  "gitHead": "a667333565279122a2fc2da437dcb62f4ca864bb"
 }