mirror of
https://github.com/jackwener/OpenCLI.git
synced 2026-09-14 18:25:42 +08:00
jakevin
4fe9a73ebc
* refactor: migrate adapter imports to package exports Replace all relative imports (../../src/registry.js, ../../browser/cdp.js, etc.) with package exports (@jackwener/opencli/registry, @jackwener/opencli/errors, etc.) across all 484 adapter files. This decouples adapter import resolution from directory structure: - User CLIs in ~/.opencli/clis/ resolve via node_modules symlink - Internal adapters resolve via Node.js self-referencing - No more shim files needed for import resolution Changes: - package.json: add sub-path exports for all public modules - clis/**: replace relative imports with @jackwener/opencli/... - discovery.ts: simplify ensureUserCliCompatShims to symlink-only - registry-api.ts: export CommandArgs type - Remove root-level shim directories (browser/, download/, pipeline/) - Remove shim entries from tsconfig.json include and package.json files * test: add regression tests for package exports Prevents regressions like #788/#791 by: 1. Scanning all adapter files for forbidden relative imports (../../src/, ../../browser/, etc.) — fails if any remain 2. Verifying every package.json export maps to an existing source file 18 new test cases. * fix: use junction on Windows + broaden test patterns - discovery.ts: use 'junction' symlink type on Windows (no admin required) - package-exports.test.ts: generalize forbidden patterns to catch any depth of ../ traversal (not just ../../ and ../../../) * fix: update stale vi.mock/importActual paths in adapter tests Test files still used old relative paths for vi.mock() and vi.importActual() calls. Updated 5 test files to use package exports. Also broadened regression test patterns to catch mock/importActual paths. * fix: use rm instead of unlink for symlink cleanup, add warn on failure Addresses review feedback from Astro-Han: - rm() handles both symlinks and stale directories (unlink fails on dirs) - Log a warning when symlink creation fails instead of silent catch * docs: update import examples to use package exports Update all documentation, contributing guides, and skills to use @jackwener/opencli/registry instead of ../../src/registry.js. Without this, users following the docs would write adapters with broken imports since the old shim files are no longer created.
69 lines
2.5 KiB
TypeScript
69 lines
2.5 KiB
TypeScript
import * as fs from 'node:fs/promises';
|
|
import * as os from 'node:os';
|
|
import * as path from 'node:path';
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import { CliError } from '@jackwener/opencli/errors';
|
|
import {
|
|
MAX_PDF_BYTES,
|
|
buildReviewUrl,
|
|
parseYesNo,
|
|
readPdfFile,
|
|
requestJson,
|
|
validateHelpfulness,
|
|
} from './utils.js';
|
|
|
|
describe('paperreview utils', () => {
|
|
beforeEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it('builds review URLs from the token', () => {
|
|
expect(buildReviewUrl('tok 123')).toBe('https://paperreview.ai/review?token=tok%20123');
|
|
});
|
|
|
|
it('parses yes/no flags', () => {
|
|
expect(parseYesNo('yes', 'critical-error')).toBe(true);
|
|
expect(parseYesNo('NO', 'critical-error')).toBe(false);
|
|
});
|
|
|
|
it('rejects invalid yes/no flags with CliError', () => {
|
|
expect(() => parseYesNo('maybe', 'critical-error')).toThrow(CliError);
|
|
expect(() => parseYesNo('maybe', 'critical-error')).toThrow('"critical-error" must be either "yes" or "no".');
|
|
});
|
|
|
|
it('validates helpfulness scores', () => {
|
|
expect(validateHelpfulness(5)).toBe(5);
|
|
expect(() => validateHelpfulness(0)).toThrow(CliError);
|
|
});
|
|
|
|
it('reads a valid PDF file and returns metadata', async () => {
|
|
const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'paperreview-'));
|
|
const pdfPath = path.join(tempDir, 'sample.pdf');
|
|
const pdfBytes = Buffer.concat([Buffer.from('%PDF-1.4\n'), Buffer.alloc(256, 1)]);
|
|
await fs.writeFile(pdfPath, pdfBytes);
|
|
|
|
const result = await readPdfFile(pdfPath);
|
|
|
|
expect(result.fileName).toBe('sample.pdf');
|
|
expect(result.resolvedPath).toBe(pdfPath);
|
|
expect(result.sizeBytes).toBe(pdfBytes.length);
|
|
expect(result.buffer.equals(pdfBytes)).toBe(true);
|
|
});
|
|
|
|
it('rejects PDFs larger than the paperreview.ai size limit', async () => {
|
|
const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'paperreview-'));
|
|
const pdfPath = path.join(tempDir, 'large.pdf');
|
|
await fs.writeFile(pdfPath, Buffer.alloc(MAX_PDF_BYTES + 1, 1));
|
|
|
|
await expect(readPdfFile(pdfPath)).rejects.toThrow(CliError);
|
|
await expect(readPdfFile(pdfPath)).rejects.toThrow('The PDF is larger than paperreview.ai\'s 10MB limit.');
|
|
});
|
|
|
|
it('normalizes fetch failures into CliError', async () => {
|
|
vi.stubGlobal('fetch', vi.fn().mockRejectedValue(new Error('socket hang up')));
|
|
|
|
await expect(requestJson('/api/review/token')).rejects.toThrow(CliError);
|
|
await expect(requestJson('/api/review/token')).rejects.toThrow('Unable to reach paperreview.ai');
|
|
});
|
|
});
|