@legendapp/state 2.2.0-next.2 → 2.2.0-next.20

package/persist.js

@@ -139,9 +139,21 @@ function observablePersistRemoteFunctionsAdapter({ get, set, }) {
     const ret = {};
     if (get) {
         ret.get = (async (params) => {
-            const value = (await get(params));
-            params.onChange({ value, dateModified: params.dateModified || Date.now() });
-            params.onGet();
+            try {
+                let value = get(params);
+                if (state.isPromise(value)) {
+                    value = await value;
+                }
+                params.onChange({
+                    value,
+                    dateModified: params.dateModified,
+                    lastSync: params.lastSync,
+                    mode: params.mode,
+                });
+                params.onGet();
+                // eslint-disable-next-line no-empty
+            }
+            catch (_a) { }
         });
     }
     if (set) {
@@ -150,7 +162,22 @@ function observablePersistRemoteFunctionsAdapter({ get, set, }) {
     return ret;
 }
 
-const { getProxy, globalState } = state.internal;
+function removeNullUndefined(val) {
+    if (val) {
+        Object.keys(val).forEach((key) => {
+            const v = val[key];
+            if (v === null || v === undefined) {
+                delete val[key];
+            }
+            else if (state.isObject(v)) {
+                removeNullUndefined(v);
+            }
+        });
+    }
+    return val;
+}
+
+const { globalState: globalState$1 } = state.internal;
 const mapPersistences = new WeakMap();
 const metadatas = new WeakMap();
 const promisesLocalSaves = new Set();
@@ -165,11 +192,12 @@ function doInOrder(arg1, arg2) {
     return state.isPromise(arg1) ? arg1.then(arg2) : arg2(arg1);
 }
 function onChangeRemote(cb) {
-    state.when(() => !globalState.isLoadingRemote$.get(), () => {
+    state.when(() => !globalState$1.isLoadingRemote$.get(), () => {
+        state.endBatch(true);
         // Remote changes should only update local state
-        globalState.isLoadingRemote$.set(true);
+        globalState$1.isLoadingRemote$.set(true);
         state.batch(cb, () => {
-            globalState.isLoadingRemote$.set(false);
+            globalState$1.isLoadingRemote$.set(false);
         });
     });
 }
@@ -216,24 +244,28 @@ async function updateMetadataImmediate(obs, localState, syncState, persistOption
     const { table, config } = parseLocalConfig(local);
     // Save metadata
     const oldMetadata = metadatas.get(obs);
-    const { modified, pending } = newMetadata;
-    const needsUpdate = pending || (modified && (!oldMetadata || modified !== oldMetadata.modified));
+    const { lastSync, pending } = newMetadata;
+    const needsUpdate = pending || (lastSync && (!oldMetadata || lastSync !== oldMetadata.lastSync));
     if (needsUpdate) {
         const metadata = Object.assign({}, oldMetadata, newMetadata);
         metadatas.set(obs, metadata);
         if (persistenceLocal) {
             await persistenceLocal.setMetadata(table, metadata, config);
         }
-        if (modified) {
-            syncState.dateModified.set(modified);
+        if (lastSync) {
+            syncState.assign({
+                lastSync: lastSync,
+                dateModified: lastSync,
+            });
         }
     }
 }
 function updateMetadata(obs, localState, syncState, persistOptions, newMetadata) {
+    var _a;
     if (localState.timeoutSaveMetadata) {
         clearTimeout(localState.timeoutSaveMetadata);
     }
-    localState.timeoutSaveMetadata = setTimeout(() => updateMetadataImmediate(obs, localState, syncState, persistOptions, newMetadata), 30);
+    localState.timeoutSaveMetadata = setTimeout(() => updateMetadataImmediate(obs, localState, syncState, persistOptions, newMetadata), ((_a = persistOptions === null || persistOptions === void 0 ? void 0 : persistOptions.remote) === null || _a === void 0 ? void 0 : _a.metadataTimeout) || 0);
 }
 let _queuedChanges = [];
 async function processQueuedChanges() {
@@ -252,7 +284,7 @@ async function processQueuedChanges() {
     // 4. Wait for remote load or error if allowed
     // 5. Save to remote
     // 6. On successful save, merge changes (if any) back into observable
-    // 7. Lastly, update metadata to clear pending and update dateModified. Doing this earlier could potentially cause
+    // 7. Lastly, update metadata to clear pending and update lastSync. Doing this earlier could potentially cause
     // sync inconsistences so it's very important that this is last.
     changes.forEach(doChange);
 }
@@ -405,6 +437,7 @@ async function doChange(changeInfo) {
         await state.when(() => syncState.isLoaded.get() || ((configRemote === null || configRemote === void 0 ? void 0 : configRemote.allowSetIfError) && syncState.error.get()));
         const value = obs.peek();
         (_a = configRemote === null || configRemote === void 0 ? void 0 : configRemote.onBeforeSet) === null || _a === void 0 ? void 0 : _a.call(configRemote);
+        localState.numSavesOutstanding = (localState.numSavesOutstanding || 0) + 1;
         const saved = await ((_b = persistenceRemote.set({
             obs,
             syncState: syncState,
@@ -412,17 +445,18 @@ async function doChange(changeInfo) {
             changes: changesRemote,
             value,
         })) === null || _b === void 0 ? void 0 : _b.catch((err) => { var _a; return (_a = configRemote === null || configRemote === void 0 ? void 0 : configRemote.onSetError) === null || _a === void 0 ? void 0 : _a.call(configRemote, err); }));
+        localState.numSavesOutstanding--;
         // If this remote save changed anything then update persistence and metadata
         // Because save happens after a timeout and they're batched together, some calls to save will
         // return saved data and others won't, so those can be ignored.
         if (saved) {
             const pathStrs = Array.from(new Set(changesRemote.map((change) => change.pathStr)));
-            const { changes, dateModified } = saved;
+            const { changes, lastSync } = saved;
             if (pathStrs.length > 0) {
                 if (local) {
                     const metadata = {};
                     const pending = (_c = persistenceLocal.getMetadata(table, configLocal)) === null || _c === void 0 ? void 0 : _c.pending;
-                    let transformedChanges = [];
+                    let transformedChanges = undefined;
                     for (let i = 0; i < pathStrs.length; i++) {
                         const pathStr = pathStrs[i];
                         // Clear pending for this path
@@ -432,22 +466,34 @@ async function doChange(changeInfo) {
                             metadata.pending = pending;
                         }
                     }
-                    if (dateModified) {
-                        metadata.modified = dateModified;
+                    if (lastSync) {
+                        metadata.lastSync = lastSync;
                     }
                     // Remote can optionally have data that needs to be merged back into the observable,
                     // for example Firebase may update dateModified with the server timestamp
                     if (changes && !state.isEmpty(changes)) {
-                        transformedChanges.push(transformLoadData(changes, persistOptions.remote, false));
+                        transformedChanges = transformLoadData(changes, persistOptions.remote, false);
                     }
-                    if (transformedChanges.length > 0) {
-                        if (transformedChanges.some((change) => state.isPromise(change))) {
-                            transformedChanges = await Promise.all(transformedChanges);
+                    if (localState.numSavesOutstanding > 0) {
+                        if (transformedChanges) {
+                            if (!localState.pendingSaveResults) {
+                                localState.pendingSaveResults = [];
+                            }
+                            localState.pendingSaveResults.push(transformedChanges);
                         }
-                        onChangeRemote(() => state.mergeIntoObservable(obs, ...transformedChanges));
                     }
-                    if (shouldSaveMetadata && !state.isEmpty(metadata)) {
-                        updateMetadata(obs, localState, syncState, persistOptions, metadata);
+                    else {
+                        let allChanges = [...(localState.pendingSaveResults || []), transformedChanges];
+                        if (allChanges.length > 0) {
+                            if (allChanges.some((change) => state.isPromise(change))) {
+                                allChanges = await Promise.all(allChanges);
+                            }
+                            onChangeRemote(() => state.mergeIntoObservable(obs, ...allChanges));
+                        }
+                        if (shouldSaveMetadata && !state.isEmpty(metadata)) {
+                            updateMetadata(obs, localState, syncState, persistOptions, metadata);
+                        }
+                        localState.pendingSaveResults = [];
                     }
                 }
                 (_d = configRemote === null || configRemote === void 0 ? void 0 : configRemote.onSet) === null || _d === void 0 ? void 0 : _d.call(configRemote);
@@ -498,7 +544,7 @@ async function loadLocal(obs, persistOptions, syncState, localState) {
         }
         const { persist: persistenceLocal, initialized } = mapPersistences.get(localPersistence);
         localState.persistenceLocal = persistenceLocal;
-        if (!initialized.get()) {
+        if (!initialized.peek()) {
             await state.when(initialized);
         }
         // If persistence has an asynchronous load, wait for it
@@ -512,12 +558,21 @@ async function loadLocal(obs, persistOptions, syncState, localState) {
         let value = persistenceLocal.getTable(table, config);
         const metadata = persistenceLocal.getMetadata(table, config);
         if (metadata) {
+            // @ts-expect-error Migration from old version
+            if (!metadata.lastSync && metadata.modified) {
+                // @ts-expect-error Migration from old
+                metadata.lastSync = metadata.modified;
+            }
             metadatas.set(obs, metadata);
             localState.pendingChanges = metadata.pending;
-            syncState.dateModified.set(metadata.modified);
+            // TODOV3 Remove dateModified
+            syncState.assign({
+                dateModified: metadata.lastSync,
+                lastSync: metadata.lastSync,
+            });
         }
         // Merge the data from local persistence into the default state
-        if (value !== null && value !== undefined) {
+        if (value !== undefined) {
             const { transform, fieldTransforms } = config;
             value = transformLoadData(value, { transform, fieldTransforms }, true);
             if (state.isPromise(value)) {
@@ -528,7 +583,12 @@ async function loadLocal(obs, persistOptions, syncState, localState) {
                 // are set on the same observable
                 state.internal.globalState.isLoadingLocal = true;
                 // We want to merge the local data on top of any initial state the object is created with
-                state.mergeIntoObservable(obs, value);
+                if (value === null && !obs.peek()) {
+                    obs.set(value);
+                }
+                else {
+                    state.mergeIntoObservable(obs, value);
+                }
             }, () => {
                 state.internal.globalState.isLoadingLocal = false;
             });
@@ -541,18 +601,11 @@ async function loadLocal(obs, persistOptions, syncState, localState) {
     }
     syncState.isLoadedLocal.set(true);
 }
-function persistObservable(initialOrObservable, persistOptions) {
-    var _a;
-    const obs = (state.isObservable(initialOrObservable)
-        ? initialOrObservable
-        : state.observable(state.isFunction(initialOrObservable) ? initialOrObservable() : initialOrObservable));
+function persistObservable(obs, persistOptions) {
     const node = state.getNode(obs);
-    if (process.env.NODE_ENV === 'development' && ((_a = obs === null || obs === void 0 ? void 0 : obs.peek()) === null || _a === void 0 ? void 0 : _a._state)) {
-        console.warn('[legend-state] WARNING: persistObservable creates a property named "_state" but your observable already has "state" in it');
-    }
     // Merge remote persist options with clobal options
     if (persistOptions.remote) {
-        persistOptions.remote = Object.assign({}, observablePersistConfiguration.remoteOptions, persistOptions.remote);
+        persistOptions.remote = Object.assign({}, observablePersistConfiguration.remoteOptions, removeNullUndefined(persistOptions.remote));
     }
     let { remote } = persistOptions;
     const { local } = persistOptions;
@@ -564,6 +617,7 @@ function persistObservable(initialOrObservable, persistOptions) {
         isLoaded: false,
         isEnabledLocal: true,
         isEnabledRemote: true,
+        refreshNum: 0,
         clearLocal: undefined,
         sync: () => Promise.resolve(),
         getPendingChanges: () => localState.pendingChanges,
@@ -594,73 +648,93 @@ function persistObservable(initialOrObservable, persistOptions) {
             var _a, _b;
             if (!isSynced) {
                 isSynced = true;
-                const dateModified = (_a = metadatas.get(obs)) === null || _a === void 0 ? void 0 : _a.modified;
+                const lastSync = (_a = metadatas.get(obs)) === null || _a === void 0 ? void 0 : _a.lastSync;
+                const pending = localState.pendingChanges;
                 const get = (_b = localState.persistenceRemote.get) === null || _b === void 0 ? void 0 : _b.bind(localState.persistenceRemote);
                 if (get) {
-                    get({
-                        state: syncState,
-                        obs,
-                        options: persistOptions,
-                        dateModified,
-                        onGet: () => {
-                            syncState.isLoaded.set(true);
-                        },
-                        onChange: async ({ value, path = [], pathTypes = [], mode = 'set', dateModified }) => {
-                            // Note: value is the constructed value, path is used for setInObservableAtPath
-                            // to start the set into the observable from the path
-                            if (value !== undefined) {
-                                value = transformLoadData(value, remote, true);
-                                if (state.isPromise(value)) {
-                                    value = await value;
-                                }
-                                const invertedMap = remote.fieldTransforms && invertFieldMap(remote.fieldTransforms);
-                                if (path.length && invertedMap) {
-                                    path = transformPath(path, pathTypes, invertedMap);
-                                }
-                                if (mode === 'dateModified') {
-                                    if (dateModified && !state.isEmpty(value)) {
+                    const runGet = () => {
+                        get({
+                            state: syncState,
+                            obs,
+                            options: persistOptions,
+                            lastSync,
+                            dateModified: lastSync,
+                            onError: (error) => {
+                                var _a;
+                                (_a = remote.onGetError) === null || _a === void 0 ? void 0 : _a.call(remote, error);
+                            },
+                            onGet: () => {
+                                node.state.assign({
+                                    isLoaded: true,
+                                    error: undefined,
+                                });
+                            },
+                            onChange: async ({ value, path = [], pathTypes = [], mode = 'set', lastSync }) => {
+                                // Note: value is the constructed value, path is used for setInObservableAtPath
+                                // to start the set into the observable from the path
+                                if (value !== undefined) {
+                                    value = transformLoadData(value, remote, true);
+                                    if (state.isPromise(value)) {
+                                        value = await value;
+                                    }
+                                    const invertedMap = remote.fieldTransforms && invertFieldMap(remote.fieldTransforms);
+                                    if (path.length && invertedMap) {
+                                        path = transformPath(path, pathTypes, invertedMap);
+                                    }
+                                    if (mode === 'lastSync' || mode === 'dateModified') {
+                                        if (lastSync && !state.isEmpty(value)) {
+                                            onChangeRemote(() => {
+                                                state.setInObservableAtPath(
+                                                // @ts-expect-error Fix this type
+                                                obs, path, pathTypes, value, 'assign');
+                                            });
+                                        }
+                                    }
+                                    else {
+                                        const pending = localState.pendingChanges;
+                                        if (pending) {
+                                            Object.keys(pending).forEach((key) => {
+                                                const p = key.split('/').filter((p) => p !== '');
+                                                const { v, t } = pending[key];
+                                                if (t.length === 0) {
+                                                    value = v;
+                                                }
+                                                else if (value[p[0]] !== undefined) {
+                                                    value = state.setAtPath(value, p, t, v, obs.peek(), (path, value) => {
+                                                        delete pending[key];
+                                                        pending[path.join('/')] = {
+                                                            p: null,
+                                                            v: value,
+                                                            t: t.slice(0, path.length),
+                                                        };
+                                                    });
+                                                }
+                                            });
+                                        }
                                         onChangeRemote(() => {
-                                            state.setInObservableAtPath(obs, path, pathTypes, value, 'assign');
+                                            // @ts-expect-error Fix this type
+                                            state.setInObservableAtPath(obs, path, pathTypes, value, mode);
                                         });
                                     }
                                 }
-                                else {
-                                    const pending = localState.pendingChanges;
-                                    if (pending) {
-                                        Object.keys(pending).forEach((key) => {
-                                            const p = key.split('/').filter((p) => p !== '');
-                                            const { v, t } = pending[key];
-                                            if (value[p[0]] !== undefined) {
-                                                value = state.setAtPath(value, p, t, v, obs.peek(), (path, value) => {
-                                                    delete pending[key];
-                                                    pending[path.join('/')] = {
-                                                        p: null,
-                                                        v: value,
-                                                        t: t.slice(0, path.length),
-                                                    };
-                                                });
-                                            }
-                                        });
-                                    }
-                                    onChangeRemote(() => {
-                                        state.setInObservableAtPath(obs, path, pathTypes, value, mode);
+                                if (lastSync && local) {
+                                    updateMetadata(obs, localState, syncState, persistOptions, {
+                                        lastSync,
                                     });
                                 }
-                            }
-                            if (dateModified && local) {
-                                updateMetadata(obs, localState, syncState, persistOptions, {
-                                    modified: dateModified,
-                                });
-                            }
-                        },
-                    });
+                            },
+                        });
+                    };
+                    runGet();
                 }
                 else {
-                    syncState.isLoaded.set(true);
+                    node.state.assign({
+                        isLoaded: true,
+                        error: undefined,
+                    });
                 }
                 // Wait for remote to be ready before saving pending
                 await state.when(() => syncState.isLoaded.get() || (remote.allowSetIfError && syncState.error.get()));
-                const pending = localState.pendingChanges;
                 if (pending && !state.isEmpty(pending)) {
                     localState.isApplyingPending = true;
                     const keys = Object.keys(pending);
@@ -673,6 +747,7 @@ function persistObservable(initialOrObservable, persistOptions) {
                         changes.push({ path, valueAtPath: v, prevAtPath: p, pathTypes: t });
                     }
                     // Send the changes into onObsChange so that they get persisted remotely
+                    // @ts-expect-error Fix this type
                     onObsChange(obs, syncState, localState, persistOptions, {
                         value: obs.peek(),
                         // TODO getPrevious if any remote persistence layers need it
@@ -708,44 +783,122 @@ function persistObservable(initialOrObservable, persistOptions) {
         }
         obs.onChange(onObsChange.bind(this, obs, syncState, localState, persistOptions));
     });
-    return obs;
+    return syncState;
 }
-globalState.activateNode = function activateNodePersist(node, newValue, setter, subscriber, cacheOptions, lastSync) {
-    let onChange = undefined;
-    const pluginRemote = {
-        get: async (params) => {
-            onChange = params.onChange;
-            if (state.isPromise(newValue)) {
-                newValue = await newValue;
+
+const { getProxy, globalState, runWithRetry, symbolActivated } = state.internal;
+function persistActivateNode() {
+    globalState.activateNode = function activateNodePersist(node, refresh, wasPromise, newValue) {
+        if (node.activationState) {
+            const { get, initial, onSet, subscribe, cache, retry, offlineBehavior } = node.activationState;
+            let onChange = undefined;
+            const pluginRemote = {};
+            if (get) {
+                pluginRemote.get = (params) => {
+                    onChange = params.onChange;
+                    const updateLastSync = (lastSync) => (params.lastSync = lastSync);
+                    const setMode = (mode) => (params.mode = mode);
+                    const nodeValue = state.getNodeValue(node);
+                    const value = runWithRetry(node, { attemptNum: 0 }, () => {
+                        return get({
+                            value: state.isFunction(nodeValue) || (nodeValue === null || nodeValue === void 0 ? void 0 : nodeValue[symbolActivated]) ? undefined : nodeValue,
+                            lastSync: params.lastSync,
+                            updateLastSync,
+                            setMode,
+                        });
+                    });
+                    return value;
+                };
+            }
+            if (onSet) {
+                // TODO: Work out these types better
+                pluginRemote.set = async (params) => {
+                    var _a;
+                    if ((_a = node.state) === null || _a === void 0 ? void 0 : _a.isLoaded.get()) {
+                        return runWithRetry(node, { attemptNum: 0 }, async () => {
+                            let changes = {};
+                            let maxModified = 0;
+                            let didError = false;
+                            if (!node.state.isLoaded.peek()) {
+                                await state.whenReady(node.state.isLoaded);
+                            }
+                            await onSet({
+                                ...params,
+                                node,
+                                update: (params) => {
+                                    const { value, lastSync } = params;
+                                    maxModified = Math.max(lastSync || 0, maxModified);
+                                    changes = state.mergeIntoObservable(changes, value);
+                                },
+                                onError: () => {
+                                    // TODO Is this necessary?
+                                    didError = true;
+                                    throw new Error();
+                                },
+                                refresh,
+                                fromSubscribe: false,
+                            });
+                            if (!didError) {
+                                return { changes, lastSync: maxModified || undefined };
+                            }
+                        });
+                    }
+                };
+            }
+            if (subscribe) {
+                subscribe({
+                    node,
+                    update: (params) => {
+                        if (!onChange) {
+                            // TODO: Make this message better
+                            console.log('[legend-state] Cannot update immediately before the first return');
+                        }
+                        else {
+                            onChange(params);
+                        }
+                    },
+                    refresh,
+                });
+            }
+            persistObservable(getProxy(node), {
+                pluginRemote,
+                ...(cache || {}),
+                remote: {
+                    retry: retry,
+                    offlineBehavior,
+                },
+            });
+            const nodeVal = state.getNodeValue(node);
+            if (nodeVal !== undefined) {
+                newValue = nodeVal;
             }
-            if (lastSync.value) {
-                params.dateModified = lastSync.value;
+            else if (newValue === undefined) {
+                newValue = initial;
             }
-            return newValue;
-        },
+            return { update: onChange, value: newValue };
+        }
+        else {
+            let onChange = undefined;
+            const pluginRemote = {
+                get: async (params) => {
+                    onChange = params.onChange;
+                    if (state.isPromise(newValue)) {
+                        try {
+                            newValue = await newValue;
+                            // eslint-disable-next-line no-empty
+                        }
+                        catch (_a) { }
+                    }
+                    return newValue;
+                },
+            };
+            persistObservable(getProxy(node), {
+                pluginRemote,
+            });
+            return { update: onChange, value: newValue };
+        }
     };
-    if (setter) {
-        pluginRemote.set = setter;
-    }
-    if (subscriber) {
-        subscriber({
-            update: (params) => {
-                if (!onChange) {
-                    // TODO: Make this message better
-                    console.log('[legend-state] Cannot update immediately before the first return');
-                }
-                else {
-                    onChange(params);
-                }
-            },
-        });
-    }
-    persistObservable(getProxy(node), {
-        pluginRemote,
-        ...(cacheOptions || {}),
-    });
-    return { update: onChange };
-};
+}
 
 function isInRemoteChange() {
     return state.internal.globalState.isLoadingRemote$.get();
@@ -753,6 +906,7 @@ function isInRemoteChange() {
 const internal = {
     observablePersistConfiguration,
 };
+persistActivateNode();
 
 exports.configureObservablePersistence = configureObservablePersistence;
 exports.internal = internal;