fix(solid-query): respect suspense: false

packages/query-core/src/types.ts

@@ -317,7 +317,8 @@ export interface QueryObserverOptions<
   /**
    * If set to `true`, the query will suspend when `status === 'pending'`
    * and throw errors when `status === 'error'`.
-   * Defaults to `false`.
+   * Defaults to `false` for React.
+   * Defaults to `true` for Solid.
    */
   suspense?: boolean
   /**

packages/solid-query/src/__tests__/createQuery.test.tsx

@@ -1308,7 +1308,11 @@ describe('createQuery', () => {
 
   it('should not fetch when switching to a disabled query', async () => {
     const key = queryKey()
-    const states: Array<CreateQueryResult<number>> = []
+    const states: Array<{
+      data: number | undefined
+      isFetching: boolean
+      isSuccess: boolean
+    }> = []
 
     function Page() {
       const [count, setCount] = createSignal(0)
@@ -1323,7 +1327,11 @@ describe('createQuery', () => {
       }))
 
       createRenderEffect(() => {
-        states.push({ ...state })
+        states.push({
+          data: state.data,
+          isFetching: state.isFetching,
+          isSuccess: state.isSuccess,
+        })
       })
 
       createEffect(() => {
@@ -1342,7 +1350,6 @@ describe('createQuery', () => {
     ))
 
     await sleep(50)
-
     expect(states.length).toBe(3)
 
     // Fetch query

packages/solid-query/src/__tests__/suspense.test.tsx

@@ -955,4 +955,46 @@ describe("useQuery's in Suspense mode", () => {
     expect(renders).toBe(2)
     expect(screen.queryByText('rendered')).not.toBeNull()
   })
+
+  it('should not suspend when suspense is set as false', async () => {
+    const key1 = queryKey()
+
+    function Component() {
+      const result = createQuery(() => ({
+        queryKey: key1,
+        queryFn: async () => {
+          await sleep(100)
+          return key1
+        },
+        retry: false,
+        suspense: false,
+      }))
+      return (
+        <>
+          {result.isLoading ? (
+            <div>No suspense loading...</div>
+          ) : (
+            <div>data: {result.data}</div>
+          )}
+        </>
+      )
+    }
+
+    function Page() {
+      return (
+        <Suspense fallback="Suspense loading...">
+          <Component />
+        </Suspense>
+      )
+    }
+
+    render(() => (
+      <QueryClientProvider client={queryClient}>
+        <Page />
+      </QueryClientProvider>
+    ))
+
+    await waitFor(() => screen.getByText('No suspense loading...'))
+    await waitFor(() => screen.getByText(`data: ${key1}`))
+  })
 })

packages/solid-query/src/createBaseQuery.ts

@@ -319,7 +319,11 @@ export function createBaseQuery<
       target: QueryObserverResult<TData, TError>,
       prop: keyof QueryObserverResult<TData, TError>,
     ): any {
-      const val = queryResource()?.[prop]
+      // we should suspend unless user specifically says not to
+      const shouldSuspend = untrack(defaultedOptions)?.suspense !== false
+      const val = shouldSuspend
+        ? queryResource()?.[prop]
+        : queryResource.latest?.[prop]
       return val !== undefined ? val : Reflect.get(target, prop)
     },
   }