@exodus/atoms 5.4.0 → 5.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/atoms",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "main": "src/index.js",
   "description": "Abstraction for encapsulating a piece of data behind a simple unified interface: get, set, observe",
   "author": "Exodus Movement Inc.",
@@ -30,10 +30,11 @@
     "proxy-freeze": "^1.0.0"
   },
   "devDependencies": {
+    "@exodus/atom-tests": "^1.0.0",
     "@exodus/storage-memory": "^2.1.0",
     "delay": "^5.0.0",
     "eslint": "^8.44.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "1944a27f2309fbda6bba55d7ea153e81ab0c2c03"
+  "gitHead": "aec5804ed663dec0767599dde6208d8487ab07f7"
 }

package/src/enhancers/optimistic-notifier.js

@@ -0,0 +1,60 @@
+import makeConcurrent from 'make-concurrent'
+import createInMemoryAtom from '../factories/memory'
+
+const optimisticNotifier = (atom) => {
+  const memoryAtom = createInMemoryAtom()
+
+  const set = makeConcurrent(async (newValue) => {
+    let previous
+    await memoryAtom.set((previousValue) => {
+      previous = previousValue
+      return newValue
+    })
+
+    atom
+      .set(newValue)
+      // only revert in case the value hasn't changed in the meanwhile
+      .catch(() => memoryAtom.set((value) => (value === newValue ? previous : value)))
+  })
+
+  let unsubscribeSource
+  let subscribers = 0
+
+  const maybeUnsubscribeSource = () => {
+    subscribers -= 1
+    if (subscribers > 0) return
+    unsubscribeSource()
+    unsubscribeSource = undefined
+  }
+
+  const observe = (callback) => {
+    if (subscribers === 0) {
+      unsubscribeSource = atom.observe(set)
+    }
+
+    subscribers += 1
+    const unsubscribe = memoryAtom.observe(callback)
+
+    return () => {
+      unsubscribe()
+      maybeUnsubscribeSource()
+    }
+  }
+
+  const get = async () => {
+    if (subscribers === 0) {
+      return atom.get()
+    }
+
+    return memoryAtom.get()
+  }
+
+  return {
+    ...memoryAtom,
+    set,
+    get,
+    observe,
+  }
+}
+
+export default optimisticNotifier

package/src/factories/observer.js

@@ -0,0 +1,27 @@
+const createAtomObserver = ({ port, atom, event }) => {
+  let emitting = false
+  let unobserve
+
+  const register = () => {
+    unobserve = atom.observe((value) => {
+      if (emitting) port.emit(event, value)
+    })
+  }
+
+  const unregister = () => {
+    unobserve?.()
+  }
+
+  const start = async () => {
+    emitting = true
+    port.emit(event, await atom.get())
+  }
+
+  return {
+    register,
+    unregister,
+    start,
+  }
+}
+
+export default createAtomObserver

package/src/index.js

@@ -4,6 +4,7 @@ export { default as createStorageAtomFactory } from './factories/storage'
 export { default as createRemoteConfigAtomFactory } from './factories/remote-config'
 export { default as createKeystoreAtom } from './factories/keystore'
 export { default as createSequencedKeystoreAtom } from './factories/sequenced-keystore'
+export { default as createAtomObserver } from './factories/observer'
 export { default as fromEventEmitter } from './event-emitter'
 export { default as compute } from './enhancers/compute'
 export { default as blockUntil } from './enhancers/block-until'