refactor: rename ObservablePersistState properties isLoadedRemote to …

…isLoaded and remoteError to error
LegendApp · Oct 8, 2023 · 1cccb4a · 1cccb4a
1 parent 8b40318
commit 1cccb4a
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 15 deletions.
diff --git a/src/observableInterfaces.ts b/src/observableInterfaces.ts
@@ -295,10 +295,10 @@ export interface ObservablePersistRemoteFunctions<T = any, TState = {}> {
 
 export interface ObservablePersistState {
     isLoadedLocal: boolean;
-    isLoadedRemote: boolean;
+    isLoaded: boolean;
     isEnabledLocal: boolean;
     isEnabledRemote: boolean;
-    remoteError?: Error;
+    error?: Error;
     dateModified?: number;
     clearLocal: () => Promise<void>;
     sync: () => Promise<void>;

diff --git a/src/persist-plugins/firebase.ts b/src/persist-plugins/firebase.ts
@@ -353,7 +353,7 @@ class ObservablePersistFirebaseBase implements ObservablePersistRemoteClass {
                         onLoadParams,
                         status$,
                     });
-                    params.state.remoteError.set(err);
+                    params.state.error.set(err);
                     onLoadError?.(err);
                     if (allowSetIfError) {
                         status$.numWaitingCanSave.set((v) => v - 1);
@@ -740,7 +740,7 @@ class ObservablePersistFirebaseBase implements ObservablePersistRemoteClass {
 
         // If this path previously errored, clear the error state
         const obs = params.obs;
-        params.state.remoteError.delete();
+        params.state.error.delete();
         this.listenErrors.delete(obs);
 
         status$.startedLoading.set(true);

diff --git a/src/persist/persistObservable.ts b/src/persist/persistObservable.ts
@@ -409,9 +409,7 @@ async function doChange(
 
     if (changesRemote.length > 0) {
         // Wait for remote to be ready before saving
-        await when(
-            () => syncState.isLoadedRemote.get() || (configRemote?.allowSetIfError && syncState.remoteError.get()),
-        );
+        await when(() => syncState.isLoaded.get() || (configRemote?.allowSetIfError && syncState.error.get()));
 
         const value = obs.peek();
 
@@ -639,7 +637,7 @@ export function persistObservable<T, TState = {}>(
 
     const syncState = observable<ObservablePersistState>({
         isLoadedLocal: false,
-        isLoadedRemote: false,
+        isLoaded: false,
         isEnabledLocal: true,
         isEnabledRemote: true,
         clearLocal: undefined as unknown as () => Promise<void>,
@@ -684,7 +682,7 @@ export function persistObservable<T, TState = {}>(
                     options: persistOptions as PersistOptions<T, any>,
                     dateModified,
                     onGet: () => {
-                        syncState.isLoadedRemote.set(true);
+                        syncState.isLoaded.set(true);
                     },
                     onChange: async ({ value, path = [], pathTypes = [], mode = 'set', dateModified }) => {
                         // Note: value is the constructed value, path is used for setInObservableAtPath
@@ -748,9 +746,7 @@ export function persistObservable<T, TState = {}>(
                 });
 
                 // Wait for remote to be ready before saving pending
-                await when(
-                    () => syncState.isLoadedRemote.get() || (remote.allowSetIfError && syncState.remoteError.get()),
-                );
+                await when(() => syncState.isLoaded.get() || (remote.allowSetIfError && syncState.error.get()));
 
                 const pending = localState.pendingChanges;
                 if (pending && !isEmpty(pending)) {

diff --git a/tests/persist-remote-fn.test.ts b/tests/persist-remote-fn.test.ts
@@ -26,7 +26,7 @@ describe('Persist remote with functions', () => {
 
         expect(obs.peek()).toEqual({ test: { x: 'hi' } });
 
-        await when(state.isLoadedRemote);
+        await when(state.isLoaded);
 
         expect(obs.peek()).toEqual({ test: { x: 'hello' } });
     });
@@ -58,7 +58,7 @@ describe('Persist remote with functions', () => {
 
         expect(obs$.peek()).toEqual({ test: { x: 'hi' } });
 
-        await when(state.isLoadedRemote);
+        await when(state.isLoaded);
 
         expect(obs$.peek()).toEqual({ test: { x: 'hello' } });
 
@@ -102,7 +102,7 @@ describe('Persist remote with functions', () => {
 
         expect(obs$.peek()).toEqual({ test: { x: 'hi' } });
 
-        await when(state.isLoadedRemote);
+        await when(state.isLoaded);
 
         expect(obs$.peek()).toEqual({ test: { x: 'hello' } });