fix(streamedQuery): fall back to initialValue when stream yields no values

ahmethos · ahmethos · commit 2749ece6eb7f · 2025-11-15T18:24:23.000+01:00
Add failing test for empty streams and update implementation to avoid returning undefined.
Includes changeset for patch release.
diff --git a/.changeset/puny-walls-eat.md b/.changeset/puny-walls-eat.md
@@ -0,0 +1,5 @@
+---
+'@tanstack/query-core': patch
+---
+
+Fix streamedQuery to avoid returning undefined when the stream yields no values
diff --git a/packages/query-core/src/__tests__/streamedQuery.test.tsx b/packages/query-core/src/__tests__/streamedQuery.test.tsx
@@ -128,6 +128,37 @@ describe('streamedQuery', () => {
     unsubscribe()
   })
 
+  test('should handle empty streams', async () => {
+
+    const key = queryKey()
+
+    const observer = new QueryObserver(queryClient, {
+      queryKey: key,
+      queryFn: streamedQuery({
+        streamFn: () => { return {async *[Symbol.asyncIterator]() {}}},
+      }),
+    })
+
+    const unsubscribe = observer.subscribe(vi.fn())
+
+    expect(observer.getCurrentResult()).toMatchObject({
+      status: 'pending',
+      fetchStatus: 'fetching',
+      data: undefined,
+    })
+
+    await vi.advanceTimersByTimeAsync(50)
+
+    expect(observer.getCurrentResult()).toMatchObject({
+      status: 'success',
+      fetchStatus: 'idle',
+      data: [],
+    })
+
+    unsubscribe()
+
+  })
+
   test('should replace on refetch', async () => {
     const key = queryKey()
     const observer = new QueryObserver(queryClient, {
diff --git a/packages/query-core/src/streamedQuery.ts b/packages/query-core/src/streamedQuery.ts
@@ -94,6 +94,6 @@ export function streamedQuery<
       context.client.setQueryData<TData>(context.queryKey, result)
     }
 
-    return context.client.getQueryData(context.queryKey)!
+    return context.client.getQueryData(context.queryKey) ?? initialValue
   }
 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@tanstack/query-core': patch
 +---
++
 +Fix streamedQuery to avoid returning undefined when the stream yields no values
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,6 @@ export function streamedQuery<`
`94`	`94`	`context.client.setQueryData<TData>(context.queryKey, result)`
`95`	`95`	`}`
`96`	`96`
`97`		`- return context.client.getQueryData(context.queryKey)!`
	`97`	`+ return context.client.getQueryData(context.queryKey) ?? initialValue`
`98`	`98`	`}`
`99`	`99`	`}`