14e94e69c5
There're few places calling `loadConfig` to access nextjs config for different purpose, and every of them will do validation of next config scheme and could log the warnings potentially to cause duplicated warnings. To address that issue this PR limit the places when should the warnings be logged in certain places, mainly the `next` command entry. Refactor the API here to make it more explicit Previous logging redeisgn also might trigger duplicated compilation, for instance you compiled page A but then editing another component it might still displaying page A is recompiled. Now we always display `"Compiled .."` message when there's a recompilation but avoid the unnecessary ones such as initial edge compilor ready but there's no modules inside. Then when it recompiles or recovers from error nextjs server will tell "Compiled .." instead of the specific page which might be not related. Also refactors a minor issue: When `silent` option is set to `true`, auto recorrect next config option from `loadConfig` API like `traillingSlash` is not working Closes NEXT-1610 Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
102 lines
3.4 KiB
TypeScript
102 lines
3.4 KiB
TypeScript
/* eslint-env jest */
|
|
import { join } from 'path'
|
|
import loadConfig from 'next/dist/server/config'
|
|
import { PHASE_DEVELOPMENT_SERVER } from 'next/constants'
|
|
|
|
const pathToConfig = join(__dirname, '_resolvedata', 'without-function')
|
|
const pathToConfigFn = join(__dirname, '_resolvedata', 'with-function')
|
|
|
|
// force require usage instead of dynamic import in jest
|
|
// x-ref: https://github.com/nodejs/node/issues/35889
|
|
process.env.__NEXT_TEST_MODE = 'jest'
|
|
|
|
describe('config', () => {
|
|
it('Should get the configuration', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, pathToConfig)
|
|
expect(config.customConfig).toBe(true)
|
|
})
|
|
|
|
it('Should pass the phase correctly', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, pathToConfigFn)
|
|
expect(config.phase).toBe(PHASE_DEVELOPMENT_SERVER)
|
|
})
|
|
|
|
it('Should pass the defaultConfig correctly', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, pathToConfigFn)
|
|
expect(config.defaultConfig).toBeDefined()
|
|
})
|
|
|
|
it('Should assign object defaults deeply to user config', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, pathToConfigFn)
|
|
expect(config.distDir).toEqual('.next')
|
|
expect(config.onDemandEntries.maxInactiveAge).toBeDefined()
|
|
})
|
|
|
|
it('Should pass the customConfig correctly', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, null, {
|
|
customConfig: {
|
|
customConfigKey: 'customConfigValue',
|
|
},
|
|
})
|
|
expect(config.customConfigKey).toBe('customConfigValue')
|
|
})
|
|
|
|
it('Should assign object defaults deeply to customConfig', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, null, {
|
|
customConfig: {
|
|
customConfig: true,
|
|
onDemandEntries: { custom: true },
|
|
},
|
|
})
|
|
expect(config.customConfig).toBe(true)
|
|
expect(config.onDemandEntries.maxInactiveAge).toBeDefined()
|
|
})
|
|
|
|
it('Should allow setting objects which do not have defaults', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, null, {
|
|
customConfig: {
|
|
bogusSetting: { custom: true },
|
|
},
|
|
})
|
|
expect(config.bogusSetting).toBeDefined()
|
|
expect(config.bogusSetting.custom).toBe(true)
|
|
})
|
|
|
|
it('Should override defaults for arrays from user arrays', async () => {
|
|
const config = await loadConfig(PHASE_DEVELOPMENT_SERVER, null, {
|
|
customConfig: {
|
|
pageExtensions: ['.bogus'],
|
|
},
|
|
})
|
|
expect(config.pageExtensions).toEqual(['.bogus'])
|
|
})
|
|
|
|
it('Should throw when an invalid target is provided', async () => {
|
|
await expect(async () => {
|
|
await loadConfig(
|
|
PHASE_DEVELOPMENT_SERVER,
|
|
join(__dirname, '_resolvedata', 'invalid-target')
|
|
)
|
|
}).rejects.toThrow(/The "target" property is no longer supported/)
|
|
})
|
|
|
|
it('Should throw an error when next.config.js is not present', async () => {
|
|
await expect(
|
|
async () =>
|
|
await loadConfig(
|
|
PHASE_DEVELOPMENT_SERVER,
|
|
join(__dirname, '_resolvedata', 'typescript-config')
|
|
)
|
|
).rejects.toThrow(
|
|
/Configuring Next.js via .+ is not supported. Please replace the file with 'next.config.js'/
|
|
)
|
|
})
|
|
|
|
it('Should not throw an error when two versions of next.config.js are present', async () => {
|
|
const config = await loadConfig(
|
|
PHASE_DEVELOPMENT_SERVER,
|
|
join(__dirname, '_resolvedata', 'js-ts-config')
|
|
)
|
|
expect(config.__test__ext).toBe('js')
|
|
})
|
|
})
|