@dsh-workbench/shared 0.1.14 → 0.1.15

package/src/host/__tests__/browser-read.test.ts

@@ -0,0 +1,197 @@
+import { describe, expect, it } from 'vitest';
+import { browserRead } from '../browser-read.js';
+
+interface Step {
+  readonly stdout?: string;
+  readonly stderr?: string;
+  readonly exitCode?: number;
+  readonly timedOut?: boolean;
+}
+
+function fakeShell(plan: readonly Step[]) {
+  const commands: string[] = [];
+  let index = 0;
+  const shell = {
+    resolve(request: { command: string }) {
+      commands.push(request.command);
+      return request;
+    },
+    async execute() {
+      const step = plan[Math.min(index, plan.length - 1)] ?? {};
+      index += 1;
+      return {
+        result: async () => ({
+          exitCode: step.exitCode ?? 0,
+          timedOut: step.timedOut ?? false,
+          aborted: false,
+          stdout: { text: step.stdout ?? '', truncated: false },
+          stderr: { text: step.stderr ?? '', truncated: false },
+        }),
+      };
+    },
+  };
+  return { shell: shell as never, commands };
+}
+
+const FAST = { retryMs: 1, settleMs: 1, timeoutMs: 50 } as const;
+const script = 'return 1';
+const URL = 'https://example.test/wallet';
+
+describe('browserRead · 读成功', () => {
+  it('页面回 JSON → ok，命令走 `browser <session> eval`', async () => {
+    const { shell, commands } = fakeShell([{ stdout: JSON.stringify({ ok: true, n: 3 }) }]);
+    const out = await browserRead({ shell, script, url: URL, ...FAST });
+
+    expect(out.ok).toBe(true);
+    expect(out.code).toBe('ok');
+    expect(out.value).toEqual({ ok: true, n: 3 });
+    expect(commands[0]).toContain("'browser' 'workbench' 'eval'");
+  });
+
+  it('脚本没回 ok 字段（例如直接回一个数）也算读到了', async () => {
+    const { shell } = fakeShell([{ stdout: '42' }]);
+    const out = await browserRead({ shell, script, ...FAST });
+    expect(out.ok).toBe(true);
+    expect(out.value).toBe(42);
+  });
+});
+
+describe('browserRead · 平台码归一（不许透传）', () => {
+  it('AUTH_UNAUTHORIZED → auth-required + helpUrl', async () => {
+    const { shell } = fakeShell([
+      { stdout: JSON.stringify({ ok: false, code: 'AUTH_UNAUTHORIZED', message: '登录已过期' }) },
+    ]);
+    const out = await browserRead({ shell, script, url: URL, loginUrl: 'https://sso.example.com', ...FAST });
+
+    expect(out.ok).toBe(false);
+    expect(out.code).toBe('auth-required');
+    expect(out.pageCode).toBe('AUTH_UNAUTHORIZED');
+    expect(out.helpUrl).toBe('https://sso.example.com');
+    expect(out.message).toBe('登录已过期');
+  });
+
+  it('PERMISSION_DENIED → permission-denied', async () => {
+    const { shell } = fakeShell([{ stdout: JSON.stringify({ ok: false, code: 'permission_denied' }) }]);
+    const out = await browserRead({ shell, script, url: URL, ...FAST });
+    expect(out.code).toBe('permission-denied');
+  });
+
+  it('业务码原样回（落到阻断屏的"其它"那一支）', async () => {
+    const { shell } = fakeShell([
+      { stdout: JSON.stringify({ ok: false, code: 'network', message: '连不上', hint: '稍后重试' }) },
+    ]);
+    const out = await browserRead({ shell, script, url: URL, ...FAST });
+    expect(out.code).toBe('network');
+    expect(out.pageCode).toBe('network');
+    expect(out.message).toBe('连不上');
+    expect(out.hint).toBe('稍后重试');
+  });
+});
+
+describe('browserRead · 两拍（不在站点上就先打开）', () => {
+  it('not-on-site → open（后台窗口）→ 再读一遍 → ok', async () => {
+    const { shell, commands } = fakeShell([
+      { stdout: JSON.stringify({ ok: false, code: 'not-on-site' }) },
+      { stdout: 'opened' },
+      { stdout: JSON.stringify({ ok: true }) },
+    ]);
+    const out = await browserRead({ shell, script, url: URL, ...FAST });
+
+    expect(out.ok).toBe(true);
+    expect(commands.some((one) => one.includes("'open'") && one.includes('--window'))).toBe(true);
+    expect(commands.filter((one) => one.includes("'eval'"))).toHaveLength(2);
+  });
+
+  it('open 关了：直接说清"没停在那套系统上"', async () => {
+    const { shell, commands } = fakeShell([{ stdout: JSON.stringify({ ok: false, code: 'not-on-site' }) }]);
+    const out = await browserRead({ shell, script, url: URL, open: false, ...FAST });
+
+    expect(out.ok).toBe(false);
+    expect(out.message).toContain('没停在那套系统上');
+    expect(commands.some((one) => one.includes("'open'"))).toBe(false);
+  });
+
+  it('打开之后还是不在站点上：报 cli-exec-failed（不是静默成功）', async () => {
+    const { shell } = fakeShell([
+      { stdout: JSON.stringify({ ok: false, code: 'not-on-site' }) },
+      { stdout: 'opened' },
+      { stdout: JSON.stringify({ ok: false, code: 'not-on-site' }) },
+    ]);
+    const out = await browserRead({ shell, script, url: URL, ...FAST });
+    expect(out.code).toBe('cli-exec-failed');
+    expect(out.message).toContain('仍然不在那套系统上');
+  });
+});
+
+describe('browserRead · 命令这一层的问题', () => {
+  it('刚重启时第一次失败：等一下再读一次就成功（实测的那个坑）', async () => {
+    const { shell, commands } = fakeShell([
+      { exitCode: 1, stderr: 'opencli: daemon not ready' },
+      { stdout: JSON.stringify({ ok: true }) },
+    ]);
+    const out = await browserRead({ shell, script, ...FAST });
+    expect(out.ok).toBe(true);
+    expect(commands.filter((one) => one.includes("'eval'"))).toHaveLength(2);
+  });
+
+  it('一直失败 → cli-exec-failed + 原始输出尾巴', async () => {
+    const { shell } = fakeShell([{ exitCode: 1, stderr: 'boom\nline2' }]);
+    const out = await browserRead({ shell, script, ...FAST });
+    expect(out.code).toBe('cli-exec-failed');
+    expect(out.detail).toContain('boom');
+  });
+
+  it('stderr 里是权限问题 → permission-denied（不当成普通失败）', async () => {
+    const { shell } = fakeShell([{ exitCode: 1, stderr: 'PERMISSION_DENIED: nope' }]);
+    const out = await browserRead({ shell, script, ...FAST });
+    expect(out.code).toBe('permission-denied');
+  });
+
+  it('超时 → cli-timeout，而且**不**重试（已经等满了）', async () => {
+    const { shell, commands } = fakeShell([{ timedOut: true }]);
+    const out = await browserRead({ shell, script, ...FAST });
+    expect(out.code).toBe('cli-timeout');
+    expect(commands.filter((one) => one.includes("'eval'"))).toHaveLength(1);
+  });
+
+  it('输出不是 JSON → cli-exec-failed 且说清是"不是 JSON"', async () => {
+    const { shell } = fakeShell([{ stdout: 'not json at all' }]);
+    const out = await browserRead({ shell, script, ...FAST });
+    expect(out.code).toBe('cli-exec-failed');
+    expect(out.message).toContain('不是 JSON');
+  });
+});
+
+function backgroundless(commands: readonly string[]): readonly string[] {
+  return commands
+    .filter((one) => one.includes("'browser'"))
+    .filter(
+      (one) => !one.includes("'--window' 'background'") || !one.includes("'OPENCLI_WINDOW=background'"),
+    );
+}
+
+describe('browserRead · 后台静默（每一拍都不许抢焦点）', () => {
+  it('不在站点上那一趟：eval → open → eval 三条全带', async () => {
+    const { shell, commands } = fakeShell([
+      { stdout: JSON.stringify({ ok: false, code: 'not-on-site' }) },
+      {},
+      { stdout: JSON.stringify({ ok: true, n: 1 }) },
+    ]);
+    const out = await browserRead({ shell, script, url: URL, ...FAST });
+
+    expect(out.ok).toBe(true);
+    expect(commands.filter((one) => one.includes("'browser'"))).toHaveLength(3);
+    expect(backgroundless(commands)).toEqual([]);
+  });
+
+  it('命令失败重试那一拍也带', async () => {
+    const { shell, commands } = fakeShell([
+      { exitCode: 1, stderr: 'boom' },
+      { stdout: JSON.stringify({ ok: true }) },
+    ]);
+    await browserRead({ shell, script, url: URL, ...FAST });
+
+    expect(commands.filter((one) => one.includes("'eval'"))).toHaveLength(2);
+    expect(backgroundless(commands)).toEqual([]);
+  });
+});

package/src/host/browser-find.ts

@@ -0,0 +1,311 @@
+import type { DshShell } from '../api/dsh.js';
+import { parseJsonLoose } from '../lib/text.js';
+import { BROWSER_BRIDGE_SESSION } from './browser-read.js';
+import { backgroundLine } from './opencli-window.js';
+import { runShell } from './shell.js';
+
+const DEFAULT_TIMEOUT_MS = 25000;
+const DEFAULT_SETTLE_MS = 2500;
+const URL_TIMEOUT_MS = 8000;
+const DEFAULT_LIMIT = 50;
+const DEFAULT_TEXT_MAX = 200;
+
+export interface BrowserFindEntry {
+  readonly text: string;
+  readonly tag: string;
+  readonly nth: number;
+}
+
+export interface BrowserFindResult {
+  readonly ok: boolean;
+  readonly code: string;
+  readonly at: number;
+  readonly entries: readonly BrowserFindEntry[];
+  readonly count: number;
+  readonly message: string;
+  readonly hint?: string;
+  readonly detail?: string;
+  readonly helpUrl?: string;
+}
+
+export interface BrowserFindOptions {
+  readonly shell: DshShell;
+  readonly css: string;
+  readonly url?: string;
+  readonly command?: string;
+  readonly session?: string;
+  readonly limit?: number;
+  readonly textMax?: number;
+  readonly open?: boolean;
+  readonly timeoutMs?: number;
+  readonly settleMs?: number;
+}
+
+export function cellRowsOf(
+  entries: readonly { readonly text?: string }[],
+  minCells = 2,
+): string[][] {
+  const rows: string[][] = [];
+  for (const entry of entries) {
+    const text = typeof entry?.text === 'string' ? entry.text : '';
+    const cells = text
+      .split('\n')
+      .map((one) => one.trim())
+      .filter((one) => one !== '');
+    if (cells.length >= minCells) rows.push(cells);
+  }
+  return rows;
+}
+
+export function cellRows(text: string): string[] {
+  return text
+    .split('\n')
+    .map((one) => one.trim())
+    .filter((one) => one !== '');
+}
+
+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() : '';
+}
+
+export function entriesOf(value: unknown): BrowserFindEntry[] {
+  const record = asRecord(value);
+  const raw = record === undefined ? undefined : record['entries'];
+  if (!Array.isArray(raw)) return [];
+  const entries: BrowserFindEntry[] = [];
+  for (const one of raw) {
+    const item = asRecord(one);
+    if (item === undefined) continue;
+    const nth = typeof item['nth'] === 'number' ? item['nth'] : entries.length;
+    entries.push({ text: textOf(item['text']), tag: textOf(item['tag']), nth });
+  }
+  return entries;
+}
+
+export function reasonOf(stdout: string, stderr: string): string {
+  const parsed = asRecord(parseJsonLoose(stdout));
+  const error = parsed === undefined ? undefined : asRecord(parsed['error']);
+  const message = error === undefined ? '' : textOf(error['message']);
+  if (message !== '') return message;
+  const source = stderr.trim() === '' ? stdout : stderr;
+  const lines = source
+    .split('\n')
+    .map((one) => one.trim())
+    .filter((one) => one !== '');
+  return (lines[lines.length - 1] ?? '').slice(-200);
+}
+
+function hintOf(stdout: string): string | undefined {
+  const parsed = asRecord(parseJsonLoose(stdout));
+  const error = parsed === undefined ? undefined : asRecord(parsed['error']);
+  const hint = error === undefined ? '' : textOf(error['hint']);
+  return hint === '' ? undefined : hint;
+}
+
+export function sameOrigin(left: string, right: string): boolean {
+  try {
+    return new URL(left).origin === new URL(right).origin;
+  } catch {
+    return false;
+  }
+}
+
+export function urlOf(stdout: string): string {
+  const lines = stdout
+    .split('\n')
+    .map((one) => one.trim())
+    .filter((one) => one !== '');
+  const first = (lines[0] ?? '').replace(/^url:\s*/i, '').trim();
+  const bare = first.replace(/^["']+|["']+$/g, '');
+  if (bare.startsWith('{')) {
+    const parsed = asRecord(parseJsonLoose(bare));
+    const url = parsed === undefined ? '' : textOf(parsed['url']);
+    if (url !== '') return url;
+  }
+  return bare;
+}
+
+async function currentUrl(
+  shell: DshShell,
+  command: string,
+  session: string,
+): Promise<string> {
+  const line = backgroundLine(command, ['browser', session, 'get', 'url', '--window', 'background']);
+  try {
+    const result = await runShell(shell, line, { timeoutMs: URL_TIMEOUT_MS });
+    if (result.exitCode !== 0) return '';
+    return urlOf(result.stdout);
+  } catch {
+    return '';
+  }
+}
+
+function sleep(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+type FindOutcome =
+  | { readonly kind: 'ok'; readonly entries: readonly BrowserFindEntry[]; readonly stdout: string }
+  | { readonly kind: 'timeout'; readonly detail: string }
+  | { readonly kind: 'failed'; readonly detail: string; readonly hint?: string };
+
+async function findOnce(
+  shell: DshShell,
+  command: string,
+  session: string,
+  css: string,
+  limit: number,
+  textMax: number,
+  timeoutMs: number,
+): Promise<FindOutcome | undefined> {
+  const line = backgroundLine(command, [
+    'browser',
+    session,
+    'find',
+    '--css',
+    css,
+    '--limit',
+    String(limit),
+    '--text-max',
+    String(textMax),
+    '--window',
+    'background',
+  ]);
+  const result = await runShell(shell, line, { timeoutMs });
+  if (result.timedOut) {
+    return { kind: 'timeout', detail: `没在 ${Math.round(timeoutMs / 1000)} 秒内返回` };
+  }
+  if (result.exitCode !== 0) {
+    return {
+      kind: 'failed',
+      detail: reasonOf(result.stdout, result.stderr),
+      ...(hintOf(result.stdout) === undefined ? {} : { hint: hintOf(result.stdout) }),
+    };
+  }
+  const entries = entriesOf(parseJsonLoose(result.stdout));
+  return { kind: 'ok', entries, stdout: result.stdout };
+}
+
+async function openOnce(
+  shell: DshShell,
+  command: string,
+  session: string,
+  url: string,
+  timeoutMs: number,
+): Promise<string | undefined> {
+  const line = backgroundLine(command, ['browser', session, 'open', url, '--window', 'background']);
+  let result: Awaited<ReturnType<typeof runShell>>;
+  try {
+    result = await runShell(shell, line, { timeoutMs });
+  } catch (error) {
+    return error instanceof Error ? error.message : String(error);
+  }
+  if (result.timedOut) return `没在 ${Math.round(timeoutMs / 1000)} 秒内打开`;
+  if (result.exitCode !== 0) {
+    const reason = reasonOf(result.stdout, result.stderr);
+    return reason === '' ? `opencli 打开失败（退出码 ${String(result.exitCode ?? '?')}）` : reason;
+  }
+  return undefined;
+}
+
+export async function browserFind(options: BrowserFindOptions): Promise<BrowserFindResult> {
+  const { shell, css, url, open = true } = options;
+  const command = options.command ?? 'opencli';
+  const session = options.session ?? BROWSER_BRIDGE_SESSION;
+  const limit = options.limit ?? DEFAULT_LIMIT;
+  const textMax = options.textMax ?? DEFAULT_TEXT_MAX;
+  const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+  const settleMs = options.settleMs ?? DEFAULT_SETTLE_MS;
+  const at = Date.now();
+
+  const find = async (): Promise<FindOutcome | undefined> => {
+    try {
+      return await findOnce(shell, command, session, css, limit, textMax, timeoutMs);
+    } catch (error) {
+      return {
+        kind: 'failed',
+        detail: error instanceof Error ? error.message : String(error),
+        hint: '确认这台机器上 opencli 能跑（工作台会自己把它挂好）',
+      };
+    }
+  };
+
+  const canMove = open && url !== undefined;
+
+  if (canMove) {
+    const here = await currentUrl(shell, command, session);
+    if (here !== '' && !sameOrigin(here, url)) {
+      const opened = await openOnce(shell, command, session, url, timeoutMs);
+      if (opened !== undefined) {
+        return {
+          ok: false,
+          code: 'cli-exec-failed',
+          at,
+          entries: [],
+          count: 0,
+          message: '打不开那个页面',
+          hint: '在浏览器里手动打开一次，然后重试',
+          detail: opened,
+          helpUrl: url,
+        };
+      }
+      await sleep(settleMs);
+    }
+  }
+
+  let outcome = await find();
+  if (outcome === undefined) {
+    return { ok: false, code: 'cli-exec-failed', at, entries: [], count: 0, message: '没找到元素' };
+  }
+
+  if (outcome.kind === 'failed' && canMove) {
+    const opened = await openOnce(shell, command, session, url, timeoutMs);
+    if (opened === undefined) {
+      await sleep(settleMs);
+      const second = await find();
+      if (second !== undefined) outcome = second;
+    }
+  }
+
+  if (outcome.kind === 'timeout') {
+    return {
+      ok: false,
+      code: 'cli-timeout',
+      at,
+      entries: [],
+      count: 0,
+      message: '这次没找到元素（等超时了）',
+      hint: '稍后重试',
+      detail: outcome.detail,
+      ...(url === undefined ? {} : { helpUrl: url }),
+    };
+  }
+
+  if (outcome.kind === 'failed') {
+    const detail = outcome.detail;
+    return {
+      ok: false,
+      code: 'cli-exec-failed',
+      at,
+      entries: [],
+      count: 0,
+      message: detail === '' ? '没找到元素（opencli 命令失败）' : `没找到元素：${detail}`,
+      ...(outcome.hint === undefined ? {} : { hint: outcome.hint }),
+      ...(detail === '' ? {} : { detail }),
+      ...(url === undefined ? {} : { helpUrl: url }),
+    };
+  }
+
+  return {
+    ok: true,
+    code: 'ok',
+    at,
+    entries: outcome.entries,
+    count: outcome.entries.length,
+    message: outcome.entries.length === 0 ? '页面上没有匹配的元素' : `找到 ${String(outcome.entries.length)} 个元素`,
+  };
+}