@exodus/atoms 3.6.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/atoms",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "main": "src/index.js",
   "author": "Exodus Movement Inc.",
   "scripts": {
@@ -34,5 +34,5 @@
     "eslint": "^8.33.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "9352420baa5144820706bb4d9476f0e7b535a72a"
+  "gitHead": "99487e27398623ebf0588233db4f01443c93102d"
 }

package/src/enforce-rules.js

@@ -12,11 +12,7 @@ const withChangeDetection = (listener) => {
       called = true
       currentValue = value
 
-      try {
-        await listener(currentValue)
-      } catch (error) {
-        console.warn('observer failed', error)
-      }
+      await listener(currentValue)
     },
     get called() {
       return called
@@ -24,7 +20,7 @@ const withChangeDetection = (listener) => {
   }
 }
 
-const enforceObservableRules = ({ defaultValue, ...atom }) => {
+const enforceObservableRules = ({ defaultValue, logger, ...atom }) => {
   // ensure observers get called in series
   const enqueue = makeConcurrent((fn) => fn(), { concurrency: 1 })
 

package/src/enhancers/swallow-observer-errors.js

@@ -0,0 +1,16 @@
+import enforceObservableRules from '../enforce-rules'
+
+const swallowObserverErrors = ({ atom, logger }) => {
+  const observe = (observer) =>
+    atom.observe(async (...args) => {
+      try {
+        await observer(...args)
+      } catch (err) {
+        logger.error('Observer threw error', err)
+      }
+    })
+
+  return enforceObservableRules({ ...atom, observe })
+}
+
+export default swallowObserverErrors

package/src/enhancers/timeout-observers.js

@@ -0,0 +1,19 @@
+import delay from 'delay'
+import enforceObservableRules from '../enforce-rules'
+
+const timeoutObservers = ({ atom, logger, timeout }) => {
+  const observe = (observer) =>
+    atom.observe(async (...args) =>
+      Promise.race([
+        //
+        observer(...args),
+        delay.reject(timeout, {
+          value: new Error('Observer timed out!'),
+        }),
+      ])
+    )
+
+  return enforceObservableRules({ ...atom, observe })
+}
+
+export default timeoutObservers

package/src/enhancers/warn-on-same-value-set.js

@@ -0,0 +1,18 @@
+import { isEqual as deepEqual } from 'lodash'
+import enforceObservableRules from '../enforce-rules'
+
+const warnOnSameValueSet = ({ atom, isEqual = deepEqual, logger }) => {
+  const set = async (value) => {
+    if (isEqual(value, await atom.get())) {
+      logger.warn(
+        `Atom was called with the same value it currently holds: ${JSON.stringify(value)}`
+      )
+    }
+
+    await atom.set(value)
+  }
+
+  return enforceObservableRules({ ...atom, set })
+}
+
+export default warnOnSameValueSet

package/src/event-emitter.js

@@ -1,6 +1,6 @@
 import enforceObservableRules from './enforce-rules'
 
-const fromEventEmitter = ({ emitter, event, get, set, defaultValue }) => {
+const fromEventEmitter = ({ emitter, event, get, set, defaultValue, logger }) => {
   const observe = (listener) => {
     emitter.on(event, listener)
     return () => emitter.removeListener(event, listener)
@@ -11,6 +11,7 @@ const fromEventEmitter = ({ emitter, event, get, set, defaultValue }) => {
     set,
     observe,
     defaultValue,
+    logger,
   })
 }
 

package/src/factories/fusion.js

@@ -3,7 +3,7 @@ import { get as getValueAtPath, set as setValueAtPath } from 'lodash'
 import enforceObservableRules from '../enforce-rules'
 
 const createFusionAtomFactory =
-  ({ fusion }) =>
+  ({ fusion, logger }) =>
   ({ path, defaultValue }) => {
     const set = async (value) => {
       await fusion.mergeProfile(setValueAtPath({}, path, value))
@@ -23,6 +23,7 @@ const createFusionAtomFactory =
       set,
       observe,
       defaultValue,
+      logger,
     })
   }
 

package/src/factories/keystore.js

@@ -3,6 +3,7 @@ import createSimpleObserver from '../simple-observer'
 
 const createKeystoreAtom = ({
   keystore,
+  logger,
   config: {
     //
     key,
@@ -32,6 +33,7 @@ const createKeystoreAtom = ({
     set,
     observe,
     defaultValue,
+    logger,
   })
 }
 

package/src/factories/memory.js

@@ -30,7 +30,7 @@ const createAtomMock = (options = {}) => {
     }
   }
 
-  return fromEventEmitter({ emitter, event: 'data', get, set, defaultValue })
+  return fromEventEmitter({ ...options, emitter, event: 'data', get, set })
 }
 
 export default createAtomMock

package/src/factories/storage.js

@@ -2,7 +2,7 @@ import createSimpleObserver from '../simple-observer'
 import enforceObservableRules from '../enforce-rules'
 
 const createStorageAtomFactory =
-  ({ storage }) =>
+  ({ storage, logger }) =>
   ({ key, defaultValue, isSoleWriter }) => {
     const { notify, observe } = createSimpleObserver({ enable: isSoleWriter })
 
@@ -39,6 +39,7 @@ const createStorageAtomFactory =
       set,
       observe,
       defaultValue,
+      logger,
     })
   }
 

package/src/index.js

@@ -13,4 +13,7 @@ export { default as difference } from './enhancers/difference'
 export { default as withSerialization } from './enhancers/with-serialization'
 export { default as combine } from './enhancers/combine'
 export { default as readOnly } from './enhancers/read-only'
+export { default as warnOnSameValueSet } from './enhancers/warn-on-same-value-set'
+export { default as swallowObserverErrors } from './enhancers/swallow-observer-errors'
+export { default as timeoutObservers } from './enhancers/timeout-observers'
 export { default as enforceObservableRules } from './enforce-rules'