@dsh-workbench/shared 0.3.11 → 1.0.0-beta.0

package/src/host/browser-read.ts

@@ -1,311 +0,0 @@
-import type { DshShell } from '../api/dsh.js';
-import { parseJsonLoose } from '../lib/text.js';
-import { tailLines } from './shell-text.js';
-import { backgroundLine } from './opencli-window.js';
-import { runShell } from './shell.js';
-
-export const BROWSER_SCREEN_SESSION = 'workbench';
-export const BROWSER_READ_SESSION = 'workbench-read';
-export const BROWSER_RECORD_SESSION = 'workbench-rec';
-
-const DEFAULT_TIMEOUT_MS = 25000;
-const DEFAULT_RETRY_MS = 1200;
-const DEFAULT_SETTLE_MS = 900;
-
-const AUTH_CODES = new Set([
-  'NOT_LOGGED_IN',
-  'NOT_LOGIN',
-  'AUTH_FAILED',
-  'AUTH_REQUIRED',
-  'UNAUTHENTICATED',
-  'UNAUTHORIZED',
-  'TOKEN_EXPIRED',
-]);
-
-const PERMISSION_CODES = new Set(['FORBIDDEN', 'PERMISSION_DENIED', 'NO_PERMISSION', 'EACCES']);
-
-export interface BrowserReadResult {
-  readonly ok: boolean;
-  readonly code: string;
-  readonly at: number;
-  readonly value?: unknown;
-  readonly pageCode?: string;
-  readonly message: string;
-  readonly hint?: string;
-  readonly detail?: string;
-  readonly helpUrl?: string;
-}
-
-export interface BrowserReadOptions {
-  readonly shell: DshShell;
-  readonly script: string;
-  readonly url?: string;
-  readonly loginUrl?: string;
-  readonly command?: string;
-  readonly session?: string;
-  readonly open?: boolean;
-  readonly timeoutMs?: number;
-  readonly retryMs?: number;
-  readonly settleMs?: number;
-}
-
-function asRecord(value: unknown): Record<string, unknown> | undefined {
-  return typeof value === 'object' && value !== null ? (value as Record<string, unknown>) : undefined;
-}
-
-function textOf(value: unknown): string {
-  return typeof value === 'string' ? value.trim() : '';
-}
-
-function codeOf(page: unknown): string {
-  const record = asRecord(page);
-  return record === undefined ? '' : textOf(record['code']);
-}
-
-function messageOf(page: unknown): string {
-  const record = asRecord(page);
-  return record === undefined ? '' : textOf(record['message']);
-}
-
-function hintOf(page: unknown): string | undefined {
-  const record = asRecord(page);
-  const hint = record === undefined ? '' : textOf(record['hint']);
-  return hint === '' ? undefined : hint;
-}
-
-function pageFailed(page: unknown): boolean {
-  const record = asRecord(page);
-  return record !== undefined && record['ok'] === false;
-}
-
-function blockerFor(code: string): 'auth-required' | 'permission-denied' | undefined {
-  const normalized = code.trim().toUpperCase().replace(/-/g, '_');
-  if (normalized === '') return undefined;
-  const matches = (set: Set<string>): boolean =>
-    [...set].some((one) => normalized === one || normalized.endsWith(`_${one}`));
-  if (matches(PERMISSION_CODES)) return 'permission-denied';
-  if (matches(AUTH_CODES) || normalized.includes('UNAUTH')) return 'auth-required';
-  return undefined;
-}
-
-function sleep(ms: number): Promise<void> {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
-
-type Attempt =
-  | { readonly kind: 'value'; readonly value: unknown }
-  | { readonly kind: 'failure'; readonly result: Omit<BrowserReadResult, 'at'> };
-
-type ShellOutcome =
-  | { readonly kind: 'ok'; readonly stdout: string }
-  | { readonly kind: 'timeout'; readonly detail: string; readonly stderr: string }
-  | { readonly kind: 'failed'; readonly detail: string; readonly stderr: string };
-
-async function shellRun(
-  shell: DshShell,
-  command: string,
-  argv: readonly string[],
-  timeoutMs: number,
-): Promise<ShellOutcome> {
-  const result = await runShell(shell, backgroundLine(command, argv), { timeoutMs });
-  if (result.timedOut) {
-    return { kind: 'timeout', detail: `没在 ${Math.round(timeoutMs / 1000)} 秒内返回`, stderr: result.stderr };
-  }
-  if (result.exitCode !== 0) {
-    return { kind: 'failed', detail: tailLines(result.stderr || result.stdout, 4), stderr: result.stderr };
-  }
-  return { kind: 'ok', stdout: result.stdout };
-}
-
-async function evalOnce(
-  shell: DshShell,
-  command: string,
-  session: string,
-  script: string,
-  timeoutMs: number,
-  retryMs: number,
-): Promise<Attempt> {
-  const run = async (): Promise<Attempt> => {
-    let attempt: Awaited<ReturnType<typeof shellRun>>;
-    try {
-      attempt = await shellRun(
-        shell,
-        command,
-        ['browser', session, 'eval', script, '--window', 'background'],
-        timeoutMs,
-      );
-    } catch (error) {
-      return {
-        kind: 'failure',
-        result: {
-          ok: false,
-          code: 'cli-exec-failed',
-          message: '读不了：后台服务起不来',
-          hint: '确认后台服务能跑起来，再重试',
-          detail: error instanceof Error ? error.message : String(error),
-        },
-      };
-    }
-    if (attempt.kind === 'timeout') {
-      return {
-        kind: 'failure',
-        result: {
-          ok: false,
-          code: 'cli-timeout',
-          message: '这次没读到（等超时了）',
-          hint: '稍后重试',
-          detail: attempt.detail,
-        },
-      };
-    }
-    if (attempt.kind === 'failed') {
-      const normalized = attempt.stderr.trim().toUpperCase().replace(/-/g, '_');
-      const forbidden = [...PERMISSION_CODES].some((one) => normalized.includes(one));
-      return {
-        kind: 'failure',
-        result: {
-          ok: false,
-          code: forbidden ? 'permission-denied' : 'cli-exec-failed',
-          message: forbidden ? '没有权限在这台机器上读' : '读不了（命令失败）',
-          hint: forbidden ? '换一个有权限的账号，或让用户开权限' : '把下面这段原始输出看一眼再重试',
-          detail: attempt.detail,
-        },
-      };
-    }
-    const value = parseJsonLoose(attempt.stdout);
-    if (value === undefined) {
-      return {
-        kind: 'failure',
-        result: {
-          ok: false,
-          code: 'cli-exec-failed',
-          message: '读到的格式不对',
-          hint: '让 agent 检查一下这条读',
-          detail: tailLines(attempt.stdout, 4),
-        },
-      };
-    }
-    return { kind: 'value', value };
-  };
-
-  const first = await run();
-  if (first.kind === 'value') return first;
-  if (first.result.code !== 'cli-exec-failed') return first;
-  await sleep(retryMs);
-  return run();
-}
-
-async function openOnce(
-  shell: DshShell,
-  command: string,
-  session: string,
-  url: string,
-  timeoutMs: number,
-): Promise<Omit<BrowserReadResult, 'at'> | undefined> {
-  let attempt: Awaited<ReturnType<typeof shellRun>>;
-  try {
-    attempt = await shellRun(shell, command, ['browser', session, 'open', url, '--window', 'background'], timeoutMs);
-  } catch (error) {
-    return {
-      ok: false,
-      code: 'cli-exec-failed',
-      message: '打不开那个页面',
-      hint: '确认后台服务能跑起来，再重试',
-      detail: error instanceof Error ? error.message : String(error),
-      helpUrl: url,
-    };
-  }
-  if (attempt.kind === 'ok') return undefined;
-  return {
-    ok: false,
-    code: attempt.kind === 'timeout' ? 'cli-timeout' : 'cli-exec-failed',
-    message: '打不开那个页面',
-    hint: '在浏览器里手动打开一次，然后重试',
-    detail: attempt.detail,
-    helpUrl: url,
-  };
-}
-
-export async function browserRead(options: BrowserReadOptions): Promise<BrowserReadResult> {
-  const { shell, script, url, loginUrl, open = true } = options;
-  const command = options.command ?? 'opencli';
-  const session = options.session ?? BROWSER_READ_SESSION;
-  const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
-  const retryMs = options.retryMs ?? DEFAULT_RETRY_MS;
-  const settleMs = options.settleMs ?? DEFAULT_SETTLE_MS;
-  const at = Date.now();
-
-  const first = await evalOnce(shell, command, session, script, timeoutMs, retryMs);
-  if (first.kind === 'failure') return { ...first.result, at };
-  let page = first.value;
-
-  if (codeOf(page) === 'not-on-site') {
-    if (!open || url === undefined) {
-      return {
-        ok: false,
-        code: 'cli-exec-failed',
-        at,
-        message: '没停在那套系统上',
-        hint: '先在那个浏览器里把它打开，再读一次',
-        detail: JSON.stringify(page),
-        ...(url === undefined ? {} : { helpUrl: url }),
-      };
-    }
-    const opened = await openOnce(shell, command, session, url, timeoutMs);
-    if (opened !== undefined) return { ...opened, at };
-    await sleep(settleMs);
-    const second = await evalOnce(shell, command, session, script, timeoutMs, retryMs);
-    if (second.kind === 'failure') return { ...second.result, at };
-    page = second.value;
-    if (codeOf(page) === 'not-on-site') {
-      return {
-        ok: false,
-        code: 'cli-exec-failed',
-        at,
-        message: '打开了页面、又读了一遍，仍然不在那套系统上',
-        hint: '确认这个地址就是那套系统（或者它跳到了别的域）',
-        detail: JSON.stringify(page),
-        helpUrl: url,
-      };
-    }
-  }
-
-  if (!pageFailed(page)) return { ok: true, code: 'ok', at, value: page, message: '读到了' };
-
-  const pageCode = codeOf(page) || 'read-failed';
-  const message = messageOf(page) || `读不到（${pageCode}）`;
-  const blocker = blockerFor(pageCode);
-  if (blocker === 'auth-required') {
-    return {
-      ok: false,
-      code: blocker,
-      at,
-      pageCode,
-      message,
-      hint: '去登录一次，再重试',
-      detail: JSON.stringify(page),
-      ...(loginUrl === undefined && url === undefined ? {} : { helpUrl: loginUrl ?? url }),
-    };
-  }
-  if (blocker === 'permission-denied') {
-    return {
-      ok: false,
-      code: blocker,
-      at,
-      pageCode,
-      message,
-      hint: '这个账号没有权限',
-      detail: JSON.stringify(page),
-      ...(loginUrl === undefined && url === undefined ? {} : { helpUrl: loginUrl ?? url }),
-    };
-  }
-  return {
-    ok: false,
-    code: pageCode,
-    at,
-    pageCode,
-    message,
-    detail: JSON.stringify(page),
-    ...(hintOf(page) === undefined ? {} : { hint: hintOf(page) }),
-  };
-}

package/src/host/opencli-runtime.ts

@@ -1,79 +0,0 @@
-import { OPENCLI_PIN } from '../config/constants.js';
-import type { UnitLibNeed } from '../api/unit.js';
-import { quoteShellArg } from './shell-text.js';
-
-import { dshHome } from './data-root.js';
-
-export { dshHome };
-
-export function isolatedRoot(): string {
-  return `${dshHome()}/workbench/opencli`;
-}
-
-export function isolatedHome(): string {
-  return `${isolatedRoot()}/home`;
-}
-
-export const OPENCLI_NPM_PACKAGE = '@jackwener/opencli';
-
-export function toolchainDir(): string {
-  return `${isolatedRoot()}/toolchain`;
-}
-
-export function toolchainOpencliDir(): string {
-  return `${toolchainDir()}/node_modules/${OPENCLI_NPM_PACKAGE}`;
-}
-
-export function vendorPrefix(): string {
-  return `${isolatedRoot()}/plugins-npm`;
-}
-
-export function vendorPluginsDir(): string {
-  return `${vendorPrefix()}/node_modules`;
-}
-
-export const OPENCLI_CATALOG_ENV = 'DSH_WB_OPENCLI_CATALOG';
-
-export function cliCatalogPath(): string {
-  const override = process.env[OPENCLI_CATALOG_ENV]?.trim();
-  return override === undefined || override === ''
-    ? `${toolchainOpencliDir()}/cli-manifest.json`
-    : override;
-}
-
-export function vendorPeerLink(): { readonly dir: string; readonly parent: string } {
-  const base = `${vendorPrefix()}/node_modules`;
-  const [scope] = OPENCLI_NPM_PACKAGE.split('/');
-  return { dir: `${base}/${OPENCLI_NPM_PACKAGE}`, parent: `${base}/${scope}` };
-}
-
-export function npmCacheDir(): string {
-  return `${isolatedRoot()}/npm-cache`;
-}
-
-export function isolatedCommand(): string {
-  return `${isolatedRoot()}/bin/opencli`;
-}
-
-export function libsPrefix(): string {
-  return `${isolatedRoot()}/libs`;
-}
-
-export function libDir(name: string): string {
-  return `${libsPrefix()}/node_modules/${name}`;
-}
-
-export function libInstallCommand(options: {
-  readonly need: UnitLibNeed;
-  readonly version?: string | undefined;
-}): string {
-  const { need, version } = options;
-  const registry =
-    process.env[need.registryEnv]?.trim() || need.registryDefault;
-  const spec = version ?? need.version ?? 'latest';
-  return `npm i --prefix '${libsPrefix()}' ${quoteShellArg(`${need.name}@${spec}`)} --registry '${registry}' --cache '${npmCacheDir()}'`;
-}
-
-export function isolatedInstallCommand(): string {
-  return `npm i --prefix '${toolchainDir()}' ${OPENCLI_NPM_PACKAGE}@${OPENCLI_PIN} --cache '${npmCacheDir()}'`;
-}

package/src/host/opencli-window.ts

@@ -1,11 +0,0 @@
-import { quoteShellArg } from './shell-text.js';
-
-const OPENCLI_WINDOW_ENV = 'OPENCLI_WINDOW=background';
-
-export function backgroundPrefix(): readonly string[] {
-  return [quoteShellArg('env'), quoteShellArg(OPENCLI_WINDOW_ENV)];
-}
-
-export function backgroundLine(command: string, argv: readonly string[]): string {
-  return [...backgroundPrefix(), quoteShellArg(command), ...argv.map(quoteShellArg)].join(' ');
-}

package/src/host/opencli.ts

@@ -1,213 +0,0 @@
-import type { DshShell } from '../api/dsh.js';
-import { OPENCLI_MAX_CONCURRENT, OPENCLI_TIMEOUT_MS } from '../config/constants.js';
-import { parseJsonLoose } from '../lib/text.js';
-import { quoteShellArg, tailLines } from './shell-text.js';
-import { helpUrlOf, parseCliErrorEnvelope } from './cli-error.js';
-import { backgroundPrefix } from './opencli-window.js';
-import { runShell } from './shell.js';
-
-const FORBIDDEN_CODES = new Set(['FORBIDDEN', 'PERMISSION_DENIED']);
-
-const SITE_SESSION_ARGS = ['--site-session', 'persistent'] as const;
-
-export class WorkbenchDataError extends Error {
-  readonly code: string;
-  readonly detail?: string;
-  readonly hint?: string;
-  readonly project?: unknown;
-  readonly helpUrl?: string;
-
-  constructor(
-    code: string,
-    message: string,
-    extra: { detail?: string; hint?: string; project?: unknown; helpUrl?: string } = {},
-  ) {
-    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 interface OpencliResult {
-  readonly value: unknown;
-  readonly at: number;
-}
-
-export type OpencliSession = 'persistent' | 'ephemeral' | 'none';
-
-export function opencliCommandLine(
-  command: string,
-  argv: readonly string[],
-  session: OpencliSession = 'persistent',
-): string {
-  return [
-    ...backgroundPrefix(),
-    quoteShellArg(command),
-    ...argv.map(quoteShellArg),
-    ...(session === 'persistent' ? SITE_SESSION_ARGS : []),
-    '-f',
-    'json',
-  ].join(' ');
-}
-
-export interface Opencli {
-  json(
-    args: readonly string[],
-    options?: { key?: string; workdir?: string; session?: OpencliSession },
-  ): Promise<OpencliResult>;
-}
-
-export function createOpencli(options: {
-  shell: DshShell;
-  plugin: string;
-  logger?: { warn?(message: string): void } | undefined;
-  command?: string;
-  timeoutMs?: number;
-  maxConcurrent?: number;
-}): Opencli {
-  const {
-    shell,
-    plugin,
-    logger,
-    command = 'opencli',
-    timeoutMs = OPENCLI_TIMEOUT_MS,
-    maxConcurrent = OPENCLI_MAX_CONCURRENT,
-  } = options;
-
-  const inflight = new Map<string, Promise<OpencliResult>>();
-
-  const MAX_CONCURRENT = maxConcurrent;
-  let running = 0;
-  const waiting: Array<() => void> = [];
-
-  async function acquire(): Promise<void> {
-    if (running < MAX_CONCURRENT) {
-      running += 1;
-      return;
-    }
-    await new Promise<void>((resolve) => waiting.push(resolve));
-  }
-
-  function release(): void {
-    const next = waiting.shift();
-    if (next === undefined) running -= 1;
-    else next();
-  }
-
-  async function runLimited<T>(task: () => Promise<T>): Promise<T> {
-    await acquire();
-    try {
-      return await task();
-    } finally {
-      release();
-    }
-  }
-
-  async function call(commandLine: string, workdir: string | undefined): Promise<unknown> {
-    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: readonly string[],
-    callOptions: { key?: string; workdir?: string; session?: OpencliSession } = {},
-  ): Promise<OpencliResult> {
-    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 (): Promise<OpencliResult> => {
-      const value = await call(commandLine, workdir);
-      return { value, at: Date.now() };
-    };
-
-    const task = runLimited(async (): Promise<OpencliResult> => {
-      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/src/host/unit-libs.ts

@@ -1,41 +0,0 @@
-import type { PluginSourceProblem } from './plugin-source.js';
-import type { PluginRelease, UnitLibNeed, UnitPluginNeed } from '../api/unit.js';
-
-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 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" | "failed" | "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;
-}