add extras to onSet, move persistence upgrading node activation to be…

… run from persist.ts
LegendApp · Oct 28, 2023 · efc3261 · efc3261
1 parent 96d4c8a
commit efc3261
Show file tree

Hide file tree

Showing 5 changed files with 114 additions and 77 deletions.
diff --git a/persist.ts b/persist.ts
@@ -14,3 +14,6 @@ export const internal: {
 } = {
     observablePersistConfiguration,
 };
+
+import { persistActivateNode } from './src/persist/persistActivateNode';
+persistActivateNode();
diff --git a/src/ObservableObject.ts b/src/ObservableObject.ts
@@ -44,6 +44,8 @@ import type {
     UpdateFn,
     RetryOptions,
     ObservablePersistStateInternal,
+    OnSetExtra,
+    SubscribeOptions,
 } from './observableInterfaces';
 import { observe } from './observe';
 import { onChange } from './onChange';
@@ -888,6 +890,7 @@ function createNodeActivationParams(node: NodeValue): ActivateProxyParams {
         retry,
         subscribe,
         updateLastSync,
+        obs$: getProxy(node),
     };
 }
 
@@ -989,7 +992,7 @@ const activateNodeBase = (globalState.activateNode = function activateNodeBase(
                 ) {
                     isSetting = true;
                     batch(
-                        () => onSetFn(params),
+                        () => onSetFn(params, { update } as OnSetExtra),
                         () => {
                             isSetting = false;
                         },
@@ -1017,7 +1020,7 @@ const activateNodeBase = (globalState.activateNode = function activateNodeBase(
     };
 
     if (subscriber) {
-        subscriber({ update, refresh });
+        subscriber({ update, refresh } as SubscribeOptions);
     }
 
     return { update };

diff --git a/src/observableInterfaces.ts b/src/observableInterfaces.ts
@@ -482,9 +482,9 @@ interface BaseNodeValue {
     activated?: boolean;
     proxyFn2?: (key: string, params: ActivateParams) => any;
     activationState?: {
-        onSetFn?: (value: ListenerParams<any>) => void;
+        onSetFn?: (value: ListenerParams<any>, extra: OnSetExtra) => void;
         update?: UpdateFn;
-        subscriber?: (params: { update: UpdateFn; refresh: () => void }) => void;
+        subscriber?: (params: SubscribeOptions) => void;
         retryOptions?: RetryOptions;
         lastSync: { value?: number };
         cacheOptions?: CacheOptions;
@@ -543,7 +543,8 @@ export interface CacheOptions<T = any> {
     pluginLocal?: ClassConstructor<ObservablePersistLocal, T[]>;
 }
 export interface ActivateParams<T = any> {
-    onSet: (fn: (params: ListenerParams<T>) => void) => void;
+    obs$: Observable<T>;
+    onSet: (fn: (params: ListenerParams<T>, extra: OnSetExtra) => void) => void;
     subscribe: (fn: (params: { update: UpdateFn; refresh: () => void }) => void) => void;
 }
 export interface ActivateProxyParams<T = any> extends ActivateParams {
@@ -557,3 +558,10 @@ export interface RetryOptions {
     backoff?: 'constant' | 'exponential';
     maxDelay?: number;
 }
+export interface OnSetExtra {
+    update: UpdateFn;
+}
+export interface SubscribeOptions {
+    update: UpdateFn;
+    refresh: () => void;
+}
diff --git a/src/persist/persistActivateNode.ts b/src/persist/persistActivateNode.ts
@@ -0,0 +1,93 @@
+import type {
+    CacheOptions,
+    ListenerParams,
+    NodeValue,
+    ObservableOnChangeParams,
+    ObservablePersistRemoteFunctions,
+    ObservablePersistRemoteGetParams,
+    ObservablePersistRemoteSetParams,
+    ObservablePersistStateBase,
+    RetryOptions,
+    UpdateFn,
+} from '@legendapp/state';
+import { internal, isPromise } from '@legendapp/state';
+import { onChangeRemote, persistObservable } from './persistObservable';
+const { getProxy, globalState } = internal;
+
+export function persistActivateNode() {
+    globalState.activateNode = function activateNodePersist(
+        node: NodeValue,
+        refresh: () => void,
+        wasPromise: boolean,
+        newValue: any,
+    ) {
+        const { onSetFn, subscriber, lastSync, cacheOptions, retryOptions } = node.activationState!;
+
+        let onChange: UpdateFn | undefined = undefined;
+        const pluginRemote: ObservablePersistRemoteFunctions = {
+            get: async (params: ObservablePersistRemoteGetParams<any>) => {
+                onChange = params.onChange;
+                if (isPromise(newValue)) {
+                    newValue = await newValue;
+                }
+                if (lastSync.value) {
+                    params.dateModified = lastSync.value;
+                }
+                return newValue;
+            },
+        };
+        if (onSetFn) {
+            // TODO: Work out these types better
+            pluginRemote.set = (params: ObservablePersistRemoteSetParams<any>) => {
+                if (node.state?.isLoaded.get()) {
+                    onSetFn(params as unknown as ListenerParams, {
+                        update: onChange as UpdateFn,
+                        updateLastSync: () => {
+                            console.log('TODO updateLastSync');
+                        },
+                        applyRemoteChange: onChangeRemote,
+                    });
+                }
+            };
+        }
+        if (subscriber) {
+            subscriber({
+                update: (params: ObservableOnChangeParams) => {
+                    if (!onChange) {
+                        // TODO: Make this message better
+                        console.log('[legend-state] Cannot update immediately before the first return');
+                    } else {
+                        onChange(params);
+                    }
+                },
+                refresh,
+                applyRemoteChange: onChangeRemote,
+            });
+        }
+        persistObservable(getProxy(node), {
+            pluginRemote,
+            ...(cacheOptions || {}),
+            remote: {
+                retry: retryOptions,
+            },
+        });
+
+        return { update: onChange! };
+    };
+}
+declare module '@legendapp/state' {
+    interface ActivateParams<T> {
+        cache: (cacheOptions: CacheOptions<T> | (() => CacheOptions<T>)) => void;
+        updateLastSync: (lastSync: number) => void;
+        retry: (options: RetryOptions) => void;
+    }
+    interface OnSetExtra {
+        updateLastSync: (lastSync: number) => void;
+        applyRemoteChange: (fn: () => void) => void;
+    }
+    interface SubscribeOptions {
+        applyRemoteChange: (fn: () => void) => void;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-empty-interface
+    interface ObservableState extends ObservablePersistStateBase {}
+}
diff --git a/src/persist/persistObservable.ts b/src/persist/persistObservable.ts
@@ -1,20 +1,15 @@
 import type {
-    CacheOptions,
     Change,
     ClassConstructor,
     FieldTransforms,
     ListenerParams,
     NodeValue,
     Observable,
     ObservableObject,
-    ObservableOnChangeParams,
     ObservablePersistLocal,
     ObservablePersistRemoteClass,
     ObservablePersistRemoteFunctions,
-    ObservablePersistRemoteGetParams,
-    ObservablePersistRemoteSetParams,
     ObservablePersistState,
-    ObservablePersistStateBase,
     ObservablePersistStateInternal,
     ObservableReadable,
     ObservableWriteable,
@@ -24,9 +19,7 @@ import type {
     PersistOptionsRemote,
     PersistTransform,
     Primitive,
-    RetryOptions,
     TypeAtPath,
-    UpdateFn,
     WithPersistState,
 } from '@legendapp/state';
 import {
@@ -50,7 +43,7 @@ import {
 import { observablePersistConfiguration } from './configureObservablePersistence';
 import { invertFieldMap, transformObject, transformObjectWithPath, transformPath } from './fieldTransformer';
 import { observablePersistRemoteFunctionsAdapter } from './observablePersistRemoteFunctionsAdapter';
-const { getProxy, globalState } = internal;
+const { globalState } = internal;
 
 export const mapPersistences: WeakMap<
     ClassConstructor<ObservablePersistLocal | ObservablePersistRemoteClass>,
@@ -88,7 +81,7 @@ function doInOrder<T>(arg1: T | Promise<T>, arg2: (value: T) => void): any {
     return isPromise(arg1) ? arg1.then(arg2) : arg2(arg1);
 }
 
-function onChangeRemote(cb: () => void) {
+export function onChangeRemote(cb: () => void) {
     when(
         () => !globalState.isLoadingRemote$.get(),
         () => {
@@ -867,66 +860,3 @@ export function persistObservable<T extends WithoutState>(
 
     return obs as any;
 }
-
-globalState.activateNode = function activateNodePersist(
-    node: NodeValue,
-    refresh: () => void,
-    wasPromise: boolean,
-    newValue: any,
-) {
-    const { onSetFn, subscriber, lastSync, cacheOptions, retryOptions } = node.activationState!;
-
-    let onChange: UpdateFn | undefined = undefined;
-    const pluginRemote: ObservablePersistRemoteFunctions = {
-        get: async (params: ObservablePersistRemoteGetParams<any>) => {
-            onChange = params.onChange;
-            if (isPromise(newValue)) {
-                newValue = await newValue;
-            }
-            if (lastSync.value) {
-                params.dateModified = lastSync.value;
-            }
-            return newValue;
-        },
-    };
-    if (onSetFn) {
-        // TODO: Work out these types better
-        pluginRemote.set = (params: ObservablePersistRemoteSetParams<any>) => {
-            if (node.state?.isLoaded.get()) {
-                onSetFn(params as unknown as ListenerParams);
-            }
-        };
-    }
-    if (subscriber) {
-        subscriber({
-            update: (params: ObservableOnChangeParams) => {
-                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,
-        ...(cacheOptions || {}),
-        remote: {
-            retry: retryOptions,
-        },
-    });
-
-    return { update: onChange! };
-};
-
-declare module '@legendapp/state' {
-    interface ActivateParams<T> {
-        cache: (cacheOptions: CacheOptions<T> | (() => CacheOptions<T>)) => void;
-        updateLastSync: (lastSync: number) => void;
-        retry: (options: RetryOptions) => void;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-empty-interface
-    interface ObservableState extends ObservablePersistStateBase {}
-}