@exodus/atoms 7.6.1 → 8.1.0

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@8.0.0...@exodus/atoms@8.1.0) (2024-08-10)
+
+### Features
+
+- **atoms:** warn when using cache enhancer on atom with no setter ([#8147](https://github.com/ExodusMovement/exodus-hydra/issues/8147)) ([1511a55](https://github.com/ExodusMovement/exodus-hydra/commit/1511a5528cce33d82795b4eb06385de370e7a847))
+
+### Bug Fixes
+
+- **atoms:** invalidate cache on failed writes, adjust user id analytics atom API ([#8303](https://github.com/ExodusMovement/exodus-hydra/issues/8303)) ([17537a8](https://github.com/ExodusMovement/exodus-hydra/commit/17537a8b18aff90d5e7e1b12dd7964032af7b44b))
+
+## [8.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@7.6.1...@exodus/atoms@8.0.0) (2024-07-17)
+
+### ⚠ BREAKING CHANGES
+
+- extract remote config atoms (#7817)
+
+### Features
+
+- **enhancers:** add compute asynchronous selector support ([#7873](https://github.com/ExodusMovement/exodus-hydra/issues/7873)) ([e62576e](https://github.com/ExodusMovement/exodus-hydra/commit/e62576e5a257f012a184e75a505c2381cc42e07c))
+- extract remote config atoms ([#7817](https://github.com/ExodusMovement/exodus-hydra/issues/7817)) ([7c67be4](https://github.com/ExodusMovement/exodus-hydra/commit/7c67be43e1cdd8376cbf211a64e3fec9b049b90b))
+
 ## [7.6.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/atoms@7.6.0...@exodus/atoms@7.6.1) (2024-07-09)
 
 **Note:** Version bump only for package @exodus/atoms

package/README.md

@@ -13,6 +13,7 @@ An atom is a data source wrapper that exposes a single piece of data through 3 d
 - **get()**: read data
 - **set(newValue)**: write data
 - **observe(async (data) => {})**: observes data changes. Will be called initially with current data value. Observers are awaited in series.
+- **reset()**: clear the stored value. The next `get()` call will return the default value\* and observers will be called with the default value.
 
 ## Data sources
 
@@ -33,12 +34,7 @@ This library provides helpers for creating atoms from multiple data sources we u
 ## Usage
 
 ```js
-import {
-  createInMemoryAtom,
-  createStorageAtomFactory,
-  createRemoteConfigAtomFactory,
-  fromEventEmitter,
-} from '@exodus/atoms'
+import { createInMemoryAtom, createStorageAtomFactory, fromEventEmitter } from '@exodus/atoms'
 
 // In memory atoms
 const availableAssetNamesAtom = createInMemoryAtom({
@@ -54,14 +50,6 @@ const acceptedTermsAtom = storageAtomFactory({
   isSoleWriter: true,
 })
 
-// Remote config atoms
-const createRemoteConfigAtom = createRemoteConfigAtomFactory({ remoteConfig })
-
-const fiatOnrampConfigAtom = createRemoteConfigAtom({
-  path: `dapps.fiatOnramp`,
-  defaultValue: {},
-})
-
 // Event emitter
 const geolocationAtom = fromEventEmitter({
   emitter: geolocation,

package/lib/enhancers/compute.d.ts

@@ -1,7 +1,7 @@
 import { Atom, ReadonlyAtom } from '../utils/types.js';
 type Params<T, V> = {
     atom: Atom<T> | ReadonlyAtom<T>;
-    selector: (value: T) => V;
+    selector: (value: T) => V | Promise<V>;
 };
 declare const compute: <T, V>({ atom, selector }: Params<T, V>) => ReadonlyAtom<V>;
 export default compute;

package/lib/enhancers/compute.js

@@ -9,8 +9,8 @@ const compute = ({ atom, selector }) => {
     const observe = (callback) => {
         let prev;
         let called;
-        return atom.observe((values) => {
-            const selected = selector(values);
+        return atom.observe(async (values) => {
+            const selected = await selector(values);
             if (called && prev === selected)
                 return;
             called = true;

package/lib/enhancers/difference.d.ts

@@ -1,9 +1,9 @@
-import { Atom, Listener } from '../utils/types.js';
+import { Atom } from '../utils/types.js';
 type Diff<T> = {
     previous?: T;
     current: T;
 };
 declare const difference: <T>(atom: Atom<T>) => Omit<Atom<T>, "observe"> & {
-    observe: (listener: Listener<Diff<T>>) => import("../utils/types.js").Unsubscribe;
+    observe: Atom<Diff<T>>["observe"];
 };
 export default difference;

package/lib/enhancers/with-storage-cache.js

@@ -6,6 +6,9 @@ const getCacheAtom = ({ storage, key }) => {
 const enhanceAtom = (params) => {
     const { atom, logger } = params;
     const cacheAtom = getCacheAtom(params);
+    if (!atom.hasOwnProperty('set')) {
+        logger.warn('Atom does not have a "set" method, cache will last only until the app is restarted');
+    }
     let hasCache = false;
     const setCache = async (fresh) => {
         try {
@@ -31,15 +34,29 @@ const enhanceAtom = (params) => {
         return fresh;
     };
     const set = async (value) => {
-        await atom.set(value);
-        hasCache = false;
+        try {
+            await atom.set(value);
+        }
+        catch (error) {
+            logger.warn('Failed to write to atom, is it a readonly atom? Clearing cache...', error);
+        }
+        finally {
+            hasCache = false;
+        }
     };
     const get = async () => {
         return hasCache ? readCache() : readFresh();
     };
     const reset = async () => {
-        await atom.reset();
-        hasCache = false;
+        try {
+            await atom.reset();
+        }
+        catch (error) {
+            logger.warn('Failed to write to atom, is it a readonly atom? Clearing cache...', error);
+        }
+        finally {
+            hasCache = false;
+        }
     };
     return { ...atom, get, set, reset };
 };

package/lib/factories/storage.d.ts

@@ -9,7 +9,7 @@ type Params<D> = {
     isSoleWriter?: boolean;
 };
 declare const createStorageAtomFactory: <T>({ storage }: FactoryParams<T>) => {
-    (opts: Omit<Params<unknown>, 'defaultValue'>): Atom<T | undefined>;
+    (opts: Omit<Params<unknown>, "defaultValue">): Atom<T | undefined>;
     <D extends T>(opts: Params<D>): Atom<T | D>;
 };
 export default createStorageAtomFactory;

package/lib/index.d.ts

@@ -1,10 +1,10 @@
 export { default as createAtomMock } from './factories/memory.js';
 export { default as createInMemoryAtom } from './factories/memory.js';
 export { default as createStorageAtomFactory } from './factories/storage.js';
-export { default as createRemoteConfigAtomFactory } from './factories/remote-config.js';
 export { default as createKeystoreAtom } from './factories/keystore.js';
 export { default as createSequencedKeystoreAtom } from './factories/sequenced-keystore.js';
 export { default as createAtomObserver } from './factories/observer.js';
+export { default as createSimpleObserver } from './simple-observer.js';
 export { default as compute } from './enhancers/compute.js';
 export { default as blockUntil } from './enhancers/block-until.js';
 export { default as filter } from './enhancers/filter.js';

package/lib/index.js

@@ -1,10 +1,10 @@
 export { default as createAtomMock } from './factories/memory.js';
 export { default as createInMemoryAtom } from './factories/memory.js';
 export { default as createStorageAtomFactory } from './factories/storage.js';
-export { default as createRemoteConfigAtomFactory } from './factories/remote-config.js';
 export { default as createKeystoreAtom } from './factories/keystore.js';
 export { default as createSequencedKeystoreAtom } from './factories/sequenced-keystore.js';
 export { default as createAtomObserver } from './factories/observer.js';
+export { default as createSimpleObserver } from './simple-observer.js';
 export { default as compute } from './enhancers/compute.js';
 export { default as blockUntil } from './enhancers/block-until.js';
 export { default as filter } from './enhancers/filter.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/atoms",
-  "version": "7.6.1",
+  "version": "8.1.0",
   "description": "Abstraction for encapsulating a piece of data behind a simple unified interface: get, set, observe",
   "type": "module",
   "main": "lib/index.js",
@@ -41,7 +41,6 @@
   },
   "devDependencies": {
     "@exodus/atom-tests": "^1.0.0",
-    "@exodus/remote-config": "^2.4.0",
     "@exodus/storage-memory": "^2.1.1",
     "@types/jest": "^29.5.11",
     "@types/json-stringify-safe": "^5.0.3",
@@ -49,5 +48,5 @@
     "@types/minimalistic-assert": "^1.0.2",
     "events": "^3.3.0"
   },
-  "gitHead": "4d0f338fc17d176f1293b54fc881914c62f0cfce"
+  "gitHead": "b1c2b04c40dfc00630a26f3f5f9a9fab1a9dce91"
 }

package/lib/factories/remote-config.d.ts

@@ -1,13 +0,0 @@
-import type { RemoteConfigType } from '@exodus/remote-config';
-type FactoryParams = {
-    remoteConfig: RemoteConfigType;
-};
-type Params<T> = {
-    defaultValue?: T;
-} & ({
-    path: string;
-} | {
-    selector: (config: object) => T;
-});
-declare const createRemoteConfigAtomFactory: ({ remoteConfig }: FactoryParams) => <T>({ defaultValue, ...params }: Params<T>) => import("../utils/types.js").Atom<T>;
-export default createRemoteConfigAtomFactory;

package/lib/factories/remote-config.js

@@ -1,35 +0,0 @@
-import lodash from 'lodash';
-import createSimpleObserver from '../simple-observer.js';
-import enforceObservableRules from '../enforce-rules.js';
-const { get: getValueAtPath, isEqual } = lodash;
-const createRemoteConfigAtomFactory = ({ remoteConfig }) => ({ defaultValue, ...params }) => {
-    if ('path' in params && 'selector' in params) {
-        throw new Error('Provide either a path or a selector to get data from remote config - not both.');
-    }
-    const getValue = (value) => 'path' in params ? getValueAtPath(value, params.path) : params.selector(value);
-    const { notify, observe } = createSimpleObserver();
-    const get = async () => {
-        const data = await remoteConfig.getAll();
-        return getValue(data);
-    };
-    const set = async () => {
-        throw new Error('remoteConfig is read-only');
-    };
-    remoteConfig.on('sync', async ({ current }) => {
-        const data = getValue(current);
-        return notify(data);
-    });
-    const observeDistinct = (callback) => observe(function (value) {
-        if (isEqual(this.lastValue, value))
-            return;
-        this.lastValue = value;
-        callback(value);
-    }.bind({}));
-    return enforceObservableRules({
-        get,
-        set,
-        observe: observeDistinct,
-        defaultValue,
-    });
-};
-export default createRemoteConfigAtomFactory;