@exodus/error-tracking 1.5.0 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@1.5.1...@exodus/error-tracking@2.0.0) (2025-04-09)
+
+### ⚠ BREAKING CHANGES
+
+- require `error` to be `Error` instances (#11965)
+
+### Features
+
+- feat!: require `error` to be `Error` instances (#11965)
+
+### Bug Fixes
+
+- fix: make `context` parameter optional in type definitions (#11975)
+
+## [1.5.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@1.5.0...@exodus/error-tracking@1.5.1) (2025-03-13)
+
+**Note:** Version bump only for package @exodus/error-tracking
+
 ## [1.5.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@1.4.1...@exodus/error-tracking@1.5.0) (2025-02-27)
 
 ### Features

package/api/index.d.ts

@@ -5,12 +5,12 @@ export interface ErrorTrackingApi {
    * ```typescript
    * exodus.errors.track({
    *   namespace: 'balances',
-   *   error: 'Encountered an issue when computing total balances',
+   *   error: new Error('Encountered an issue when computing total balances'),
    *   context: {},
    * })
    * ```
    */
-  track(params: { error: string | Error; namespace: string; context: any }): Promise<void>
+  track(params: { error: Error; namespace: string; context?: any }): Promise<void>
   /**
    * Track an error remotely using sentry if available
    * @example

package/atoms/index.d.ts

@@ -0,0 +1,15 @@
+import type { Atom } from '@exodus/atoms'
+
+interface ErrorsSchema {
+  errors: { namespace: string; error: Error; context: any; time: number }[]
+}
+
+export type ErrorsAtom = Atom<ErrorsSchema>
+
+declare const errorsAtomDefinition: {
+  id: 'errorsAtom'
+  type: 'atom'
+  factory(): ErrorsAtom
+}
+
+export default errorsAtomDefinition

package/index.d.ts

@@ -1,8 +1,17 @@
 import type errorTrackingApiDefinition from './api/index.js'
+import type errorTrackingModuleDefinition from './module/index.js'
+import type errorsAtomDefinition from './atoms/index.js'
 
-declare const errorTracking: () => {
+declare const errorTracking: (config?: { maxErrorsCount?: number }) => {
   id: 'errorTracking'
-  definitions: [{ definition: typeof errorTrackingApiDefinition }]
+  definitions: [
+    { definition: typeof errorTrackingApiDefinition },
+    { definition: typeof errorTrackingModuleDefinition },
+    { definition: typeof errorsAtomDefinition },
+  ]
 }
 
+export { ErrorTrackingModule } from './module/index.js'
+export { ErrorsAtom } from './atoms/index.js'
+
 export default errorTracking

package/module/error-tracking.js

@@ -6,6 +6,10 @@ const createErrorTracking = ({ errorsAtom, config }) => {
       throw new Error('no namespace provided')
     }
 
+    if (!(error instanceof Error)) {
+      throw new TypeError('error must be an instance of Error')
+    }
+
     return errorsAtom.set(({ errors }) => {
       return {
         // this array can be big. not sure about prefering spread operator here

package/module/index.d.ts

@@ -0,0 +1,26 @@
+import type { ErrorsAtom } from '../atoms/index.js'
+
+export interface ErrorTrackingModule {
+  /**
+   * Track an error
+   * @example
+   * ```typescript
+   * errorTracking.track({
+   *   namespace: 'balances',
+   *   error: new Error('Encountered an issue when computing total balances'),
+   *   context: {},
+   * })
+   * ```
+   */
+  track(params: { error: Error; namespace: string; context?: any }): Promise<void>
+}
+
+declare const errorTrackingModuleDefinition: {
+  id: 'errorTracking'
+  type: 'module'
+  factory({ config, errorsAtom }: { config: { maxErrorsCount: number }; errorsAtom: ErrorsAtom }): {
+    errors: ErrorTrackingModule
+  }
+}
+
+export default errorTrackingModuleDefinition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/error-tracking",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "type": "module",
   "description": "A simple error tracking package to let any feature collect errors and create the report",
   "author": "Exodus Movement, Inc.",
@@ -33,13 +33,15 @@
   },
   "dependencies": {
     "@exodus/atoms": "^9.0.0",
+    "@exodus/basic-utils": "^3.0.1",
     "@exodus/errors": "^2.0.1",
     "@exodus/fetch": "^1.3.1",
     "@exodus/sentry-client": "^4.0.0",
-    "@exodus/typeforce": "^1.19.0"
+    "@exodus/typeforce": "^1.19.0",
+    "@exodus/zod": "^3.24.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b85ce886087a09896bff3f9a619a7d99ff705667"
+  "gitHead": "d76155ed627a340ea60a910b77a250967f5a692b"
 }

package/report/index.js

@@ -1,4 +1,6 @@
 import { SafeError } from '@exodus/errors'
+import { memoize } from '@exodus/basic-utils'
+import { z } from '@exodus/zod'
 
 const errorTrackingReportDefinition = {
   type: 'report',
@@ -15,6 +17,21 @@ const errorTrackingReportDefinition = {
         })),
       }
     },
+    getSchema: memoize(() =>
+      z
+        .object({
+          errors: z.array(
+            z
+              .object({
+                namespace: z.string(),
+                error: z.instanceof(SafeError),
+                time: z.number(),
+              })
+              .strict()
+          ),
+        })
+        .strict()
+    ),
   }),
   dependencies: ['errorsAtom'],
   public: true,