add a refresh function to subscribe

LegendApp · Oct 27, 2023 · 5d305c3 · 5d305c3
1 parent e873de5
commit 5d305c3
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 19 deletions.
diff --git a/src/ObservableObject.ts b/src/ObservableObject.ts
@@ -43,6 +43,7 @@ import type {
     TrackingType,
     UpdateFn,
     RetryOptions,
+    ObservablePersistStateInternal,
 } from './observableInterfaces';
 import { observe } from './observe';
 import { onChange } from './onChange';
@@ -891,6 +892,7 @@ function activateNodeFunction(node: NodeValue, lazyFn: () => void) {
     let curTarget$: ObservableObject<any>;
     const activator = (isFunction(node) ? node : lazyFn) as (value: ActivateProxyParams) => any;
     let wasPromise: Promise<any> | undefined;
+    const refresh = () => (node.state as ObservableObject<ObservablePersistStateInternal>).refreshNum.set((v) => v + 1);
     observe(
         () => {
             const params = createNodeActivationParams(node);
@@ -927,9 +929,11 @@ function activateNodeFunction(node: NodeValue, lazyFn: () => void) {
             if (!node.activated) {
                 node.activated = true;
                 const activateNodeFn = wasPromise ? globalState.activateNode : activateNodeBase;
-                activateNodeFn(node, value).update!;
+                activateNodeFn(node, refresh, value);
             }
 
+            (node.state as ObservableObject<ObservablePersistStateInternal>).refreshNum.get();
+
             return value;
         },
         ({ value }) => {
@@ -953,7 +957,7 @@ function activateNodeFunction(node: NodeValue, lazyFn: () => void) {
     );
 }
 
-const activateNodeBase = (globalState.activateNode = function activateNodeBase(node: NodeValue): { update: UpdateFn } {
+const activateNodeBase = (globalState.activateNode = function activateNodeBase(node: NodeValue, refresh: () => void) {
     const { onSetFn, subscriber } = node.activationState!;
     let isSetting = false;
     if (!node.state) {
@@ -1001,8 +1005,6 @@ const activateNodeBase = (globalState.activateNode = function activateNodeBase(n
     };
 
     if (subscriber) {
-        subscriber({ update });
+        subscriber({ update, refresh });
     }
-
-    return { update };
 });
diff --git a/src/globals.ts b/src/globals.ts
@@ -24,12 +24,7 @@ export const globalState = {
     isLoadingLocal: false,
     isMerging: false,
     isLoadingRemote$: undefined as unknown as ObservablePrimitive<boolean>,
-    activateNode: undefined as unknown as (
-        node: NodeValue,
-        newValue: any,
-    ) => {
-        update?: UpdateFn;
-    },
+    activateNode: undefined as unknown as (node: NodeValue, refresh: () => void, newValue: any) => void,
 };
 
 export function isObservable(obs: any): obs is ObservableObject {

diff --git a/src/observableInterfaces.ts b/src/observableInterfaces.ts
@@ -327,6 +327,7 @@ export interface ObservablePersistStateBase {
     isEnabledLocal: boolean;
     isEnabledRemote: boolean;
     dateModified?: number;
+    syncCount?: number;
     clearLocal: () => Promise<void>;
     sync: () => Promise<void>;
     getPendingChanges: () =>
@@ -340,6 +341,9 @@ export interface ObservablePersistStateBase {
         | undefined;
 }
 export type ObservablePersistState = ObservableState & ObservablePersistStateBase;
+export type ObservablePersistStateInternal = ObservablePersistState & {
+    refreshNum: number;
+};
 export interface WithPersistState {
     state?: ObservablePersistState; // TODOV3: remove this
     _state?: ObservablePersistState;
@@ -480,7 +484,7 @@ interface BaseNodeValue {
     activationState?: {
         onSetFn?: (value: ListenerParams<any>) => void;
         update?: UpdateFn;
-        subscriber?: (params: { update: UpdateFn }) => void;
+        subscriber?: (params: { update: UpdateFn; refresh: () => void }) => void;
         retryOptions?: RetryOptions;
         lastSync: { value?: number };
         cacheOptions?: CacheOptions;
@@ -540,7 +544,7 @@ export interface CacheOptions<T = any> {
 }
 export interface ActivateParams<T = any> {
     onSet: (fn: (params: ListenerParams<T>) => void) => void;
-    subscribe: (fn: (params: { update: (props: ObservableOnChangeParams) => void }) => void) => void;
+    subscribe: (fn: (params: { update: UpdateFn; refresh: () => void }) => void) => void;
 }
 export interface ActivateProxyParams<T = any> extends ActivateParams {
     proxy: (fn: (key: string, params: ActivateParams<T>) => T | Promise<T>) => void;

diff --git a/src/persist/persistObservable.ts b/src/persist/persistObservable.ts
@@ -15,6 +15,7 @@ import type {
     ObservablePersistRemoteSetParams,
     ObservablePersistState,
     ObservablePersistStateBase,
+    ObservablePersistStateInternal,
     ObservableReadable,
     ObservableWriteable,
     PersistMetadata,
@@ -654,11 +655,12 @@ export function persistObservable<T extends WithoutState>(
     const localState: LocalState = {};
     let sync: () => Promise<void>;
 
-    const syncState = (node.state = observable<ObservablePersistState>({
+    const syncState = (node.state = observable<ObservablePersistStateInternal>({
         isLoadedLocal: false,
         isLoaded: false,
         isEnabledLocal: true,
         isEnabledRemote: true,
+        refreshNum: 0,
         clearLocal: undefined as unknown as () => Promise<void>,
         sync: () => Promise.resolve(),
         getPendingChanges: () => localState.pendingChanges,
@@ -866,7 +868,7 @@ export function persistObservable<T extends WithoutState>(
     return obs as any;
 }
 
-globalState.activateNode = function activateNodePersist(node: NodeValue, newValue: any): { update?: UpdateFn } {
+globalState.activateNode = function activateNodePersist(node: NodeValue, refresh: () => void, newValue: any) {
     const { onSetFn, subscriber, lastSync, cacheOptions, retryOptions } = node.activationState!;
 
     let onChange: UpdateFn | undefined = undefined;
@@ -896,6 +898,7 @@ globalState.activateNode = function activateNodePersist(node: NodeValue, newValu
                     onChange(params);
                 }
             },
+            refresh,
         });
     }
     persistObservable(getProxy(node), {
@@ -905,8 +908,6 @@ globalState.activateNode = function activateNodePersist(node: NodeValue, newValu
             retry: retryOptions,
         },
     });
-
-    return { update: onChange };
 };
 
 declare module '@legendapp/state' {

diff --git a/tests/computedtests.ts b/tests/computedtests.ts
@@ -1001,7 +1001,7 @@ export const run = (isPersist: boolean) => {
         });
     });
     describe('subscribing to computeds', () => {
-        test('basic subscription', async () => {
+        test('subscription with update', async () => {
             const obs = observable(({ subscribe }: ActivateParams) => {
                 subscribe(({ update }) => {
                     setTimeout(() => {
@@ -1015,9 +1015,27 @@ export const run = (isPersist: boolean) => {
             expect(obs.get()).toEqual(undefined);
             await promiseTimeout(0);
             expect(obs.get()).toEqual('hi there');
-            await promiseTimeout(5);
+            await promiseTimeout(10);
             expect(obs.get()).toEqual('hi there again');
         });
+        test('subscription with refresh', async () => {
+            let num = 0;
+            const obs = observable(({ subscribe }: ActivateParams) => {
+                subscribe(({ refresh }) => {
+                    setTimeout(() => {
+                        refresh();
+                    }, 5);
+                });
+                return new Promise((resolve) => {
+                    setTimeout(() => resolve('hi there ' + num++), 0);
+                });
+            });
+            expect(obs.get()).toEqual(undefined);
+            await promiseTimeout(0);
+            expect(obs.get()).toEqual('hi there 0');
+            await promiseTimeout(10);
+            expect(obs.get()).toEqual('hi there 1');
+        });
     });
     describe('loading', () => {
         test('isLoaded', async () => {