Unverified Commit d8f45609 authored by Niklas Mischkulnig's avatar Niklas Mischkulnig Committed by GitHub

[16.3.x] Fix build error when aliasing typescript to @typescript/typescript6 (#97997)

Backport #97942
Co-authored-by: 's avatarvercel-fleet-prod[bot] <318278635+vercel-fleet-prod[bot]@users.noreply.github.com>
parent 656aebfb
import type { ChildProcess } from 'node:child_process' import type { ChildProcess } from 'node:child_process'
import { EventEmitter } from 'node:events' import { EventEmitter } from 'node:events'
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
import { tmpdir } from 'node:os'
import path from 'node:path'
import { PassThrough } from 'node:stream' import { PassThrough } from 'node:stream'
const mockSpawn = jest.fn() const mockSpawn = jest.fn()
...@@ -9,9 +12,114 @@ jest.mock('next/dist/compiled/cross-spawn', () => ({ ...@@ -9,9 +12,114 @@ jest.mock('next/dist/compiled/cross-spawn', () => ({
default: (...args: unknown[]) => mockSpawn(...args), default: (...args: unknown[]) => mockSpawn(...args),
})) }))
const { runTypeScriptCli } = const { getTypeScriptPackageInfo, runTypeScriptCli } =
require('./runTypeScriptCli') as typeof import('./runTypeScriptCli') require('./runTypeScriptCli') as typeof import('./runTypeScriptCli')
function createTypeScriptFixture({
packageJson,
files,
}: {
packageJson: Record<string, unknown>
files: string[]
}) {
const baseDir = mkdtempSync(path.join(tmpdir(), 'next-typescript-'))
const packageDir = path.join(baseDir, 'node_modules', 'typescript')
mkdirSync(packageDir, { recursive: true })
writeFileSync(
path.join(packageDir, 'package.json'),
JSON.stringify(packageJson)
)
for (const file of files) {
const filePath = path.join(packageDir, file)
mkdirSync(path.dirname(filePath), { recursive: true })
writeFileSync(filePath, '')
}
return { baseDir, packageDir }
}
function removeTypeScriptFixture(baseDir: string) {
rmSync(baseDir, { recursive: true, force: true })
}
describe('getTypeScriptPackageInfo', () => {
it('resolves a standard tsc bin', () => {
const { baseDir, packageDir } = createTypeScriptFixture({
packageJson: {
version: '6.0.1',
bin: { tsc: './bin/tsc' },
},
files: ['bin/tsc', 'lib/typescript.js'],
})
try {
expect(getTypeScriptPackageInfo(baseDir)).toMatchObject({
apiPath: path.join(packageDir, 'lib', 'typescript.js'),
tscPath: path.join(packageDir, 'bin', 'tsc'),
})
} finally {
removeTypeScriptFixture(baseDir)
}
})
it('resolves a versioned tsc bin from an aliased TypeScript package', () => {
const { baseDir, packageDir } = createTypeScriptFixture({
packageJson: {
name: '@typescript/typescript6',
version: '6.0.1',
bin: { tsc6: './bin/tsc6' },
},
files: ['bin/tsc6', 'lib/typescript.js'],
})
try {
expect(getTypeScriptPackageInfo(baseDir)).toMatchObject({
apiPath: path.join(packageDir, 'lib', 'typescript.js'),
tscPath: path.join(packageDir, 'bin', 'tsc6'),
})
} finally {
removeTypeScriptFixture(baseDir)
}
})
it('does not return a tsc path when the declared bin is missing', () => {
const { baseDir } = createTypeScriptFixture({
packageJson: {
version: '6.0.1',
bin: { tsc6: './bin/tsc6' },
},
files: ['lib/typescript.js'],
})
try {
expect(getTypeScriptPackageInfo(baseDir)?.tscPath).toBeUndefined()
} finally {
removeTypeScriptFixture(baseDir)
}
})
it('uses the JS CLI wrapper for an extensionless ESM bin', () => {
const { baseDir, packageDir } = createTypeScriptFixture({
packageJson: {
version: '7.0.0',
type: 'module',
bin: { tsc: './bin/tsc' },
},
files: ['bin/tsc', 'lib/tsc.js'],
})
try {
expect(getTypeScriptPackageInfo(baseDir)?.tscPath).toBe(
path.join(packageDir, 'lib', 'tsc.js')
)
} finally {
removeTypeScriptFixture(baseDir)
}
})
})
const processEvents = ['exit', 'SIGINT', 'SIGTERM', 'SIGHUP'] as const const processEvents = ['exit', 'SIGINT', 'SIGTERM', 'SIGHUP'] as const
type ProcessEvent = (typeof processEvents)[number] type ProcessEvent = (typeof processEvents)[number]
......
...@@ -33,7 +33,12 @@ export function getTypeScriptPackageInfo( ...@@ -33,7 +33,12 @@ export function getTypeScriptPackageInfo(
const packageDir = path.dirname(packageJsonPath) const packageDir = path.dirname(packageJsonPath)
const apiPath = path.join(packageDir, 'lib', 'typescript.js') const apiPath = path.join(packageDir, 'lib', 'typescript.js')
const tscBin = const tscBin =
typeof packageJson.bin === 'string' ? packageJson.bin : packageJson.bin?.tsc typeof packageJson.bin === 'string'
? packageJson.bin
: (packageJson.bin?.tsc ??
Object.entries(packageJson.bin ?? {}).find(([name]) =>
/^tsc\d+$/.test(name)
)?.[1])
const tscBinPath = tscBin ? path.resolve(packageDir, tscBin) : undefined const tscBinPath = tscBin ? path.resolve(packageDir, tscBin) : undefined
let tscPath = tscBinPath let tscPath = tscBinPath
......
...@@ -31,7 +31,9 @@ const typescriptApiPackage: MissingDependency = { ...@@ -31,7 +31,9 @@ const typescriptApiPackage: MissingDependency = {
} }
const typescriptCliPackage: MissingDependency = { const typescriptCliPackage: MissingDependency = {
file: 'typescript/bin/tsc', // The CLI path is resolved from the package's bin metadata after this initial
// package-presence check, since aliased TypeScript packages may rename it.
file: 'typescript/package.json',
pkg: 'typescript', pkg: 'typescript',
exportsRestrict: true, exportsRestrict: true,
} }
......
...@@ -169,4 +169,27 @@ describe('TypeScript CLI backend', () => { ...@@ -169,4 +169,27 @@ describe('TypeScript CLI backend', () => {
expect(await next.hasFile('.next/cache/.tsbuildinfo')).toBe(true) expect(await next.hasFile('.next/cache/.tsbuildinfo')).toBe(true)
}) })
}) })
describe('TypeScript 6 npm alias', () => {
const { next, skipped } = nextTestSetup({
files: __dirname,
skipStart: true,
skipDeployment: true,
dependencies: {
typescript: 'npm:@typescript/typescript6@6.0.1',
},
})
if (skipped) return
it('builds with the versioned tsc6 entry point', async () => {
const result = await next.build()
expect(result.exitCode).toBe(0)
expect(result.cliOutput).not.toContain(
'do not have the required package(s) installed'
)
expect(await next.hasFile('.next/cache/.tsbuildinfo')).toBe(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