fix(query): 🐞 support throwOnError

throwOnError true calls observer.error now ✅ Closes: #180
ngneat · May 26, 2024 · c232b47 · c232b47
1 parent 39bc985
commit c232b47
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 10 deletions.
diff --git a/query/src/lib/base-query.ts b/query/src/lib/base-query.ts
@@ -12,6 +12,7 @@ import {
 } from '@tanstack/query-core';
 import { Observable, shareReplay } from 'rxjs';
 import { normalizeOptions } from './query-options';
+import { shouldThrowError } from './utils';
 
 export type QueryFunctionWithObservable<
   T = unknown,
@@ -121,11 +122,22 @@ export function createBaseQuery<
 
     const queryObserverDispose = queryObserver.subscribe(
       notifyManager.batchCalls((result) => {
-        observer.next(
-          defaultedOptions.notifyOnChangeProps
-            ? result
-            : queryObserver?.trackResult(result),
-        );
+        if (
+          !result.isFetching &&
+          result.isError &&
+          shouldThrowError(queryObserver!.options.throwOnError, [
+            result.error,
+            queryObserver!.getCurrentQuery(),
+          ])
+        ) {
+          observer.error(result.error);
+        } else {
+          observer.next(
+            defaultedOptions.notifyOnChangeProps
+              ? result
+              : queryObserver?.trackResult(result),
+          );
+        }
       }),
     );
 

diff --git a/query/src/lib/mutation.ts b/query/src/lib/mutation.ts
@@ -10,7 +10,7 @@ import {
 } from '@tanstack/query-core';
 import { isObservable, Observable, shareReplay } from 'rxjs';
 import { toSignal } from '@angular/core/rxjs-interop';
-import { toPromise } from './utils';
+import { shouldThrowError, toPromise } from './utils';
 
 export type CreateMutationOptions<
   TData = unknown,
@@ -89,7 +89,18 @@ class Mutation {
         notifyManager.batchCalls(
           (
             result: MutationObserverResult<TData, TError, TVariables, TContext>,
-          ) => observer.next(result),
+          ) => {
+            if (
+              result.isError &&
+              shouldThrowError(mutationObserver!.options.throwOnError, [
+                result.error,
+              ])
+            ) {
+              observer.error(result.error);
+            } else {
+              observer.next(result);
+            }
+          },
         ),
       );
 

diff --git a/query/src/lib/utils.ts b/query/src/lib/utils.ts
@@ -1,7 +1,7 @@
 import {
   DefaultError,
   QueryObserverResult,
-  QueryObserverSuccessResult
+  QueryObserverSuccessResult,
 } from '@tanstack/query-core';
 import { Observable, Subject, firstValueFrom, takeUntil } from 'rxjs';
 
@@ -38,7 +38,10 @@ export function createSuccessObserverResult<T, Error = DefaultError>(
   } as QueryObserverSuccessResult<T, Error>;
 }
 
-export function createPendingObserverResult<T = unknown, Error = DefaultError>(): QueryObserverResult<T, Error> {
+export function createPendingObserverResult<
+  T = unknown,
+  Error = DefaultError,
+>(): QueryObserverResult<T, Error> {
   return {
     isError: false,
     isLoading: true,
@@ -49,3 +52,14 @@ export function createPendingObserverResult<T = unknown, Error = DefaultError>()
     status: 'pending',
   } as QueryObserverResult<T, Error>;
 }
+
+export function shouldThrowError<T extends (...args: Array<any>) => boolean>(
+  throwError: boolean | T | undefined,
+  params: Parameters<T>,
+): boolean {
+  if (typeof throwError === 'function') {
+    return throwError(...params);
+  }
+
+  return !!throwError;
+}
diff --git a/src/app/app.config.ts b/src/app/app.config.ts
@@ -1,5 +1,5 @@
 import { provideHttpClient } from '@angular/common/http';
-import { ApplicationConfig, inject } from '@angular/core';
+import { ApplicationConfig, ErrorHandler, inject } from '@angular/core';
 import { provideRouter, withComponentInputBinding } from '@angular/router';
 
 import {
@@ -22,8 +22,15 @@ const withFunctionaFactory: QueryClientConfigFn = () => {
   };
 };
 
+class MyErrorHandler extends ErrorHandler {
+  override handleError(error: any) {
+    return super.handleError(error);
+  }
+}
+
 export const appConfig: ApplicationConfig = {
   providers: [
+    { provide: ErrorHandler, useClass: MyErrorHandler },
     provideRouter(appRoutes, withComponentInputBinding()),
     provideHttpClient(),
     provideQueryClientOptions(withFunctionaFactory),