Files
2026-07-13 13:12:33 +08:00

392 lines
13 KiB
JavaScript

import { spawn } from 'node:child_process'
import { createServer } from 'node:net'
import { mkdtemp, mkdir, readdir, rm, writeFile } from 'node:fs/promises'
import { statSync } from 'node:fs'
import { dirname, join, resolve } from 'node:path'
import process from 'node:process'
import { tmpdir } from 'node:os'
import { fileURLToPath } from 'node:url'
const scriptDir = dirname(fileURLToPath(import.meta.url))
const packageRoot = resolve(scriptDir, '..')
const repoRoot = resolve(packageRoot, '..', '..')
const desktopOutputDir = join(repoRoot, 'dist', 'desktop-electron')
const sourceRuntimeGatewayDir = join(packageRoot, 'runtime', 'gateway')
const binaryName = process.platform === 'win32' ? 'opensquilla-gateway.exe' : 'opensquilla-gateway'
const deadlineMs = Number.parseInt(process.env.OPENSQUILLA_GATEWAY_SMOKE_TIMEOUT_MS || '90000', 10)
const pollIntervalMs = 250
const killGraceMs = 3_000
const maxTailLines = 80
function appendTail(tail, chunk) {
const lines = chunk
.toString()
.split(/\r?\n/)
.filter((line) => line.length > 0)
if (lines.length === 0) return tail
return [...tail, ...lines].slice(-maxTailLines)
}
function formatTail(stdoutTail, stderrTail) {
const parts = []
if (stdoutTail.length > 0) parts.push(`stdout tail:\n${stdoutTail.join('\n')}`)
if (stderrTail.length > 0) parts.push(`stderr tail:\n${stderrTail.join('\n')}`)
return parts.length > 0 ? `\n\n${parts.join('\n\n')}` : ''
}
function pathIsFile(path) {
try {
return statSync(path).isFile()
} catch {
return false
}
}
function pathIsDirectory(path) {
try {
return statSync(path).isDirectory()
} catch {
return false
}
}
function gatewayBinaryCandidates(runtimeGatewayDir) {
return [join(runtimeGatewayDir, 'opensquilla-gateway', binaryName), join(runtimeGatewayDir, binaryName)]
}
function findGatewayBinary(runtimeGatewayDir) {
return gatewayBinaryCandidates(runtimeGatewayDir).find(pathIsFile)
}
async function findGeneratedBundleRuntimes(root) {
const runtimes = []
const seenResourcesDirs = new Set()
if (!pathIsDirectory(root)) return runtimes
function addRuntime(label, resourcesDir, platform) {
if (platform !== process.platform || seenResourcesDirs.has(resourcesDir)) return
seenResourcesDirs.add(resourcesDir)
runtimes.push({
label,
runtimeGatewayDir: join(resourcesDir, 'runtime', 'gateway'),
})
}
async function walk(dir, depth) {
if (depth > 5) return
const entries = await readdir(dir, { withFileTypes: true }).catch(() => [])
for (const entry of entries) {
if (!entry.isDirectory()) continue
const path = join(dir, entry.name)
if (entry.name.endsWith('.app')) {
addRuntime(`generated app bundle ${path}`, join(path, 'Contents', 'Resources'), 'darwin')
} else if (entry.name === 'win-unpacked' || entry.name === 'linux-unpacked') {
addRuntime(`generated bundle ${path}`, join(path, 'resources'), entry.name === 'win-unpacked' ? 'win32' : 'linux')
} else {
await walk(path, depth + 1)
}
}
}
await walk(root, 0)
return runtimes.sort((left, right) => left.runtimeGatewayDir.localeCompare(right.runtimeGatewayDir))
}
async function selectRuntimeGateway() {
const generatedRuntimes = await findGeneratedBundleRuntimes(desktopOutputDir)
if (generatedRuntimes.length > 0) {
const selected = generatedRuntimes[0]
if (generatedRuntimes.length > 1) {
console.log(`Found ${generatedRuntimes.length} generated bundle runtimes; selecting first sorted path.`)
for (const runtime of generatedRuntimes) console.log(`- ${runtime.runtimeGatewayDir}`)
}
console.log(`Smoking packaged gateway runtime from ${selected.label}: ${selected.runtimeGatewayDir}`)
return selected.runtimeGatewayDir
}
if (process.env.OPENSQUILLA_REQUIRE_PACKAGED_GATEWAY_SMOKE === '1') {
throw new Error(`No current-platform generated Electron bundle runtime found under ${desktopOutputDir}.`)
}
console.log(`No current-platform generated Electron bundle runtime found under ${desktopOutputDir}; falling back to source runtime ${sourceRuntimeGatewayDir}.`)
return sourceRuntimeGatewayDir
}
function smokeEnv(tempHome, stateDir, config) {
const env = {}
for (const [key, value] of Object.entries(process.env)) {
if (key.startsWith('OPENSQUILLA_')) continue
env[key] = value
}
return {
...env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENSQUILLA_DESKTOP: '1',
OPENSQUILLA_INSTALL_METHOD: 'desktop',
OPENSQUILLA_STATE_DIR: stateDir,
OPENSQUILLA_GATEWAY_CONFIG_PATH: config,
PYTHONUNBUFFERED: '1',
PYTHONUTF8: '1',
PYTHONIOENCODING: 'utf-8:replace',
}
}
async function findFreePort() {
return await new Promise((resolvePort, reject) => {
const server = createServer()
server.unref()
server.once('error', reject)
server.listen(0, '127.0.0.1', () => {
const address = server.address()
if (!address || typeof address === 'string') {
server.close(() => reject(new Error('Could not determine an available loopback port.')))
return
}
const { port } = address
server.close((error) => {
if (error) reject(error)
else resolvePort(port)
})
})
})
}
async function sleep(ms) {
await new Promise((resolveSleep) => setTimeout(resolveSleep, ms))
}
function bodySnippet(body) {
return body.length > 300 ? `${body.slice(0, 300)}...` : body
}
async function healthCheck(url) {
try {
const response = await fetch(url, { signal: AbortSignal.timeout(1_000) })
const body = await response.text()
if (!response.ok) {
return { ok: false, detail: `${url} returned HTTP ${response.status}: ${bodySnippet(body)}` }
}
let payload
try {
payload = JSON.parse(body)
} catch (error) {
return {
ok: false,
detail: `${url} returned HTTP ${response.status} with non-JSON body: ${bodySnippet(body)} (${error instanceof Error ? error.message : String(error)})`,
}
}
if (payload?.ok === true) return { ok: true, detail: '' }
return { ok: false, detail: `${url} returned JSON without ok=true: ${bodySnippet(body)}` }
} catch (error) {
return { ok: false, detail: `${url} request failed: ${error instanceof Error ? error.message : String(error)}` }
}
}
async function fetchText(url) {
const response = await fetch(url, { signal: AbortSignal.timeout(2_000) })
const body = await response.text()
if (!response.ok) {
throw new Error(`${url} returned HTTP ${response.status}: ${bodySnippet(body)}`)
}
return body
}
function controlAssetUrls(html, baseUrl) {
const urls = []
for (const match of html.matchAll(/<script\b[^>]*\btype="module"[^>]*\bsrc="([^"]+)"/g)) {
urls.push(new URL(match[1], baseUrl).toString())
}
for (const match of html.matchAll(/<link\b[^>]*\brel="stylesheet"[^>]*\bhref="([^"]+)"/g)) {
urls.push(new URL(match[1], baseUrl).toString())
}
return urls
}
async function verifyControlUi(port, stdoutTail, stderrTail) {
const controlUrl = `http://127.0.0.1:${port}/control/`
const html = await fetchText(controlUrl)
const assetUrls = controlAssetUrls(html, controlUrl)
const hasModule = assetUrls.some((url) => url.includes('/static/dist/') && url.endsWith('.js'))
const hasStylesheet = assetUrls.some((url) => url.includes('/static/dist/') && url.endsWith('.css'))
if (!hasModule || !hasStylesheet) {
throw new Error(
`${controlUrl} did not inject Vite JS/CSS assets from /static/dist/. ` +
`Found assets: ${assetUrls.length > 0 ? assetUrls.join(', ') : '(none)'}.` +
formatTail(stdoutTail, stderrTail)
)
}
for (const url of assetUrls.filter((assetUrl) => assetUrl.includes('/static/dist/'))) {
await fetchText(url)
}
}
async function waitForGateway(port, childExit, stdoutTail, stderrTail) {
const deadline = Date.now() + deadlineMs
const healthzUrl = `http://127.0.0.1:${port}/healthz`
const healthUrl = `http://127.0.0.1:${port}/health`
let lastHealthFailure = ''
while (Date.now() < deadline) {
if (childExit.value) {
const { code, signal } = childExit.value
throw new Error(
`Gateway exited before becoming healthy (code=${code ?? 'null'} signal=${signal ?? 'null'}).` +
formatTail(stdoutTail, stderrTail)
)
}
const healthz = await healthCheck(healthzUrl)
if (healthz.ok) return
const health = await healthCheck(healthUrl)
if (health.ok) return
lastHealthFailure = `${healthz.detail}; ${health.detail}`
await sleep(pollIntervalMs)
}
const detail = lastHealthFailure ? ` Last health failure: ${lastHealthFailure}` : ''
throw new Error(`Timed out after ${deadlineMs / 1000}s waiting for ${healthzUrl} or ${healthUrl}.${detail}` + formatTail(stdoutTail, stderrTail))
}
async function terminateChild(child, childClosed) {
if (childClosed.value) return
await new Promise((resolveTerminate) => {
let settled = false
let forceTimer = null
let abandonTimer = null
function finish() {
if (settled) return
settled = true
if (forceTimer) clearTimeout(forceTimer)
if (abandonTimer) clearTimeout(abandonTimer)
resolveTerminate()
}
if (process.platform !== 'win32') child.once('close', finish)
if (child.exitCode === null && child.signalCode === null) {
if (process.platform === 'win32' && child.pid) {
const finishAfterTaskkill = () => {
if (childClosed.value || child.exitCode !== null || child.signalCode !== null) {
finish()
return
}
abandonTimer = setTimeout(finish, 1_000)
}
const killer = spawn('taskkill', ['/PID', String(child.pid), '/T', '/F'], {
stdio: 'ignore',
windowsHide: true,
})
const taskkillTimer = setTimeout(() => {
console.warn(`taskkill timed out while terminating gateway process ${child.pid}.`)
killer.kill()
finishAfterTaskkill()
}, killGraceMs)
killer.once('error', (error) => {
clearTimeout(taskkillTimer)
console.warn(`taskkill failed while terminating gateway process ${child.pid}: ${error.message}`)
finishAfterTaskkill()
})
killer.once('close', (code, signal) => {
clearTimeout(taskkillTimer)
if (code !== 0) {
console.warn(`taskkill exited while terminating gateway process ${child.pid} with code=${code ?? 'null'} signal=${signal ?? 'null'}.`)
}
finishAfterTaskkill()
})
} else if (process.platform === 'win32') {
console.warn('Gateway process had no PID for taskkill fallback.')
child.kill()
} else {
child.kill('SIGTERM')
}
}
forceTimer = setTimeout(() => {
if (child.exitCode === null && child.signalCode === null) {
if (process.platform !== 'win32') {
child.kill('SIGKILL')
abandonTimer = setTimeout(finish, 1_000)
} else {
finish()
}
} else {
finish()
}
}, killGraceMs)
})
}
async function main() {
const runtimeGatewayDir = await selectRuntimeGateway()
const candidates = gatewayBinaryCandidates(runtimeGatewayDir)
const gatewayBinary = findGatewayBinary(runtimeGatewayDir)
if (!gatewayBinary) {
throw new Error(
`Packaged gateway binary is missing. Checked: ${candidates.join(', ')}. Run npm run build:gateway first; release CI should run this after electron-builder.`
)
}
const tempHome = await mkdtemp(join(tmpdir(), 'opensquilla-gateway-smoke-'))
const config = join(tempHome, 'config.toml')
const stateDir = join(tempHome, 'state')
let child = null
const stdoutTail = []
const stderrTail = []
const childExit = { value: null }
const childClosed = { value: false }
try {
await mkdir(stateDir, { recursive: true })
await writeFile(
config,
[
'[auth]',
'mode = "none"',
'',
].join('\n'),
'utf8'
)
const port = await findFreePort()
child = spawn(gatewayBinary, ['gateway', 'run', '--port', String(port), '--bind', '127.0.0.1', '--config', config], {
cwd: dirname(gatewayBinary),
env: smokeEnv(tempHome, stateDir, config),
windowsHide: true,
})
child.stdout.on('data', (chunk) => {
stdoutTail.splice(0, stdoutTail.length, ...appendTail(stdoutTail, chunk))
})
child.stderr.on('data', (chunk) => {
stderrTail.splice(0, stderrTail.length, ...appendTail(stderrTail, chunk))
})
child.once('close', (code, signal) => {
childClosed.value = true
childExit.value = { code, signal }
})
child.once('error', (error) => {
childExit.value = { code: null, signal: `spawn error: ${error.message}` }
})
await waitForGateway(port, childExit, stdoutTail, stderrTail)
await verifyControlUi(port, stdoutTail, stderrTail)
console.log('OpenSquilla packaged gateway smoke passed.')
} finally {
if (child) await terminateChild(child, childClosed)
await rm(tempHome, { recursive: true, force: true })
}
}
main().catch((error) => {
console.error(error instanceof Error ? error.message : String(error))
process.exit(1)
})