| |
| new file mode 100644 |
| |
| |
| |
| @@ -0,0 +1,277 @@ |
| +/* global jest */ |
| + |
| +jest.autoMockOff() |
| + |
| +const fs = require('fs') |
| +const os = require('os') |
| +const path = require('path') |
| +const { spawnSync } = require('child_process') |
| + |
| +const codemodRoot = path.resolve(__dirname, '../..') |
| +const tsx = path.resolve(codemodRoot, '../../node_modules/.bin/tsx') |
| +const projects = [] |
| + |
| +// The verifier setup builds the base revision before applying a candidate patch. |
| +// Run a source snapshot of the current package so tests see candidate changes |
| +// instead of stale generated JavaScript while still reusing the prebuilt |
| +// transforms. Copy the whole package rather than assuming that an implementation |
| +// must live in bin/ and lib/: a CLI may legitimately import a new source folder, |
| +// a JavaScript-only helper, or package metadata added by the candidate. |
| +function createSourceCli() { |
| + const root = fs.mkdtempSync(path.join(os.tmpdir(), 'next-codemod-cli-')) |
| + projects.push(root) |
| + |
| + const sourceFile = (file) => { |
| + const relative = path.relative(codemodRoot, file) |
| + const topLevel = relative.split(path.sep)[0] |
| + if (topLevel === 'node_modules' || topLevel === 'transforms') return false |
| + |
| + // Ignore a generated artifact only when its source sibling exists. This |
| + // keeps candidate-authored JavaScript modules while ensuring tsx loads a |
| + // changed TypeScript source file instead of JavaScript built from HEAD. |
| + const sourceBase = file.replace(/(?:\.js(?:\.map)?|\.d\.ts(?:\.map)?)$/, '') |
| + if (sourceBase !== file) { |
| + if (fs.existsSync(`${sourceBase}.ts`)) return false |
| + if (fs.existsSync(`${sourceBase}.tsx`)) return false |
| + } |
| + return true |
| + } |
| + fs.cpSync(codemodRoot, root, { recursive: true, filter: sourceFile }) |
| + |
| + for (const entry of ['node_modules', 'transforms']) { |
| + fs.symlinkSync( |
| + path.join(codemodRoot, entry), |
| + path.join(root, entry), |
| + 'dir' |
| + ) |
| + } |
| + |
| + return path.join(root, 'bin', 'next-codemod.ts') |
| +} |
| + |
| +function writeJson(file, value) { |
| + fs.mkdirSync(path.dirname(file), { recursive: true }) |
| + fs.writeFileSync(file, JSON.stringify(value, null, 2)) |
| +} |
| + |
| +function createProject({ |
| + installedNext, |
| + installedReact, |
| + targetNext, |
| + targetReact, |
| + devScript, |
| + pages = false, |
| +}) { |
| + const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'next-codemod-upgrade-')) |
| + projects.push(dir) |
| + |
| + writeJson(path.join(dir, 'package.json'), { |
| + private: true, |
| + scripts: { dev: devScript }, |
| + dependencies: { |
| + next: installedNext, |
| + react: installedReact, |
| + 'react-dom': installedReact, |
| + }, |
| + }) |
| + writeJson(path.join(dir, 'package-lock.json'), {}) |
| + for (const dependency of ['next', 'react', 'react-dom']) { |
| + writeJson(path.join(dir, 'node_modules', dependency, 'package.json'), { |
| + name: dependency, |
| + version: dependency === 'next' ? installedNext : installedReact, |
| + }) |
| + } |
| + if (pages) { |
| + fs.mkdirSync(path.join(dir, 'pages'), { recursive: true }) |
| + fs.writeFileSync( |
| + path.join(dir, 'pages', 'index.js'), |
| + 'export default () => null\n' |
| + ) |
| + } |
| + |
| + const fakeBin = path.join(dir, 'fake-bin') |
| + fs.mkdirSync(fakeBin) |
| + const npm = `#!/usr/bin/env node |
| +const fs = require('fs') |
| +const args = process.argv.slice(2) |
| +const query = args.find((arg) => arg.includes('@')) || '' |
| +if (args.includes('view')) { |
| + if (query.startsWith('next@') && args.includes('version')) { |
| + console.log(JSON.stringify(process.env.TEST_TARGET_NEXT)) |
| + } else if (query.startsWith('next@')) { |
| + console.log(JSON.stringify({ version: process.env.TEST_TARGET_NEXT, peerDependencies: { react: process.env.TEST_REACT_RANGE } })) |
| + } else { |
| + console.log(JSON.stringify(process.env.TEST_TARGET_REACT)) |
| + } |
| +} else { |
| + fs.appendFileSync(process.env.TEST_COMMAND_LOG, 'npm ' + args.join(' ') + '\\n') |
| +} |
| +` |
| + const npx = `#!/usr/bin/env node |
| +require('fs').appendFileSync(process.env.TEST_COMMAND_LOG, 'npx ' + process.argv.slice(2).join(' ') + '\\n') |
| +` |
| + for (const [name, contents] of [ |
| + ['npm', npm], |
| + ['npx', npx], |
| + ]) { |
| + const file = path.join(fakeBin, name) |
| + fs.writeFileSync(file, contents) |
| + fs.chmodSync(file, 0o755) |
| + } |
| + |
| + return { |
| + dir, |
| + cli: createSourceCli(), |
| + commandLog: path.join(dir, 'commands.log'), |
| + env: { |
| + ...process.env, |
| + PATH: `${fakeBin}${path.delimiter}${process.env.PATH}`, |
| + TEST_TARGET_NEXT: targetNext, |
| + TEST_TARGET_REACT: targetReact, |
| + TEST_REACT_RANGE: `^${targetReact}`, |
| + TEST_COMMAND_LOG: path.join(dir, 'commands.log'), |
| + FORCE_COLOR: '0', |
| + }, |
| + } |
| +} |
| + |
| +function runUpgrade(project, args, { tty = false, input } = {}) { |
| + if (!tty) { |
| + return spawnSync(tsx, [project.cli, 'upgrade', ...args], { |
| + cwd: project.dir, |
| + env: project.env, |
| + encoding: 'utf8', |
| + timeout: 15_000, |
| + }) |
| + } |
| + |
| + const quote = (value) => `'${value.replaceAll("'", "'\\''")}'` |
| + const command = [tsx, project.cli, 'upgrade', ...args].map(quote).join(' ') |
| + return spawnSync('script', ['-q', '-e', '-c', command, '/dev/null'], { |
| + cwd: project.dir, |
| + env: project.env, |
| + encoding: 'utf8', |
| + timeout: 15_000, |
| + input, |
| + }) |
| +} |
| + |
| +function outputOf(result) { |
| + return `${result.stdout || ''}\n${result.stderr || ''}` |
| +} |
| + |
| +afterEach(() => { |
| + while (projects.length) { |
| + fs.rmSync(projects.pop(), { recursive: true, force: true }) |
| + } |
| +}) |
| + |
| +test('upgrade help exposes both non-interactive option spellings', () => { |
| + const cli = createSourceCli() |
| + const result = spawnSync(tsx, [cli, 'upgrade', '--help'], { |
| + encoding: 'utf8', |
| + timeout: 15_000, |
| + }) |
| + |
| + expect(result.status).toBe(0) |
| + expect(outputOf(result)).toMatch(/-y, --yes\b/) |
| +}) |
| + |
| +test('TTY use without --yes remains interactive', () => { |
| + const project = createProject({ |
| + installedNext: '15.0.0-canary.90', |
| + installedReact: '19.0.0', |
| + targetNext: '15.0.0-canary.100', |
| + targetReact: '19.0.0', |
| + devScript: 'next dev', |
| + }) |
| + |
| + // Reject the default Turbopack suggestion. A command that incorrectly forces |
| + // non-interactive defaults would update this script instead. |
| + const result = runUpgrade(project, ['15.0.0-canary.100'], { |
| + tty: true, |
| + input: 'n\n', |
| + }) |
| + expect(outputOf(result)).toContain('Enable Turbopack') |
| + expect(result.status).toBe(0) |
| + |
| + const manifest = JSON.parse( |
| + fs.readFileSync(path.join(project.dir, 'package.json'), 'utf8') |
| + ) |
| + expect(manifest.scripts.dev).toBe('next dev') |
| +}) |
| + |
| +test('--yes accepts prompt defaults even when the command has a TTY', () => { |
| + const project = createProject({ |
| + installedNext: '15.0.0-canary.90', |
| + installedReact: '18.2.0', |
| + targetNext: '15.0.0-canary.100', |
| + targetReact: '19.0.0', |
| + devScript: 'next dev', |
| + pages: true, |
| + }) |
| + |
| + const result = runUpgrade(project, ['15.0.0-canary.100', '--yes'], { |
| + tty: true, |
| + }) |
| + expect(result.status).toBe(0) |
| + |
| + const manifest = JSON.parse( |
| + fs.readFileSync(path.join(project.dir, 'package.json'), 'utf8') |
| + ) |
| + expect(manifest.scripts.dev).toContain('next dev --turbo') |
| + expect(manifest.dependencies.next).toBe('15.0.0-canary.100') |
| + expect(manifest.dependencies.react).toBe('19.0.0') |
| + expect(manifest.dependencies['react-dom']).toBe('19.0.0') |
| + |
| + const commands = fs.readFileSync(project.commandLog, 'utf8') |
| + expect(commands).toContain('react/19/migration-recipe') |
| + expect(commands).toContain('types-react-codemod@latest') |
| +}) |
| + |
| +test('piped stdin automatically leaves an unrecognized custom dev script unchanged', () => { |
| + const devScript = 'node scripts/start-development.js --inspect' |
| + const project = createProject({ |
| + installedNext: '15.0.0-canary.90', |
| + installedReact: '19.0.0', |
| + targetNext: '15.0.0-canary.100', |
| + targetReact: '19.0.0', |
| + devScript, |
| + }) |
| + |
| + const result = runUpgrade(project, ['15.0.0-canary.100']) |
| + expect(result.status).toBe(0) |
| + const manifest = JSON.parse( |
| + fs.readFileSync(path.join(project.dir, 'package.json'), 'utf8') |
| + ) |
| + expect(manifest.scripts.dev).toBe(devScript) |
| + expect(manifest.dependencies.next).toBe('15.0.0-canary.100') |
| +}) |
| + |
| +test('piped stdin applies every recommended Next.js codemod', () => { |
| + const project = createProject({ |
| + installedNext: '13.5.0', |
| + installedReact: '18.2.0', |
| + targetNext: '14.2.0', |
| + targetReact: '18.3.1', |
| + devScript: 'next dev', |
| + }) |
| + const page = path.join(project.dir, 'app', 'page.tsx') |
| + fs.mkdirSync(path.dirname(page), { recursive: true }) |
| + fs.writeFileSync( |
| + page, |
| + `import { ImageResponse } from 'next/server'\n\nexport const metadata = {\n title: 'Keep this title',\n viewport: { width: 'device-width' },\n themeColor: 'black',\n}\n\nexport default function Page() { return null }\n` |
| + ) |
| + |
| + const result = runUpgrade(project, ['14.2.0']) |
| + expect(result.status).toBe(0) |
| + |
| + const output = outputOf(result) |
| + expect(output).toContain('metadata-to-viewport-export') |
| + expect(output).toContain('next-og-import') |
| + |
| + const transformed = fs.readFileSync(page, 'utf8') |
| + expect(transformed).toMatch(/from ['"]next\/og['"]/) |
| + expect(transformed).toContain('export const viewport') |
| + expect(transformed).toContain("title: 'Keep this title'") |
| +}) |
|
|