c1f8d93175
Previously we only display the warning when it's a new key format `<object>.<property>`, we should display all cases to help users understand where the new key is moved to x-ref: https://x.com/huozhi/status/1789335665252921381
150 lines
3.7 KiB
TypeScript
150 lines
3.7 KiB
TypeScript
import {
|
|
warnOptionHasBeenMovedOutOfExperimental,
|
|
warnOptionHasBeenDeprecated,
|
|
} from 'next/dist/server/config'
|
|
|
|
describe('warnOptionHasBeenMovedOutOfExperimental', () => {
|
|
let spy: jest.SpyInstance
|
|
beforeAll(() => {
|
|
spy = jest.spyOn(console, 'warn').mockImplementation(() => {})
|
|
})
|
|
|
|
it('should not log warning message without experimental config', () => {
|
|
warnOptionHasBeenMovedOutOfExperimental(
|
|
{},
|
|
'skipTrailingSlashRedirect',
|
|
'skipTrailingSlashRedirect',
|
|
'next.config.js',
|
|
false
|
|
)
|
|
|
|
warnOptionHasBeenMovedOutOfExperimental(
|
|
{
|
|
experimental: {},
|
|
},
|
|
'skipTrailingSlashRedirect',
|
|
'skipTrailingSlashRedirect',
|
|
'next.config.js',
|
|
false
|
|
)
|
|
|
|
expect(spy).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should log warning message with removed experimental config', () => {
|
|
warnOptionHasBeenMovedOutOfExperimental(
|
|
{
|
|
experimental: {
|
|
skipTrailingSlashRedirect: true,
|
|
},
|
|
} as any,
|
|
'skipTrailingSlashRedirect',
|
|
'skipTrailingSlashRedirect',
|
|
'next.config.js',
|
|
false
|
|
)
|
|
|
|
expect(spy).toHaveBeenCalledWith(
|
|
expect.stringContaining('⚠'),
|
|
'`experimental.skipTrailingSlashRedirect` has been moved to `skipTrailingSlashRedirect`. Please update your next.config.js file accordingly.'
|
|
)
|
|
})
|
|
|
|
it('should log warning message with removed experimental config - complex key', () => {
|
|
warnOptionHasBeenMovedOutOfExperimental(
|
|
{
|
|
experimental: {
|
|
relay: true,
|
|
},
|
|
} as any,
|
|
'relay',
|
|
'compiler.relay',
|
|
'next.config.js',
|
|
false
|
|
)
|
|
|
|
expect(spy).toHaveBeenCalledWith(
|
|
expect.stringContaining('⚠'),
|
|
'`experimental.relay` has been moved to `compiler.relay`. Please update your next.config.js file accordingly.'
|
|
)
|
|
})
|
|
|
|
it('should update removed experimental config into new config', () => {
|
|
const config = {
|
|
experimental: {
|
|
skipTrailingSlashRedirect: true,
|
|
},
|
|
} as any
|
|
warnOptionHasBeenMovedOutOfExperimental(
|
|
config,
|
|
'skipTrailingSlashRedirect',
|
|
'skipTrailingSlashRedirect',
|
|
'next.config.js',
|
|
false
|
|
)
|
|
|
|
expect(config.experimental.skipTrailingSlashRedirect).toBe(true)
|
|
expect(config.skipTrailingSlashRedirect).toBe(true)
|
|
})
|
|
|
|
it('should update removed experimental config into new config - complex key', () => {
|
|
const config = {
|
|
experimental: {
|
|
foo: 'bar',
|
|
},
|
|
} as any
|
|
warnOptionHasBeenMovedOutOfExperimental(
|
|
config,
|
|
'foo',
|
|
'deep.prop.baz',
|
|
'next.config.js',
|
|
false
|
|
)
|
|
|
|
expect(config.experimental.foo).toBe('bar')
|
|
expect(config.deep.prop.baz).toBe('bar')
|
|
})
|
|
|
|
it('should show the new key name in the warning', () => {
|
|
const config = {
|
|
experimental: {
|
|
bundlePagesExternals: true,
|
|
},
|
|
} as any
|
|
|
|
warnOptionHasBeenMovedOutOfExperimental(
|
|
config,
|
|
'bundlePagesExternals',
|
|
'bundlePagesRouterDependencies',
|
|
'next.config.js',
|
|
false
|
|
)
|
|
|
|
expect(spy).toHaveBeenCalledWith(
|
|
expect.stringContaining('⚠'),
|
|
'`experimental.bundlePagesExternals` has been moved to `bundlePagesRouterDependencies`. Please update your next.config.js file accordingly.'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('warnOptionHasBeenDeprecated', () => {
|
|
let spy: jest.SpyInstance
|
|
beforeAll(() => {
|
|
spy = jest.spyOn(console, 'warn').mockImplementation(() => {})
|
|
})
|
|
|
|
it('should warn experimental.appDir has been deprecated', () => {
|
|
const config = {
|
|
experimental: {
|
|
appDir: true,
|
|
},
|
|
} as any
|
|
warnOptionHasBeenDeprecated(
|
|
config,
|
|
'experimental.appDir',
|
|
'experimental.appDir has been removed',
|
|
false
|
|
)
|
|
expect(spy).toHaveBeenCalled()
|
|
})
|
|
})
|