parseCmdline(ctx, program): void only adapts commander control flow to
the launcher: it parses the immutable cmdlineArgs snapshot and turns
help, version, parse errors, and action rejections into a ctx.appExit
request. App validation and the ctx.provide of the app-owned service
live in the program's own synchronous .action(), which commander runs
inside parse — program.error(...) there shares the exit path with a
grammar rejection. Deletes the CmdlinePlan export, its unread ctx
parameter, the type-unsound (() => ({}) as T) default, and the
T | undefined return with its per-caller publish guard.
233 lines
9.3 KiB
TypeScript
233 lines
9.3 KiB
TypeScript
/**
|
|
* The launcher-to-app command line over a REAL Loader tree, mounted the way a
|
|
* profile boot mounts it: Loader holds each row until its injections are
|
|
* active, then resolves that row's config against its injection-ready context.
|
|
*/
|
|
|
|
import { mkdtempSync, writeFileSync } from 'node:fs'
|
|
import { tmpdir } from 'node:os'
|
|
import { join } from 'node:path'
|
|
import { pathToFileURL } from 'node:url'
|
|
import { Command } from 'commander'
|
|
import { Context } from '@deepseek-ai/cordis'
|
|
import Loader from '@deepseek-ai/cordis-plugin-loader'
|
|
import Include from '@deepseek-ai/cordis-plugin-include'
|
|
import type { PatchOptions } from '@deepseek-ai/cordis-plugin-include'
|
|
import { afterEach, describe, expect, it } from 'vitest'
|
|
import { internals, parseCmdline, provideCmdline } from '../src/index.ts'
|
|
|
|
/** Every value one boot of the fixture tree observed. */
|
|
interface Observed {
|
|
/** Config the reading row started with; absent means it never started. */
|
|
started?: Record<string, unknown>
|
|
exits: number[]
|
|
out: string
|
|
}
|
|
|
|
/** A booted fixture tree: what it observed, and its root for direct parser calls. */
|
|
interface Fixture {
|
|
observed: Observed
|
|
ctx: Context
|
|
}
|
|
|
|
const disposers: (() => Promise<void>)[] = []
|
|
|
|
afterEach(async () => {
|
|
for (const dispose of disposers.splice(0)) await dispose()
|
|
internals.stdout = process.stdout
|
|
internals.stderr = process.stderr
|
|
})
|
|
|
|
/** The fixture app's flag family: one `--port` its rows read from the service. */
|
|
function demoCommand(): Command {
|
|
return new Command().name('demo').exitOverride().option('--port <port>', 'listen port')
|
|
}
|
|
|
|
/** The fixture app's action body: the resolved values its rows read. */
|
|
const resolveDemo = (program: Command): { port?: number } => {
|
|
const port = program.opts<{ port?: string }>().port
|
|
if (port === undefined) return {}
|
|
if (!/^\d+$/.test(port)) program.error(`error: --port must be a number, got ${JSON.stringify(port)}`)
|
|
return { port: Number(port) }
|
|
}
|
|
|
|
/** A YAML `!!js` expression node, as the include parses one out of a patch file. */
|
|
const expression = (source: string): unknown => ({ __jsExpr: source })
|
|
|
|
/**
|
|
* Mount a two-row composition the way a profile boot does: both rows at once,
|
|
* with Loader ordering config resolution from their injections.
|
|
* @param args - the invocation's inner arguments.
|
|
* @param resolve - the app's action body; defaults to the fixture's own.
|
|
* @returns the booted fixture.
|
|
*/
|
|
async function bootFixture(
|
|
args: string[],
|
|
resolve: (program: Command) => unknown = resolveDemo,
|
|
options: { objectInject?: boolean; withoutProvider?: boolean } = {},
|
|
): Promise<Fixture> {
|
|
const dir = mkdtempSync(join(tmpdir(), 'dsh-cmdline-'))
|
|
const observed: Observed = { exits: [], out: '' }
|
|
writeFileSync(join(dir, 'reader.mjs'), `
|
|
export const name = 'reader'
|
|
export const inject = ['demoStartup']
|
|
export function apply(ctx, config) { globalThis.__observed.started = config }
|
|
`)
|
|
// The Loader imports a row through Node's own resolver, which cannot resolve
|
|
// this workspace's sources; the row delegates to the real function the test
|
|
// imported through the source-plane path mapping.
|
|
writeFileSync(join(dir, 'startup.mjs'), `
|
|
export const name = 'demo-startup'
|
|
export const inject = ['cmdlineArgs']
|
|
export function apply(ctx) { return globalThis.__provideDemoArgs(ctx) }
|
|
`)
|
|
writeFileSync(join(dir, 'cordis.yml'), '[]\n')
|
|
const observing = { write: (chunk: string) => { observed.out += chunk; return true } }
|
|
internals.stdout = observing
|
|
internals.stderr = observing
|
|
const globals = globalThis as unknown as { __observed: Observed; __provideDemoArgs: (ctx: Context) => void }
|
|
globals.__observed = observed
|
|
globals.__provideDemoArgs = (ctx: Context) => {
|
|
const program = demoCommand()
|
|
program.action(() => { ctx.provide('demoStartup', resolve(program)) })
|
|
parseCmdline(ctx, program)
|
|
}
|
|
|
|
// The composition, exactly as a profile delivers one: include patches whose
|
|
// config carries `!!js` expressions.
|
|
const composition: PatchOptions[] = [{
|
|
insert: [
|
|
...options.withoutProvider === true
|
|
? []
|
|
: [{ id: 'demo-startup', name: pathToFileURL(join(dir, 'startup.mjs')).href }],
|
|
{
|
|
id: 'reader',
|
|
name: pathToFileURL(join(dir, 'reader.mjs')).href,
|
|
inject: options.objectInject === true ? { demoStartup: { required: true } } : ['demoStartup'],
|
|
config: { port: expression('ctx.demoStartup.port ?? 3080') },
|
|
},
|
|
],
|
|
}]
|
|
const ctx = new Context()
|
|
await ctx.plugin(Loader)
|
|
ctx.loader.builtins.include = Include
|
|
provideCmdline(ctx, { args, exit: code => void observed.exits.push(code) })
|
|
await ctx.loader.create({
|
|
name: 'cordis:include',
|
|
config: { path: pathToFileURL(join(dir, 'cordis.yml')).href, patches: structuredClone(composition) },
|
|
})
|
|
await ctx.loader.await()
|
|
disposers.push(async () => { await ctx.fiber.dispose() })
|
|
return { observed, ctx }
|
|
}
|
|
|
|
describe('parseCmdline', () => {
|
|
it('lets a row read the flag value the app resolved', async () => {
|
|
const { observed } = await bootFixture(['--port', '8080'])
|
|
expect(observed.started).toEqual({ port: 8080 })
|
|
expect(observed.exits).toEqual([])
|
|
})
|
|
|
|
it('leaves a row on the value written beside the expression when no flag names one', async () => {
|
|
const { observed } = await bootFixture([])
|
|
expect(observed.started).toEqual({ port: 3080 })
|
|
})
|
|
|
|
it('recognizes the Loader object form of a provider-service injection', async () => {
|
|
const { observed } = await bootFixture(['--port', '8080'], resolveDemo, { objectInject: true })
|
|
expect(observed.started).toEqual({ port: 8080 })
|
|
})
|
|
|
|
it('prints the app help, starts no reading row, and requests exit 0', async () => {
|
|
const { observed } = await bootFixture(['--help'])
|
|
expect(observed.out).toContain('Usage: demo')
|
|
expect(observed.started).toBeUndefined()
|
|
expect(observed.exits).toEqual([0])
|
|
})
|
|
|
|
it('rejects the invocation from the action without starting the app', async () => {
|
|
const { observed } = await bootFixture(['--port', 'abc'])
|
|
expect(observed.out).toContain('--port must be a number')
|
|
expect(observed.started).toBeUndefined()
|
|
expect(observed.exits).toEqual([1])
|
|
})
|
|
|
|
it('rethrows an action failure that is not commander asking to exit', async () => {
|
|
const { ctx } = await bootFixture([], resolveDemo, { withoutProvider: true })
|
|
const program = demoCommand().action(() => { throw new Error('action exploded') })
|
|
expect(() => { parseCmdline(ctx, program) }).toThrow('action exploded')
|
|
})
|
|
|
|
it('rethrows a thrown value that is not an object at all', async () => {
|
|
const { ctx } = await bootFixture([], resolveDemo, { withoutProvider: true })
|
|
const program = demoCommand().action(() => {
|
|
const thrown: unknown = 'action threw a string'
|
|
throw thrown
|
|
})
|
|
expect(() => { parseCmdline(ctx, program) }).toThrow('action threw a string')
|
|
})
|
|
|
|
it('runs the action without inspecting Loader rows or owning a service', async () => {
|
|
const { ctx } = await bootFixture([], resolveDemo, { withoutProvider: true })
|
|
let values: unknown
|
|
const program = demoCommand()
|
|
program.action(() => { values = resolveDemo(program) })
|
|
parseCmdline(ctx, program)
|
|
expect(values).toEqual({})
|
|
expect(ctx.get('demoStartup')).toBeUndefined()
|
|
})
|
|
})
|
|
|
|
describe('provideCmdline', () => {
|
|
it('hands the app a snapshot the caller cannot mutate afterwards', () => {
|
|
const ctx = new Context()
|
|
const args = ['--resume', 'abc']
|
|
provideCmdline(ctx, { args, exit: () => {} })
|
|
args.push('--tampered')
|
|
expect(ctx.cmdlineArgs?.get()).toEqual(['--resume', 'abc'])
|
|
})
|
|
|
|
it('refuses at load a program in which no command declares an action', async () => {
|
|
const { ctx } = await bootFixture([], resolveDemo, { withoutProvider: true })
|
|
expect(() => { parseCmdline(ctx, demoCommand()) })
|
|
.toThrow('no command in the program declares an action')
|
|
})
|
|
|
|
it('routes a pre-registered subcommand rejection through the launcher exit request', () => {
|
|
const ctx = new Context()
|
|
const exits: number[] = []
|
|
let err = ''
|
|
internals.stderr = { write: (chunk: string) => { err += chunk; return true } }
|
|
provideCmdline(ctx, { args: ['serve'], exit: code => void exits.push(code) })
|
|
// The root declares no action of its own: the tree-wide guard accepts the
|
|
// subcommand's, and the subcommand inherits the exit and output routing.
|
|
const program = new Command().name('demo')
|
|
const child = program.command('serve')
|
|
child.action(() => { child.error('error: serve rejected') })
|
|
parseCmdline(ctx, program)
|
|
expect(err).toContain('serve rejected')
|
|
expect(exits).toEqual([1])
|
|
})
|
|
|
|
it('fails loud when a parser runs without the launcher values', () => {
|
|
const ctx = new Context()
|
|
expect(() => { parseCmdline(ctx, demoCommand()) })
|
|
.toThrow('the launcher must provide ctx.cmdlineArgs and ctx.appExit')
|
|
})
|
|
|
|
it('lets multiple parsers read the same immutable snapshot', () => {
|
|
const ctx = new Context()
|
|
provideCmdline(ctx, { args: ['--port', '8080'], exit: () => {} })
|
|
const parseOnce = (): unknown => {
|
|
let values: unknown
|
|
const program = demoCommand()
|
|
program.action(() => { values = resolveDemo(program) })
|
|
parseCmdline(ctx, program)
|
|
return values
|
|
}
|
|
expect(parseOnce()).toEqual({ port: 8080 })
|
|
expect(parseOnce()).toEqual({ port: 8080 })
|
|
expect(Object.isFrozen(ctx.cmdlineArgs?.get())).toBe(true)
|
|
})
|
|
})
|