@dsh-workbench/shared 0.1.0

package/dist/host/opencli.js

@@ -0,0 +1,152 @@
+import { OPENCLI_MAX_CONCURRENT, OPENCLI_TIMEOUT_MS } from '../config/constants.js';
+import { parseJsonLoose, quoteShellArg, tailLines } from '../lib/text.js';
+import { helpUrlOf, parseCliErrorEnvelope } from './cli-error';
+import { runShell } from './shell';
+const FORBIDDEN_CODES = new Set(['FORBIDDEN', 'PERMISSION_DENIED']);
+const SITE_SESSION_ARGS = ['--site-session', 'persistent'];
+export class WorkbenchDataError extends Error {
+    code;
+    detail;
+    hint;
+    project;
+    helpUrl;
+    constructor(code, message, extra = {}) {
+        super(message);
+        this.name = 'WorkbenchDataError';
+        this.code = code;
+        if (extra.detail !== undefined)
+            this.detail = extra.detail;
+        if (extra.hint !== undefined)
+            this.hint = extra.hint;
+        if (extra.project !== undefined)
+            this.project = extra.project;
+        if (extra.helpUrl !== undefined)
+            this.helpUrl = extra.helpUrl;
+    }
+}
+export function opencliCommandLine(command, argv, session = 'persistent') {
+    return [
+        quoteShellArg(command),
+        ...argv.map(quoteShellArg),
+        ...(session === 'persistent' ? SITE_SESSION_ARGS : []),
+        '-f',
+        'json',
+    ].join(' ');
+}
+export function createOpencli(options) {
+    const { shell, plugin, logger, command = 'opencli', timeoutMs = OPENCLI_TIMEOUT_MS, maxConcurrent = OPENCLI_MAX_CONCURRENT, } = options;
+    const inflight = new Map();
+    const MAX_CONCURRENT = maxConcurrent;
+    let running = 0;
+    const waiting = [];
+    async function acquire() {
+        if (running < MAX_CONCURRENT) {
+            running += 1;
+            return;
+        }
+        await new Promise((resolve) => waiting.push(resolve));
+    }
+    function release() {
+        const next = waiting.shift();
+        if (next === undefined)
+            running -= 1;
+        else
+            next();
+    }
+    async function runLimited(task) {
+        await acquire();
+        try {
+            return await task();
+        }
+        finally {
+            release();
+        }
+    }
+    async function call(commandLine, workdir) {
+        let result;
+        try {
+            result = await runShell(shell, commandLine, {
+                ...(workdir === undefined ? {} : { workdir }),
+                timeoutMs,
+            });
+        }
+        catch (error) {
+            throw new WorkbenchDataError('cli-exec-failed', `执行 opencli 失败：${String(error)}`, {
+                hint: '确认 opencli 已安装且在 PATH 里（which opencli）。',
+            });
+        }
+        if (result.timedOut) {
+            throw new WorkbenchDataError('cli-timeout', `opencli 超过 ${Math.round(timeoutMs / 1000)} 秒没有返回`, { hint: '无头浏览器可能没起来，重试一次通常就好。' });
+        }
+        if (result.exitCode !== 0) {
+            const detail = tailLines(result.stderr || result.stdout, 6);
+            const envelope = parseCliErrorEnvelope(result.stderr) ?? parseCliErrorEnvelope(result.stdout);
+            const url = envelope === undefined ? undefined : helpUrlOf(envelope);
+            if (envelope?.code === 'AUTH_REQUIRED') {
+                throw new WorkbenchDataError('auth-required', envelope.message, {
+                    detail,
+                    ...(url === undefined ? {} : { helpUrl: url }),
+                });
+            }
+            if (envelope !== undefined && FORBIDDEN_CODES.has(envelope.code)) {
+                throw new WorkbenchDataError('permission-denied', envelope.message, {
+                    detail,
+                    ...(url === undefined ? {} : { helpUrl: url }),
+                });
+            }
+            if (envelope !== undefined) {
+                throw new WorkbenchDataError('cli-command-failed', `${envelope.code}：${envelope.message}`, {
+                    detail,
+                    ...(envelope.help === undefined ? {} : { hint: envelope.help }),
+                });
+            }
+            throw new WorkbenchDataError('cli-unclassified', `opencli 这条命令没跑通（退出码 ${result.exitCode}），而且没有结构化错误码`, {
+                detail,
+                hint: '多半是插件里没有这条命令（版本旧就会缺），也可能是命令自己失败了：先确认命令存在，再更新插件重试。',
+            });
+        }
+        const parsed = parseJsonLoose(result.stdout);
+        if (parsed === undefined) {
+            throw new WorkbenchDataError('cli-bad-output', 'opencli 输出不是 JSON', {
+                detail: tailLines(result.stdout, 4),
+            });
+        }
+        return parsed;
+    }
+    async function json(args, callOptions = {}) {
+        const { key, workdir } = callOptions;
+        const session = callOptions.session ?? 'persistent';
+        const callKey = key ?? args.map((arg) => String(arg)).join(' ');
+        const pending = inflight.get(callKey);
+        if (pending !== undefined)
+            return pending;
+        const commandLine = opencliCommandLine(command, [plugin, ...args], session);
+        const once = async () => {
+            const value = await call(commandLine, workdir);
+            return { value, at: Date.now() };
+        };
+        const task = runLimited(async () => {
+            try {
+                return await once();
+            }
+            catch (error) {
+                if (!(error instanceof WorkbenchDataError) || error.code !== 'auth-required')
+                    throw error;
+                return await once();
+            }
+        });
+        inflight.set(callKey, task);
+        try {
+            return await task;
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            logger?.warn?.(`[dsh-workbench] opencli 调用失败：${message}`);
+            throw error;
+        }
+        finally {
+            inflight.delete(callKey);
+        }
+    }
+    return { json };
+}

package/dist/host/plugin-source.d.ts

@@ -0,0 +1,31 @@
+import type { PluginSource } from '../api/unit.js';
+export type PluginSourceProblem = "not-declared" | "env-missing" | "malformed";
+export interface PluginSourceCommand {
+    readonly line: string;
+    readonly optional?: true;
+}
+export type ResolvedPluginSource = {
+    readonly ok: true;
+    readonly commands: readonly PluginSourceCommand[];
+    readonly line: string;
+} | {
+    readonly ok: false;
+    readonly problem: PluginSourceProblem;
+    readonly env?: string;
+};
+export interface PluginSourceOptions {
+    readonly command?: string;
+    readonly plugin?: string;
+    readonly version?: string;
+    readonly mode?: "install" | "update";
+}
+export declare function npmRegistryOf(source: {
+    readonly registryEnv: string;
+    readonly registryDefault?: string;
+}, env: Readonly<Record<string, string | undefined>>): {
+    readonly ok: true;
+    readonly value: string;
+} | {
+    readonly ok: false;
+};
+export declare function resolvePluginSource(source: PluginSource | undefined, env: Readonly<Record<string, string | undefined>>, options?: PluginSourceOptions): ResolvedPluginSource;

package/dist/host/plugin-source.js

@@ -0,0 +1,81 @@
+import { quoteShellArg } from '../lib/text.js';
+import { npmCacheDir, toolchainOpencliDir, vendorPeerLink, vendorPrefix } from '../host/opencli-runtime.js';
+function mergeLines(commands) {
+    return commands
+        .map((item) => item.optional === true ? `(${item.line} || true)` : item.line)
+        .join(" && ");
+}
+function envValue(env, name) {
+    const value = env[name]?.trim();
+    return value === undefined || value === ""
+        ? { ok: false }
+        : { ok: true, value };
+}
+export function npmRegistryOf(source, env) {
+    const fromEnv = envValue(env, source.registryEnv);
+    if (fromEnv.ok)
+        return fromEnv;
+    const fallback = source.registryDefault?.trim();
+    return fallback === undefined || fallback === ""
+        ? { ok: false }
+        : { ok: true, value: fallback };
+}
+function installOne(command, spec) {
+    const line = `${quoteShellArg(command)} plugin install ${quoteShellArg(spec)}`;
+    return { ok: true, commands: [{ line }], line };
+}
+function npmSource(source, env, options) {
+    const registry = npmRegistryOf(source, env);
+    if (!registry.ok)
+        return { ok: false, problem: "env-missing", env: source.registryEnv };
+    const name = source.package.trim();
+    if (name === "")
+        return { ok: false, problem: "malformed" };
+    const { command = "opencli", plugin = "", version = "latest", mode = "install", } = options;
+    const prefix = vendorPrefix();
+    const dirInPrefix = `${prefix}/node_modules/${name}`;
+    const peer = vendorPeerLink();
+    const commands = [
+        {
+            line: [
+                "npm i",
+                `--prefix ${quoteShellArg(prefix)}`,
+                quoteShellArg(`${name}@${version}`),
+                `--registry ${quoteShellArg(registry.value)}`,
+                `--cache ${quoteShellArg(npmCacheDir())}`,
+            ].join(" "),
+        },
+        {
+            line: `rm -rf ${quoteShellArg(peer.dir)} && mkdir -p ${quoteShellArg(peer.parent)} && ln -s ${quoteShellArg(toolchainOpencliDir())} ${quoteShellArg(peer.dir)}`,
+        },
+    ];
+    if (mode === "install") {
+        if (plugin !== "") {
+            commands.push({
+                line: `${quoteShellArg(command)} plugin uninstall ${quoteShellArg(plugin)}`,
+                optional: true,
+            });
+        }
+        commands.push({
+            line: `NPM_CONFIG_REGISTRY=${quoteShellArg(registry.value)} ${quoteShellArg(command)} plugin install ${quoteShellArg(dirInPrefix)}`,
+        });
+    }
+    return { ok: true, commands, line: mergeLines(commands) };
+}
+export function resolvePluginSource(source, env, options = {}) {
+    if (source === undefined)
+        return { ok: false, problem: "not-declared" };
+    const command = options.command ?? "opencli";
+    if (source.kind === "git") {
+        const url = source.url.trim();
+        return url === ""
+            ? { ok: false, problem: "malformed" }
+            : installOne(command, url);
+    }
+    if (source.kind === "npm")
+        return npmSource(source, env, options);
+    const value = envValue(env, source.env);
+    return value.ok
+        ? installOne(command, value.value)
+        : { ok: false, problem: "env-missing", env: source.env };
+}

package/dist/host/preflight.d.ts

@@ -0,0 +1,58 @@
+import type { DshShell } from '@dsh-workbench/shared';
+export type PreflightStepId = 'opencli' | 'bridge' | 'warm';
+export type PreflightStepStatus = 'pending' | 'running' | 'ok' | 'warn' | 'failed';
+export interface PreflightStep {
+    readonly id: PreflightStepId;
+    readonly status: PreflightStepStatus;
+    readonly detail?: string;
+    readonly action?: string;
+    readonly command?: string;
+}
+export type PreflightFailure = 'permission' | 'network' | 'missing' | 'unknown';
+export declare function classifyFailure(text: string): PreflightFailure;
+export type PreflightGuidance = 'install' | 'path' | 'shell';
+export type PreflightBridgeIssue = 'daemon' | 'extension' | 'profile' | 'stale' | 'unknown';
+export declare function readBridgeReport(stdout: string): {
+    readonly ok: boolean;
+    readonly issues: readonly PreflightBridgeIssue[];
+    readonly detail: string;
+};
+export interface PreflightSnapshot {
+    readonly phase: 'idle' | 'checking' | 'installing' | 'ready' | 'failed';
+    readonly steps: readonly PreflightStep[];
+    readonly at: number;
+    readonly error?: string;
+    readonly failure?: PreflightFailure;
+    readonly guidance?: PreflightGuidance;
+    readonly bridgeIssues?: readonly PreflightBridgeIssue[];
+}
+export interface Preflight {
+    run(options?: {
+        force?: boolean;
+    }): Promise<PreflightSnapshot>;
+    snapshot(): PreflightSnapshot;
+}
+export declare const OPENCLI_INSTALL_COMMAND: string;
+export interface BridgeVerdict {
+    readonly ok: boolean;
+    readonly detail: string;
+    readonly issues: readonly PreflightBridgeIssue[];
+    readonly command?: string | undefined;
+}
+export declare function canWarm(bridge: {
+    ok: boolean;
+    issues: readonly PreflightBridgeIssue[];
+}): boolean;
+export declare function createPreflight(options: {
+    shell: DshShell;
+    command?: string;
+    installCommand?: string;
+    logger?: {
+        warn?(message: string): void;
+    } | undefined;
+    install?: (() => Promise<{
+        ok: boolean;
+        detail: string;
+    }>) | undefined;
+    warmReads?: (() => readonly (readonly string[])[]) | undefined;
+}): Preflight;

package/dist/host/preflight.js

@@ -0,0 +1,233 @@
+import { INSTALL_TIMEOUT_MS, OPENCLI_TIMEOUT_MS, WARM_TIMEOUT_MS } from '@dsh-workbench/shared';
+import { tailLines } from '@dsh-workbench/shared';
+import { opencliCommandLine } from './opencli';
+import { isolatedInstallCommand } from './opencli-runtime';
+import { runShell } from './shell';
+export function classifyFailure(text) {
+    const lower = text.toLowerCase();
+    if (/eacces|eperm|permission denied|operation not permitted/.test(lower))
+        return 'permission';
+    if (/enotfound|etimedout|econnrefused|econnreset|network|proxy|fetch failed/.test(lower))
+        return 'network';
+    if (/command not found|not found|no such file/.test(lower))
+        return 'missing';
+    return 'unknown';
+}
+export function readBridgeReport(stdout) {
+    const text = String(stdout ?? '');
+    const ok = /^\[OK\] Daemon:/m.test(text) && /^\[OK\] Extension:/m.test(text) && /^\[OK\] Connectivity:/m.test(text);
+    if (ok) {
+        const good = text.split('\n').find((line) => line.trim() === 'Everything looks good!');
+        return { ok: true, issues: [], detail: good?.trim() ?? tailLines(text, 1) };
+    }
+    const found = new Set();
+    if (!/^\[OK\] Daemon:/m.test(text))
+        found.add('daemon');
+    if (!/^\[OK\] Extension:/m.test(text))
+        found.add('extension');
+    if (/Multiple Chrome profiles are connected/i.test(text))
+        found.add('profile');
+    if (/Default browser profile is stale|Selected browser profile is not connected/i.test(text)) {
+        found.add('stale');
+    }
+    if (found.has('profile') || found.has('stale'))
+        found.delete('extension');
+    if (found.size === 0)
+        found.add('unknown');
+    const order = ['profile', 'stale', 'daemon', 'extension', 'unknown'];
+    return { ok: false, issues: order.filter((issue) => found.has(issue)), detail: issuesSection(text) };
+}
+function issuesSection(text) {
+    const lines = text.split('\n');
+    const start = lines.findIndex((line) => /^Issues:/.test(line.trim()));
+    if (start < 0)
+        return tailLines(text, 6);
+    return lines.slice(start).join('\n').trim();
+}
+function bridgeFixCommand(command, issues) {
+    if (issues.includes('profile') || issues.includes('stale'))
+        return `${command} profile list`;
+    if (issues.includes('daemon') || issues.includes('extension'))
+        return `${command} daemon restart`;
+    return undefined;
+}
+export const OPENCLI_INSTALL_COMMAND = isolatedInstallCommand();
+const WARMABLE_BRIDGE_ISSUES = ['daemon', 'stale'];
+export function canWarm(bridge) {
+    return bridge.ok || bridge.issues.every((issue) => WARMABLE_BRIDGE_ISSUES.includes(issue));
+}
+function step(id) {
+    return { id, status: 'pending' };
+}
+export function createPreflight(options) {
+    const { shell, command = 'opencli', logger } = options;
+    const installCommand = options.installCommand ?? OPENCLI_INSTALL_COMMAND;
+    const warmReads = () => options.warmReads?.() ?? [];
+    const steps = () => [
+        step('opencli'),
+        step('bridge'),
+        ...(warmReads().length === 0 ? [] : [step('warm')]),
+    ];
+    let current = { phase: 'idle', steps: steps(), at: Date.now() };
+    let running = null;
+    let latest = null;
+    let rerun = false;
+    function set(next) {
+        current = { ...current, ...next, at: Date.now() };
+        return current;
+    }
+    function patchStep(id, patch) {
+        return set({ steps: current.steps.map((item) => (item.id === id ? { ...item, ...patch } : item)) });
+    }
+    async function exec(commandLine, timeoutMs) {
+        try {
+            const result = await runShell(shell, commandLine, { timeoutMs });
+            if (result.timedOut) {
+                return { kind: 'error', detail: `超时（${String(timeoutMs)} ms）：${commandLine}` };
+            }
+            if (result.exitCode !== 0) {
+                return { kind: 'nonzero', detail: tailLines(result.stderr || result.stdout, 4) };
+            }
+            return { kind: 'ok', stdout: result.stdout };
+        }
+        catch (error) {
+            return { kind: 'error', detail: String(error) };
+        }
+    }
+    async function probeVersion() {
+        const result = await exec(`${command} --version`, OPENCLI_TIMEOUT_MS);
+        if (result.kind === 'ok')
+            return { ok: true, missing: false, detail: result.stdout.trim().split('\n')[0] ?? '' };
+        return { ok: false, missing: result.kind === 'nonzero', detail: result.detail };
+    }
+    async function probeBridge() {
+        const result = await exec(`${command} doctor`, OPENCLI_TIMEOUT_MS);
+        if (result.kind !== 'ok')
+            return { ok: false, detail: result.detail, issues: ['unknown'] };
+        const report = readBridgeReport(result.stdout);
+        if (report.ok)
+            return report;
+        return { ...report, command: bridgeFixCommand(command, report.issues) };
+    }
+    async function installOpencli() {
+        if (options.install !== undefined)
+            return options.install();
+        const result = await exec(installCommand, INSTALL_TIMEOUT_MS);
+        if (result.kind !== 'ok')
+            return { ok: false, detail: result.detail };
+        return { ok: true, detail: tailLines(result.stdout, 1) };
+    }
+    async function warmSites(bridge) {
+        const reads = warmReads();
+        if (reads.length === 0)
+            return bridge;
+        if (!canWarm(bridge)) {
+            patchStep('warm', { status: 'warn', detail: '' });
+            return bridge;
+        }
+        patchStep('warm', {
+            status: 'running',
+            action: `${command} <套件自己声明的那条读命令> --site-session persistent -f json`,
+        });
+        const results = await Promise.all(reads.map((read) => exec(opencliCommandLine(command, read), WARM_TIMEOUT_MS)));
+        const failed = reads.filter((_, index) => results[index]?.kind !== 'ok');
+        patchStep('warm', {
+            status: failed.length === 0 ? 'ok' : 'warn',
+            detail: failed.length === 0 ? String(reads.length) : failed.map((read) => read.join(' ')).join(' '),
+            action: undefined,
+        });
+        if (bridge.ok)
+            return bridge;
+        const again = await probeBridge();
+        patchStep('bridge', {
+            status: again.ok ? 'ok' : 'warn',
+            detail: again.detail,
+            action: undefined,
+            command: again.command,
+        });
+        return again;
+    }
+    async function doRun() {
+        set({ phase: 'checking', error: undefined, failure: undefined, steps: steps() });
+        patchStep('opencli', { status: 'running', action: `${command} --version` });
+        let version = await probeVersion();
+        if (!version.ok && !version.missing) {
+            patchStep('opencli', { status: 'failed', detail: version.detail, action: undefined });
+            return set({
+                phase: 'failed',
+                error: version.detail,
+                failure: classifyFailure(version.detail),
+                guidance: 'shell',
+            });
+        }
+        if (!version.ok) {
+            set({ phase: 'installing' });
+            patchStep('opencli', { status: 'running', action: installCommand, command: installCommand });
+            const installed = await installOpencli();
+            if (!installed.ok) {
+                patchStep('opencli', {
+                    status: 'failed',
+                    detail: installed.detail,
+                    command: installCommand,
+                });
+                return set({
+                    phase: 'failed',
+                    error: installed.detail,
+                    failure: classifyFailure(installed.detail),
+                    guidance: 'install',
+                });
+            }
+            patchStep('opencli', { status: 'running', action: `${command} --version` });
+            version = await probeVersion();
+            if (!version.ok) {
+                patchStep('opencli', { status: 'failed', detail: version.detail, command: installCommand });
+                return set({
+                    phase: 'failed',
+                    error: version.detail,
+                    failure: classifyFailure(version.detail),
+                    guidance: 'path',
+                });
+            }
+        }
+        patchStep('opencli', { status: 'ok', detail: version.detail, action: undefined });
+        patchStep('bridge', { status: 'running', action: `${command} doctor` });
+        const bridge = await probeBridge();
+        const healable = !bridge.ok && warmReads().length > 0 && canWarm(bridge);
+        if (!healable) {
+            patchStep('bridge', {
+                status: bridge.ok ? 'ok' : 'warn',
+                detail: bridge.detail,
+                action: undefined,
+                ...(bridge.command === undefined ? {} : { command: bridge.command }),
+            });
+        }
+        const settled = await warmSites(bridge);
+        logger?.warn?.(`[dsh-workbench] 环境体检：${current.steps.map((item) => `${item.id}=${item.status}`).join(' ')}`);
+        return set({ phase: 'ready', ...(settled.ok ? {} : { bridgeIssues: settled.issues }) });
+    }
+    async function start(runOptions = {}) {
+        if (running !== null) {
+            if (runOptions.force === true)
+                rerun = true;
+            return running;
+        }
+        if (runOptions.force !== true && latest !== null)
+            return latest;
+        const inflight = doRun();
+        latest = inflight;
+        running = inflight;
+        await inflight.catch(() => undefined);
+        running = null;
+        if (rerun) {
+            rerun = false;
+            return start({ force: true });
+        }
+        return inflight;
+    }
+    return {
+        run: start,
+        snapshot() {
+            return current;
+        },
+    };
+}

package/dist/host/probe-cache.d.ts

@@ -0,0 +1,6 @@
+export interface TimedMemo<T> {
+    get(key: string, now?: number): T | undefined;
+    set(key: string, value: T, now?: number): void;
+    clear(): void;
+}
+export declare function createTimedMemo<T>(ttlMs: number): TimedMemo<T>;

package/dist/host/probe-cache.js

@@ -0,0 +1,19 @@
+export function createTimedMemo(ttlMs) {
+    const entries = new Map();
+    return {
+        get(key, now = Date.now()) {
+            const hit = entries.get(key);
+            if (hit === undefined)
+                return undefined;
+            if (now - hit.at >= ttlMs)
+                return undefined;
+            return hit.value;
+        },
+        set(key, value, now = Date.now()) {
+            entries.set(key, { at: now, value });
+        },
+        clear() {
+            entries.clear();
+        },
+    };
+}

package/dist/host/probe-libs.d.ts

@@ -0,0 +1,45 @@
+import type { DshShell } from '@dsh-workbench/shared';
+import type { PluginRelease, UnitLibNeed, UnitPluginNeed } from '@dsh-workbench/shared';
+import type { PluginSourceProblem } from './plugin-source';
+export interface UnitLibState {
+    readonly name: string;
+    readonly purpose: string;
+    readonly status: 'ok' | 'outdated' | 'missing' | 'unsatisfied';
+    readonly installed?: string;
+    readonly latest?: string;
+    readonly command?: string;
+}
+export declare function installedLibVersion(name: string): string | undefined;
+export declare function probeLibs(options: {
+    readonly needs: readonly UnitLibNeed[];
+    readonly shell: DshShell;
+    readonly force: boolean;
+}): Promise<ReadonlyMap<string, UnitLibState>>;
+export interface UnitCommands {
+    readonly unit: string;
+    readonly plugins?: readonly UnitPluginNeed[];
+    readonly libs?: readonly UnitLibNeed[];
+}
+export interface UnitPluginState {
+    readonly name: string;
+    readonly status: "ok" | "outdated" | "missing";
+    readonly missing: readonly string[];
+    readonly install?: "ready" | PluginSourceProblem;
+    readonly command?: string;
+    readonly release?: PluginRelease;
+}
+export interface UnitCapability {
+    readonly unit: string;
+    readonly status: "ok" | "missing-commands" | "missing-plugin" | "unchecked";
+    readonly plugin?: string;
+    readonly required: readonly string[];
+    readonly missing: readonly string[];
+    readonly detail: string;
+    readonly command?: string;
+    readonly fix?: "install" | "update";
+    readonly install?: "ready" | PluginSourceProblem;
+    readonly plugins?: readonly UnitPluginState[];
+    readonly libs?: readonly UnitLibState[];
+    readonly released?: boolean;
+}
+export declare function resetLibCache(): void;