Skip to content

fix: ensure appDir routes with null dataRoutes are not added to edge manifest for rsc-data #2044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/runtime/src/helpers/edge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ export const writeDevEdgeFunction = async ({
* Writes an edge function that routes RSC data requests to the `.rsc` route
*/

export const writeRscDataEdgeFunction = async ({
export const generateRscDataEdgeManifest = async ({
prerenderManifest,
appPathRoutesManifest,
}: {
Expand All @@ -275,14 +275,14 @@ export const writeRscDataEdgeFunction = async ({
}
const staticAppdirRoutes: Array<string> = []
for (const [path, route] of Object.entries(prerenderManifest.routes)) {
if (isAppDirRoute(route.srcRoute, appPathRoutesManifest)) {
if (isAppDirRoute(route.srcRoute, appPathRoutesManifest) && route.dataRoute) {
staticAppdirRoutes.push(path, route.dataRoute)
}
}
const dynamicAppDirRoutes: Array<string> = []

for (const [path, route] of Object.entries(prerenderManifest.dynamicRoutes)) {
if (isAppDirRoute(path, appPathRoutesManifest)) {
if (isAppDirRoute(path, appPathRoutesManifest) && route.dataRouteRegex) {
dynamicAppDirRoutes.push(route.routeRegex, route.dataRouteRegex)
}
}
Expand Down Expand Up @@ -368,7 +368,7 @@ export const writeEdgeFunctions = async ({
return
}

const rscFunctions = await writeRscDataEdgeFunction({
const rscFunctions = await generateRscDataEdgeManifest({
prerenderManifest: await loadPrerenderManifest(netlifyConfig),
appPathRoutesManifest: await loadAppPathRoutesManifest(netlifyConfig),
})
Expand Down
118 changes: 118 additions & 0 deletions test/edge.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
import { generateRscDataEdgeManifest } from '../packages/runtime/src/helpers/edge'
import type { PrerenderManifest } from 'next/dist/build'

const basePrerenderManifest: PrerenderManifest = {
version: 3,
routes: {},
dynamicRoutes: {},
notFoundRoutes: [],
preview: {
previewModeId: '',
previewModeSigningKey: '',
previewModeEncryptionKey: '',
},
}

describe('generateRscDataEdgeManifest', () => {
it('should return manifest entries for static appDir routes', async () => {
const prerenderManifest: PrerenderManifest = {
...basePrerenderManifest,
routes: {
'/': {
initialRevalidateSeconds: false,
srcRoute: '/',
dataRoute: '/index.rsc',
},
},
}
const appPathRoutesManifest = {
'/page': '/',
}
const edgeManifest = await generateRscDataEdgeManifest({ prerenderManifest, appPathRoutesManifest })

expect(edgeManifest).toEqual([
{
function: 'rsc-data',
name: 'RSC data routing',
path: '/',
},
{
function: 'rsc-data',
name: 'RSC data routing',
path: '/index.rsc',
},
])
})

it('should not return manifest entries for static appDir routes without dataRoutes', async () => {
const prerenderManifest: PrerenderManifest = {
...basePrerenderManifest,
routes: {
'/api/hello': {
initialRevalidateSeconds: false,
srcRoute: '/api/hello',
dataRoute: null,
},
},
}
const appPathRoutesManifest = {
'/api/hello/route': '/api/hello',
}
const edgeManifest = await generateRscDataEdgeManifest({ prerenderManifest, appPathRoutesManifest })

expect(edgeManifest).toEqual([])
})

it('should return manifest entries for dynamic appDir routes', async () => {
const prerenderManifest: PrerenderManifest = {
...basePrerenderManifest,
dynamicRoutes: {
'/blog/[author]': {
routeRegex: '^/blog/([^/]+?)(?:/)?$',
dataRoute: '/blog/[author].rsc',
fallback: null,
dataRouteRegex: '^/blog/([^/]+?)\\.rsc$',
},
},
}

const appPathRoutesManifest = {
'/blog/[author]/page': '/blog/[author]',
}
const edgeManifest = await generateRscDataEdgeManifest({ prerenderManifest, appPathRoutesManifest })

expect(edgeManifest).toEqual([
{
function: 'rsc-data',
name: 'RSC data routing',
pattern: '^/blog/([^/]+?)(?:/)?$',
},
{
function: 'rsc-data',
name: 'RSC data routing',
pattern: '^/blog/([^/]+?)\\.rsc$',
},
])
})

it('should not return manifest entries for dynamic appDir routes without dataRouteRegex', async () => {
const prerenderManifest: PrerenderManifest = {
...basePrerenderManifest,
dynamicRoutes: {
'/api/[endpoint]': {
routeRegex: '^/api/([^/]+?)(?:/)?$',
dataRoute: '/api/[endpoint].rsc',
fallback: null,
dataRouteRegex: null,
},
},
}

const appPathRoutesManifest = {
'/api/[endpoint]/route': '/api/[endpoint]',
}
const edgeManifest = await generateRscDataEdgeManifest({ prerenderManifest, appPathRoutesManifest })

expect(edgeManifest).toEqual([])
})
})