Files
archived-orca/config/scripts/macos/terminal-host-bundle/macos-terminal-host-bundle.test.mjs

185 lines
8.2 KiB
JavaScript

import { execFileSync } from 'node:child_process'
import { copyFileSync, existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
import { createRequire } from 'node:module'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import { afterEach, beforeEach, describe, expect, it } from 'vitest'
const require = createRequire(new URL('../../macos-terminal-host-bundle.test.mjs', import.meta.url))
const {
assembleMacTerminalHost,
assertMacTerminalHostUuid,
daemonBareRequires,
findUnresolvedDaemonRequires
} = require('./macos/terminal-host-bundle/macos-terminal-host-bundle.cjs')
const INFO = { CFBundleIdentifier: 'com.stablyai.orca' }
describe.skipIf(process.platform !== 'darwin')('terminal host assembly', () => {
let root
let appPath
beforeEach(() => {
root = mkdtempSync(join(tmpdir(), 'orca-terminal-host-'))
appPath = join(root, 'Orca.app')
const resources = join(appPath, 'Contents', 'Resources')
const out = join(resources, 'app.asar.unpacked', 'out')
mkdirSync(join(out, 'main', 'chunks'), { recursive: true })
writeFileSync(join(out, 'main', 'daemon-entry.js'), 'entry')
writeFileSync(join(out, 'main', 'chunks', 'protocol.js'), 'chunk')
writeFileSync(join(out, 'package.json'), '{"type":"commonjs"}')
const nodePty = join(resources, 'node_modules', 'node-pty')
mkdirSync(join(nodePty, 'lib'), { recursive: true })
mkdirSync(join(nodePty, 'build', 'Release'), { recursive: true })
mkdirSync(join(nodePty, 'src'), { recursive: true })
writeFileSync(join(nodePty, 'package.json'), '{}')
writeFileSync(join(nodePty, 'lib', 'index.js'), 'lib')
writeFileSync(join(nodePty, 'build', 'Release', 'pty.node'), 'addon')
// Some packaged node-pty copies ship spawn-helper without its execute bit.
writeFileSync(join(nodePty, 'build', 'Release', 'spawn-helper'), 'helper', { mode: 0o644 })
writeFileSync(join(nodePty, 'src', 'unix.cc'), 'source')
// A real Mach-O stands in for the pinned Node, whose UUID assembly rewrites.
copyFileSync('/usr/bin/true', join(root, 'node'))
writeFileSync(join(root, 'icon.icns'), 'icon')
})
afterEach(() => {
rmSync(root, { recursive: true, force: true })
})
it("gives the helper executable the main executable's UUID instead of stock Node's", () => {
const paths = assembleMacTerminalHost({
appPath,
nodeExecutable: join(root, 'node'),
iconPath: join(root, 'icon.icns'),
info: INFO
})
execFileSync(paths.executable)
const uuids = execFileSync('dwarfdump', ['--uuid', paths.executable], { encoding: 'utf8' })
// Orca.app's main executable carries these (macos-executable-uuid.test.mjs).
expect(uuids).toContain('016EE681-3DC3-81C7-A6DA-12DC23B89DD9 (x86_64)')
expect(uuids).toContain('E6430410-3B22-8BD6-9677-B18884034A30 (arm64e)')
assertMacTerminalHostUuid(appPath, INFO.CFBundleIdentifier)
})
it('copies every package the daemon requires, with its dependencies', () => {
const resources = join(appPath, 'Contents', 'Resources')
const main = join(resources, 'app.asar.unpacked', 'out', 'main')
writeFileSync(join(main, 'daemon-entry.js'), "require('./chunks/kill.js')")
writeFileSync(
join(main, 'chunks', 'kill.js'),
"require(`node:fs`);require('os');require(`@orca/process-host/gate`)"
)
// Main-process code shipped alongside is not part of the daemon.
writeFileSync(join(main, 'index.js'), "require('unused');require(`electron`)")
const modules = join(resources, 'node_modules')
mkdirSync(join(modules, '@orca', 'process-host', 'dist'), { recursive: true })
writeFileSync(
join(modules, '@orca', 'process-host', 'package.json'),
'{"dependencies":{"retry":"1"}}'
)
mkdirSync(join(modules, 'retry'), { recursive: true })
writeFileSync(join(modules, 'retry', 'package.json'), '{}')
mkdirSync(join(modules, 'unused'), { recursive: true })
writeFileSync(join(modules, 'unused', 'package.json'), '{}')
const paths = assembleMacTerminalHost({
appPath,
nodeExecutable: join(root, 'node'),
iconPath: join(root, 'icon.icns'),
info: INFO
})
const helperModules = join(paths.daemon, 'node_modules')
expect(daemonBareRequires(join(paths.daemon, 'out', 'main'))).toEqual([
'@orca/process-host/gate'
])
expect(existsSync(join(helperModules, '@orca', 'process-host', 'package.json'))).toBe(true)
expect(existsSync(join(helperModules, 'retry', 'package.json'))).toBe(true)
expect(existsSync(join(helperModules, 'unused'))).toBe(false)
expect(existsSync(join(helperModules, 'electron'))).toBe(false)
})
it('fails when the app lacks a package the daemon requires', () => {
const main = join(appPath, 'Contents', 'Resources', 'app.asar.unpacked', 'out', 'main')
writeFileSync(join(main, 'daemon-entry.js'), "require('./gone')")
writeFileSync(join(main, 'gone.js'), "require('yaml')")
expect(() =>
assembleMacTerminalHost({
appPath,
nodeExecutable: join(root, 'node'),
iconPath: join(root, 'icon.icns'),
info: INFO
})
).toThrow(/requires yaml, missing/)
})
it('flags a require that only resolves outside the helper', () => {
const paths = assembleMacTerminalHost({
appPath,
nodeExecutable: join(root, 'node'),
iconPath: join(root, 'icon.icns'),
info: INFO
})
writeFileSync(paths.entry, "require('jsonc-parser')")
// The build tree's node_modules above dist/ is what hid this from the boot check.
mkdirSync(join(root, 'node_modules', 'jsonc-parser'), { recursive: true })
writeFileSync(join(root, 'node_modules', 'jsonc-parser', 'package.json'), '{"main":"i.js"}')
writeFileSync(join(root, 'node_modules', 'jsonc-parser', 'i.js'), '')
expect(findUnresolvedDaemonRequires(paths)).toEqual([
expect.stringMatching(
/^jsonc-parser resolves to .*node_modules\/jsonc-parser\/i\.js, not inside/
)
])
// Node caches resolutions, so the in-bundle case uses a package not resolved above.
writeFileSync(paths.entry, "require('yaml')")
mkdirSync(join(paths.daemon, 'node_modules', 'yaml'), { recursive: true })
writeFileSync(join(paths.daemon, 'node_modules', 'yaml', 'package.json'), '{"main":"i.js"}')
writeFileSync(join(paths.daemon, 'node_modules', 'yaml', 'i.js'), '')
expect(findUnresolvedDaemonRequires(paths)).toEqual([])
})
it("copies a nested package's dependency from wherever Node resolves it", () => {
const resources = join(appPath, 'Contents', 'Resources')
writeFileSync(
join(resources, 'app.asar.unpacked', 'out', 'main', 'daemon-entry.js'),
"require('b')"
)
const modules = join(resources, 'node_modules')
const packages = {
b: { dependencies: { c: '2' } },
// The top-level c is another version; b gets its own nested copy.
c: {},
[join('b', 'node_modules', 'c')]: { dependencies: { e: '1' } },
e: {}
}
for (const [dir, manifest] of Object.entries(packages)) {
mkdirSync(join(modules, dir), { recursive: true })
writeFileSync(join(modules, dir, 'package.json'), JSON.stringify(manifest))
}
const paths = assembleMacTerminalHost({
appPath,
nodeExecutable: join(root, 'node'),
iconPath: join(root, 'icon.icns'),
info: INFO
})
const helperModules = join(paths.daemon, 'node_modules')
expect(existsSync(join(helperModules, 'b', 'node_modules', 'c', 'package.json'))).toBe(true)
expect(existsSync(join(helperModules, 'e', 'package.json'))).toBe(true)
expect(existsSync(join(helperModules, 'c'))).toBe(false)
})
it.each([
['a variable', 'const name = pick();require(name)'],
['a concatenated literal', "require('yaml' + suffix)"],
['a template with a substitution', 'require(`./chunk-${id}.js`)']
])('fails when the daemon loads a module through %s', (_label, source) => {
const main = join(appPath, 'Contents', 'Resources', 'app.asar.unpacked', 'out', 'main')
writeFileSync(join(main, 'daemon-entry.js'), source)
expect(() =>
assembleMacTerminalHost({
appPath,
nodeExecutable: join(root, 'node'),
iconPath: join(root, 'icon.icns'),
info: INFO
})
).toThrow(/loads a module by a computed name/)
})
})