Files
jackwener__opencli/clis/imdb/utils.test.ts
jakevin 4fe9a73ebc refactor: migrate adapter imports to package exports (#795)
* 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.
2026-04-05 16:02:17 +08:00

118 lines
4.2 KiB
TypeScript

import { describe, expect, it, vi } from 'vitest';
import type { IPage } from '@jackwener/opencli/types';
import {
extractJsonLd,
forceEnglishUrl,
formatDuration,
getCurrentImdbId,
isChallengePage,
normalizeImdbTitleType,
normalizeImdbId,
waitForImdbPath,
waitForImdbReviewsReady,
waitForImdbSearchReady,
} from './utils.js';
describe('normalizeImdbId', () => {
it('passes through bare ids', () => {
expect(normalizeImdbId('tt1375666', 'tt')).toBe('tt1375666');
expect(normalizeImdbId('nm0634240', 'nm')).toBe('nm0634240');
});
it('extracts ids from supported urls', () => {
expect(normalizeImdbId('https://www.imdb.com/title/tt1375666/', 'tt')).toBe('tt1375666');
expect(normalizeImdbId('https://m.imdb.com/title/tt1375666/', 'tt')).toBe('tt1375666');
expect(normalizeImdbId('https://www.imdb.com/de/title/tt1375666/?ref_=nv_sr_srsg_0', 'tt')).toBe('tt1375666');
expect(normalizeImdbId('https://www.imdb.com/name/nm0634240/', 'nm')).toBe('nm0634240');
});
it('throws on invalid or mismatched ids', () => {
expect(() => normalizeImdbId('invalid', 'tt')).toThrow('Invalid IMDb ID');
expect(() => normalizeImdbId('tt1', 'tt')).toThrow('Invalid IMDb ID');
expect(() => normalizeImdbId('nm0634240', 'tt')).toThrow('Invalid IMDb ID');
});
});
describe('formatDuration', () => {
it('converts ISO-8601 durations to a short human format', () => {
expect(formatDuration('PT2H28M')).toBe('2h 28m');
expect(formatDuration('PT1H')).toBe('1h');
expect(formatDuration('PT45M')).toBe('45m');
expect(formatDuration('PT2H')).toBe('2h');
});
it('returns an empty string for invalid input', () => {
expect(formatDuration('')).toBe('');
expect(formatDuration('invalid')).toBe('');
});
});
describe('forceEnglishUrl', () => {
it('adds the English language parameter', () => {
expect(forceEnglishUrl('https://www.imdb.com/title/tt1375666/')).toContain('language=en-US');
});
it('preserves existing query parameters', () => {
const result = forceEnglishUrl('https://www.imdb.com/title/tt1375666/?ref_=nv');
expect(result).toContain('language=en-US');
expect(result).toContain('ref_=nv');
});
});
describe('normalizeImdbTitleType', () => {
it('maps internal imdb ids to readable labels', () => {
expect(normalizeImdbTitleType({ id: 'movie', text: '' })).toBe('Movie');
expect(normalizeImdbTitleType({ id: 'tvSeries', text: '' })).toBe('TV Series');
expect(normalizeImdbTitleType('short')).toBe('Short');
});
it('preserves explicit text labels', () => {
expect(normalizeImdbTitleType({ id: 'movie', text: 'Feature Film' })).toBe('Feature Film');
});
});
describe('extractJsonLd', () => {
it('returns the evaluated JSON-LD payload', async () => {
const page = {
evaluate: vi.fn().mockResolvedValue({ '@type': 'Movie', name: 'Inception' }),
} as unknown as IPage;
await expect(extractJsonLd(page, 'Movie')).resolves.toEqual({ '@type': 'Movie', name: 'Inception' });
expect(page.evaluate).toHaveBeenCalledTimes(1);
expect(page.evaluate).toHaveBeenCalledWith(expect.stringContaining('"Movie"'));
});
});
describe('isChallengePage', () => {
it('returns true when the page evaluation matches a challenge', async () => {
const page = {
evaluate: vi.fn().mockResolvedValue(true),
} as unknown as IPage;
await expect(isChallengePage(page)).resolves.toBe(true);
expect(page.evaluate).toHaveBeenCalledTimes(1);
});
});
describe('imdb browser helpers', () => {
it('reads the current imdb id from page metadata', async () => {
const page = {
evaluate: vi.fn().mockResolvedValue('nm0634240'),
} as unknown as IPage;
await expect(getCurrentImdbId(page, 'nm')).resolves.toBe('nm0634240');
expect(page.evaluate).toHaveBeenCalledTimes(1);
});
it('wait helpers resolve mocked readiness booleans', async () => {
const page = {
evaluate: vi.fn().mockResolvedValue(true),
} as unknown as IPage;
await expect(waitForImdbPath(page, '^/find/?$')).resolves.toBe(true);
await expect(waitForImdbSearchReady(page)).resolves.toBe(true);
await expect(waitForImdbReviewsReady(page)).resolves.toBe(true);
expect(page.evaluate).toHaveBeenCalledTimes(3);
});
});