Skip to content

Commit e054474

Browse files
authored
fix: streaming when using Await component (#7264)
1 parent 41e37f8 commit e054474

5 files changed

Lines changed: 106 additions & 9 deletions

File tree

‎.changeset/rotten-bars-sit.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@tanstack/solid-router': patch
3+
---
4+
5+
Fix streaming when using Await component

‎e2e/solid-start/basic/src/routeTree.gen.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import { Route as RawStreamRouteImport } from './routes/raw-stream'
1616
import { Route as PostsRouteImport } from './routes/posts'
1717
import { Route as LinksRouteImport } from './routes/links'
1818
import { Route as InlineScriptsRouteImport } from './routes/inline-scripts'
19+
import { Route as DeferredWithoutSuspenseRouteImport } from './routes/deferred-without-suspense'
1920
import { Route as DeferredRouteImport } from './routes/deferred'
2021
import { Route as LayoutRouteImport } from './routes/_layout'
2122
import { Route as SpecialCharsRouteRouteImport } from './routes/specialChars/route'
@@ -104,6 +105,11 @@ const InlineScriptsRoute = InlineScriptsRouteImport.update({
104105
path: '/inline-scripts',
105106
getParentRoute: () => rootRouteImport,
106107
} as any)
108+
const DeferredWithoutSuspenseRoute = DeferredWithoutSuspenseRouteImport.update({
109+
id: '/deferred-without-suspense',
110+
path: '/deferred-without-suspense',
111+
getParentRoute: () => rootRouteImport,
112+
} as any)
107113
const DeferredRoute = DeferredRouteImport.update({
108114
id: '/deferred',
109115
path: '/deferred',
@@ -386,6 +392,7 @@ export interface FileRoutesByFullPath {
386392
'/search-params': typeof SearchParamsRouteRouteWithChildren
387393
'/specialChars': typeof SpecialCharsRouteRouteWithChildren
388394
'/deferred': typeof DeferredRoute
395+
'/deferred-without-suspense': typeof DeferredWithoutSuspenseRoute
389396
'/inline-scripts': typeof InlineScriptsRoute
390397
'/links': typeof LinksRoute
391398
'/posts': typeof PostsRouteWithChildren
@@ -443,6 +450,7 @@ export interface FileRoutesByTo {
443450
'/': typeof IndexRoute
444451
'/specialChars': typeof SpecialCharsRouteRouteWithChildren
445452
'/deferred': typeof DeferredRoute
453+
'/deferred-without-suspense': typeof DeferredWithoutSuspenseRoute
446454
'/inline-scripts': typeof InlineScriptsRoute
447455
'/links': typeof LinksRoute
448456
'/scripts': typeof ScriptsRoute
@@ -500,6 +508,7 @@ export interface FileRoutesById {
500508
'/specialChars': typeof SpecialCharsRouteRouteWithChildren
501509
'/_layout': typeof LayoutRouteWithChildren
502510
'/deferred': typeof DeferredRoute
511+
'/deferred-without-suspense': typeof DeferredWithoutSuspenseRoute
503512
'/inline-scripts': typeof InlineScriptsRoute
504513
'/links': typeof LinksRoute
505514
'/posts': typeof PostsRouteWithChildren
@@ -562,6 +571,7 @@ export interface FileRouteTypes {
562571
| '/search-params'
563572
| '/specialChars'
564573
| '/deferred'
574+
| '/deferred-without-suspense'
565575
| '/inline-scripts'
566576
| '/links'
567577
| '/posts'
@@ -619,6 +629,7 @@ export interface FileRouteTypes {
619629
| '/'
620630
| '/specialChars'
621631
| '/deferred'
632+
| '/deferred-without-suspense'
622633
| '/inline-scripts'
623634
| '/links'
624635
| '/scripts'
@@ -675,6 +686,7 @@ export interface FileRouteTypes {
675686
| '/specialChars'
676687
| '/_layout'
677688
| '/deferred'
689+
| '/deferred-without-suspense'
678690
| '/inline-scripts'
679691
| '/links'
680692
| '/posts'
@@ -737,6 +749,7 @@ export interface RootRouteChildren {
737749
SpecialCharsRouteRoute: typeof SpecialCharsRouteRouteWithChildren
738750
LayoutRoute: typeof LayoutRouteWithChildren
739751
DeferredRoute: typeof DeferredRoute
752+
DeferredWithoutSuspenseRoute: typeof DeferredWithoutSuspenseRoute
740753
InlineScriptsRoute: typeof InlineScriptsRoute
741754
LinksRoute: typeof LinksRoute
742755
PostsRoute: typeof PostsRouteWithChildren
@@ -805,6 +818,13 @@ declare module '@tanstack/solid-router' {
805818
preLoaderRoute: typeof InlineScriptsRouteImport
806819
parentRoute: typeof rootRouteImport
807820
}
821+
'/deferred-without-suspense': {
822+
id: '/deferred-without-suspense'
823+
path: '/deferred-without-suspense'
824+
fullPath: '/deferred-without-suspense'
825+
preLoaderRoute: typeof DeferredWithoutSuspenseRouteImport
826+
parentRoute: typeof rootRouteImport
827+
}
808828
'/deferred': {
809829
id: '/deferred'
810830
path: '/deferred'
@@ -1377,6 +1397,7 @@ const rootRouteChildren: RootRouteChildren = {
13771397
SpecialCharsRouteRoute: SpecialCharsRouteRouteWithChildren,
13781398
LayoutRoute: LayoutRouteWithChildren,
13791399
DeferredRoute: DeferredRoute,
1400+
DeferredWithoutSuspenseRoute: DeferredWithoutSuspenseRoute,
13801401
InlineScriptsRoute: InlineScriptsRoute,
13811402
LinksRoute: LinksRoute,
13821403
PostsRoute: PostsRouteWithChildren,
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { Await, createFileRoute } from '@tanstack/solid-router'
2+
import { createServerFn } from '@tanstack/solid-start'
3+
4+
const promise = createServerFn().handler(async () => {
5+
await new Promise((r) => setTimeout(r, 3000))
6+
return crypto.randomUUID()
7+
})
8+
9+
export const Route = createFileRoute('/deferred-without-suspense')({
10+
component: RouteComponent,
11+
loader() {
12+
return { promise: promise() }
13+
},
14+
})
15+
16+
function RouteComponent() {
17+
const data = Route.useLoaderData()
18+
return (
19+
<>
20+
data{' '}
21+
<Await
22+
fallback={
23+
<p data-testid="deferred-without-suspense-loading">Loading...</p>
24+
}
25+
promise={data().promise}
26+
>
27+
{(data) => (
28+
<span data-testid="deferred-without-suspense-data">{data}</span>
29+
)}
30+
</Await>
31+
</>
32+
)
33+
}

‎e2e/solid-start/basic/tests/streaming.spec.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { expect } from '@playwright/test'
22
import { test } from '@tanstack/router-e2e-utils'
3+
import { isSpaMode } from './utils/isSpaMode'
34

45
test('Navigating to deferred route', async ({ page }) => {
56
await page.goto('/')
@@ -33,3 +34,19 @@ test('streaming loader data', async ({ page }) => {
3334
await expect(page.getByTestId('promise-data')).toContainText('promise-data')
3435
await expect(page.getByTestId('stream-data')).toContainText('stream-data')
3536
})
37+
38+
test('streams Await fallback for server function loader promises', async ({
39+
page,
40+
}) => {
41+
test.skip(isSpaMode, 'SPA mode does not render streamed SSR HTML')
42+
43+
const response = await page.request.get('/deferred-without-suspense')
44+
const html = await response.text()
45+
46+
expect(html).toContain('data-testid="deferred-without-suspense-loading"')
47+
48+
await page.goto('/deferred-without-suspense')
49+
await expect(
50+
page.getByTestId('deferred-without-suspense-data'),
51+
).not.toBeEmpty()
52+
})

‎packages/solid-router/src/awaited.tsx‎

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,40 @@ export function Await<T>(
2929
fallback?: SolidNode
3030
children: (result: T) => SolidNode
3131
},
32+
) {
33+
if (!('fallback' in props)) {
34+
const [resource] = Solid.createResource(
35+
() => defer(props.promise),
36+
(p) => p,
37+
{
38+
deferStream: true,
39+
},
40+
)
41+
42+
return (
43+
<Solid.Show when={resource()}>
44+
{(data) => props.children(data())}
45+
</Solid.Show>
46+
)
47+
}
48+
49+
return (
50+
<Solid.Suspense fallback={props.fallback}>
51+
<AwaitInner {...props} />
52+
</Solid.Suspense>
53+
)
54+
}
55+
56+
function AwaitInner<T>(
57+
props: AwaitOptions<T> & {
58+
fallback?: SolidNode
59+
children: (result: T) => SolidNode
60+
},
3261
) {
3362
const [resource] = Solid.createResource(
3463
() => defer(props.promise),
35-
// Simple passthrough - just return the promise for Solid to await
3664
(p) => p,
37-
{
38-
deferStream: true,
39-
},
4065
)
4166

42-
return (
43-
<Solid.Show fallback={props.fallback} when={resource()}>
44-
{(data) => props.children(data())}
45-
</Solid.Show>
46-
)
67+
return props.children(resource() as T)
4768
}

0 commit comments

Comments
 (0)