Ensure the hooks which return guaranteed data don't throw if the hook is paused

Author: airhorns

packages/react/spec/useFindFirst.spec.ts

@@ -170,4 +170,16 @@ describe("useFindFirst", () => {
     rerender();
     expect(result.current[0]).toBe(beforeObject);
   });
+
+  test("doesn't issue a request if paused", async () => {
+    const { result } = renderHook(() => useFindFirst(relatedProductsApi.user, { pause: true }), {
+      wrapper: MockClientWrapper(relatedProductsApi),
+    });
+
+    expect(result.current[0].data).toBeFalsy();
+    expect(result.current[0].fetching).toBe(false);
+    expect(result.current[0].error).toBeFalsy();
+
+    expect(mockUrqlClient.executeQuery).toBeCalledTimes(0);
+  });
 });

packages/react/spec/useFindMany.spec.ts

@@ -254,4 +254,16 @@ describe("useFindMany", () => {
     rerender();
     expect(result.current[0]).toBe(beforeObject);
   });
+
+  test("doesn't issue a request if paused", async () => {
+    const { result } = renderHook(() => useFindMany(relatedProductsApi.user, { pause: true }), {
+      wrapper: MockClientWrapper(relatedProductsApi),
+    });
+
+    expect(result.current[0].data).toBeFalsy();
+    expect(result.current[0].fetching).toBe(false);
+    expect(result.current[0].error).toBeFalsy();
+
+    expect(mockUrqlClient.executeQuery).toBeCalledTimes(0);
+  });
 });

packages/react/spec/useFindOne.spec.ts

@@ -152,4 +152,16 @@ describe("useFindOne", () => {
     rerender();
     expect(result.current[0]).toBe(beforeObject);
   });
+
+  test("doesn't issue a request if paused", async () => {
+    const { result } = renderHook(() => useFindOne(relatedProductsApi.user, "123", { pause: true }), {
+      wrapper: MockClientWrapper(relatedProductsApi),
+    });
+
+    expect(result.current[0].data).toBeFalsy();
+    expect(result.current[0].fetching).toBe(false);
+    expect(result.current[0].error).toBeFalsy();
+
+    expect(mockUrqlClient.executeQuery).toBeCalledTimes(0);
+  });
 });

packages/react/src/useFindFirst.ts

@@ -66,7 +66,7 @@ export const useFindFirst = <
       }
     }
 
-    const error = ErrorWrapper.errorIfDataAbsent(rawResult, dataPath);
+    const error = ErrorWrapper.errorIfDataAbsent(rawResult, dataPath, options?.pause);
 
     return { ...rawResult, data, error };
   }, [manager, rawResult]);

packages/react/src/useFindMany.ts

@@ -64,7 +64,7 @@ export const useFindMany = <
       }
     }
 
-    const error = ErrorWrapper.errorIfDataAbsent(rawResult, dataPath);
+    const error = ErrorWrapper.errorIfDataAbsent(rawResult, dataPath, options?.pause);
 
     return { ...rawResult, data, error };
   }, [manager, rawResult]);

packages/react/src/useFindOne.ts

@@ -61,7 +61,7 @@ export const useFindOne = <
     if (data) {
       data = hydrateRecord(rawResult, data);
     }
-    const error = ErrorWrapper.errorIfDataAbsent(rawResult, dataPath);
+    const error = ErrorWrapper.errorIfDataAbsent(rawResult, dataPath, options?.pause);
 
     return { ...rawResult, data, error };
   }, [rawResult, manager]);

packages/react/src/utils.ts

@@ -180,10 +180,10 @@ export class ErrorWrapper extends Error {
     });
   }
   /** @private */
-  static errorIfDataAbsent(result: UseQueryState<any>, dataPath: string[]) {
+  static errorIfDataAbsent(result: UseQueryState<any>, dataPath: string[], paused = false) {
     const nonNullableError = getNonNullableError(result, dataPath);
     let error = ErrorWrapper.forMaybeCombinedError(result.error);
-    if (!error && nonNullableError) {
+    if (!error && nonNullableError && !paused) {
       error = ErrorWrapper.forClientSideError(nonNullableError);
     }
     return error;