@tanstack/solid-query 5.30.0 → 5.30.2

package/build/dev.cjs

@@ -51,14 +51,30 @@ exports.useIsRestoring = () => solidJs.useContext(IsRestoringContext);
 exports.IsRestoringProvider = IsRestoringContext.Provider;
 
 // src/createBaseQuery.ts
-function reconcileFn(store$1, result, reconcileOption) {
+function reconcileFn(store$1, result, reconcileOption, queryHash) {
   if (reconcileOption === false)
     return result;
   if (typeof reconcileOption === "function") {
     const newData2 = reconcileOption(store$1.data, result.data);
     return { ...result, data: newData2 };
   }
-  const newData = store.reconcile(result.data, { key: reconcileOption })(store$1.data);
+  let data = result.data;
+  if (store$1.data === void 0) {
+    try {
+      data = structuredClone(data);
+    } catch (error) {
+      {
+        if (error instanceof Error) {
+          console.warn(
+            `Unable to correctly reconcile data for query key: ${queryHash}. Possibly because the query data contains data structures that aren't supported by the 'structuredClone' algorithm. Consider using a callback function instead to manage the reconciliation manually.
+
+ Error Received: ${error.name} - ${error.message}`
+          );
+        }
+      }
+    }
+  }
+  const newData = store.reconcile(data, { key: reconcileOption })(store$1.data);
   return { ...result, data: newData };
 }
 var hydratableObserverResult = (query, result) => {
@@ -133,12 +149,14 @@ function createBaseQuery(options, Observer, queryClient) {
     });
   };
   function setStateWithReconciliation(res) {
-    const reconcileOptions = observer().options.reconcile;
+    const opts = observer().options;
+    const reconcileOptions = opts.reconcile;
     setState((store) => {
       return reconcileFn(
         store,
         res,
-        reconcileOptions === void 0 ? false : reconcileOptions
+        reconcileOptions === void 0 ? false : reconcileOptions,
+        opts.queryHash
       );
     });
   }
@@ -165,12 +183,18 @@ function createBaseQuery(options, Observer, queryClient) {
           unsubscribe = createClientSubscriber();
         }
         obs.updateResult();
+        if (observerResult.isError && !observerResult.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
+          observerResult.error,
+          obs.getCurrentQuery()
+        ])) {
+          setStateWithReconciliation(observerResult);
+          return reject(observerResult.error);
+        }
         if (!observerResult.isLoading) {
           const query = obs.getCurrentQuery();
-          resolve(hydratableObserverResult(query, observerResult));
-        } else {
-          setStateWithReconciliation(observerResult);
+          return resolve(hydratableObserverResult(query, observerResult));
         }
+        setStateWithReconciliation(observerResult);
       });
     },
     {
@@ -205,7 +229,7 @@ function createBaseQuery(options, Observer, queryClient) {
           newOptions.refetchOnMount = false;
         }
         observer().setOptions(newOptions);
-        setState(observer().getOptimisticResult(newOptions));
+        setStateWithReconciliation(observer().getOptimisticResult(newOptions));
         unsubscribe = createClientSubscriber();
       }
     }
@@ -257,25 +281,10 @@ function createBaseQuery(options, Observer, queryClient) {
       { defer: true }
     )
   );
-  solidJs.createComputed(
-    solidJs.on(
-      () => state.status,
-      () => {
-        const obs = observer();
-        if (state.isError && !state.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
-          state.error,
-          obs.getCurrentQuery()
-        ])) {
-          throw state.error;
-        }
-      }
-    )
-  );
   const handler = {
     get(target, prop) {
       if (prop === "data") {
-        const opts = observer().options;
-        if (opts.placeholderData) {
+        if (state.data !== void 0) {
           return queryResource.latest?.data;
         }
         return queryResource()?.data;

package/build/dev.js

@@ -50,14 +50,30 @@ var useIsRestoring = () => useContext(IsRestoringContext);
 var IsRestoringProvider = IsRestoringContext.Provider;
 
 // src/createBaseQuery.ts
-function reconcileFn(store, result, reconcileOption) {
+function reconcileFn(store, result, reconcileOption, queryHash) {
   if (reconcileOption === false)
     return result;
   if (typeof reconcileOption === "function") {
     const newData2 = reconcileOption(store.data, result.data);
     return { ...result, data: newData2 };
   }
-  const newData = reconcile(result.data, { key: reconcileOption })(store.data);
+  let data = result.data;
+  if (store.data === void 0) {
+    try {
+      data = structuredClone(data);
+    } catch (error) {
+      {
+        if (error instanceof Error) {
+          console.warn(
+            `Unable to correctly reconcile data for query key: ${queryHash}. Possibly because the query data contains data structures that aren't supported by the 'structuredClone' algorithm. Consider using a callback function instead to manage the reconciliation manually.
+
+ Error Received: ${error.name} - ${error.message}`
+          );
+        }
+      }
+    }
+  }
+  const newData = reconcile(data, { key: reconcileOption })(store.data);
   return { ...result, data: newData };
 }
 var hydratableObserverResult = (query, result) => {
@@ -132,12 +148,14 @@ function createBaseQuery(options, Observer, queryClient) {
     });
   };
   function setStateWithReconciliation(res) {
-    const reconcileOptions = observer().options.reconcile;
+    const opts = observer().options;
+    const reconcileOptions = opts.reconcile;
     setState((store) => {
       return reconcileFn(
         store,
         res,
-        reconcileOptions === void 0 ? false : reconcileOptions
+        reconcileOptions === void 0 ? false : reconcileOptions,
+        opts.queryHash
       );
     });
   }
@@ -164,12 +182,18 @@ function createBaseQuery(options, Observer, queryClient) {
           unsubscribe = createClientSubscriber();
         }
         obs.updateResult();
+        if (observerResult.isError && !observerResult.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
+          observerResult.error,
+          obs.getCurrentQuery()
+        ])) {
+          setStateWithReconciliation(observerResult);
+          return reject(observerResult.error);
+        }
         if (!observerResult.isLoading) {
           const query = obs.getCurrentQuery();
-          resolve(hydratableObserverResult(query, observerResult));
-        } else {
-          setStateWithReconciliation(observerResult);
+          return resolve(hydratableObserverResult(query, observerResult));
         }
+        setStateWithReconciliation(observerResult);
       });
     },
     {
@@ -204,7 +228,7 @@ function createBaseQuery(options, Observer, queryClient) {
           newOptions.refetchOnMount = false;
         }
         observer().setOptions(newOptions);
-        setState(observer().getOptimisticResult(newOptions));
+        setStateWithReconciliation(observer().getOptimisticResult(newOptions));
         unsubscribe = createClientSubscriber();
       }
     }
@@ -256,25 +280,10 @@ function createBaseQuery(options, Observer, queryClient) {
       { defer: true }
     )
   );
-  createComputed(
-    on(
-      () => state.status,
-      () => {
-        const obs = observer();
-        if (state.isError && !state.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
-          state.error,
-          obs.getCurrentQuery()
-        ])) {
-          throw state.error;
-        }
-      }
-    )
-  );
   const handler = {
     get(target, prop) {
       if (prop === "data") {
-        const opts = observer().options;
-        if (opts.placeholderData) {
+        if (state.data !== void 0) {
           return queryResource.latest?.data;
         }
         return queryResource()?.data;

package/build/index.cjs

@@ -51,14 +51,21 @@ exports.useIsRestoring = () => solidJs.useContext(IsRestoringContext);
 exports.IsRestoringProvider = IsRestoringContext.Provider;
 
 // src/createBaseQuery.ts
-function reconcileFn(store$1, result, reconcileOption) {
+function reconcileFn(store$1, result, reconcileOption, queryHash) {
   if (reconcileOption === false)
     return result;
   if (typeof reconcileOption === "function") {
     const newData2 = reconcileOption(store$1.data, result.data);
     return { ...result, data: newData2 };
   }
-  const newData = store.reconcile(result.data, { key: reconcileOption })(store$1.data);
+  let data = result.data;
+  if (store$1.data === void 0) {
+    try {
+      data = structuredClone(data);
+    } catch (error) {
+    }
+  }
+  const newData = store.reconcile(data, { key: reconcileOption })(store$1.data);
   return { ...result, data: newData };
 }
 var hydratableObserverResult = (query, result) => {
@@ -133,12 +140,14 @@ function createBaseQuery(options, Observer, queryClient) {
     });
   };
   function setStateWithReconciliation(res) {
-    const reconcileOptions = observer().options.reconcile;
+    const opts = observer().options;
+    const reconcileOptions = opts.reconcile;
     setState((store) => {
       return reconcileFn(
         store,
         res,
-        reconcileOptions === void 0 ? false : reconcileOptions
+        reconcileOptions === void 0 ? false : reconcileOptions,
+        opts.queryHash
       );
     });
   }
@@ -165,12 +174,18 @@ function createBaseQuery(options, Observer, queryClient) {
           unsubscribe = createClientSubscriber();
         }
         obs.updateResult();
+        if (observerResult.isError && !observerResult.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
+          observerResult.error,
+          obs.getCurrentQuery()
+        ])) {
+          setStateWithReconciliation(observerResult);
+          return reject(observerResult.error);
+        }
         if (!observerResult.isLoading) {
           const query = obs.getCurrentQuery();
-          resolve(hydratableObserverResult(query, observerResult));
-        } else {
-          setStateWithReconciliation(observerResult);
+          return resolve(hydratableObserverResult(query, observerResult));
         }
+        setStateWithReconciliation(observerResult);
       });
     },
     {
@@ -205,7 +220,7 @@ function createBaseQuery(options, Observer, queryClient) {
           newOptions.refetchOnMount = false;
         }
         observer().setOptions(newOptions);
-        setState(observer().getOptimisticResult(newOptions));
+        setStateWithReconciliation(observer().getOptimisticResult(newOptions));
         unsubscribe = createClientSubscriber();
       }
     }
@@ -257,25 +272,10 @@ function createBaseQuery(options, Observer, queryClient) {
       { defer: true }
     )
   );
-  solidJs.createComputed(
-    solidJs.on(
-      () => state.status,
-      () => {
-        const obs = observer();
-        if (state.isError && !state.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
-          state.error,
-          obs.getCurrentQuery()
-        ])) {
-          throw state.error;
-        }
-      }
-    )
-  );
   const handler = {
     get(target, prop) {
       if (prop === "data") {
-        const opts = observer().options;
-        if (opts.placeholderData) {
+        if (state.data !== void 0) {
           return queryResource.latest?.data;
         }
         return queryResource()?.data;

package/build/index.js

@@ -50,14 +50,21 @@ var useIsRestoring = () => useContext(IsRestoringContext);
 var IsRestoringProvider = IsRestoringContext.Provider;
 
 // src/createBaseQuery.ts
-function reconcileFn(store, result, reconcileOption) {
+function reconcileFn(store, result, reconcileOption, queryHash) {
   if (reconcileOption === false)
     return result;
   if (typeof reconcileOption === "function") {
     const newData2 = reconcileOption(store.data, result.data);
     return { ...result, data: newData2 };
   }
-  const newData = reconcile(result.data, { key: reconcileOption })(store.data);
+  let data = result.data;
+  if (store.data === void 0) {
+    try {
+      data = structuredClone(data);
+    } catch (error) {
+    }
+  }
+  const newData = reconcile(data, { key: reconcileOption })(store.data);
   return { ...result, data: newData };
 }
 var hydratableObserverResult = (query, result) => {
@@ -132,12 +139,14 @@ function createBaseQuery(options, Observer, queryClient) {
     });
   };
   function setStateWithReconciliation(res) {
-    const reconcileOptions = observer().options.reconcile;
+    const opts = observer().options;
+    const reconcileOptions = opts.reconcile;
     setState((store) => {
       return reconcileFn(
         store,
         res,
-        reconcileOptions === void 0 ? false : reconcileOptions
+        reconcileOptions === void 0 ? false : reconcileOptions,
+        opts.queryHash
       );
     });
   }
@@ -164,12 +173,18 @@ function createBaseQuery(options, Observer, queryClient) {
           unsubscribe = createClientSubscriber();
         }
         obs.updateResult();
+        if (observerResult.isError && !observerResult.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
+          observerResult.error,
+          obs.getCurrentQuery()
+        ])) {
+          setStateWithReconciliation(observerResult);
+          return reject(observerResult.error);
+        }
         if (!observerResult.isLoading) {
           const query = obs.getCurrentQuery();
-          resolve(hydratableObserverResult(query, observerResult));
-        } else {
-          setStateWithReconciliation(observerResult);
+          return resolve(hydratableObserverResult(query, observerResult));
         }
+        setStateWithReconciliation(observerResult);
       });
     },
     {
@@ -204,7 +219,7 @@ function createBaseQuery(options, Observer, queryClient) {
           newOptions.refetchOnMount = false;
         }
         observer().setOptions(newOptions);
-        setState(observer().getOptimisticResult(newOptions));
+        setStateWithReconciliation(observer().getOptimisticResult(newOptions));
         unsubscribe = createClientSubscriber();
       }
     }
@@ -256,25 +271,10 @@ function createBaseQuery(options, Observer, queryClient) {
       { defer: true }
     )
   );
-  createComputed(
-    on(
-      () => state.status,
-      () => {
-        const obs = observer();
-        if (state.isError && !state.isFetching && !isRestoring() && shouldThrowError(obs.options.throwOnError, [
-          state.error,
-          obs.getCurrentQuery()
-        ])) {
-          throw state.error;
-        }
-      }
-    )
-  );
   const handler = {
     get(target, prop) {
       if (prop === "data") {
-        const opts = observer().options;
-        if (opts.placeholderData) {
+        if (state.data !== void 0) {
           return queryResource.latest?.data;
         }
         return queryResource()?.data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-query",
-  "version": "5.30.0",
+  "version": "5.30.2",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/__tests__/createQuery.test.tsx

@@ -1051,7 +1051,9 @@ describe('createQuery', () => {
           count++
           return count === 1 ? result1 : result2
         },
-        reconcile: 'id',
+        reconcile: (oldData, newData) => {
+          return reconcile(newData)(oldData)
+        },
       }))
 
       createRenderEffect(() => {
@@ -2407,6 +2409,7 @@ describe('createQuery', () => {
 
       return (
         <div>
+          <h1>{state.data}</h1>
           <h1>{state.status}</h1>
           <h2>{state.error?.message}</h2>
         </div>
@@ -2426,6 +2429,124 @@ describe('createQuery', () => {
     consoleMock.mockRestore()
   })
 
+  it('should throw error inside the same component if queryFn throws and throwOnError is in use', async () => {
+    const key = queryKey()
+
+    const consoleMock = vi
+      .spyOn(console, 'error')
+      .mockImplementation(() => undefined)
+
+    function Page() {
+      const state = createQuery(() => ({
+        queryKey: key,
+        queryFn: () => Promise.reject(new Error('Error test')),
+        retry: false,
+        throwOnError: true,
+      }))
+
+      return (
+        <div>
+          <ErrorBoundary fallback={() => <div>error boundary</div>}>
+            <h1>{state.data}</h1>
+            <h1>{state.status}</h1>
+            <h2>{state.error?.message}</h2>
+          </ErrorBoundary>
+        </div>
+      )
+    }
+
+    const rendered = render(() => (
+      <QueryClientProvider client={queryClient}>
+        <Page />
+      </QueryClientProvider>
+    ))
+
+    await waitFor(() => rendered.getByText('error boundary'))
+
+    consoleMock.mockRestore()
+  })
+
+  it('should throw error inside the same component if queryFn throws and show the correct error message', async () => {
+    const key = queryKey()
+
+    const consoleMock = vi
+      .spyOn(console, 'error')
+      .mockImplementation(() => undefined)
+
+    function Page() {
+      const state = createQuery(() => ({
+        queryKey: key,
+        queryFn: () => Promise.reject(new Error('Error test')),
+        retry: false,
+        throwOnError: true,
+      }))
+
+      return (
+        <div>
+          <ErrorBoundary
+            fallback={(err) => <div>Fallback error: {err.message}</div>}
+          >
+            <h1>{state.data}</h1>
+            <h1>{state.status}</h1>
+            <h2>{state.error?.message}</h2>
+          </ErrorBoundary>
+        </div>
+      )
+    }
+
+    const rendered = render(() => (
+      <QueryClientProvider client={queryClient}>
+        <Page />
+      </QueryClientProvider>
+    ))
+
+    await waitFor(() => rendered.getByText('Fallback error: Error test'))
+
+    consoleMock.mockRestore()
+  })
+
+  it('should show the correct error message on the error property when accessed outside error boundary', async () => {
+    const key = queryKey()
+
+    const consoleMock = vi
+      .spyOn(console, 'error')
+      .mockImplementation(() => undefined)
+
+    function Page() {
+      const state = createQuery(() => ({
+        queryKey: key,
+        queryFn: () => Promise.reject(new Error('Error test')),
+        retry: false,
+        throwOnError: true,
+      }))
+
+      return (
+        <div>
+          <h2>Outside error boundary: {state.error?.message}</h2>
+          <ErrorBoundary
+            fallback={(err) => <div>Fallback error: {err.message}</div>}
+          >
+            <h1>{state.data}</h1>
+            <h1>{state.status}</h1>
+          </ErrorBoundary>
+        </div>
+      )
+    }
+
+    const rendered = render(() => (
+      <QueryClientProvider client={queryClient}>
+        <Page />
+      </QueryClientProvider>
+    ))
+
+    await waitFor(() =>
+      rendered.getByText('Outside error boundary: Error test'),
+    )
+    await waitFor(() => rendered.getByText('Fallback error: Error test'))
+
+    consoleMock.mockRestore()
+  })
+
   it('should update with data if we observe no properties and throwOnError', async () => {
     const key = queryKey()
 
@@ -2491,7 +2612,7 @@ describe('createQuery', () => {
     const key = queryKey()
 
     function Page() {
-      const state = createQuery<unknown, Error>(() => ({
+      const state = createQuery(() => ({
         queryKey: key,
         queryFn: () => Promise.reject(new Error('Remote Error')),
         retry: false,
@@ -2500,6 +2621,7 @@ describe('createQuery', () => {
 
       return (
         <div>
+          <div>{state.data}</div>
           <h1>{state.status}</h1>
           <h2>{state.error?.message ?? ''}</h2>
         </div>

package/src/createBaseQuery.ts

@@ -34,13 +34,31 @@ function reconcileFn<TData, TError>(
     | string
     | false
     | ((oldData: TData | undefined, newData: TData) => TData),
+  queryHash?: string,
 ): QueryObserverResult<TData, TError> {
   if (reconcileOption === false) return result
   if (typeof reconcileOption === 'function') {
     const newData = reconcileOption(store.data, result.data as TData)
     return { ...result, data: newData } as typeof result
   }
-  const newData = reconcile(result.data, { key: reconcileOption })(store.data)
+  let data = result.data
+  if (store.data === undefined) {
+    try {
+      data = structuredClone(data)
+    } catch (error) {
+      if (process.env.NODE_ENV !== 'production') {
+        if (error instanceof Error) {
+          console.warn(
+            `Unable to correctly reconcile data for query key: ${queryHash}. ` +
+              `Possibly because the query data contains data structures that aren't supported ` +
+              `by the 'structuredClone' algorithm. Consider using a callback function instead ` +
+              `to manage the reconciliation manually.\n\n Error Received: ${error.name} - ${error.message}`,
+          )
+        }
+      }
+    }
+  }
+  const newData = reconcile(data, { key: reconcileOption })(store.data)
   return { ...result, data: newData } as typeof result
 }
 
@@ -186,14 +204,16 @@ export function createBaseQuery<
   }
 
   function setStateWithReconciliation(res: typeof observerResult) {
+    const opts = observer().options
     // @ts-expect-error - Reconcile option is not correctly typed internally
-    const reconcileOptions = observer().options.reconcile
+    const reconcileOptions = opts.reconcile
 
     setState((store) => {
       return reconcileFn(
         store,
         res,
         reconcileOptions === undefined ? false : reconcileOptions,
+        opts.queryHash,
       )
     })
   }
@@ -227,12 +247,24 @@ export function createBaseQuery<
         }
         obs.updateResult()
 
+        if (
+          observerResult.isError &&
+          !observerResult.isFetching &&
+          !isRestoring() &&
+          shouldThrowError(obs.options.throwOnError, [
+            observerResult.error,
+            obs.getCurrentQuery(),
+          ])
+        ) {
+          setStateWithReconciliation(observerResult)
+          return reject(observerResult.error)
+        }
         if (!observerResult.isLoading) {
           const query = obs.getCurrentQuery()
-          resolve(hydratableObserverResult(query, observerResult))
-        } else {
-          setStateWithReconciliation(observerResult)
+          return resolve(hydratableObserverResult(query, observerResult))
         }
+
+        setStateWithReconciliation(observerResult)
       })
     },
     {
@@ -278,7 +310,7 @@ export function createBaseQuery<
         // Setting the options as an immutable object to prevent
         // wonky behavior with observer subscriptions
         observer().setOptions(newOptions)
-        setState(observer().getOptimisticResult(newOptions))
+        setStateWithReconciliation(observer().getOptimisticResult(newOptions))
         unsubscribe = createClientSubscriber()
       },
     },
@@ -335,34 +367,13 @@ export function createBaseQuery<
     ),
   )
 
-  createComputed(
-    on(
-      () => state.status,
-      () => {
-        const obs = observer()
-        if (
-          state.isError &&
-          !state.isFetching &&
-          !isRestoring() &&
-          shouldThrowError(obs.options.throwOnError, [
-            state.error,
-            obs.getCurrentQuery(),
-          ])
-        ) {
-          throw state.error
-        }
-      },
-    ),
-  )
-
   const handler = {
     get(
       target: QueryObserverResult<TData, TError>,
       prop: keyof QueryObserverResult<TData, TError>,
     ): any {
       if (prop === 'data') {
-        const opts = observer().options
-        if (opts.placeholderData) {
+        if (state.data !== undefined) {
           return queryResource.latest?.data
         }
         return queryResource()?.data