@exodus/error-tracking 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@3.1.2...@exodus/error-tracking@3.2.0) (2025-10-14)
+
+### Features
+
+- feat: support capturing error context (#13933)
+
+## [3.1.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@3.1.1...@exodus/error-tracking@3.1.2) (2025-09-09)
+
+### Bug Fixes
+
+- fix: respect ab-testing variant for sentry [2] (#13783)
+
 ## [3.1.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/error-tracking@3.1.0...@exodus/error-tracking@3.1.1) (2025-08-25)
 
 ### Bug Fixes

package/README.md

@@ -23,8 +23,13 @@ This feature is designed to be used together with `@exodus/headless`. See [using
 See [using the sdk](../../docs/development/using-the-sdk.md#setup-the-api-side) for more details on how features plug into the SDK and the API interface in the [type declaration](./api/index.d.ts).
 
 ```ts
-await exodus.errors.track({ namespace, error, context: {} })
-await exodus.errors.trackRemote({ error })
+import type { SafeContextType } from '@exodus/errors'
+
+// Track error with optional context (see SafeContextType for available properties).
+const context: SafeContextType = {
+  /* ... */
+}
+await exodus.errors.track({ namespace: 'wallet', error, context })
 ```
 
 If you're building a feature and like to use error tracking inside that feature, you can depend on `errorTracking` and will receive the module with a track method that is auto-namespaced to your feature id.

package/module/error-tracking.js

@@ -23,7 +23,6 @@ const createErrorTracking = ({
       return onError(new TypeError('error must be an instance of Error'))
     }
 
-    // TODO: figure out what to do with `context`
     // TODO: eventually kill this and only track remote
     const localPromise = errorsAtom.set(({ errors }) => {
       return {
@@ -39,7 +38,7 @@ const createErrorTracking = ({
     const remotePromise = remoteErrorTracking
       ? remoteErrorTrackingEnabledAtom
           .get()
-          .then((enabled) => enabled && remoteErrorTracking.track({ error }))
+          .then((enabled) => enabled && remoteErrorTracking.track({ error, context }))
       : Promise.resolve()
 
     let timeoutId

package/module/index.d.ts

@@ -1,4 +1,5 @@
 import type { ErrorsAtom } from '../atoms/index.js'
+import type { SafeContextType } from '@exodus/errors'
 
 export interface ErrorTrackingModule {
   /**
@@ -12,7 +13,7 @@ export interface ErrorTrackingModule {
    * })
    * ```
    */
-  track(params: { error: Error; namespace: string; context?: any }): Promise<void>
+  track(params: { error: Error; namespace: string; context?: SafeContextType }): Promise<void>
 }
 
 declare const errorTrackingModuleDefinition: {

package/module/remote-error-tracking.js

@@ -1,19 +1,16 @@
 import createSentryClient from '@exodus/sentry-client'
-import createFetchival from '@exodus/fetch/create-fetchival'
 
 export const remoteErrorTrackingDefinition = {
   id: 'remoteErrorTracking',
   type: 'module',
-  factory: ({ config, fetch }) => {
-    const fetchival = createFetchival({ fetch })
+  factory: ({ config }) => {
     const client = createSentryClient({
       config,
-      fetchival,
     })
 
     return {
-      track: ({ error }) => client.captureError({ error }),
+      track: ({ error, context }) => client.captureError({ error, context }),
     }
   },
-  dependencies: ['config', 'fetch'],
+  dependencies: ['config'],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/error-tracking",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "type": "module",
   "description": "A simple error tracking package to let any feature collect errors and create the report",
   "author": "Exodus Movement, Inc.",
@@ -34,14 +34,14 @@
   "dependencies": {
     "@exodus/atoms": "^9.0.0",
     "@exodus/basic-utils": "^3.0.1",
-    "@exodus/errors": "^3.0.0",
-    "@exodus/fetch": "^1.3.1",
-    "@exodus/sentry-client": "^6.0.0",
+    "@exodus/errors": "^3.4.0",
+    "@exodus/sentry-client": "^6.2.0",
     "@exodus/typeforce": "^1.19.0",
     "@exodus/zod": "^3.24.2"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": false
   },
-  "gitHead": "8d0dc9654666fca43daed44971e4bc52c4d5c9a2"
+  "gitHead": "1c7823e1ee4d02280aff05d67169e915ed7909ca"
 }

package/plugin/index.js

@@ -42,6 +42,7 @@ function errorTrackingPlugin({
           trackFundedWallets,
           earliestTxDate,
           buildMetadata: await getBuildMetadata(),
+          logger,
         })
 
         if (reasonDisabled) {

package/plugin/why-is-remote-tracking-disabled.js

@@ -1,3 +1,64 @@
+import typeforce from '@exodus/typeforce'
+
+export class ErrorTrackingAbExperiment {
+  #experimentId
+  #abExperimentSchema = typeforce.maybe({
+    enabled: 'Boolean',
+  })
+
+  #abVariantSchema = typeforce.maybe({
+    value: 'String',
+    type: 'String',
+  })
+
+  #enabled
+  #variant
+
+  constructor({ experimentId, abTesting, logger }) {
+    if (!logger) {
+      throw new Error('logger is required')
+    }
+
+    this.#experimentId = experimentId
+
+    if (experimentId) {
+      try {
+        const experimentParsed = typeforce.parse(
+          this.#abExperimentSchema,
+          abTesting?.experiments?.[experimentId],
+          true
+        )
+
+        const variantParsed = typeforce.parse(
+          this.#abVariantSchema,
+          abTesting?.variants?.[experimentId],
+          true
+        )
+
+        this.#enabled = experimentParsed?.enabled
+        this.#variant = variantParsed?.value
+      } catch {
+        // Attract attention to the issue and keep 'enabled' and 'variant' undefined to ensure remote tracking is disabled.
+        logger.debug(
+          `ErrorTrackingAbExperiment: failed to parse abTesting for experimentId: ${experimentId}`
+        )
+      }
+    }
+  }
+
+  get hasExperimentId() {
+    return !!this.#experimentId
+  }
+
+  get enabled() {
+    return this.#enabled
+  }
+
+  get variant() {
+    return this.#variant
+  }
+}
+
 export function whyIsRemoteTrackingDisabled({
   remoteErrorTrackingABExperimentId,
   remoteErrorTrackingFundedWalletsABExperimentId,
@@ -7,15 +68,22 @@ export function whyIsRemoteTrackingDisabled({
   trackFundedWallets,
   earliestTxDate,
   buildMetadata,
+  logger,
 }) {
   if (buildMetadata.dev) return 'dev-mode'
 
-  if (!remoteErrorTrackingABExperimentId) return 'missing-ab-experiment-id'
-  if (!abTesting.experiments?.[remoteErrorTrackingABExperimentId]?.enabled) {
+  const unfundedExperiment = new ErrorTrackingAbExperiment({
+    experimentId: remoteErrorTrackingABExperimentId,
+    abTesting,
+    logger,
+  })
+
+  if (!unfundedExperiment.hasExperimentId) return 'missing-ab-experiment-id'
+  if (!unfundedExperiment.enabled) {
     return 'ab-experiment-disabled'
   }
 
-  if (abTesting.variants?.[remoteErrorTrackingABExperimentId] !== 'enabled') {
+  if (unfundedExperiment.variant !== 'enabled') {
     return 'ab-experiment-variant-disabled'
   }
 
@@ -35,15 +103,21 @@ export function whyIsRemoteTrackingDisabled({
   }
 
   // FUNDED WALLETS: separate AB experiment
-  if (!remoteErrorTrackingFundedWalletsABExperimentId) {
+  const fundedExperiment = new ErrorTrackingAbExperiment({
+    experimentId: remoteErrorTrackingFundedWalletsABExperimentId,
+    abTesting,
+    logger,
+  })
+
+  if (!fundedExperiment.hasExperimentId) {
     return 'missing-funded-wallets-ab-experiment-id'
   }
 
-  if (!abTesting.experiments?.[remoteErrorTrackingFundedWalletsABExperimentId]?.enabled) {
+  if (!fundedExperiment.enabled) {
     return 'funded-wallets-ab-experiment-disabled'
   }
 
-  if (abTesting.variants?.[remoteErrorTrackingFundedWalletsABExperimentId] !== 'enabled') {
+  if (fundedExperiment.variant !== 'enabled') {
     return 'funded-wallets-ab-experiment-variant-disabled'
   }
 }