Skip to content
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
73 changes: 73 additions & 0 deletions packages/next/src/server/config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,77 @@ describe('loadConfig', () => {
)
})
})

describe('middleware to proxy config key rename backward/forward compatibility', () => {
it('should copy `skipMiddlewareUrlNormalize value` to `skipProxyUrlNormalize`', async () => {
const result = await loadConfig(PHASE_PRODUCTION_BUILD, __dirname, {
customConfig: {
skipMiddlewareUrlNormalize: true,
},
})

expect(result.skipProxyUrlNormalize).toBe(true)
})

it('should copy `experimental.middlewarePrefetch` to `experimental.proxyPrefetch`', async () => {
const result = await loadConfig(PHASE_PRODUCTION_BUILD, __dirname, {
customConfig: {
experimental: {
middlewarePrefetch: 'strict',
},
},
})

expect(result.experimental.proxyPrefetch).toBe('strict')
})

it('should copy `experimental.externalMiddlewareRewritesResolve` to `experimental.externalProxyRewritesResolve`', async () => {
const result = await loadConfig(PHASE_PRODUCTION_BUILD, __dirname, {
customConfig: {
experimental: {
externalMiddlewareRewritesResolve: true,
},
},
})

expect(result.experimental.externalProxyRewritesResolve).toBe(true)
})

it('should copy `skipProxyUrlNormalize` to `skipMiddlewareUrlNormalize`', async () => {
const result = await loadConfig(PHASE_PRODUCTION_BUILD, __dirname, {
customConfig: {
skipProxyUrlNormalize: true,
},
})

expect(result.skipMiddlewareUrlNormalize).toBe(true)
expect(result.skipProxyUrlNormalize).toBe(true)
})

it('should copy `experimental.proxyPrefetch` to `experimental.middlewarePrefetch`', async () => {
const result = await loadConfig(PHASE_PRODUCTION_BUILD, __dirname, {
customConfig: {
experimental: {
proxyPrefetch: 'strict',
},
},
})

expect(result.experimental.middlewarePrefetch).toBe('strict')
expect(result.experimental.proxyPrefetch).toBe('strict')
})

it('should copy `experimental.externalProxyRewritesResolve` to `experimental.externalMiddlewareRewritesResolve`', async () => {
const result = await loadConfig(PHASE_PRODUCTION_BUILD, __dirname, {
customConfig: {
experimental: {
externalProxyRewritesResolve: true,
},
},
})

expect(result.experimental.externalMiddlewareRewritesResolve).toBe(true)
expect(result.experimental.externalProxyRewritesResolve).toBe(true)
})
})
})
22 changes: 22 additions & 0 deletions packages/next/src/server/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -836,6 +836,28 @@ function assignDefaultsAndValidate(
) {
result.skipProxyUrlNormalize = userConfig.skipMiddlewareUrlNormalize
}
// Inverse case: when new name is set but not the old name, copy the value to the old name
// to avoid breaking change on resolved config object written to `.next/`
if (
userConfig.experimental?.proxyPrefetch !== undefined &&
userConfig.experimental?.middlewarePrefetch === undefined
) {
result.experimental.middlewarePrefetch =
userConfig.experimental.proxyPrefetch
}
if (
userConfig.experimental?.externalProxyRewritesResolve !== undefined &&
userConfig.experimental?.externalMiddlewareRewritesResolve === undefined
) {
result.experimental.externalMiddlewareRewritesResolve =
userConfig.experimental.externalProxyRewritesResolve
}
Comment on lines +841 to +854
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One could certainly argue for not bothering for these two experimental keys!

if (
userConfig.skipProxyUrlNormalize !== undefined &&
userConfig.skipMiddlewareUrlNormalize === undefined
) {
result.skipMiddlewareUrlNormalize = userConfig.skipProxyUrlNormalize
}

// Normalize & validate experimental.proxyClientMaxBodySize
if (typeof result.experimental?.proxyClientMaxBodySize !== 'undefined') {
Expand Down
Loading