| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681 |
- /**
- * Shared boot glue for the app bins (`dsh`, `dsh-cli-demo`, `dsh-acp-demo`): load the gitignored
- * `.env`, install the fail-loud Loader guards, resolve the config path (snapshot-aware), load the
- * optional personal overlay patches from the Harness home (`~/.dsh`), expose its path resolver to
- * config expressions, and drive the Cordis Loader against a leaf `cordis.yml` until the tree settles.
- * @module @deepseek-ai/dsh-app-boot
- */
- import { pathToFileURL } from 'node:url'
- import { readFileSync } from 'node:fs'
- import { basename, dirname, join, resolve } from 'node:path'
- import * as yaml from 'js-yaml'
- import { Context, type FiberState } from 'cordis'
- import Loader, { type Entry, type EntryOptions } from '@cordisjs/plugin-loader'
- import Include, { applyEntryPatches, entryListSchema, type PatchOptions } from '@cordisjs/plugin-include'
- import { dshHomePath, resolveDshHome } from '@deepseek-ai/dsh-paths'
- import type {} from '@cordisjs/plugin-hmr'
- // Side-effect type import: resolves `ctx.get('systemPrompt')` to the service.
- import type {} from '@deepseek-ai/dsh-system-prompt'
- declare module 'cordis' {
- interface Context {
- /** Harness-home path resolver available to Loader `!!js` config expressions. */
- dshHomePath?: typeof dshHomePath
- }
- }
- /**
- * Resolve the config to boot. Replay swaps a `cordis.yml` basename for
- * `cordis.snapshot.yml` in the same directory; every other mode keeps the path.
- * @param configPath - the requested config path (absolute, or relative to `cwd`).
- * @param snapshotMode - the bin's `$DSH_SNAPSHOT` value; only `'replay'` swaps the
- * basename.
- * @param cwd - the base a relative `configPath` resolves against.
- * @returns the absolute path of the config to boot.
- */
- export function resolveConfigPath(
- configPath: string, snapshotMode: string | undefined, cwd: string = process.cwd(),
- ): string {
- const absolute = resolve(cwd, configPath)
- if (snapshotMode !== 'replay') return absolute
- const dir = dirname(absolute)
- const replayName = basename(absolute).replace(/cordis\.ya?ml$/, 'cordis.snapshot.yml')
- return resolve(dir, replayName)
- }
- /**
- * Load the optional gitignored `.env` from `dir`. Missing files fall back to the
- * ambient environment; other read failures are reported through `warn`.
- * @param binName - the diagnostic prefix on the warn line.
- * @param dir - the directory whose `.env` to load.
- * @param warn - sink for the one-line misconfiguration diagnostic.
- */
- export function loadEnv(
- binName: string, dir: string = process.cwd(),
- warn: (line: string) => void = line => void process.stderr.write(line),
- ): void {
- try {
- process.loadEnvFile(resolve(dir, '.env'))
- } catch (error) {
- if ((error as NodeJS.ErrnoException | null)?.code !== 'ENOENT') {
- warn(`${binName}: failed to load .env: ${String(error)}\n`)
- }
- // ENOENT (no .env) is fine — rely on the ambient environment.
- }
- }
- /** File inside the Harness home holding the personal loader overlay patches. */
- export const PERSONAL_CONFIG_FILENAME = 'config.yaml'
- const bootstrapIncludes = new WeakMap<Context, Entry>()
- // The include's YAML dialect (`!!js` scalars become expression nodes the
- // Loader interpolates against each entry's context at mount time), imported
- // from the include itself so patch parsing and config dumping can never drift
- // from what the include mounts. Personal patches share it so they may
- // reference `process.env`.
- const personalPatchesSchema = entryListSchema
- /**
- * Load the optional personal overlay patches (`config.yaml` under the Harness
- * home). The file is a top-level YAML array of loader patch entries
- * (`@cordisjs/plugin-include`'s `PatchOptions`): id-targeted config overrides
- * and `insert` lists, with `!!js` expressions allowed. A missing file means
- * "no personal overlay"; an unreadable, unparsable, or non-array file throws —
- * a present personal config that cannot apply is a misconfiguration and must
- * fail loud at boot, never be silently skipped.
- * @param binName - the diagnostic prefix on the thrown error.
- * @param dir - the Harness home; defaults to {@link resolveDshHome} (`$DSH_HOME` or `~/.dsh`).
- * @returns the parsed patches, or `undefined` when the file does not exist.
- */
- export function loadPersonalPatches(
- binName: string, dir: string = resolveDshHome(),
- ): PatchOptions[] | undefined {
- const file = join(dir, PERSONAL_CONFIG_FILENAME)
- let content: string
- try {
- content = readFileSync(file, 'utf8')
- } catch (error) {
- if ((error as NodeJS.ErrnoException | null)?.code === 'ENOENT') return undefined
- throw new Error(`${binName}: failed to read personal patches ${file}: ${String(error)}`)
- }
- return parsePatchList(binName, file, content, 'personal patches')
- }
- /**
- * Load a required overlay patch list: a surface overlay (`tui.cordis.yml`) or a
- * `--config <path>` overlay applied over the shared base. Same file format as
- * {@link loadPersonalPatches}, but a missing file throws, because the caller
- * named this file — its absence is a misconfiguration, not "no overlay".
- * @param binName - the diagnostic prefix on the thrown error.
- * @param file - absolute path of the overlay file.
- * @returns the parsed patch list.
- */
- export function loadOverlayPatches(binName: string, file: string): PatchOptions[] {
- let content: string
- try {
- content = readFileSync(file, 'utf8')
- } catch (error) {
- throw new Error(`${binName}: failed to read overlay ${file}: ${String(error)}`)
- }
- return parsePatchList(binName, file, content, 'overlay')
- }
- /**
- * Parse one loader patch list: a top-level YAML array of
- * `@cordisjs/plugin-include` `PatchOptions` (id-targeted config overrides and
- * `insert` lists, `!!js` expressions allowed). Every shape failure throws,
- * because a patch file that cannot be applied at all is a misconfiguration; a
- * single patch whose target row is absent stays a per-entry Loader warning, so
- * one overlay shared across surfaces does not have to match every tree.
- * @param binName - the diagnostic prefix on the thrown error.
- * @param file - the source path, quoted in errors.
- * @param content - the file's text.
- * @param label - what to call this list in errors (`personal patches`, `overlay`).
- * @returns the parsed patch list.
- */
- function parsePatchList(
- binName: string, file: string, content: string, label: string,
- ): PatchOptions[] {
- let parsed: unknown
- try {
- parsed = yaml.load(content, { schema: personalPatchesSchema })
- } catch (error) {
- throw new Error(`${binName}: failed to parse ${label} ${file}: ${String(error)}`)
- }
- if (!Array.isArray(parsed)) {
- throw new Error(`${binName}: ${label} ${file} must be a top-level YAML array of loader patch entries`)
- }
- parsed.forEach((entry, index) => {
- if (typeof entry !== 'object' || entry === null || Array.isArray(entry)) {
- throw new Error(`${binName}: ${label} entry ${index + 1} in ${file} must be a mapping (a loader patch entry)`)
- }
- })
- return parsed as PatchOptions[]
- }
- /** One overlay patch list with the label provenance comments print for it. */
- export interface ConfigDumpLayer {
- /** Source name shown in provenance comments (a file basename or path). */
- label: string
- /** The layer's patches, from {@link loadOverlayPatches} / {@link loadPersonalPatches}. */
- patches: PatchOptions[]
- }
- /**
- * Compose the effective entry list exactly as `boot()` would mount it: parse
- * the base config file with the include's entry-list dialect, apply every
- * layer's patches as ONE flattened list through the include's own patch
- * algorithm (`applyEntryPatches`) — the same single call `boot()` makes, so
- * even patch-visibility corner cases (a later layer targeting a group child a
- * plain config replacement introduced, which the single-pass id index never
- * sees) compose identically — then render the result as YAML in the same
- * dialect (`!!js` expressions print verbatim, unevaluated).
- *
- * Every run of rows with the same provenance is preceded by a `# ==` comment
- * naming the file that contributed the rows and any layers that patched them,
- * so the output stays a loadable YAML document while showing which section
- * comes from which file. Provenance is derived from single-call prefix
- * snapshots (base + layers 1..k), diffed positionally: the patch algorithm
- * only rewrites rows in place or appends, so a top-level index identifies one
- * row across snapshots, and a layer whose addition changes the row (config
- * replacement, disable, group insert) is listed as having patched it.
- *
- * A patch that matches no row is reported through `warn` with its layer
- * label, mirroring the Loader's boot-time warning. Earlier layers' patches
- * see an identical preceding state in every snapshot that includes them, so
- * each snapshot's warning list extends the previous one and the new tail
- * belongs to the added layer.
- * @param binName - the diagnostic prefix on read/parse errors.
- * @param absoluteConfigPath - the base config file `boot()` would include.
- * @param layers - overlay layers in application order (later wins).
- * @param warn - sink for skipped-patch diagnostics; defaults to stderr.
- * @returns the composed entry list rendered as a YAML document with
- * provenance comment separators.
- */
- export function renderConfigDump(
- binName: string,
- absoluteConfigPath: string,
- layers: ConfigDumpLayer[],
- warn: (line: string) => void = line => void process.stderr.write(`${line}\n`),
- ): string {
- let content: string
- try {
- content = readFileSync(absoluteConfigPath, 'utf8')
- } catch (error) {
- throw new Error(`${binName}: failed to read config ${absoluteConfigPath}: ${String(error)}`)
- }
- let parsed: unknown
- try {
- parsed = yaml.load(content, { schema: entryListSchema })
- } catch (error) {
- throw new Error(`${binName}: failed to parse config ${absoluteConfigPath}: ${String(error)}`)
- }
- if (!Array.isArray(parsed)) {
- throw new Error(`${binName}: config ${absoluteConfigPath} must be a top-level YAML array of entries`)
- }
- const baseLabel = basename(absoluteConfigPath)
- // The YAML boundary yields untyped rows; the include validates entry shape
- // at mount, and the dump prints whatever the file holds, so `EntryOptions`
- // here is structural trust in the same file `boot()` would include.
- const base = parsed as Parameters<typeof applyEntryPatches>[0]
- // snapshot_k = ONE application of layers 1..k flattened — boot's exact call
- // shape for that prefix. snapshot_N is therefore the mounted composition.
- // The patches are cloned per call: applyEntryPatches detaches the entry
- // list but pushes `insert` rows by reference from the patch list, so
- // sharing patch objects across snapshot calls would leak a later
- // snapshot's mutations into an earlier one's result.
- const snapshot = (count: number, warnings: string[]): ReturnType<typeof applyEntryPatches> => {
- const flattened = structuredClone(layers.slice(0, count).flatMap(layer => layer.patches))
- return applyEntryPatches(base, flattened, (message: string, ...args: unknown[]) => {
- // The include logs through cordis's printf-style logger (`%C` = code); a
- // dump has no logger, so substitute inline for a plain line.
- let index = 0
- warnings.push(message.replace(/%C/g, () => JSON.stringify(args[index++])))
- })
- }
- let previous = base
- let previousWarnings: string[] = []
- const provenance: { origin: string; patchedBy: string[] }[] = base.map(() => ({ origin: baseLabel, patchedBy: [] }))
- let composed = base
- for (let count = 1; count <= layers.length; count += 1) {
- const layer = layers[count - 1]
- /* v8 ignore next -- count iterates 1..length, so the slot exists */
- if (layer === undefined) continue
- const warnings: string[] = []
- composed = snapshot(count, warnings)
- for (const line of warnings.slice(previousWarnings.length)) {
- warn(`${binName}: [${layer.label}] ${line}`)
- }
- const before = previous.map(entry => JSON.stringify(entry))
- for (let index = 0; index < composed.length; index += 1) {
- if (index >= before.length) provenance.push({ origin: layer.label, patchedBy: [] })
- else if (JSON.stringify(composed[index]) !== before[index]) provenance[index]?.patchedBy.push(layer.label)
- }
- previous = composed
- previousWarnings = warnings
- }
- return groupedDump(composed, provenance)
- }
- /** Render the composed rows grouped under one provenance comment per contiguous run. */
- function groupedDump(
- composed: readonly unknown[],
- provenance: readonly { origin: string; patchedBy: string[] }[],
- ): string {
- const lines: string[] = []
- let currentLabel: string | undefined
- let group: unknown[] = []
- const flush = (): void => {
- if (currentLabel === undefined || group.length === 0) return
- lines.push(`# == ${currentLabel}`)
- lines.push(yaml.dump(group, { schema: entryListSchema, noRefs: true }).trimEnd())
- group = []
- }
- for (let index = 0; index < composed.length; index += 1) {
- const record = provenance[index]
- /* v8 ignore next -- provenance is index-aligned with composed by construction */
- if (record === undefined) continue
- const label = record.patchedBy.length === 0
- ? record.origin
- : `${record.origin}, patched by ${record.patchedBy.join(', ')}`
- if (label !== currentLabel) {
- flush()
- currentLabel = label
- }
- group.push(composed[index])
- }
- flush()
- return lines.join('\n') + '\n'
- }
- /** Options for live personal-config reconciliation. */
- export interface PersonalPatchWatchOptions {
- /** Diagnostic prefix used by {@link loadPersonalPatches}. */
- binName: string
- /** Harness home containing `config.yaml`; defaults to {@link resolveDshHome}. */
- dir?: string
- /**
- * Compose the full patch list for a fresh personal-overlay generation —
- * the same composition the app booted with, so a reload can interleave the
- * new personal patches between app-owned layers (surface overlay below,
- * profile/flag patches above). Identity when omitted: the personal overlay
- * is the whole patch list.
- */
- compose?: (personalPatches: PatchOptions[]) => PatchOptions[]
- }
- /**
- * Watch the personal overlay through Cordis HMR and transactionally reapply it to the boot include.
- * @param ctx - settled app context containing the root Include and an active HMR service.
- * @param options - diagnostic, Harness-home, and patch-composition inputs.
- * @returns an asynchronous disposer after the exact-path watcher is ready.
- * @throws when HMR or the root Include is absent, watcher setup fails, or initial path resolution fails.
- */
- export async function watchPersonalPatches(
- ctx: Context,
- options: PersonalPatchWatchOptions,
- ): Promise<() => Promise<void>> {
- const { binName, dir = resolveDshHome(), compose = (patches: PatchOptions[]) => patches } = options
- const hmr = ctx.get('hmr')
- if (hmr === undefined) throw new Error(`${binName}: personal config watching requires the Cordis HMR service`)
- const entry = bootstrapIncludes.get(ctx)
- if (entry === undefined) throw new Error(`${binName}: personal config watching requires the root Include entry`)
- const filename = join(dir, PERSONAL_CONFIG_FILENAME)
- const register = hmr.registerConfig(filename, async () => {
- // Re-read the include's non-patch options per refresh: a writer that
- // updates the root Include's other options between refreshes (none exists
- // today) must not have them silently reverted by a personal reload.
- const { patches: _previousPatches, ...includeConfig } = entry.options.config as Include.Config
- const personalPatches = loadPersonalPatches(binName, dir) ?? []
- const patches = compose(personalPatches)
- await entry.update({
- config: {
- ...includeConfig,
- patches,
- },
- })
- })
- try {
- return await register
- } catch (error) {
- // A surface can dispose the whole tree while the watcher is still opening;
- // the HMR effect registration then fails with INACTIVE_EFFECT. That is the
- // app exiting exactly as asked, not a watch failure, so return a no-op
- // disposer instead of crashing.
- if ((error as { code?: string } | null)?.code === 'INACTIVE_EFFECT') return async () => {}
- throw error
- }
- }
- /**
- * Mount and remember the exact root Include entry used by app boot and personal-config HMR.
- * @param ctx - context carrying an initialized Loader service.
- * @param absoluteConfigPath - absolute YAML or JSON configuration path.
- * @param patches - initial app and personal patches, applied in order.
- * @returns the created root Include entry, or `undefined` when a surface
- * disposed the whole tree (taking the Loader service with it) while the
- * transactional create was still settling entry lifecycle.
- */
- export async function mountRootInclude(
- ctx: Context,
- absoluteConfigPath: string,
- patches: readonly PatchOptions[] = [],
- ): Promise<Entry | undefined> {
- ctx.loader.builtins.include = Include
- // Pinned id: the bootstrap include is app glue, not a config row, and its
- // id appears in Loader failure chains — a random id would make startup
- // diagnostics unstable across runs (and snapshot fixtures).
- const rootInclude: EntryOptions = {
- id: 'include',
- name: 'cordis:include',
- config: {
- path: pathToFileURL(absoluteConfigPath).href,
- ...patches.length > 0 ? { patches: [...patches] } : {},
- },
- }
- const includeId = await ctx.loader.create(rootInclude)
- const loader = ctx.get('loader')
- if (loader === undefined) return undefined
- const entry = loader.resolve(includeId)
- bootstrapIncludes.set(ctx, entry)
- return entry
- }
- /**
- * The slice of `process` {@link installFailLoud} needs — injectable so tests
- * exercise the handler without registering on (or exiting) the real process.
- */
- export interface FailLoudProcess {
- on(event: 'unhandledRejection', handler: (err: unknown) => void): unknown
- off(event: 'unhandledRejection', handler: (err: unknown) => void): unknown
- stderr: { write(chunk: string): unknown }
- /**
- * Terminate the process. Callers treat this as the end of the run, as
- * `process.exit` is; a fake that returns lets the caller continue, which only
- * a test observes.
- */
- exit(code: number): void
- }
- // Loader rc.5 derives and drops a rejected promise after a fiber fails. Keep
- // exact reasons already folded into the boot diagnostic visible through the
- // next process rejection checkpoint so the process guard can coalesce them.
- const assembledActivationRejections = new Map<unknown, number>()
- function retainAssembledRejection(reason: unknown): void {
- assembledActivationRejections.set(reason, (assembledActivationRejections.get(reason) ?? 0) + 1)
- }
- function releaseAssembledRejection(reason: unknown): void {
- const count = assembledActivationRejections.get(reason)
- if (count === undefined || count === 1) {
- assembledActivationRejections.delete(reason)
- } else {
- assembledActivationRejections.set(reason, count - 1)
- }
- }
- async function observeLoaderRejectionCheckpoint(reasons: readonly unknown[]): Promise<void> {
- for (const reason of reasons) retainAssembledRejection(reason)
- try {
- await new Promise<void>(resolve => setImmediate(resolve))
- } finally {
- for (const reason of reasons) releaseAssembledRejection(reason)
- }
- }
- /**
- * How long {@link installFailLoud} waits for its `release` hook before exiting
- * anyway. A wedged disposer must delay the fatal exit, never cancel it.
- */
- export const FAIL_LOUD_RELEASE_TIMEOUT_MS = 2_000
- /**
- * Install before boot to turn a late unhandled plugin-init rejection into one
- * labelled stderr diagnostic and `exit(1)`. A rejection already included by
- * {@link assertEntriesActivated} is ignored during its process checkpoint;
- * every other rejection remains fatal. Stdout remains untouched for ACP; the
- * returned function removes the handler.
- *
- * The Loader mounts entries concurrently, so a surface that owns the terminal
- * can already hold it when a sibling entry rejects. Exiting straight from the
- * handler would strand raw mode, bracketed paste, and the keyboard protocol on
- * the user's shell, and leave an in-flight terminal query's reply to land as
- * literal text at the next prompt. `release` is the terminal owner's chance to
- * hand it back; it is awaited under {@link FAIL_LOUD_RELEASE_TIMEOUT_MS}, whose
- * timer stays referenced so a never-settling disposer cannot let Node reach an
- * empty event loop and exit 0 instead of failing.
- *
- * The diagnostic is written before the release so a hanging or failing disposer
- * cannot swallow the reason. The handler stays installed while the release runs
- * — removing it would let a second concurrent rejection become uncaught and kill
- * the process mid-teardown, stranding exactly the terminal state this restores —
- * so a latch keeps the first rejection the reported one and lets later
- * rejections (including the release's own) fall through to the pending exit.
- * @param binName - the diagnostic prefix on the fatal-failure line.
- * @param proc - the process slice to register on; tests inject a fake.
- * @param release - optional teardown awaited before exit, used by a
- * terminal-owning surface to restore the terminal. Its own failure is
- * swallowed because the pending fatal exit already owns the outcome.
- * @returns the uninstaller that removes the rejection handler.
- */
- export function installFailLoud(
- binName: string,
- proc: FailLoudProcess = process,
- release?: () => Promise<void> | void,
- ): () => void {
- let exiting = false
- const handler = (err: unknown): void => {
- if (assembledActivationRejections.has(err)) return
- // A release in flight already owns the exit. Swallow later rejections
- // (teardown's own included) rather than reporting a second failure over the
- // real one or letting Node kill the process before the terminal is back.
- if (exiting) return
- exiting = true
- proc.stderr.write(`${binName}: fatal load failure: ${err instanceof Error ? err.stack ?? err.message : String(err)}\n`)
- if (release === undefined) {
- proc.exit(1)
- return
- }
- void (async () => {
- // Definitely assigned: the timeout promise's executor runs synchronously
- // while the race is being constructed, before the first await.
- let timer!: ReturnType<typeof setTimeout>
- try {
- await Promise.race([
- (async () => release())(),
- new Promise<void>((resolve) => {
- timer = setTimeout(resolve, FAIL_LOUD_RELEASE_TIMEOUT_MS)
- }),
- ])
- } catch {
- // The terminal release failed; the fatal exit below is the outcome that
- // matters, and no reporter runs after it.
- }
- clearTimeout(timer)
- proc.exit(1)
- })()
- }
- const uninstall = (): void => void proc.off('unhandledRejection', handler)
- proc.on('unhandledRejection', handler)
- return uninstall
- }
- /**
- * After the tree settles, reject entries with no fiber and name every plugin
- * whose module failed to resolve. Disabled entries are the only valid
- * fiber-less state.
- * @param ctx - the settled context whose loader entries to audit.
- * @param binName - the diagnostic prefix on the thrown error.
- */
- export function assertEntriesLoaded(ctx: Context, binName: string): void {
- const failed = [...ctx.loader.entries()].filter(entry => entry.fiber === undefined && !entry.disabled)
- if (failed.length > 0) {
- const names = failed.map(entry => entry.options.name).join(', ')
- throw new Error(`${binName}: plugin(s) failed to load: ${names}; Cordis startup failed because these plugin(s) could not be resolved (see the error(s) logged above)`)
- }
- }
- /**
- * Value mirrors used because Cordis's const enum has no runtime object to import.
- * Keep aligned with `packages/cordis/tool-cordis/src/fiber-state.ts` and
- * `packages/client/web/src/loader-status.ts`.
- */
- const FIBER_PENDING = 0 as FiberState.PENDING
- const FIBER_ACTIVE = 2 as FiberState.ACTIVE
- const FIBER_FAILED = 3 as FiberState.FAILED
- /** Render a thrown plugin value without discarding an Error's original stack. */
- function formatActivationError(error: unknown): string {
- return error instanceof Error ? error.stack ?? error.message : String(error)
- }
- /**
- * Reject a settled Loader tree when an enabled entry failed or remains inactive.
- * Plugin failures include the original thrown stack; pending entries name their
- * unresolved services because no plugin error exists for that state. Active
- * entries require no further wait; only failed fibers are awaited to recover
- * their private rejection reason.
- * @param ctx - the settled context whose Loader entries to audit.
- * @param binName - the diagnostic prefix on the thrown error.
- * @returns nothing when every enabled entry is active.
- * @throws after one process rejection checkpoint when an entry failed to
- * import, rejected during activation, or did not become active.
- */
- export async function assertEntriesActivated(ctx: Context, binName: string): Promise<void> {
- assertEntriesLoaded(ctx, binName)
- const failures: string[] = []
- const rejectionReasons: unknown[] = []
- for (const entry of ctx.loader.entries()) {
- const fiber = entry.fiber
- if (fiber === undefined || entry.disabled) continue
- const state = fiber.state
- if (state === FIBER_ACTIVE) continue
- if (state === FIBER_FAILED) {
- try {
- await fiber.await()
- } catch (error) {
- rejectionReasons.push(error)
- failures.push(`${entry.options.name}: ${formatActivationError(error)}`)
- }
- continue
- }
- if (state === FIBER_PENDING) {
- const missing = Object.keys(fiber.inject).filter(service => fiber.ctx.get(service) === undefined)
- const subject = missing.length === 1 ? 'service' : 'services'
- failures.push(`${entry.options.name}: pending (waiting for ${subject}: ${missing.join(', ') || 'unknown'})`)
- } else {
- failures.push(`${entry.options.name}: fiber state ${String(state)}`)
- }
- }
- if (failures.length > 0) {
- if (rejectionReasons.length > 0) {
- await observeLoaderRejectionCheckpoint(rejectionReasons)
- }
- const noun = failures.length === 1 ? 'entry' : 'entries'
- throw new Error(`${binName}: ${String(failures.length)} ${noun} did not activate\n${failures.join('\n')}`)
- }
- }
- /**
- * Boot the Loader against `absoluteConfigPath` and return only after the whole
- * tree settles. Entry names load through the Loader's internal module loader
- * against `baseUrl` (the config directory), which may live outside
- * `node_modules` reach and, unbuilt, cannot load vendored source; the
- * bootstrap include is therefore statically imported and mounted as the
- * `cordis:include` builtin, loading through the ambient module pipeline
- * (vite/tsx/plain ESM) while the included tree's own specifiers stay
- * config-relative. The package build embeds Include while leaving Loader
- * external, so the built include tree and host share one Loader peer. Loader
- * settlement rejects startup failures, which `boot` wraps after disposing the
- * partial context; a missing fiber or never-activating entry is rejected by
- * the final audit, {@link assertEntriesActivated}, which rethrows a plugin's
- * init rejection with its original stack; later unhandled rejections remain
- * covered by {@link installFailLoud}. Built bins need the Loader's native
- * helper for bare plugin specifiers; relative specifiers do not.
- * @param binName - the diagnostic prefix for load-failure errors.
- * @param absoluteConfigPath - the config to include; must already be absolute
- * (see {@link resolveConfigPath}).
- * @param patches - optional overlay patches applied over the included tree
- * (see {@link loadPersonalPatches}); an empty list mounts none.
- * @param prepare - optional host setup run after Loader installation and before any config-tree entry mounts.
- * @returns the root context once every entry has started, or as soon as a
- * surface disposed the tree while startup was still in flight.
- * @throws a labelled error after disposing the partial context — `host
- * preparation failed` when `prepare` threw before any config-tree entry
- * mounted, `plugin tree failed to load` afterwards.
- */
- export async function boot(
- binName: string,
- absoluteConfigPath: string,
- patches?: PatchOptions[],
- prepare?: (ctx: Context) => Promise<void> | void,
- ): Promise<Context> {
- const ctx = new Context()
- // Two failure labels: `prepare` runs before any config-tree entry mounts,
- // so its failure is host setup, not the plugin tree.
- let stage = 'host preparation failed'
- try {
- ctx.baseUrl = pathToFileURL(dirname(absoluteConfigPath)).href + '/'
- ctx.provide('dshHomePath', dshHomePath)
- await ctx.plugin(Loader)
- await prepare?.(ctx)
- stage = 'plugin tree failed to load'
- await mountRootInclude(ctx, absoluteConfigPath, patches)
- // A surface can finish and dispose the whole tree while startup is still
- // in flight, before the last entry settles. The Loader service goes with
- // it, and the activation audit describes a live tree — reading `ctx.loader`
- // past this point would throw a TypeError over an app that exited exactly
- // as asked. Transactional group updates settle
- // lifecycle inside the mount, so the teardown can land before it returns;
- // re-check after every await.
- await ctx.get('loader')?.await()
- if (ctx.get('loader') === undefined) return ctx
- await assertEntriesActivated(ctx, binName)
- return ctx
- } catch (cause) {
- // Root-fiber disposal contains cleanup failures per observer (Cordis
- // fiber.ts hardening) and a repeated call returns the settled single-shot
- // result, so this await cannot reject and replace `cause`.
- await ctx.fiber.dispose()
- const detail = cause instanceof Error ? cause.message : String(cause)
- // The transactional Loader wraps a failing entry apply in one message per
- // tree layer; every layer's message is folded into `detail` above, and the
- // deepest cause is the plugin's own thrown error, whose stack names the
- // real failure site — append it so the startup diagnostic preserves the
- // original activation error instead of only the wrap chain.
- let deepest: unknown = cause
- while (deepest instanceof Error && deepest.cause !== undefined) deepest = deepest.cause
- const stack = deepest instanceof Error && deepest !== cause ? `\n${deepest.stack ?? deepest.message}` : ''
- throw new Error(`${binName}: ${stage}: ${detail}${stack}`, { cause })
- }
- }
- /** Prompt-section name for the harness-source location line an app bin adds after boot. */
- export const HARNESS_SOURCE_SECTION = 'harness:source'
- /**
- * Add a global prompt section naming the on-disk harness source checkout while
- * explicitly distinguishing it from the task workspace and current working
- * directory. The self-referential `dsh-tool-cordis` toolset reads and edits this
- * checkout. Call once on the settled boot context ({@link boot}); the section
- * orders just after the harness identity opener (`-100`) and before the deployment
- * persona (`0`). A booted tree with no `systemPrompt` service has no prompt to
- * augment, so this is then a no-op that returns `undefined`. The section is
- * registered against the `systemPrompt` service's fiber, so a dev HMR reload of
- * that plugin drops it until the next boot.
- * @param ctx - the settled boot context whose global system prompt to augment.
- * @param sourceRoot - the absolute path to the harness checkout root.
- * @returns the section disposer, or `undefined` when no `systemPrompt` service is mounted.
- */
- export function addHarnessSourceSection(ctx: Context, sourceRoot: string): (() => void) | undefined {
- const systemPrompt = ctx.get('systemPrompt')
- if (systemPrompt === undefined) return undefined
- return systemPrompt.section({
- name: HARNESS_SOURCE_SECTION,
- order: -99,
- text: `The DeepSeek Harness implementation checkout is at ${sourceRoot}. The checkout location and current working directory are separate values and may differ; never infer the working directory from this path. Use pwd to determine the current working directory. Use this checkout only to inspect or extend DSH itself.`,
- })
- }
|