Commit d0686b8e authored by JJ Kasper's avatar JJ Kasper Committed by Tobias Koppers

Fix next-routing header interpolation (#91010)

## Summary
- interpolate source and `has` captures in `@next/routing` route headers
anywhere destinations are already interpolated
- make `onMatch` headers respect route matching and capture
interpolation instead of applying unconditionally
- keep middleware and initial request headers internal to routing so
`resolvedHeaders` only contains actual response headers
- add regressions for header interpolation and for request-header
leakage into `resolvedHeaders`

## Testing
- `pnpm --dir packages/next-routing types`
- `pnpm --dir packages/next-routing test -- --runInBand`
parent ff3b0743
...@@ -563,6 +563,137 @@ describe('Has Condition Captures in Destination', () => { ...@@ -563,6 +563,137 @@ describe('Has Condition Captures in Destination', () => {
expect(result.redirect).toBeDefined() expect(result.redirect).toBeDefined()
expect(result.redirect?.url.pathname).toBe('/es/home') expect(result.redirect?.url.pathname).toBe('/es/home')
}) })
it('should interpolate source and has captures in route headers', async () => {
const headers = new Headers({
'x-language': 'es',
})
const params = createBaseParams({
url: new URL('https://example.com/users/123'),
headers,
routes: {
beforeMiddleware: [
{
sourceRegex: '^/users/([^/]+)$',
headers: {
Location: '/profiles/$1',
'x-user-id': '$1',
'x-language': '$xlanguage',
'x-combined': '$1-$xlanguage',
},
has: [
{
type: 'header',
key: 'x-language',
},
],
},
],
beforeFiles: [],
afterFiles: [],
dynamicRoutes: [],
onMatch: [],
fallback: [],
},
pathnames: ['/users/123'],
})
const result = await resolveRoutes(params)
expect(result.matchedPathname).toBe('/users/123')
expect(result.resolvedHeaders?.get('Location')).toBe('/profiles/123')
expect(result.resolvedHeaders?.get('x-user-id')).toBe('123')
expect(result.resolvedHeaders?.get('x-language')).toBe('es')
expect(result.resolvedHeaders?.get('x-combined')).toBe('123-es')
})
it('should interpolate source and has captures in onMatch headers', async () => {
const headers = new Headers({
'x-language': 'fr',
})
const params = createBaseParams({
url: new URL('https://example.com/api/posts'),
headers,
routes: {
beforeMiddleware: [],
beforeFiles: [],
afterFiles: [],
dynamicRoutes: [],
onMatch: [
{
sourceRegex: '^/api/(?<resource>[^/]+)$',
headers: {
'x-resource': '$resource',
'x-language': '$xlanguage',
'x-combined': '$resource-$xlanguage',
},
has: [
{
type: 'header',
key: 'x-language',
},
],
},
{
sourceRegex: '^/admin$',
headers: {
'x-should-not-match': 'true',
},
},
],
fallback: [],
},
pathnames: ['/api/posts'],
})
const result = await resolveRoutes(params)
expect(result.matchedPathname).toBe('/api/posts')
expect(result.resolvedHeaders?.get('x-resource')).toBe('posts')
expect(result.resolvedHeaders?.get('x-language')).toBe('fr')
expect(result.resolvedHeaders?.get('x-combined')).toBe('posts-fr')
expect(result.resolvedHeaders?.get('x-should-not-match')).toBeNull()
})
it('should interpolate has captures in dynamic route destinations', async () => {
const headers = new Headers({
'x-language': 'fr',
})
const params = createBaseParams({
url: new URL('https://example.com/profile/john'),
headers,
routes: {
beforeMiddleware: [],
beforeFiles: [],
afterFiles: [],
dynamicRoutes: [
{
sourceRegex: '^/profile/([^/]+)$',
destination: '/$xlanguage/profile/$1',
has: [
{
type: 'header',
key: 'x-language',
},
],
},
],
onMatch: [],
fallback: [],
},
pathnames: ['/fr/profile/john'],
})
const result = await resolveRoutes(params)
expect(result.matchedPathname).toBe('/fr/profile/john')
expect(result.routeMatches).toEqual({
'1': 'john',
})
})
}) })
describe('Complex Capture Scenarios', () => { describe('Complex Capture Scenarios', () => {
......
...@@ -223,24 +223,90 @@ describe('resolveRoutes - invokeMiddleware', () => { ...@@ -223,24 +223,90 @@ describe('resolveRoutes - invokeMiddleware', () => {
expect(result.externalRewrite?.toString()).toBe('https://external.com/api') expect(result.externalRewrite?.toString()).toBe('https://external.com/api')
}) })
it('should apply requestHeaders from middleware', async () => { it('should use requestHeaders from middleware for downstream routing without returning them', async () => {
const newHeaders = new Headers({ const middlewareRequestHeaders = new Headers({
'x-custom-header': 'middleware-value', 'x-custom-header': 'middleware-value',
}) })
const params = createBaseParams({ const params = createBaseParams({
url: new URL('https://example.com/test'), url: new URL('https://example.com/test'),
invokeMiddleware: async () => ({ invokeMiddleware: async () => ({
requestHeaders: newHeaders, requestHeaders: middlewareRequestHeaders,
}),
routes: {
beforeMiddleware: [],
beforeFiles: [
{
sourceRegex: '^/test$',
destination: '/internal',
has: [
{
type: 'header',
key: 'x-custom-header',
value: 'middleware-value',
},
],
},
],
afterFiles: [],
dynamicRoutes: [],
onMatch: [],
fallback: [],
},
pathnames: ['/internal'],
})
const result = await resolveRoutes(params)
expect(result.matchedPathname).toBe('/internal')
expect(result.resolvedHeaders?.get('x-custom-header')).toBeNull()
})
it('should return middleware responseHeaders without leaking request headers', async () => {
const middlewareRequestHeaders = new Headers({
'x-internal-header': 'middleware-only',
})
const middlewareResponseHeaders = new Headers({
'x-response-header': 'response-value',
})
const params = createBaseParams({
url: new URL('https://example.com/test'),
headers: new Headers({
authorization: 'Bearer secret',
}),
invokeMiddleware: async () => ({
requestHeaders: middlewareRequestHeaders,
responseHeaders: middlewareResponseHeaders,
}), }),
pathnames: ['/test'], pathnames: ['/test'],
}) })
const result = await resolveRoutes(params) const result = await resolveRoutes(params)
expect(result.resolvedHeaders?.get('x-custom-header')).toBe( expect(result.matchedPathname).toBe('/test')
'middleware-value' expect(result.resolvedHeaders?.get('x-response-header')).toBe(
'response-value'
) )
expect(result.resolvedHeaders?.get('x-internal-header')).toBeNull()
expect(result.resolvedHeaders?.get('authorization')).toBeNull()
})
it('should not return initial request headers in resolvedHeaders', async () => {
const params = createBaseParams({
url: new URL('https://example.com/test'),
headers: new Headers({
authorization: 'Bearer secret',
'x-request-id': 'req-123',
}),
pathnames: ['/test'],
})
const result = await resolveRoutes(params)
expect(result.matchedPathname).toBe('/test')
expect(result.resolvedHeaders?.get('authorization')).toBeNull()
expect(result.resolvedHeaders?.get('x-request-id')).toBeNull()
}) })
}) })
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment