Refactor retry error handling

LegendApp · Aug 25, 2024 · d6b75fb · d6b75fb
1 parent 775e86c
commit d6b75fb
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 13 deletions.
diff --git a/src/sync-plugins/keel.ts b/src/sync-plugins/keel.ts
@@ -82,7 +82,10 @@ export interface SyncedKeelConfiguration
         | 'generateId'
     > {
     client: {
-        auth: { refresh: () => Promise<boolean>; isAuthenticated: () => Promise<boolean> };
+        auth: {
+            refresh: () => Promise<APIResult<boolean>>;
+            isAuthenticated: () => Promise<APIResult<boolean>>;
+        };
         api: { queries: Record<string, (i: any) => Promise<any>> };
     };
     realtimePlugin?: KeelRealtimePlugin;
@@ -454,11 +457,11 @@ export function syncedKeel<
                 params.cancelRetry = true;
             }
 
-            throw new Error(error.message);
+            throw new Error(error.message, { cause: { input } });
         } else {
             await handleApiError(error);
 
-            throw new Error(error.message);
+            throw new Error(error.message, { cause: { input } });
         }
     };
 

diff --git a/src/sync/retry.ts b/src/sync/retry.ts
@@ -57,7 +57,7 @@ export function runWithRetry<T>(
 
                             if (timeout === false) {
                                 state.cancelRetry = true;
-                                reject();
+                                reject(error);
                             } else {
                                 mapRetryTimeouts.set(state.node, timeout);
                                 timeoutRetry = timeout;

diff --git a/src/sync/syncObservable.ts b/src/sync/syncObservable.ts
@@ -42,9 +42,11 @@ import type {
     SyncTransform,
     SyncTransformMethod,
     Synced,
+    SyncedErrorParams,
     SyncedGetParams,
     SyncedOptions,
     SyncedSetParams,
+    SyncedSubscribeParams,
 } from './syncTypes';
 import { runWithRetry } from './retry';
 
@@ -629,7 +631,11 @@ async function doChangeRemote(changeInfo: PreppedChangeRemote | undefined) {
 
         const onError = (error: Error) => {
             state$.error.set(error);
-            syncOptions.onSetError?.(error, setParams as SyncedSetParams<any>);
+            syncOptions.onSetError?.(error, {
+                setParams: setParams as SyncedSetParams<any>,
+                source: 'set',
+                value$: obs$,
+            });
         };
 
         const setParams: SyncedSetParams<any> = {
@@ -906,9 +912,9 @@ export function syncObservable<T>(
     allSyncStates.set(syncState$, node);
     syncStateValue.getPendingChanges = () => localState.pendingChanges;
 
-    const onGetError = (error: Error, getParams: SyncedGetParams<T> | undefined, source: 'get' | 'subscribe') => {
+    const onGetError = (error: Error, params: Omit<SyncedErrorParams, 'value$'>) => {
         syncState$.error.set(error);
-        syncOptions.onGetError?.(error, getParams, source);
+        syncOptions.onGetError?.(error, { ...params, value$: obs$ });
     };
 
     loadLocal(obs$, syncOptions, syncState$, localState);
@@ -1076,7 +1082,7 @@ export function syncObservable<T>(
                         const subscribe = syncOptions.subscribe;
                         isSubscribed = true;
                         const doSubscribe = () => {
-                            unsubscribe = subscribe({
+                            const subscribeParams: SyncedSubscribeParams<T> = {
                                 node,
                                 value$: obs$,
                                 lastSync,
@@ -1089,8 +1095,9 @@ export function syncObservable<T>(
                                     });
                                 },
                                 refresh: () => when(syncState$.isLoaded, sync),
-                                onError: (error) => onGetError(error, undefined, 'subscribe'),
-                            });
+                                onError: (error: Error) => onGetError(error, { source: 'subscribe', subscribeParams }),
+                            };
+                            unsubscribe = subscribe(subscribeParams);
                         };
 
                         if (waitFor) {
@@ -1101,7 +1108,7 @@ export function syncObservable<T>(
                     }
                     const existingValue = getNodeValue(node);
 
-                    const onError = (error: Error) => onGetError(error, getParams as SyncedGetParams<T>, 'get');
+                    const onError = (error: Error) => onGetError(error, { getParams, source: 'get' });
 
                     const getParams: SyncedGetParams<T> = {
                         node,

diff --git a/src/sync/syncTypes.ts b/src/sync/syncTypes.ts
@@ -66,6 +66,14 @@ export interface SyncedSubscribeParams<T = any> extends SyncedGetSetSubscribeBas
     onError: (error: Error) => void;
 }
 
+export interface SyncedErrorParams {
+    getParams?: SyncedGetParams<any>;
+    setParams?: SyncedSetParams<any>;
+    subscribeParams?: SyncedSubscribeParams<any>;
+    source: 'get' | 'set' | 'subscribe';
+    value$: ObservableParam<any>;
+}
+
 export interface SyncedOptions<TRemote = any, TLocal = TRemote> extends Omit<LinkedOptions<TRemote>, 'get' | 'set'> {
     get?: (params: SyncedGetParams<TRemote>) => Promise<TRemote> | TRemote;
     set?: (params: SyncedSetParams<TRemote>) => void | Promise<any>;
@@ -76,8 +84,8 @@ export interface SyncedOptions<TRemote = any, TLocal = TRemote> extends Omit<Lin
     syncMode?: 'auto' | 'manual';
     mode?: GetMode;
     transform?: SyncTransform<TLocal, TRemote>;
-    onGetError?: (error: Error, getParams: SyncedGetParams<TRemote> | undefined, source: 'get' | 'subscribe') => void;
-    onSetError?: (error: Error, setParams: SyncedSetParams<TRemote>) => void;
+    onGetError?: (error: Error, params: SyncedErrorParams) => void;
+    onSetError?: (error: Error, params: SyncedErrorParams) => void;
     onBeforeGet?: (params: {
         value: TRemote;
         lastSync: number | undefined;