Files
next.js/packages/next-swc/maybe-build-native.mjs
Tobias KoppersandGitHub 9a7733ed83 Automatically build and clear native build when running pnpm build (#89819)
## What?

Adds a `maybe-build-native.mjs` script to `packages/next-swc/` that conditionally rebuilds native SWC bindings during `pnpm build`. The script is integrated into the turborepo pipeline as the `build` task for `@next/swc`.

## Why?

Developers often forget to run `pnpm swc-build-native` after pulling Rust changes, leading to confusing runtime errors. Conversely, rebuilding native binaries when nothing changed wastes significant time. This automates the decision so `pnpm build` always does the right thing.

## How?

The `maybe-build-native.mjs` script runs as `@next/swc`'s `build` task and:

1. **Skips in CI** — exits immediately when the `CI` env var is set, since CI uses prebuilt `@next/swc-*` npm packages
2. **Finds the last version bump** — uses `git log -G` to locate the commit that last changed `"version":` in `packages/next/package.json`
3. **Checks for Rust changes** — compares `*.rs` files against the working tree (committed + staged + unstaged) since that version bump commit
4. **Rebuilds if needed** — runs `build-native` and copies/formats the generated TypeScript definitions
5. **Clears stale binaries** — if no Rust changes are detected, removes any leftover `.node` files from `native/` so the prebuilt npm packages are used instead

Turborepo's `turbo.json` is configured with Rust-specific inputs (`crates/`, `Cargo.*`, `rust-toolchain`) and `CI` in `env` so CI and local builds get separate cache keys.

### Files changed
- `packages/next-swc/maybe-build-native.mjs` — new script with the conditional build logic
- `packages/next-swc/package.json` — added `"build": "node maybe-build-native.mjs"`
- `packages/next-swc/turbo.json` — added `build` task with Rust inputs, `CI` env, and `native/*.node` outputs
2026-02-19 13:24:33 +01:00

111 lines
2.6 KiB
JavaScript

import { execSync } from 'child_process'
import { readdirSync, rmSync } from 'fs'
import { dirname, join } from 'path'
import { fileURLToPath } from 'url'
const __dirname = dirname(fileURLToPath(import.meta.url))
const PKG_DIR = __dirname
const ROOT_DIR = join(__dirname, '../..')
const NATIVE_DIR = join(PKG_DIR, 'native')
function hasExistingNativeBinary() {
try {
const files = readdirSync(NATIVE_DIR)
return files.some((f) => f.endsWith('.node'))
} catch {
return false
}
}
function clearNativeBinaries() {
try {
const files = readdirSync(NATIVE_DIR)
for (const f of files) {
if (f.endsWith('.node')) {
rmSync(join(NATIVE_DIR, f))
}
}
} catch {
// directory doesn't exist, nothing to clear
}
}
function getVersionBumpCommit() {
try {
return (
execSync(
`git log -1 --format=%H -G '"version":' -- packages/next/package.json`,
{ cwd: ROOT_DIR, encoding: 'utf8' }
).trim() || null
)
} catch {
return null
}
}
function hasRustChanges(sinceCommit) {
try {
// Omit HEAD to compare against the working tree, which includes
// committed, staged, and unstaged changes.
const diff = execSync(
`git diff --name-only ${sinceCommit} -- ':(glob)**/*.rs' ':(glob)**/*.toml' ':(glob).cargo/**' Cargo.lock rust-toolchain`,
{ cwd: ROOT_DIR, encoding: 'utf8' }
).trim()
return diff.length > 0
} catch {
// If we can't determine whether changes occurred, assume they did
return true
}
}
function buildNative() {
console.log('Running swc-build-native...')
execSync('pnpm run swc-build-native', {
cwd: ROOT_DIR,
stdio: 'inherit',
env: {
...process.env,
CARGO_TERM_COLOR: 'always',
TTY: '1',
},
})
}
function main() {
if (process.env.CI) {
console.log('Skipping swc-build-native in CI')
return
}
const versionBumpCommit = getVersionBumpCommit()
if (!versionBumpCommit) {
console.log(
'Could not determine version bump commit (shallow clone?), building native to be safe...'
)
buildNative()
return
}
if (hasRustChanges(versionBumpCommit)) {
console.log(
'Rust source files changed since last version bump, building native...'
)
buildNative()
return
}
// No Rust changes from the release version — clear any stale native build
// so the prebuilt @next/swc-* npm packages are used instead.
if (hasExistingNativeBinary()) {
console.log(
'No Rust changes since last version bump, clearing stale native binary...'
)
clearNativeBinaries()
}
console.log('Skipping swc-build-native (no Rust changes since version bump)')
}
main()