/** * @deepseek-ai/dsh-web-app — the browser-surface bundle's runtime glue plugin * plus the bundle patch (`cordis.patch.yml`, declared by the `dsh.bundle.patch` * manifest field). The plugin owns the browser-surface glue: it resolves * the built frontend dist (workspace knowledge of this bundle, never user * config), mounts the `frontend-static` fallback owner over it, registers the * harness-source and web-surface prompt sections, the bash-visible web runtime * variables, and the URL line. App command-line values arrive through the * `webStartup` service expressions in the bundle patch. * @module @deepseek-ai/dsh-web-app */ import { createRequire } from 'node:module' import { networkInterfaces } from 'node:os' import { fileURLToPath } from 'node:url' import type { Context } from '@deepseek-ai/cordis' import z from '@deepseek-ai/schemastery' import { addHarnessSourceSection } from '@deepseek-ai/dsh-app-boot' import { enableRow } from '@deepseek-ai/dsh-cmdline' import * as FrontendStatic from '@deepseek-ai/dsh-frontend-static' import type {} from '@deepseek-ai/cordis-plugin-loader' import type {} from '@deepseek-ai/dsh-host-webserver' import type {} from '@deepseek-ai/dsh-system-prompt' import type {} from '@deepseek-ai/dsh-bash-env' /** Stable Cordis plugin name. */ export const name = 'web-app' /** This dsh installation's root, from either this package's source or built entry. */ const SOURCE_ROOT = fileURLToPath(new URL('../../../..', import.meta.url)) const HMR_ROW_ID = 'client-hmr' /** Runtime service that releases Web rows after bind-dependent values resolve. */ const WEB_RUNTIME_SERVICE = 'webRuntime' /** Services required before the web runtime can mount. */ export const inject = ['httpServer'] /** Web runtime mode: production, or development when the client-plugin HMR receiver is active. */ export type WebMode = 'production' | 'development' /** Plugin config: composed deployment settings plus per-invocation command-line values. */ export interface Config { /** Whether this process mounted the client-plugin HMR receiver (`dsh web --dev`). */ mode: WebMode /** Print the URL line on activation; a non-interactive layer can turn it off. */ printUrl: boolean /** * Register the model-visible surface context (the `app:web-surface` prompt * section and the `DSH_WEB_URL`/`DSH_WEB_MODE` bash variables). A one-shot * non-interactive layer can turn it off when its user is not in the GUI, so the * orientation text would be false. */ surfaceContext: boolean /** Explicit `--trusted-host` authorities from this invocation. */ trustedHosts: string[] } export const Config: z = z.object({ mode: z.union([z.const('production'), z.const('development')]).default('production'), printUrl: z.boolean().default(true), surfaceContext: z.boolean().default(true), trustedHosts: z.array(String).default([]), }) /** Bind-dependent Web values shared by the trust fence and URL display. */ export interface WebRuntimeValues { /** LAN IPv4 literals sampled once when the server binds all interfaces. */ lanAddresses: string[] /** LAN literals followed by explicit invocation authorities. */ trustedHosts: string[] } /** Environment variable naming the canonical local URL of this Web GUI. */ const DSH_WEB_URL = 'DSH_WEB_URL' as const /** Environment variable naming the Web runtime mode. */ const DSH_WEB_MODE = 'DSH_WEB_MODE' as const // Display-only mirror of the webserver schema's loopback host: the address the // local URL always prints. Not a source of truth — the schema is. const LOOPBACK_HOST = '127.0.0.1' /** The webserver schema's all-interfaces bind literal. */ const ALL_INTERFACES_HOST = '0.0.0.0' /** * Resolve one LAN-trust snapshot from the active server bind. * * Derived entries are port-less IP literals: DNS rebinding needs an * attacker-controlled name, while an IP-literal Host is safe on any port and * an OS-assigned port is unknowable before bind. * @param bindHost - the active webserver bind host. * @param extra - explicit `--trusted-host` values, in argument order. * @returns the LAN display addresses and invocation-derived fence authorities. */ export function resolveLanTrust(bindHost: string, extra: readonly string[]): WebRuntimeValues { const lanAddresses = bindHost === ALL_INTERFACES_HOST ? Object.values(networkInterfaces()).flat() .filter((iface): iface is NonNullable => iface !== undefined && iface.family === 'IPv4' && !iface.internal) .map(iface => iface.address) : [] return { lanAddresses, trustedHosts: [...lanAddresses, ...extra] } } /** Model-visible orientation and acceptance boundary for sessions created through `dsh web`. */ function webSurfacePrompt(webUrl: string, mode: WebMode): string { const updateContract = mode === 'development' ? 'This Web process was launched with `dsh web --dev`, so its client-plugin HMR receiver is active. ' + 'No-refresh updates occur only when `pnpm run dev:web` is also running from this same checkout to rebuild client-plugin bundles; verify that watcher before promising automatic updates. ' + 'Client-plugin changes then reload automatically, while apps/web shell and other plain-package changes still require a rebuild and page refresh. ' : 'This Web process was launched without `--dev`, so HMR is inactive: rebuild the affected Web artifacts and verify this existing URL after a page refresh. ' + 'If the user wants no-refresh client-plugin updates, explain that this GUI must be restarted with `dsh web --dev` and `pnpm run dev:web` must also run from this same checkout; do not present either command alone as sufficient. ' return `You are interacting with the user through the DeepSeek Harness Web GUI at ${webUrl}. ` + 'When the user refers to "this page", "this GUI", or "this app" without naming another target, they mean this GUI. ' + 'The browser provides no implicit DOM, route, or screenshot context. ' + updateContract + 'Starting another server does not update this GUI. ' + 'The apps/web Vite entry builds the shell but is not a standalone application because only dsh web injects window.__DSH_BOOT__. ' + 'Do not start a replacement server unless the user asks; if one is needed, use a managed background task and verify its exact URL.' } /** Resolve the canonical loopback URL from the active Web server. */ function localWebUrl(ctx: Context): string { const port = ctx.get('httpServer')?.port if (port === undefined) throw new Error('web-app: httpServer service missing while resolving Web runtime') return `http://${LOOPBACK_HOST}:${String(port)}` } /** Dist location is workspace knowledge of this bundle: resolved through the frontend package exports, not configured. */ function resolveDistIndex(): string { const require = createRequire(import.meta.url) try { return require.resolve('@deepseek-ai/dsh-frontend/dist/index.html') } catch { /* v8 ignore next 2 -- reachable only on a checkout without a built dist; the test tree builds it */ throw new Error('web-app: frontend dist not built; run pnpm run build from the repository root first') } } /** Test hook: hosts with no built frontend dist substitute the resolver; production never touches this. */ export const internals: { resolveDistIndex: () => string } = { resolveDistIndex } /** * Mount the Web runtime: dist serving, surface prompt, bash runtime * variables, and the URL line. * @param ctx - plugin context carrying the httpServer service. * @param config - validated {@link Config}. * @returns nothing once the invocation's client roster and runtime contributions are registered. */ export async function apply(ctx: Context, config: Config): Promise { // Client discovery must start after the optional HMR row has a pending // fiber. Otherwise its first browser graph omits the reload receiver, which // cannot use that receiver to discover itself later. if (config.mode === 'development') await enableRow(ctx, HMR_ROW_ID) const runtime = resolveLanTrust(ctx.httpServer.host, config.trustedHosts) // Release dependent rows only after the optional row has a pending fiber and // bind-dependent trust has been sampled once. ctx.provide(WEB_RUNTIME_SERVICE, runtime) ctx.plugin(FrontendStatic, { distIndex: internals.resolveDistIndex() }) if (config.surfaceContext) { ctx.inject(['systemPrompt'], (promptCtx) => { addHarnessSourceSection(promptCtx, SOURCE_ROOT) promptCtx.systemPrompt.section({ name: 'app:web-surface', order: -98, text: () => webSurfacePrompt(localWebUrl(promptCtx), config.mode), }) }) ctx.inject(['bashEnv'], (runtimeCtx) => { runtimeCtx.bashEnv.register({ name: 'web-runtime', variables: { [DSH_WEB_URL]: { description: 'Canonical local URL of the DeepSeek Harness Web GUI serving this session.' }, [DSH_WEB_MODE]: { description: 'Web runtime mode: production, or development when the client-plugin HMR receiver is active.' }, }, resolve: () => ({ [DSH_WEB_URL]: localWebUrl(runtimeCtx), [DSH_WEB_MODE]: config.mode }), }) }) } if (config.printUrl) { // The URL line is a readiness signal: supervisors (and the keyless CLI // smoke) RPC as soon as they observe it, so it must not print while // sibling rows (the /api route owner) are still mounting. Await Loader // settlement first; a hand-built tree without a Loader prints at once. const printUrl = (): void => { // Reuse the exact LAN snapshot provided to the /api trust fence. const lanCandidate = runtime.lanAddresses[0] const port = ctx.httpServer.port console.log(`dsh web: ${localWebUrl(ctx)}${lanCandidate === undefined ? '' : ` (LAN: http://${lanCandidate}:${String(port)})`}`) } // This row's own activation can precede a sibling failure. The app owns // readiness by waiting for its Loader tree, or prints at once in a // hand-built context without Loader. const settled = ctx.get('loader')?.await() if (settled === undefined) printUrl() else { void settled.then(() => { // The tree can be disposed while the boot was in flight (early // SIGTERM); a URL line for a dead server would only mislead, and // reading the torn-down port would turn a clean shutdown into a crash. if (ctx.get('httpServer') !== undefined) printUrl() // Loader reports a failed boot; this row only stays quiet. }, () => {}) } } }