Unverified Commit 1c247b5c authored by Joe Haddad's avatar Joe Haddad Committed by GitHub

Check next.config.js settings (#10425)

* Check next.config.js settings

* Add tests

* test package.json case too
parent ecfa7f7d
...@@ -50,8 +50,8 @@ import { normalizePagePath } from '../next-server/server/normalize-page-path' ...@@ -50,8 +50,8 @@ import { normalizePagePath } from '../next-server/server/normalize-page-path'
import { import {
eventBuildCompleted, eventBuildCompleted,
eventBuildOptimize, eventBuildOptimize,
eventCliSession,
eventNextPlugins, eventNextPlugins,
eventVersion,
} from '../telemetry/events' } from '../telemetry/events'
import { Telemetry } from '../telemetry/storage' import { Telemetry } from '../telemetry/storage'
import { CompilerResult, runCompiler } from './compiler' import { CompilerResult, runCompiler } from './compiler'
...@@ -161,7 +161,7 @@ export default async function build(dir: string, conf = null): Promise<void> { ...@@ -161,7 +161,7 @@ export default async function build(dir: string, conf = null): Promise<void> {
let hasPublicDir = false let hasPublicDir = false
telemetry.record( telemetry.record(
eventVersion({ eventCliSession(PHASE_PRODUCTION_BUILD, dir, {
cliCommand: 'build', cliCommand: 'build',
isSrcDir: path.relative(dir, pagesDir!).startsWith('src'), isSrcDir: path.relative(dir, pagesDir!).startsWith('src'),
hasNowJson: !!(await findUp('now.json', { cwd: dir })), hasNowJson: !!(await findUp('now.json', { cwd: dir })),
......
...@@ -31,7 +31,7 @@ import { ...@@ -31,7 +31,7 @@ import {
import loadConfig, { import loadConfig, {
isTargetLikeServerless, isTargetLikeServerless,
} from '../next-server/server/config' } from '../next-server/server/config'
import { eventVersion } from '../telemetry/events' import { eventCliSession } from '../telemetry/events'
import { Telemetry } from '../telemetry/storage' import { Telemetry } from '../telemetry/storage'
import { normalizePagePath } from '../next-server/server/normalize-page-path' import { normalizePagePath } from '../next-server/server/normalize-page-path'
...@@ -105,7 +105,7 @@ export default async function( ...@@ -105,7 +105,7 @@ export default async function(
if (telemetry) { if (telemetry) {
telemetry.record( telemetry.record(
eventVersion({ eventCliSession(PHASE_EXPORT, distDir, {
cliCommand: 'export', cliCommand: 'export',
isSrcDir: null, isSrcDir: null,
hasNowJson: !!(await findUp('now.json', { cwd: dir })), hasNowJson: !!(await findUp('now.json', { cwd: dir })),
......
...@@ -198,7 +198,7 @@ function assignDefaults(userConfig: { [key: string]: any }) { ...@@ -198,7 +198,7 @@ function assignDefaults(userConfig: { [key: string]: any }) {
return result return result
} }
function normalizeConfig(phase: string, config: any) { export function normalizeConfig(phase: string, config: any) {
if (typeof config === 'function') { if (typeof config === 'function') {
config = config(phase, { defaultConfig }) config = config(phase, { defaultConfig })
......
...@@ -25,7 +25,7 @@ import { __ApiPreviewProps } from '../next-server/server/api-utils' ...@@ -25,7 +25,7 @@ import { __ApiPreviewProps } from '../next-server/server/api-utils'
import Server, { ServerConstructor } from '../next-server/server/next-server' import Server, { ServerConstructor } from '../next-server/server/next-server'
import { normalizePagePath } from '../next-server/server/normalize-page-path' import { normalizePagePath } from '../next-server/server/normalize-page-path'
import Router, { Params, route } from '../next-server/server/router' import Router, { Params, route } from '../next-server/server/router'
import { eventVersion } from '../telemetry/events' import { eventCliSession } from '../telemetry/events'
import { Telemetry } from '../telemetry/storage' import { Telemetry } from '../telemetry/storage'
import ErrorDebug from './error-debug' import ErrorDebug from './error-debug'
import HotReloader from './hot-reloader' import HotReloader from './hot-reloader'
...@@ -233,7 +233,7 @@ export default class DevServer extends Server { ...@@ -233,7 +233,7 @@ export default class DevServer extends Server {
const telemetry = new Telemetry({ distDir: this.distDir }) const telemetry = new Telemetry({ distDir: this.distDir })
telemetry.record( telemetry.record(
eventVersion({ eventCliSession(PHASE_DEVELOPMENT_SERVER, this.distDir, {
cliCommand: 'dev', cliCommand: 'dev',
isSrcDir: relative(this.dir, this.pagesDir!).startsWith('src'), isSrcDir: relative(this.dir, this.pagesDir!).startsWith('src'),
hasNowJson: !!(await findUp('now.json', { cwd: this.dir })), hasNowJson: !!(await findUp('now.json', { cwd: this.dir })),
......
import findUp from 'find-up'
import path from 'path'
import {
CONFIG_FILE,
PHASE_DEVELOPMENT_SERVER,
PHASE_EXPORT,
PHASE_PRODUCTION_BUILD,
} from '../../next-server/lib/constants'
import { normalizeConfig } from '../../next-server/server/config'
const EVENT_VERSION = 'NEXT_CLI_SESSION_STARTED' const EVENT_VERSION = 'NEXT_CLI_SESSION_STARTED'
type EventCliSessionStarted = { type EventCliSessionStarted = {
...@@ -7,27 +17,92 @@ type EventCliSessionStarted = { ...@@ -7,27 +17,92 @@ type EventCliSessionStarted = {
isSrcDir: boolean | null isSrcDir: boolean | null
hasNowJson: boolean hasNowJson: boolean
isCustomServer: boolean | null isCustomServer: boolean | null
hasNextConfig: boolean
buildTarget: string
hasWebpackConfig: boolean
hasBabelConfig: boolean
}
function hasBabelConfig(dir: string): boolean {
try {
const noopFile = path.join(dir, 'noop.js')
const res = require('@babel/core').loadPartialConfig({
cwd: dir,
filename: noopFile,
sourceFileName: noopFile,
}) as any
const isForTooling =
res.options?.presets?.every(
(e: any) => e?.file?.request === 'next/babel'
) && res.options?.plugins?.length === 0
return res.hasFilesystemConfig() && !isForTooling
} catch {
return false
}
}
type NextConfigurationPhase =
| typeof PHASE_DEVELOPMENT_SERVER
| typeof PHASE_PRODUCTION_BUILD
| typeof PHASE_EXPORT
function getNextConfig(
phase: NextConfigurationPhase,
dir: string
): { [key: string]: any } | null {
try {
const configurationPath = findUp.sync(CONFIG_FILE, {
cwd: dir,
})
if (configurationPath) {
// This should've already been loaded, and thus should be cached / won't
// be re-evaluated.
const configurationModule = require(configurationPath)
// Re-normalize the configuration.
return normalizeConfig(
phase,
configurationModule.default || configurationModule
)
}
} catch {
// ignored
}
return null
} }
export function eventVersion( export function eventCliSession(
event: Omit<EventCliSessionStarted, 'nextVersion' | 'nodeVersion'> phase: NextConfigurationPhase,
dir: string,
event: Omit<
EventCliSessionStarted,
| 'nextVersion'
| 'nodeVersion'
| 'hasNextConfig'
| 'buildTarget'
| 'hasWebpackConfig'
| 'hasBabelConfig'
>
): { eventName: string; payload: EventCliSessionStarted }[] { ): { eventName: string; payload: EventCliSessionStarted }[] {
// This should be an invariant, if it fails our build tooling is broken. // This should be an invariant, if it fails our build tooling is broken.
if (typeof process.env.__NEXT_VERSION !== 'string') { if (typeof process.env.__NEXT_VERSION !== 'string') {
return [] return []
} }
return [ const userConfiguration = getNextConfig(phase, dir)
{
eventName: EVENT_VERSION, const payload: EventCliSessionStarted = {
payload: { nextVersion: process.env.__NEXT_VERSION,
nextVersion: process.env.__NEXT_VERSION, nodeVersion: process.version,
nodeVersion: process.version, cliCommand: event.cliCommand,
cliCommand: event.cliCommand, isSrcDir: event.isSrcDir,
isSrcDir: event.isSrcDir, hasNowJson: event.hasNowJson,
hasNowJson: event.hasNowJson, isCustomServer: event.isCustomServer,
isCustomServer: event.isCustomServer, hasNextConfig: !!userConfiguration,
} as EventCliSessionStarted, buildTarget: userConfiguration?.target ?? 'default',
}, hasWebpackConfig: typeof userConfiguration?.webpack === 'function',
] hasBabelConfig: hasBabelConfig(dir),
}
return [{ eventName: EVENT_VERSION, payload }]
} }
{
"presets": ["next/babel"],
"plugins": ["@babel/plugin-proposal-object-rest-spread"]
}
{
"presets": ["next/babel", "@babel/preset-flow"]
}
const { PHASE_PRODUCTION_BUILD } = require('next/constants')
module.exports = phase => {
if (phase === PHASE_PRODUCTION_BUILD) {
return {
target: 'experimental-serverless-trace',
}
}
return {}
}
module.exports = {
webpack(config) {
return config
},
}
{
"babel": {
"presets": [
"next/babel"
],
"plugins": [
"@babel/plugin-proposal-object-rest-spread"
]
}
}
...@@ -138,6 +138,182 @@ describe('Telemetry CLI', () => { ...@@ -138,6 +138,182 @@ describe('Telemetry CLI', () => {
expect(event2).toMatch(/hasTestPages.*?true/) expect(event2).toMatch(/hasTestPages.*?true/)
}) })
it('detects correct cli session defaults', async () => {
const { stderr } = await runNextCommand(['build', appDir], {
stderr: true,
env: {
NEXT_TELEMETRY_DEBUG: 1,
},
})
const event = /NEXT_CLI_SESSION_STARTED[\s\S]+?{([\s\S]+?)}/
.exec(stderr)
.pop()
expect(event).toMatch(/"hasNextConfig": false/)
expect(event).toMatch(/"buildTarget": "default"/)
expect(event).toMatch(/"hasWebpackConfig": false/)
expect(event).toMatch(/"hasBabelConfig": false/)
})
it('cli session: babel tooling config', async () => {
await fs.rename(
path.join(appDir, '.babelrc.default'),
path.join(appDir, '.babelrc')
)
const { stderr } = await runNextCommand(['build', appDir], {
stderr: true,
env: {
NEXT_TELEMETRY_DEBUG: 1,
},
})
await fs.rename(
path.join(appDir, '.babelrc'),
path.join(appDir, '.babelrc.default')
)
const event = /NEXT_CLI_SESSION_STARTED[\s\S]+?{([\s\S]+?)}/
.exec(stderr)
.pop()
expect(event).toMatch(/"hasNextConfig": false/)
expect(event).toMatch(/"buildTarget": "default"/)
expect(event).toMatch(/"hasWebpackConfig": false/)
expect(event).toMatch(/"hasBabelConfig": false/)
})
it('cli session: custom babel config (plugin)', async () => {
await fs.rename(
path.join(appDir, '.babelrc.plugin'),
path.join(appDir, '.babelrc')
)
const { stderr } = await runNextCommand(['build', appDir], {
stderr: true,
env: {
NEXT_TELEMETRY_DEBUG: 1,
},
})
await fs.rename(
path.join(appDir, '.babelrc'),
path.join(appDir, '.babelrc.plugin')
)
const event = /NEXT_CLI_SESSION_STARTED[\s\S]+?{([\s\S]+?)}/
.exec(stderr)
.pop()
expect(event).toMatch(/"hasNextConfig": false/)
expect(event).toMatch(/"buildTarget": "default"/)
expect(event).toMatch(/"hasWebpackConfig": false/)
expect(event).toMatch(/"hasBabelConfig": true/)
})
it('cli session: package.json custom babel config (plugin)', async () => {
await fs.rename(
path.join(appDir, 'package.babel'),
path.join(appDir, 'package.json')
)
const { stderr } = await runNextCommand(['build', appDir], {
stderr: true,
env: {
NEXT_TELEMETRY_DEBUG: 1,
},
})
await fs.rename(
path.join(appDir, 'package.json'),
path.join(appDir, 'package.babel')
)
console.log(stderr)
const event = /NEXT_CLI_SESSION_STARTED[\s\S]+?{([\s\S]+?)}/
.exec(stderr)
.pop()
expect(event).toMatch(/"hasNextConfig": false/)
expect(event).toMatch(/"buildTarget": "default"/)
expect(event).toMatch(/"hasWebpackConfig": false/)
expect(event).toMatch(/"hasBabelConfig": true/)
})
it('cli session: custom babel config (preset)', async () => {
await fs.rename(
path.join(appDir, '.babelrc.preset'),
path.join(appDir, '.babelrc')
)
const { stderr } = await runNextCommand(['build', appDir], {
stderr: true,
env: {
NEXT_TELEMETRY_DEBUG: 1,
},
})
await fs.rename(
path.join(appDir, '.babelrc'),
path.join(appDir, '.babelrc.preset')
)
const event = /NEXT_CLI_SESSION_STARTED[\s\S]+?{([\s\S]+?)}/
.exec(stderr)
.pop()
expect(event).toMatch(/"hasNextConfig": false/)
expect(event).toMatch(/"buildTarget": "default"/)
expect(event).toMatch(/"hasWebpackConfig": false/)
expect(event).toMatch(/"hasBabelConfig": true/)
})
it('cli session: next config with target', async () => {
await fs.rename(
path.join(appDir, 'next.config.target'),
path.join(appDir, 'next.config.js')
)
const { stderr } = await runNextCommand(['build', appDir], {
stderr: true,
env: {
NEXT_TELEMETRY_DEBUG: 1,
},
})
await fs.rename(
path.join(appDir, 'next.config.js'),
path.join(appDir, 'next.config.target')
)
const event = /NEXT_CLI_SESSION_STARTED[\s\S]+?{([\s\S]+?)}/
.exec(stderr)
.pop()
expect(event).toMatch(/"hasNextConfig": true/)
expect(event).toMatch(/"buildTarget": "experimental-serverless-trace"/)
expect(event).toMatch(/"hasWebpackConfig": false/)
expect(event).toMatch(/"hasBabelConfig": false/)
})
it('cli session: next config with webpack', async () => {
await fs.rename(
path.join(appDir, 'next.config.webpack'),
path.join(appDir, 'next.config.js')
)
const { stderr } = await runNextCommand(['build', appDir], {
stderr: true,
env: {
NEXT_TELEMETRY_DEBUG: 1,
},
})
await fs.rename(
path.join(appDir, 'next.config.js'),
path.join(appDir, 'next.config.webpack')
)
const event = /NEXT_CLI_SESSION_STARTED[\s\S]+?{([\s\S]+?)}/
.exec(stderr)
.pop()
expect(event).toMatch(/"hasNextConfig": true/)
expect(event).toMatch(/"buildTarget": "default"/)
expect(event).toMatch(/"hasWebpackConfig": true/)
expect(event).toMatch(/"hasBabelConfig": false/)
})
it('detect static 404 correctly for `next build`', async () => { it('detect static 404 correctly for `next build`', async () => {
const { stderr } = await nextBuild(appDir, [], { const { stderr } = await nextBuild(appDir, [], {
stderr: true, stderr: true,
......
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