@exodus/error-tracking 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@1.0.0...@exodus/error-tracking@1.1.0) (2024-07-12)
+
+### Features
+
+- add errorTracking feature to sdk ([#7670](https://github.com/ExodusMovement/exodus-hydra/issues/7670)) ([34dbc5c](https://github.com/ExodusMovement/exodus-hydra/commit/34dbc5c1f0b94ef4213dfaec788790c475eb962c)), closes [#7708](https://github.com/ExodusMovement/exodus-hydra/issues/7708)
+- **error-tracking:** adds errorTracking module + namespaced preprocessor ([#7603](https://github.com/ExodusMovement/exodus-hydra/issues/7603)) ([aa7f8d7](https://github.com/ExodusMovement/exodus-hydra/commit/aa7f8d75aad88f83495c963f7271331a87181467)), closes [#7708](https://github.com/ExodusMovement/exodus-hydra/issues/7708)

package/api/index.js

@@ -1,34 +1,18 @@
+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 = {
   id: 'errorTrackingApi',
   type: 'api',
   factory: ({ errorsAtom, config }) => {
-    if (
-      !config.maxErrorsCount ||
-      typeof config.maxErrorsCount !== 'number' ||
-      config.maxErrorsCount < 1 ||
-      config.maxErrorsCount > 9999
-    ) {
-      throw new Error('`maxErrorsCount` is required config and must be a number [0-9999]')
-    }
+    const { track } = createErrorTracking({ errorsAtom, config })
 
     return {
       errors: {
-        track: async ({ namespace, error, context }) => {
-          if (!namespace) {
-            throw new Error('`namespace` is required to track/collect errors')
-          }
-
-          return errorsAtom.set((namespaces) => {
-            const errors = namespaces[namespace] || []
-            return {
-              ...namespaces,
-              [namespace]: [{ namespace, error, context, time: Date.now() }, ...errors].slice(
-                0,
-                config.maxErrorsCount
-              ),
-            }
-          })
-        },
+        track,
       },
     }
   },

package/atoms/index.js

@@ -2,14 +2,14 @@ import { createInMemoryAtom } from '@exodus/atoms'
 
 /* errorsAtom schema:
   {
-    `namespace`: [{ `namespace`, `error`, `context`, `time` }, ...]
+    errors: [{ `namespace`, `error`, `context`, `time` }, ...]
   }
 */
 const errorsAtomDefinition = {
   id: 'errorsAtom',
   private: true,
   type: 'atom',
-  factory: () => createInMemoryAtom({ defaultValue: {} }),
+  factory: () => createInMemoryAtom({ defaultValue: { errors: [] } }),
   dependencies: [],
 }
 

package/index.js

@@ -1,16 +1,28 @@
+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 = 10 } = Object.create(null)) => ({
+const errorTracking = ({ maxErrorsCount = 100, sentryConfig } = Object.create(null)) => ({
   id: 'errorTracking',
   definitions: [
+    {
+      definition: errorTrackingAtomDefinition,
+    },
     {
       definition: errorTrackingApiDefinition,
       config: { maxErrorsCount },
     },
     {
-      definition: errorTrackingAtomDefinition,
+      definition: errorTrackingDefinition,
+      config: { maxErrorsCount },
+    },
+    {
+      if: sentryConfig !== undefined && sentryConfig !== null && !isEmpty(sentryConfig),
+      definition: remoteErrorTrackingDefinition,
+      config: sentryConfig,
     },
     {
       definition: errorTrackingReportDefinition,

package/module/create-error-tracking.js

@@ -0,0 +1,30 @@
+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')
+    }
+
+    return errorsAtom.set(({ errors }) => {
+      errors = errors || []
+      return {
+        // this array can be big. not sure about prefering spread operator here
+        // concat function seems like a better option
+        errors: [{ namespace, error, context, time: Date.now() }]
+          // eslint-disable-next-line unicorn/prefer-spread
+          .concat(errors)
+          .slice(0, maxErrorsCount),
+      }
+    })
+  }
+
+  return { track }
+}

package/module/error-tracking.js

@@ -0,0 +1,10 @@
+import { createErrorTracking } from './create-error-tracking.js'
+
+const MODULE_ID = 'errorTracking'
+
+export const errorTrackingDefinition = {
+  id: MODULE_ID,
+  type: 'module',
+  factory: createErrorTracking,
+  dependencies: ['config', 'errorsAtom'],
+}

package/module/index.js

@@ -0,0 +1,2 @@
+export { errorTrackingDefinition } from './error-tracking.js'
+export { remoteErrorTrackingDefinition } from './remote-error-tracking.js'

package/module/remote-error-tracking.js

@@ -0,0 +1,18 @@
+import createSentryClient from '@exodus/sentry-client'
+import stackTraceParser from '@exodus/sentry-client/src/stack-trace-parsers/default.js'
+import createFetchival from '@exodus/fetch/create-fetchival'
+
+export const remoteErrorTrackingDefinition = {
+  id: 'remoteErrorTracking',
+  type: 'module',
+  private: true,
+  factory: ({ config, fetch, defaultStackTraceParser }) => {
+    const fetchival = createFetchival({ fetch })
+    return createSentryClient({
+      config,
+      fetchival,
+      defaultStackTraceParser: defaultStackTraceParser || stackTraceParser,
+    })
+  },
+  dependencies: ['config', 'fetch', 'defaultStackTraceParser?'],
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/error-tracking",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
   "description": "A simple error tracking package to let any feature collect errors and create the report",
   "author": "Exodus Movement, Inc.",
@@ -19,6 +19,7 @@
     ".",
     "api",
     "atoms",
+    "module",
     "report",
     "CHANGELOG.md",
     "README.md",
@@ -30,7 +31,11 @@
     "lint:fix": "yarn lint --fix"
   },
   "dependencies": {
-    "@exodus/atoms": "^7.5.0"
+    "@exodus/atoms": "^7.5.0",
+    "@exodus/basic-utils": "^3.0.1",
+    "@exodus/fetch": "^1.3.1",
+    "@exodus/sentry-client": "^3.2.0",
+    "@exodus/typeforce": "^1.19.0"
   },
-  "gitHead": "5618f82730d7fab9716a974488d2d96afbe99922"
+  "gitHead": "14d2baaf7c1adf673aeb49562d6625a30195de03"
 }