Files
jackwener__opencli/clis/twitter/reply.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

178 lines
6.6 KiB
TypeScript

import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
import { describe, expect, it, vi } from 'vitest';
import { getRegistry } from '@jackwener/opencli/registry';
import type { IPage } from '@jackwener/opencli/types';
import { __test__ } from './reply.js';
function createPageMock(evaluateResults: any[], overrides: Partial<IPage> = {}): IPage {
const evaluate = vi.fn();
for (const result of evaluateResults) {
evaluate.mockResolvedValueOnce(result);
}
return {
goto: vi.fn().mockResolvedValue(undefined),
evaluate,
snapshot: vi.fn().mockResolvedValue(undefined),
click: vi.fn().mockResolvedValue(undefined),
typeText: vi.fn().mockResolvedValue(undefined),
pressKey: vi.fn().mockResolvedValue(undefined),
scrollTo: vi.fn().mockResolvedValue(undefined),
getFormState: vi.fn().mockResolvedValue({ forms: [], orphanFields: [] }),
wait: vi.fn().mockResolvedValue(undefined),
tabs: vi.fn().mockResolvedValue([]),
selectTab: vi.fn().mockResolvedValue(undefined),
networkRequests: vi.fn().mockResolvedValue([]),
consoleMessages: vi.fn().mockResolvedValue([]),
scroll: vi.fn().mockResolvedValue(undefined),
autoScroll: vi.fn().mockResolvedValue(undefined),
installInterceptor: vi.fn().mockResolvedValue(undefined),
getInterceptedRequests: vi.fn().mockResolvedValue([]),
getCookies: vi.fn().mockResolvedValue([]),
screenshot: vi.fn().mockResolvedValue(''),
waitForCapture: vi.fn().mockResolvedValue(undefined),
...overrides,
};
}
describe('twitter reply command', () => {
it('keeps the text-only reply flow working', async () => {
const cmd = getRegistry().get('twitter/reply');
expect(cmd?.func).toBeTypeOf('function');
const page = createPageMock([
{ ok: true, message: 'Reply posted successfully.' },
]);
const result = await cmd!.func!(page, {
url: 'https://x.com/_kop6/status/2040254679301718161?s=20',
text: 'text-only reply',
});
expect(page.goto).toHaveBeenCalledWith('https://x.com/_kop6/status/2040254679301718161?s=20');
expect(page.wait).toHaveBeenCalledWith({ selector: '[data-testid="primaryColumn"]' });
expect(result).toEqual([
{
status: 'success',
message: 'Reply posted successfully.',
text: 'text-only reply',
},
]);
});
it('uploads a local image through the dedicated reply composer when --image is provided', async () => {
const cmd = getRegistry().get('twitter/reply');
expect(cmd?.func).toBeTypeOf('function');
const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'opencli-twitter-reply-'));
const imagePath = path.join(tempDir, 'qr.png');
fs.writeFileSync(imagePath, Buffer.from([0x89, 0x50, 0x4e, 0x47]));
const setFileInput = vi.fn().mockResolvedValue(undefined);
const page = createPageMock([
{ ok: true, previewCount: 1 },
{ ok: true, message: 'Reply posted successfully.' },
], {
setFileInput,
});
const result = await cmd!.func!(page, {
url: 'https://x.com/_kop6/status/2040254679301718161?s=20',
text: 'reply with image',
image: imagePath,
});
expect(page.goto).toHaveBeenCalledWith('https://x.com/compose/post?in_reply_to=2040254679301718161');
expect(page.wait).toHaveBeenNthCalledWith(1, { selector: '[data-testid="tweetTextarea_0"]' });
expect(page.wait).toHaveBeenNthCalledWith(2, { selector: 'input[type="file"][data-testid="fileInput"]', timeout: 20 });
expect(setFileInput).toHaveBeenCalledWith([imagePath], 'input[type="file"][data-testid="fileInput"]');
expect(result).toEqual([
{
status: 'success',
message: 'Reply posted successfully.',
text: 'reply with image',
image: imagePath,
},
]);
});
it('downloads a remote image before uploading when --image-url is provided', async () => {
const cmd = getRegistry().get('twitter/reply');
expect(cmd?.func).toBeTypeOf('function');
const fetchMock = vi.fn().mockResolvedValue({
ok: true,
headers: {
get: vi.fn().mockReturnValue('image/png'),
},
arrayBuffer: vi.fn().mockResolvedValue(Uint8Array.from([0x89, 0x50, 0x4e, 0x47]).buffer),
});
vi.stubGlobal('fetch', fetchMock);
const setFileInput = vi.fn().mockResolvedValue(undefined);
const page = createPageMock([
{ ok: true, previewCount: 1 },
{ ok: true, message: 'Reply posted successfully.' },
], {
setFileInput,
});
const result = await cmd!.func!(page, {
url: 'https://x.com/_kop6/status/2040254679301718161?s=20',
text: 'reply with remote image',
'image-url': 'https://example.com/qr',
});
expect(fetchMock).toHaveBeenCalledWith('https://example.com/qr');
expect(setFileInput).toHaveBeenCalledTimes(1);
const uploadedPath = setFileInput.mock.calls[0][0][0];
expect(uploadedPath).toMatch(/opencli-twitter-reply-.*\/image\.png$/);
expect(fs.existsSync(uploadedPath)).toBe(false);
expect(result).toEqual([
{
status: 'success',
message: 'Reply posted successfully.',
text: 'reply with remote image',
'image-url': 'https://example.com/qr',
},
]);
vi.unstubAllGlobals();
});
it('rejects invalid image paths early', async () => {
await expect(() => __test__.resolveImagePath('/tmp/does-not-exist.png'))
.toThrow('Image file not found');
});
it('rejects using --image and --image-url together', async () => {
const cmd = getRegistry().get('twitter/reply');
expect(cmd?.func).toBeTypeOf('function');
const page = createPageMock([]);
await expect(cmd!.func!(page, {
url: 'https://x.com/_kop6/status/2040254679301718161?s=20',
text: 'nope',
image: '/tmp/a.png',
'image-url': 'https://example.com/a.png',
})).rejects.toThrow('Use either --image or --image-url, not both.');
});
it('extracts tweet ids from both user and i/status URLs', () => {
expect(__test__.extractTweetId('https://x.com/_kop6/status/2040254679301718161?s=20')).toBe('2040254679301718161');
expect(__test__.extractTweetId('https://x.com/i/status/2040318731105313143')).toBe('2040318731105313143');
expect(__test__.buildReplyComposerUrl('https://x.com/i/status/2040318731105313143'))
.toBe('https://x.com/compose/post?in_reply_to=2040318731105313143');
});
it('prefers content-type when resolving remote image extensions', () => {
expect(__test__.resolveImageExtension('https://example.com/no-ext', 'image/webp')).toBe('.webp');
expect(__test__.resolveImageExtension('https://example.com/a.jpeg?x=1', null)).toBe('.jpeg');
});
});