@dsh-workbench/shared 1.1.8 → 1.1.10

package/src/host/__tests__/opencli-runner.test.ts

@@ -1,120 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-import type { DataRequest, DataResult } from '../../contract/data.js';
-import { opencliRunnerOf } from '../opencli-runner.js';
-
-type Read = (request: DataRequest) => Promise<DataResult<unknown>>;
-
-function readerOf(result: DataResult<unknown>): {
-  readonly read: Read;
-  readonly spy: ReturnType<typeof vi.fn>;
-} {
-  const spy = vi.fn(async (_request: DataRequest) => result);
-  return { read: spy as unknown as Read, spy };
-}
-
-describe('opencliRunnerOf', () => {
-  it('把 argv 原样交给读缝，解析后的值序列化回 stdout', async () => {
-    const { read, spy } = readerOf({ ok: true, data: [{ name: 'lsznh' }] });
-    const runner = opencliRunnerOf(read);
-
-    await expect(
-      runner(['argocd', 'application-resource-tree', '--name', 'lsznh']),
-    ).resolves.toEqual({ stdout: JSON.stringify([{ name: 'lsznh' }]) });
-    expect(spy).toHaveBeenCalledWith({
-      kind: 'command',
-      adapter: 'opencli',
-      argv: ['argocd', 'application-resource-tree', '--name', 'lsznh'],
-    });
-  });
-
-  it('timeoutMs 透传给读缝；不传就不出现这一格', async () => {
-    const withTimeout = readerOf({ ok: true, data: [] });
-    await opencliRunnerOf(withTimeout.read, { timeoutMs: 1_800_000 })([
-      'coding',
-      'ci-status',
-    ]);
-    expect(withTimeout.spy).toHaveBeenCalledWith(
-      expect.objectContaining({ timeoutMs: 1_800_000 }),
-    );
-
-    const withoutTimeout = readerOf({ ok: true, data: [] });
-    await opencliRunnerOf(withoutTimeout.read)(['coding', 'ci-status']);
-    expect(withoutTimeout.spy).toHaveBeenCalledWith(
-      expect.not.objectContaining({ timeoutMs: expect.anything() }),
-    );
-  });
-
-  it('未登录还原成 opencli 的约定：退出码 77 + AUTH_REQUIRED + 登录地址', async () => {
-    const { read } = readerOf({
-      ok: false,
-      error: {
-        code: 'auth',
-        pageCode: 'auth-required',
-        message: 'Coding 未登录',
-        helpUrl: 'https://baiguokeji.coding.net/login',
-      },
-    });
-
-    const failure = await opencliRunnerOf(read)(['coding', 'ci-status']).then(
-      () => null,
-      (error: unknown) => error as Error & { code?: number },
-    );
-
-    expect(failure).toBeInstanceOf(Error);
-    expect(failure?.code).toBe(77);
-    expect(failure?.message).toBe(
-      [
-        'Command failed: opencli coding ci-status',
-        'code: AUTH_REQUIRED',
-        'message: Coding 未登录',
-        'help: Please open Chrome or Chromium and log in to https://baiguokeji.coding.net/login',
-      ].join('\n'),
-    );
-  });
-
-  it('其它失败保留 Command failed 外壳与原因 / 细节 / 下一步', async () => {
-    const { read } = readerOf({
-      ok: false,
-      error: {
-        code: 'command',
-        pageCode: 'cli-command-failed',
-        message: 'UNKNOWN：插件里没有这条命令',
-        detail: 'error: unknown command',
-        hint: '升级插件后重试',
-      },
-    });
-
-    const failure = await opencliRunnerOf(read)([
-      'argocd',
-      'application-resource-tree',
-    ]).then(
-      () => null,
-      (error: unknown) => error as Error,
-    );
-
-    expect(failure?.message).toBe(
-      [
-        'Command failed: opencli argocd application-resource-tree',
-        'UNKNOWN：插件里没有这条命令',
-        'error: unknown command',
-        '升级插件后重试',
-      ].join('\n'),
-    );
-  });
-
-  it('没有原因时也有一句能看懂的兜底', async () => {
-    const { read } = readerOf({
-      ok: false,
-      error: { code: 'command', message: '' },
-    });
-
-    const failure = await opencliRunnerOf(read)(['cmdb', 'publish']).then(
-      () => null,
-      (error: unknown) => error as Error,
-    );
-
-    expect(failure?.message).toBe(
-      'Command failed: opencli cmdb publish\nopencli 这条命令没跑通',
-    );
-  });
-});

package/src/host/channel-plugin.ts

@@ -1,55 +0,0 @@
-import { existsSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { isolatedHome, toolchainOpencliDir, vendorPeerLink, vendorPluginsDir } from './paths.js';
-import { quoteShellArg } from './shell-text.js';
-
-export const CHANNEL_PLUGIN_NAME = 'opencli-plugin-workbench';
-export const CHANNEL_PLUGIN_SITE = 'workbench';
-
-export interface ChannelPluginPlan {
-  readonly dest: string;
-  readonly version: string;
-  readonly commands: readonly string[];
-  readonly line: string;
-}
-
-function textOf(value: unknown): string {
-  return typeof value === 'string' ? value.trim() : '';
-}
-
-export function channelVersionOf(dir: string): string | undefined {
-  try {
-    const parsed: unknown = JSON.parse(readFileSync(join(dir, 'opencli-plugin.json'), 'utf8'));
-    if (typeof parsed !== 'object' || parsed === null) return undefined;
-    const version = textOf((parsed as Record<string, unknown>)['version']);
-    return version === '' ? undefined : version;
-  } catch {
-    return undefined;
-  }
-}
-
-export function channelPluginPlan(options: {
-  readonly channelDir: string;
-  readonly command?: string;
-}): ChannelPluginPlan | undefined {
-  const version = channelVersionOf(options.channelDir);
-  if (version === undefined) return undefined;
-  const command = options.command ?? 'opencli';
-  const dest = join(vendorPluginsDir(), CHANNEL_PLUGIN_NAME);
-  const peer = vendorPeerLink();
-  const commands = [
-    `rm -rf ${quoteShellArg(dest)} && mkdir -p ${quoteShellArg(dest)} && cp -R ${quoteShellArg(options.channelDir)}/. ${quoteShellArg(dest)}/`,
-    `rm -rf ${quoteShellArg(peer.dir)} && mkdir -p ${quoteShellArg(peer.parent)} && ln -s ${quoteShellArg(toolchainOpencliDir())} ${quoteShellArg(peer.dir)}`,
-    `(${quoteShellArg(command)} plugin uninstall ${quoteShellArg(CHANNEL_PLUGIN_SITE)} || true)`,
-    `${quoteShellArg(command)} plugin install ${quoteShellArg(dest)}`,
-  ];
-  return { dest, version, commands, line: commands.join(' && ') };
-}
-
-export function channelInstalledVersion(): string | undefined {
-  return channelVersionOf(join(vendorPluginsDir(), CHANNEL_PLUGIN_NAME));
-}
-
-export function channelSiteInstalled(): boolean {
-  return existsSync(join(isolatedHome(), '.opencli', 'plugins', CHANNEL_PLUGIN_SITE));
-}

package/src/host/command-name.ts

@@ -1,15 +0,0 @@
-function baseName(value: string): string {
-  const parts = value.trim().split(/[\\/]/);
-  return parts[parts.length - 1] ?? '';
-}
-
-function isOpencli(name: string): boolean {
-  return name === 'opencli' || name === 'opencli.cmd' || name === 'opencli.exe';
-}
-
-export function commandNamesMatch(declared: string, resolved: string): boolean {
-  const left = baseName(declared);
-  const right = baseName(resolved);
-  if (left === '' || right === '') return false;
-  return left === right || (isOpencli(left) && isOpencli(right));
-}

package/src/host/opencli-runner.ts

@@ -1,76 +0,0 @@
-import type { DataError, DataRequest, DataResult } from '../contract/data.js';
-
-/**
- * 一条 opencli 命令的执行器：同一形状的 `execFile('opencli', args)`，结果只留 stdout。
- */
-export type OpencliRunner = (
-  args: readonly string[],
-) => Promise<{ readonly stdout: string }>;
-
-/**
- * 读缝（`DataReader.read`）的形状；模块直接把自己的 `data.read` 传进来即可。
- */
-export type OpencliRead = (
-  request: DataRequest,
-) => Promise<DataResult<unknown>>;
-
-export interface OpencliRunnerOptions {
-  readonly timeoutMs?: number;
-}
-
-const AUTH_REQUIRED_EXIT_CODE = 77;
-
-function textOf(value: unknown): string {
-  return typeof value === 'string' ? value : '';
-}
-
-function failedOf(args: readonly string[], error: DataError | undefined): Error {
-  const head = `Command failed: opencli ${args.join(' ')}`;
-  const auth = error?.pageCode === 'auth-required';
-  const helpUrl = textOf(error?.helpUrl);
-  const detail = textOf(error?.detail);
-  const hint = textOf(error?.hint);
-  const failed = new Error(
-    [
-      head,
-      ...(auth
-        ? ['code: AUTH_REQUIRED', `message: ${textOf(error?.message)}`]
-        : [textOf(error?.message) || 'opencli 这条命令没跑通']),
-      ...(detail === '' ? [] : [detail]),
-      ...(hint === '' ? [] : [hint]),
-      ...(auth && helpUrl !== ''
-        ? [`help: Please open Chrome or Chromium and log in to ${helpUrl}`]
-        : []),
-    ].join('\n'),
-  );
-  if (auth) (failed as Error & { code?: number }).code = AUTH_REQUIRED_EXIT_CODE;
-  return failed;
-}
-
-/**
- * 把读缝包成一条 opencli 命令的执行器：给还按 `execFile('opencli', args)` 收结果的编排库用，
- * 让它们跑在面板用的那份 opencli 上（同一套插件、同一份登录态）。
- *
- * 失败按 opencli 自己的约定还原：未登录是 `code: AUTH_REQUIRED` + 退出码 77，编排库的
- * 「等登录再重试」才接得上；其它失败保留 `Command failed: opencli …` 那句外壳。
- * @param read 模块手里的读缝（`data.read`）。
- * @param options `timeoutMs` 透传给读缝；不传就用读缝自己的默认值。
- * @returns 执行器；直接交给编排库的 `setOpencliRunner`。
- */
-export function opencliRunnerOf(
-  read: OpencliRead,
-  options: OpencliRunnerOptions = {},
-): OpencliRunner {
-  return async (args) => {
-    const result = await read({
-      kind: 'command',
-      adapter: 'opencli',
-      argv: [...args],
-      ...(options.timeoutMs === undefined
-        ? {}
-        : { timeoutMs: options.timeoutMs }),
-    });
-    if (result.ok) return { stdout: JSON.stringify(result.data) };
-    throw failedOf(args, result.error);
-  };
-}

package/src/host/paths.test.ts

@@ -1,26 +0,0 @@
-import { delimiter } from 'node:path';
-import { describe, expect, it } from 'vitest';
-import { ensureLibsBinOnPath, libsBinDir, npmCacheDir } from './paths.js';
-
-describe('隔离运行时的路径', () => {
-  it('共用依赖的 bin 目录就在 libs 下面', () => {
-    expect(libsBinDir().endsWith('/opencli/libs/node_modules/.bin')).toBe(true);
-    expect(npmCacheDir().endsWith('/opencli/npm-cache')).toBe(true);
-  });
-
-  it('★ 把 bin 目录前插一次；再插不会重复（PATH 不许越跑越长）', () => {
-    const env = { PATH: `/usr/bin${delimiter}/bin` };
-    const dir = libsBinDir();
-
-    expect(ensureLibsBinOnPath(env)).toBe(true);
-    expect(env.PATH).toBe(`${dir}${delimiter}/usr/bin${delimiter}/bin`);
-    expect(ensureLibsBinOnPath(env)).toBe(false);
-    expect(env.PATH.split(delimiter).filter((one) => one === dir)).toHaveLength(1);
-  });
-
-  it('PATH 是空的也能插', () => {
-    const env: NodeJS.ProcessEnv = {};
-    expect(ensureLibsBinOnPath(env)).toBe(true);
-    expect(env.PATH).toBe(libsBinDir());
-  });
-});

package/src/host/plugin-source.ts

@@ -1,137 +0,0 @@
-import type { SupplySource } from '../contract/needs.js';
-import type { ProvisionProblem } from '../contract/plugin-source.js';
-import { quoteShellArg } from './shell-text.js';
-import { npmCacheDir, toolchainOpencliDir, vendorPeerLink, vendorPrefix } from './paths.js';
-
-export type { ProvisionProblem } from '../contract/plugin-source.js';
-
-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: ProvisionProblem;
-      readonly env?: string;
-    };
-
-export interface PluginSourceOptions {
-  readonly command?: string;
-  readonly plugin?: string;
-  readonly version?: string;
-  readonly mode?: 'install' | 'update';
-}
-
-function mergeLines(commands: readonly PluginSourceCommand[]): string {
-  return commands.map((item) => (item.optional === true ? `(${item.line} || true)` : item.line)).join(' && ');
-}
-
-function envValue(
-  env: Readonly<Record<string, string | undefined>>,
-  name: string,
-): { readonly ok: true; readonly value: string } | { readonly ok: false } {
-  const value = env[name]?.trim();
-  return value === undefined || value === '' ? { ok: false } : { ok: true, value };
-}
-
-export function npmRegistryOf(
-  source: { readonly registryEnv?: string; readonly registryDefault?: string },
-  env: Readonly<Record<string, string | undefined>>,
-): { readonly ok: true; readonly value: string } | { readonly ok: false; readonly env: string } {
-  const name = source.registryEnv ?? '';
-  if (name !== '') {
-    const fromEnv = envValue(env, name);
-    if (fromEnv.ok) return fromEnv;
-  }
-  const fallback = source.registryDefault?.trim();
-  if (fallback === undefined || fallback === '') return { ok: false, env: name };
-  return { ok: true, value: fallback };
-}
-
-function installOne(command: string, spec: string): ResolvedPluginSource {
-  const line = `${quoteShellArg(command)} plugin install ${quoteShellArg(spec)}`;
-  return { ok: true, commands: [{ line }], line };
-}
-
-function pluginPackageOf(source: SupplySource, plugin: string): string {
-  if (source.kind === 'npm') {
-    const pkg = source.package?.trim() ?? '';
-    if (pkg !== '') return pkg;
-    return plugin.trim() === '' ? '' : `opencli-plugin-${plugin.trim()}`;
-  }
-  if (source.kind === 'git') return source.url.trim();
-  return '';
-}
-
-function npmSource(
-  source: SupplySource & { kind: 'npm' },
-  env: Readonly<Record<string, string | undefined>>,
-  options: PluginSourceOptions,
-): ResolvedPluginSource {
-  const registry = npmRegistryOf(source, env);
-  if (!registry.ok) return { ok: false, problem: 'env-missing', env: registry.env };
-
-  const { command = 'opencli', plugin = '', version = 'latest', mode = 'install' } = options;
-  const name = pluginPackageOf(source, plugin);
-  if (name === '') return { ok: false, problem: 'malformed' };
-
-  const prefix = vendorPrefix();
-  const dirInPrefix = `${prefix}/node_modules/${name}`;
-  const peer = vendorPeerLink();
-
-  const commands: PluginSourceCommand[] = [
-    {
-      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: SupplySource | undefined,
-  env: Readonly<Record<string, string | undefined>>,
-  options: PluginSourceOptions = {},
-): ResolvedPluginSource {
-  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 = source.env === undefined ? { ok: false as const } : envValue(env, source.env);
-  if (value.ok) return installOne(command, value.value);
-  if (source.path !== undefined && source.path.trim() !== '') return installOne(command, source.path.trim());
-  return { ok: false, problem: 'env-missing', env: source.env ?? '' };
-}

package/src/host/runtime-links.test.ts

@@ -1,31 +0,0 @@
-import { existsSync, mkdirSync, mkdtempSync, realpathSync } from 'node:fs';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-import { afterEach, describe, expect, it, vi } from 'vitest';
-import { ensureLibsOpencliPeer } from './runtime-links.js';
-
-afterEach(() => {
-  vi.unstubAllEnvs();
-});
-
-describe('ensureLibsOpencliPeer', () => {
-  it('★ 运行时那份 opencli 在 → 链到 libs，libs 里的命令才 import 得到它', () => {
-    const root = mkdtempSync(join(tmpdir(), 'wb-peer-'));
-    vi.stubEnv('DSH_WORKBENCH_HOME', root);
-    mkdirSync(join(root, 'opencli/toolchain/node_modules/@jackwener/opencli'), { recursive: true });
-
-    expect(ensureLibsOpencliPeer()).toBe(true);
-    const link = join(root, 'opencli/libs/node_modules/@jackwener/opencli');
-    expect(existsSync(link)).toBe(true);
-    expect(realpathSync(link)).toContain('toolchain/node_modules/@jackwener/opencli');
-    expect(ensureLibsOpencliPeer()).toBe(false);
-  });
-
-  it('运行时还没装 opencli → 不建空链接（等它装好再说）', () => {
-    const root = mkdtempSync(join(tmpdir(), 'wb-peer-'));
-    vi.stubEnv('DSH_WORKBENCH_HOME', root);
-
-    expect(ensureLibsOpencliPeer()).toBe(false);
-    expect(existsSync(join(root, 'opencli/libs/node_modules/@jackwener/opencli'))).toBe(false);
-  });
-});

package/src/host/runtime-links.ts

@@ -1,23 +0,0 @@
-import { existsSync, mkdirSync, symlinkSync } from 'node:fs';
-import { dirname } from 'node:path';
-import { OPENCLI_NPM_PACKAGE, libsPrefix, toolchainOpencliDir } from './paths.js';
-
-/**
- * 让共用依赖也能 import opencli：把隔离运行时里那份 opencli 链接到 libs 的 node_modules。
- * 跑在 libs 里的命令（比如 opencli-workflow 带的 gitops）会按包名找 @jackwener/opencli，
- * 找不到就起不来 —— 它不在 libs 的依赖里，是运行时提供的那一份。
- * @returns 这次真的建了链接就 `true`；已经有了、或运行时那份还没装，就是 `false`。
- */
-export function ensureLibsOpencliPeer(): boolean {
-  const link = `${libsPrefix()}/node_modules/${OPENCLI_NPM_PACKAGE}`;
-  if (existsSync(link)) return false;
-  const target = toolchainOpencliDir();
-  if (!existsSync(target)) return false;
-  try {
-    mkdirSync(dirname(link), { recursive: true });
-    symlinkSync(target, link);
-    return true;
-  } catch {
-    return false;
-  }
-}