mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-15 14:22:43 +00:00
112 lines
No EOL
5.2 KiB
JavaScript
112 lines
No EOL
5.2 KiB
JavaScript
'use strict'
|
|
/**
|
|
* before-pack.mjs — electron-builder beforePack hook.
|
|
*
|
|
* Two responsibilities:
|
|
*
|
|
* 1. Removes any stale unpacked app directory (`appOutDir`) before
|
|
* electron-builder stages the Electron binaries into it.
|
|
*
|
|
* WHY THIS EXISTS
|
|
* ---------------
|
|
* electron-builder's final packaging step copies the stock `electron`
|
|
* binary into `release/<platform>-unpacked/` and then renames it to the
|
|
* product name (`Hermes`). If a PREVIOUS `npm run pack` was interrupted
|
|
* (Ctrl-C, OOM kill, crash, full disk) the unpacked directory is left in a
|
|
* corrupted partial state: it keeps the already-renamed `LICENSE.electron.txt`
|
|
* and the Chromium payload (.pak/.so/icudtl.dat/chrome-sandbox) but is MISSING
|
|
* the `electron` binary itself.
|
|
*
|
|
* On the next run, electron-builder sees the destination directory already
|
|
* populated, skips re-copying the binary it thinks is present, then tries to
|
|
* rename a `electron` file that no longer exists. The build dies with:
|
|
*
|
|
* ENOENT: no such file or directory, rename
|
|
* '.../release/linux-unpacked/electron' -> '.../release/linux-unpacked/Hermes'
|
|
*
|
|
* This is a hard failure with no obvious cause for the user — `hermes desktop`
|
|
* just prints "Desktop GUI build failed" and the only fix is to manually
|
|
* `rm -rf` the release directory, which a normal user has no way to know.
|
|
*
|
|
* The packaging step is not idempotent across an interrupted run, so we make
|
|
* it idempotent ourselves: wipe the target unpacked directory up front so
|
|
* electron-builder always stages into a clean tree. This is safe — the
|
|
* directory is a pure build artifact that electron-builder fully recreates
|
|
* on every pack; nothing else depends on its prior contents.
|
|
*
|
|
* Cross-platform: the same partial-state trap exists on macOS
|
|
* (the mac-unpacked Hermes.app bundle) and Windows (win-unpacked), so we
|
|
* clean whatever `appOutDir` electron-builder hands us regardless of platform.
|
|
*
|
|
* Best-effort: a cleanup failure must never mask the real build. We log and
|
|
* resolve rather than throw — worst case electron-builder hits the original
|
|
* ENOENT, which is no worse than not having this hook at all.
|
|
*
|
|
* 2. Re-stages node-pty's native files for the ACTUAL target platform/arch
|
|
* of this pack. `npm run build` already staged node-pty once for the
|
|
* host machine (see scripts/stage-native-deps.mjs), which is correct for
|
|
* single-arch builds matching the host. But electron-builder can target
|
|
* a different arch than the host (cross-build), or pack multiple archs
|
|
* from one `npm run build` (e.g. `dist:mac` => x64 + arm64). Only this
|
|
* hook knows the real per-target arch, via `context.arch` /
|
|
* `context.electronPlatformName` — so it re-stages on top of whatever
|
|
* `npm run build` left behind, per target, right before files are read
|
|
* for packing.
|
|
*
|
|
* electron-builder passes a context with:
|
|
* - appOutDir: the unpacked app directory about to be staged
|
|
* - electronPlatformName: 'win32' | 'darwin' | 'linux'
|
|
* - arch: Arch enum (0=ia32, 1=x64, 2=armv7l, 3=arm64, 4=universal)
|
|
*/
|
|
import { existsSync, rmSync } from 'node:fs'
|
|
import { Arch } from 'electron-builder'
|
|
import { stageNodePty } from './stage-native-deps.mjs'
|
|
|
|
export function cleanStaleAppOutDir(appOutDir) {
|
|
if (!appOutDir || typeof appOutDir !== 'string') {
|
|
return false
|
|
}
|
|
if (!existsSync(appOutDir)) {
|
|
return false
|
|
}
|
|
// Recursive + force so a half-written tree (read-only bits, partial files)
|
|
// can't block the wipe. retry/maxRetries rides out transient EBUSY on
|
|
// Windows where an AV/indexer may briefly hold a handle.
|
|
rmSync(appOutDir, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 })
|
|
return true
|
|
}
|
|
|
|
export default async function beforePack(context) {
|
|
const appOutDir = context && context.appOutDir
|
|
try {
|
|
if (cleanStaleAppOutDir(appOutDir)) {
|
|
console.log(`[before-pack] removed stale unpacked dir before staging: ${appOutDir}`)
|
|
}
|
|
} catch (err) {
|
|
// Never fail the build over cleanup; surface why so a genuinely stuck
|
|
// directory (permissions, mount) is still diagnosable.
|
|
console.warn(`[before-pack] could not clean ${appOutDir} (${err.message}); continuing`)
|
|
}
|
|
|
|
try {
|
|
const platform = context && context.electronPlatformName
|
|
const archName = context && typeof context.arch === 'number' ? Arch[context.arch] : undefined
|
|
if (platform && archName) {
|
|
if (archName === 'universal') {
|
|
console.warn(
|
|
'[before-pack] target arch is "universal" — node-pty has no universal prebuild; ' +
|
|
'staged binary will be whichever single-arch copy npm run build left behind. ' +
|
|
'lipo-merge x64/arm64 .node files manually if you need a true universal build.'
|
|
)
|
|
} else {
|
|
await stageNodePty({ platform, arch: archName })
|
|
console.log(`[before-pack] re-staged node-pty for target ${platform}-${archName}`)
|
|
}
|
|
}
|
|
} catch (err) {
|
|
// This one SHOULD fail the build — a missing/wrong native binary for the
|
|
// target arch means a broken package shipped to users, which is worse
|
|
// than a build that fails loudly here.
|
|
throw new Error(`[before-pack] failed to stage node-pty for this target: ${err.message}`)
|
|
}
|
|
} |