@exodus/atoms 6.0.1 → 7.0.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@6.0.2...@exodus/atoms@7.0.0) (2023-12-10)
+
+### ⚠ BREAKING CHANGES
+
+- don't call serialize/deserialize on `undefined` in withSerialization (#4896)
+
+### Features
+
+- don't call serialize/deserialize on `undefined` in withSerialization ([#4896](https://github.com/ExodusMovement/exodus-hydra/issues/4896)) ([20a7a32](https://github.com/ExodusMovement/exodus-hydra/commit/20a7a321e00a527c94650222e45c0a970164c92c))
+
+## [6.0.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@6.0.1...@exodus/atoms@6.0.2) (2023-11-30)
+
+### Bug Fixes
+
+- **atoms:** avoid observe-set loop caused by optimistic notifier ([#4932](https://github.com/ExodusMovement/exodus-hydra/issues/4932)) ([aced29b](https://github.com/ExodusMovement/exodus-hydra/commit/aced29bcd58c3aeb92653c14294cda29897ca3aa))
+- valueEmittedFromGet !== undefined ([#4634](https://github.com/ExodusMovement/exodus-hydra/issues/4634)) ([89d185f](https://github.com/ExodusMovement/exodus-hydra/commit/89d185f7bafa2b604ea76219b3fab14e8845a43d))
+
 ## [6.0.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@6.0.0...@exodus/atoms@6.0.1) (2023-10-25)
 
 ### Bug Fixes

package/README.md

@@ -18,15 +18,17 @@ An atom is a data source wrapper that exposes a single piece of data through 3 d
 
 This library provides helpers for creating atoms from multiple data sources we use in our apps
 
-|               | get | set   | observe |
-| ------------- | --- | ----- | ------- |
-| Memory        | ✅  | ✅    | ✅      |
-| Storage       | ✅  | 🟡 \* | ✅      |
-| Remote config | ✅  | ❌    | ✅      |
-| Local config  | ✅  | ✅    | ✅      |
-| Event emitter | ✅  | ❌    | ✅      |
-
-\* A storage atom needs a special `isSoleWriter` param to allow write access. This is because storage instances can overlap, e.g. a parent namespace can mutate a child namespace, and our [storage-spec](https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/storage-spec) doesn't currently provide for detecting changes across those instances.
+|               | get   | set     | observe |
+| ------------- | ----- | ------- | ------- |
+| Memory        | ✅ \* | ✅      | ✅      |
+| Storage       | ✅    | 🟡 \*\* | ✅      |
+| Remote config | ✅    | ❌      | ✅      |
+| Local config  | ✅    | ✅      | ✅      |
+| Event emitter | ✅    | ❌      | ✅      |
+
+\* If no `defaultValue` is provided, a memory atom's `get()` method will hang and observers will NOT be called until the first `set()` call.
+
+\*\* A storage atom needs a special `isSoleWriter` param to allow write access. This is because storage instances can overlap, e.g. a parent namespace can mutate a child namespace, and our [storage-spec](https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/storage-spec) doesn't currently provide for detecting changes across those instances.
 
 ## Usage
 

package/lib/enforce-rules.js

@@ -31,7 +31,7 @@ const enforceObservableRules = ({ defaultValue, getInitialized = () => true, ...
             }
         });
         return atom.observe((value) => {
-            if (valueEmittedFromGet) {
+            if (valueEmittedFromGet !== undefined) {
                 const isAlreadyEmitted = value === valueEmittedFromGet;
                 valueEmittedFromGet = undefined;
                 if (isAlreadyEmitted) {

package/lib/enhancers/optimistic-notifier.js

@@ -2,12 +2,14 @@ import makeConcurrent from 'make-concurrent';
 import createInMemoryAtom from '../factories/memory';
 const optimisticNotifier = (atom) => {
     const memoryAtom = createInMemoryAtom();
-    const set = makeConcurrent(async (newValue) => {
+    const set = makeConcurrent(async (newValue, fromRemote) => {
         let previous;
         await memoryAtom.set((previousValue) => {
             previous = previousValue;
             return newValue;
         });
+        if (fromRemote)
+            return;
         atom
             .set(newValue)
             .catch(() => memoryAtom.set((value) => (value === newValue ? previous : value)));
@@ -23,7 +25,7 @@ const optimisticNotifier = (atom) => {
     };
     const observe = (callback) => {
         if (subscribers === 0) {
-            unsubscribeSource = atom.observe(set);
+            unsubscribeSource = atom.observe((value) => set(value, true));
         }
         subscribers += 1;
         const unsubscribe = memoryAtom.observe(callback);
@@ -38,9 +40,10 @@ const optimisticNotifier = (atom) => {
         }
         return memoryAtom.get();
     };
+    const _set = (value) => set(value, false);
     return {
         ...memoryAtom,
-        set,
+        set: _set,
         get,
         observe,
     };

package/lib/enhancers/with-serialization.d.ts

@@ -4,5 +4,5 @@ type Params<T, S> = {
     serialize: (value: T) => S;
     deserialize: (serialized: S) => T;
 };
-declare const withSerialization: <T, S>({ atom, serialize, deserialize }: Params<T, S>) => Atom<T>;
+declare const withSerialization: <T, S>({ atom, serialize: customSerialize, deserialize: customDeserialize, }: Params<T, S>) => Atom<T>;
 export default withSerialization;

package/lib/enhancers/with-serialization.js

@@ -1,5 +1,7 @@
 import { isSetter } from '../utils/guards';
-const withSerialization = ({ atom, serialize, deserialize }) => {
+const withSerialization = ({ atom, serialize: customSerialize, deserialize: customDeserialize, }) => {
+    const serialize = (value) => (value === undefined ? undefined : customSerialize(value));
+    const deserialize = (value) => (value === undefined ? undefined : customDeserialize(value));
     const get = async () => {
         const serialized = await atom.get();
         return deserialize(serialized);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/atoms",
-  "version": "6.0.1",
+  "version": "7.0.0",
   "main": "lib/index.js",
   "description": "Abstraction for encapsulating a piece of data behind a simple unified interface: get, set, observe",
   "author": "Exodus Movement Inc.",
@@ -37,11 +37,12 @@
     "@exodus/atom-tests": "^1.0.0",
     "@exodus/remote-config": "^2.3.0",
     "@exodus/storage-memory": "^2.1.1",
+    "@types/jest": "^29.5.11",
     "@types/lodash": "^4.14.200",
     "@types/minimalistic-assert": "^1.0.2",
     "delay": "^5.0.0",
     "eslint": "^8.44.0",
     "jest": "^29.1.2"
   },
-  "gitHead": "7ed0324ad76734e8bd9fddaa9da79ca1e44ad809"
+  "gitHead": "e1aadf171d02cc1502ef53f905cd84ab6e307ba3"
 }