@exodus/error-tracking 1.0.0

package/README.md

@@ -0,0 +1,30 @@
+# @exodus/error-tracking
+
+A simple namespaces error tracking package to let any feature collect errors and create the report
+
+## Install
+
+```sh
+yarn add @exodus/error-tracking
+```
+
+## Methods
+
+`#errorTracking.track({ namespace: string, error: Error | string, context: Object })`
+
+Collects tracked error to the provided namespaced error list.
+
+## Usage
+
+### With a dependency injection container
+
+```js
+import errorTracking from '@exodus/error-tracking'
+
+const ioc = createIocContainer()
+
+const config = { maxErrorsCount: 20 }
+ioc.use(errorTracking(config))
+
+ioc.resolve()
+```

package/api/index.js

@@ -0,0 +1,38 @@
+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]')
+    }
+
+    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
+              ),
+            }
+          })
+        },
+      },
+    }
+  },
+  dependencies: ['config', 'errorsAtom'],
+}
+
+export default errorTrackingApiDefinition

package/atoms/index.js

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

package/index.js

@@ -0,0 +1,21 @@
+import errorTrackingApiDefinition from './api/index.js'
+import errorTrackingAtomDefinition from './atoms/index.js'
+import errorTrackingReportDefinition from './report/index.js'
+
+const errorTracking = ({ maxErrorsCount = 10 } = Object.create(null)) => ({
+  id: 'errorTracking',
+  definitions: [
+    {
+      definition: errorTrackingApiDefinition,
+      config: { maxErrorsCount },
+    },
+    {
+      definition: errorTrackingAtomDefinition,
+    },
+    {
+      definition: errorTrackingReportDefinition,
+    },
+  ],
+})
+
+export default errorTracking

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@exodus/error-tracking",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "A simple error tracking package to let any feature collect errors and create the report",
+  "author": "Exodus Movement, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
+  },
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/features/error-tracking",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Aerror-tracking"
+  },
+  "main": "index.js",
+  "exports": "./index.js",
+  "files": [
+    ".",
+    "api",
+    "atoms",
+    "report",
+    "CHANGELOG.md",
+    "README.md",
+    "!**/__tests__/**"
+  ],
+  "scripts": {
+    "test": "run -T jest",
+    "lint": "run -T eslint . --ignore-path ../../.gitignore",
+    "lint:fix": "yarn lint --fix"
+  },
+  "dependencies": {
+    "@exodus/atoms": "^7.5.0"
+  },
+  "gitHead": "5618f82730d7fab9716a974488d2d96afbe99922"
+}

package/report/index.js

@@ -0,0 +1,13 @@
+const errorTrackingReportDefinition = {
+  type: 'report',
+  id: 'errorTrackingReport',
+  factory: ({ errorsAtom }) => ({
+    namespace: 'errorTracking',
+    export: async () => {
+      return errorsAtom.get()
+    },
+  }),
+  dependencies: ['errorsAtom'],
+}
+
+export default errorTrackingReportDefinition