@dsh-workbench/shared 1.1.5 → 1.1.7

package/src/host/__tests__/market-index.test.ts

@@ -2,14 +2,23 @@ import { describe, expect, it } from 'vitest';
 import type { MarketIndex, MarketIndexEntry } from '../../contract/protocol/market-index.js';
 import { claimOf, claimOfEntry, entryOwnerOf, entryUnitOf, marketArtifactPath, samePublisher } from '../market-index-claim.js';
 import {
+  assembleMarketIndex,
+  collectMarketEntryFiles,
   filterMarketIndex,
+  marketEntryFilesOf,
+  marketEntryPath,
   marketInstallTarget,
+  marketMetaPath,
   marketSourceKey,
+  parseMarketEntryDoc,
   parseMarketIndex,
   parseMarketIndexJson,
   parseSourceConfig,
   upsertMarketEntry,
 } from '../market-index.js';
+import { mkdtempSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
 
 function entry(change: Partial<MarketIndexEntry> = {}): MarketIndexEntry {
   return {
@@ -343,3 +352,108 @@ describe('索引源与安装目标', () => {
     ).toBe(false);
   });
 });
+
+describe('条目文件：一个版本一个文件', () => {
+  const versionDoc = (version: string, timestamp: number, title: string) => ({
+    name: '@scope/module-x',
+    version,
+    source: { type: 'npm' },
+    publishTimestamp: timestamp,
+    title: { zh: title },
+  });
+
+  it('路径按包名分层，meta 文件带 epoch 与随机后缀', () => {
+    expect(marketEntryPath('market', '@scope/module-x', '0.1.0')).toBe('market/@scope/module-x/0.1.0.json');
+    expect(marketMetaPath('market', '@scope/module-x', 3, 'a1b2c3')).toBe(
+      'market/@scope/module-x/meta-3-a1b2c3.json',
+    );
+    expect(marketEntryPath('market', 'plain', '1.0.0')).toBe('market/plain/1.0.0.json');
+  });
+
+  it('包名/版本号不合法就不给路径（防止写出目录外）', () => {
+    expect(() => marketEntryPath('market', '../escape', '1.0.0')).toThrow();
+    expect(() => marketEntryPath('market', 'ok', '../1.0.0')).toThrow();
+  });
+
+  it('单条文档能解析，坏文档整条拒', () => {
+    const good = parseMarketEntryDoc(versionDoc('0.1.0', 1_760_000_000, '探针'));
+    expect(good.ok).toBe(true);
+    if (!good.ok) return;
+    expect(good.doc.name).toBe('@scope/module-x');
+    const bad = parseMarketEntryDoc({ name: 'Bad Name', version: '0.1.0', source: { type: 'npm' } });
+    expect(bad.ok).toBe(false);
+    const noSource = parseMarketEntryDoc({ name: '@scope/x', version: '0.1.0' });
+    expect(noSource.ok).toBe(false);
+  });
+
+  it('组装：版本全收并按 SemVer 降序，元数据取最新那份', () => {
+    const files = [
+      { path: 'market/@scope/module-x/0.1.0.json', text: JSON.stringify(versionDoc('0.1.0', 1_760_000_000, '旧标题')) },
+      { path: 'market/@scope/module-x/0.2.0.json', text: JSON.stringify(versionDoc('0.2.0', 1_760_000_100, '新标题')) },
+      { path: 'market/@scope/module-x/meta-1760000200000.json', text: JSON.stringify({
+        name: '@scope/module-x',
+        publishTimestamp: 1_760_000_200,
+        title: { zh: '最新标题' },
+      }) },
+    ];
+    const assembled = assembleMarketIndex(files);
+    expect(assembled.ok).toBe(true);
+    if (!assembled.ok) return;
+    const entry = assembled.index.plugins[0];
+    expect(entry?.versions.map((one) => one.version)).toEqual(['0.2.0', '0.1.0']);
+    expect(entry?.title?.zh).toBe('最新标题');
+  });
+
+  it('组装：同一个版本出现两次就整份拒（那是真重复发布）', () => {
+    const assembled = assembleMarketIndex([
+      { path: 'a/0.1.0.json', text: JSON.stringify(versionDoc('0.1.0', 1_760_000_000, '甲')) },
+      { path: 'b/0.1.0.json', text: JSON.stringify(versionDoc('0.1.0', 1_760_000_100, '乙')) },
+    ]);
+    expect(assembled.ok).toBe(false);
+    if (assembled.ok) return;
+    expect(assembled.problems.some((one) => one.kind === 'duplicate-version')).toBe(true);
+  });
+
+  it('从目录读只收 .json，README 不当条目', () => {
+    const dir = mkdtempSync(join(tmpdir(), 'wb-entry-'));
+    try {
+      mkdirSync(join(dir, '@scope/module-x'), { recursive: true });
+      writeFileSync(join(dir, 'README.md'), 'index');
+      writeFileSync(join(dir, '@scope/module-x', '0.1.0.json'), JSON.stringify(versionDoc('0.1.0', 1_760_000_000, '探针')));
+      const files = collectMarketEntryFiles(dir);
+      expect(files.map((one) => one.path)).toEqual(['@scope/module-x/0.1.0.json']);
+      const assembled = assembleMarketIndex(files);
+      expect(assembled.ok).toBe(true);
+      if (!assembled.ok) return;
+      expect(assembled.index.plugins[0]?.name).toBe('@scope/module-x');
+    } finally {
+      rmSync(dir, { recursive: true, force: true });
+    }
+  });
+
+  it('迁移：一份 format 1 能拆成条目文件，再组装回来一模一样', () => {
+    const legacy: MarketIndex = {
+      format: 1,
+      plugins: [
+        {
+          name: '@scope/module-x',
+          owner: '甲',
+          metadata: { workbench: true, unit: 'x' },
+          versions: [
+            { version: '0.2.0', source: { type: 'npm' }, publishTimestamp: 1_760_000_100 },
+            { version: '0.1.0', source: { type: 'npm' }, publishTimestamp: 1_760_000_000 },
+          ],
+        },
+      ],
+    };
+    const files = marketEntryFilesOf(legacy, 'market');
+    expect(files.map((one) => one.path)).toEqual([
+      'market/@scope/module-x/0.2.0.json',
+      'market/@scope/module-x/0.1.0.json',
+    ]);
+    const assembled = assembleMarketIndex(files);
+    expect(assembled.ok).toBe(true);
+    if (!assembled.ok) return;
+    expect(assembled.index.plugins).toEqual(legacy.plugins);
+  });
+});

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

@@ -0,0 +1,120 @@
+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/lib-runners.ts

@@ -0,0 +1,70 @@
+import type { LibNeed } from '../contract/needs.js';
+import type { LibReader } from '../contract/lib.js';
+import type { OpencliRunner } from './opencli-runner.js';
+
+export interface LibRuntimes {
+  readonly opencli?: OpencliRunner | undefined;
+}
+
+interface Logger {
+  warn?(message: string): void;
+}
+
+function runnerOf(runtimes: LibRuntimes, runtime: string): OpencliRunner | undefined {
+  return runtime === 'opencli' ? runtimes.opencli : undefined;
+}
+
+function setterNameOf(runtime: string): string {
+  return `set${runtime.charAt(0).toUpperCase()}${runtime.slice(1)}Runner`;
+}
+
+/**
+ * 给声明了 `runs` 的 lib 注入「跑这个运行时」的执行器：库侧按约定暴露 `setOpencliRunner`
+ * （运行时名字首字母大写 + `Runner`），外壳在每次 `load` 之后把执行器交给它。
+ *
+ * 没暴露的（版本旧）就保持它自己的行为（按 PATH 找），只记一条 warn；不熟悉的运行时同样只 warn。
+ * @param libs 原来的读库口。
+ * @param runtimes 外壳手上有的执行器，按运行时名字给。
+ * @param logger 记 warn 的地方（默认不记）。
+ * @returns 包好的读库口；`load` 的签名与返回不变。
+ */
+export function withLibRunners(
+  libs: LibReader,
+  runtimes: LibRuntimes,
+  logger?: Logger,
+): LibReader {
+  const warned = new Set<string>();
+  const warnOnce = (key: string, message: string): void => {
+    if (warned.has(key)) return;
+    warned.add(key);
+    logger?.warn?.(message);
+  };
+  return {
+    async load<T = unknown>(need: LibNeed, entry: string): Promise<T> {
+      const module = await libs.load<T>(need, entry);
+      for (const runtime of need.runs ?? []) {
+        const runner = runnerOf(runtimes, runtime);
+        if (runner === undefined) {
+          warnOnce(
+            `${need.name}:${runtime}:unsupported`,
+            `[dsh-workbench] ${need.name} 声明了自己会跑 ${runtime}，但工作台没有这个执行器 —— 它会按自己的方式找`,
+          );
+          continue;
+        }
+        const setter =
+          typeof module === 'object' && module !== null
+            ? (module as Record<string, unknown>)[setterNameOf(runtime)]
+            : undefined;
+        if (typeof setter !== 'function') {
+          warnOnce(
+            `${need.name}:${entry}:${runtime}:missing`,
+            `[dsh-workbench] ${need.name} 声明了自己会跑 ${runtime}，但这一版没有 ${setterNameOf(runtime)} —— 它会按 PATH 找`,
+          );
+          continue;
+        }
+        (setter as (runner: OpencliRunner) => void).call(module, runner);
+      }
+      return module;
+    },
+  };
+}

package/src/host/market-index-claim.ts

@@ -1,4 +1,5 @@
 import type { MarketClaim, MarketIndex, MarketIndexEntry } from '../contract/protocol/market-index.js';
+import { MARKET_ARTIFACTS_DIR } from '../contract/protocol/market-index.js';
 
 export interface PublisherIdentity {
   readonly name: string;
@@ -53,6 +54,14 @@ export function marketArtifactPath(name: string): string {
   return `packages/${name}`;
 }
 
+export function marketArtifactRoot(name: string): string {
+  return `${MARKET_ARTIFACTS_DIR}/${name}`;
+}
+
+export function marketArtifactPathFor(name: string, version: string): string {
+  return `${MARKET_ARTIFACTS_DIR}/${name}/${version}`;
+}
+
 export function entryUnitOf(entry: MarketIndexEntry): string | undefined {
   const unit = entry.metadata?.unit?.trim();
   if (unit !== undefined && unit !== '') return unit;

package/src/host/market-index-doc.ts

@@ -0,0 +1,62 @@
+import type {
+  MarketIndex,
+  MarketIndexEngines,
+  MarketIndexEntryMetadata,
+  MarketIndexProblem,
+  MarketIndexSource,
+  MarketLocalizedText,
+} from '../contract/protocol/market-index.js';
+
+export interface MarketVersionDoc {
+  readonly name: string;
+  readonly version: string;
+  readonly source: MarketIndexSource;
+  readonly publishTimestamp?: number;
+  readonly engines?: MarketIndexEngines;
+  readonly title?: MarketLocalizedText;
+  readonly description?: MarketLocalizedText;
+  readonly author?: string;
+  readonly owner?: string;
+  readonly homepage?: string;
+  readonly icon?: string;
+  readonly metadata?: MarketIndexEntryMetadata;
+}
+
+export interface MarketMetaDoc {
+  readonly name: string;
+  readonly epoch?: number;
+  readonly publishTimestamp: number;
+  readonly title?: MarketLocalizedText;
+  readonly description?: MarketLocalizedText;
+  readonly author?: string;
+  readonly owner?: string;
+  readonly homepage?: string;
+  readonly icon?: string;
+  readonly metadata?: MarketIndexEntryMetadata;
+}
+
+export type MarketEntryDoc = MarketVersionDoc | MarketMetaDoc;
+
+export type MarketEntryDocParse =
+  | { readonly ok: true; readonly doc: MarketEntryDoc }
+  | { readonly ok: false; readonly problems: readonly MarketIndexProblem[] };
+
+export interface MarketEntryFile {
+  readonly path: string;
+  readonly text: string;
+}
+
+export type MarketIndexAssemble =
+  | { readonly ok: true; readonly index: MarketIndex }
+  | { readonly ok: false; readonly problems: readonly MarketIndexProblem[] };
+
+export interface MarketDocFields {
+  readonly name: string;
+  readonly title?: MarketLocalizedText;
+  readonly description?: MarketLocalizedText;
+  readonly author?: string;
+  readonly owner?: string;
+  readonly homepage?: string;
+  readonly icon?: string;
+  readonly metadata?: MarketIndexEntryMetadata;
+}