@exodus/atoms 3.6.0 → 3.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/atoms",
-  "version": "3.6.0",
+  "version": "3.7.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": "de75a59d866ea737d6d1698c3c1edd7a44af0295"
 }

package/src/enforce-rules.js

@@ -1,5 +1,7 @@
 import makeConcurrent from 'make-concurrent'
 import proxyFreeze from 'proxy-freeze'
+import { isEqual } from 'lodash'
+import assert from 'minimalistic-assert'
 
 const withChangeDetection = (listener) => {
   let currentValue
@@ -24,7 +26,9 @@ const withChangeDetection = (listener) => {
   }
 }
 
-const enforceObservableRules = ({ defaultValue, ...atom }) => {
+const enforceObservableRules = ({ defaultValue, logger, warnOnSameValueSet = false, ...atom }) => {
+  assert(!warnOnSameValueSet || logger, 'warnOnSameValueSet specified but no logger supplied')
+
   // ensure observers get called in series
   const enqueue = makeConcurrent((fn) => fn(), { concurrency: 1 })
 
@@ -47,6 +51,12 @@ const enforceObservableRules = ({ defaultValue, ...atom }) => {
     // support a function a la React's setState(oldState => newState)
     if (typeof value === 'function') value = await value(await get())
 
+    if (warnOnSameValueSet && isEqual(value, await get())) {
+      logger.warn(
+        `Atom was called with the same value it currently holds: ${JSON.stringify(value)}`
+      )
+    }
+
     await atom.set(value)
   }
 

package/src/event-emitter.js

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

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, warnOnSameValueSet }) =>
   ({ path, defaultValue }) => {
     const set = async (value) => {
       await fusion.mergeProfile(setValueAtPath({}, path, value))
@@ -23,6 +23,8 @@ const createFusionAtomFactory =
       set,
       observe,
       defaultValue,
+      logger,
+      warnOnSameValueSet,
     })
   }
 

package/src/factories/keystore.js

@@ -3,6 +3,7 @@ import createSimpleObserver from '../simple-observer'
 
 const createKeystoreAtom = ({
   keystore,
+  logger,
   config: {
     //
     key,
@@ -11,6 +12,7 @@ const createKeystoreAtom = ({
     getOpts,
     setOpts,
     deleteOpts,
+    warnOnSameValueSet,
   },
 }) => {
   const { notify, observe } = createSimpleObserver({ enable: isSoleWriter })
@@ -32,6 +34,8 @@ const createKeystoreAtom = ({
     set,
     observe,
     defaultValue,
+    logger,
+    warnOnSameValueSet,
   })
 }
 

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, warnOnSameValueSet }) =>
   ({ key, defaultValue, isSoleWriter }) => {
     const { notify, observe } = createSimpleObserver({ enable: isSoleWriter })
 
@@ -39,6 +39,8 @@ const createStorageAtomFactory =
       set,
       observe,
       defaultValue,
+      logger,
+      warnOnSameValueSet,
     })
   }