Files
jackwener__opencli/clis/gemini/deep-research.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

125 lines
5.1 KiB
TypeScript

import { cli, Strategy } from '@jackwener/opencli/registry';
import type { IPage } from '@jackwener/opencli/types';
import {
GEMINI_DEEP_RESEARCH_DEFAULT_CONFIRM_LABELS,
GEMINI_DEEP_RESEARCH_DEFAULT_TOOL_LABELS,
GEMINI_APP_URL,
GEMINI_DOMAIN,
getCurrentGeminiUrl,
getLatestGeminiAssistantResponse,
parseGeminiPositiveInt,
readGeminiSnapshot,
resolveGeminiLabels,
selectGeminiTool,
sendGeminiMessage,
startNewGeminiChat,
waitForGeminiSubmission,
waitForGeminiConfirmButton,
} from './utils.js';
function isGeminiRootAppUrl(url: string): boolean {
try {
const parsed = new URL(url);
return parsed.origin + parsed.pathname.replace(/\/+$/, '') === GEMINI_APP_URL;
} catch {
return false;
}
}
function parseDeepResearchProgress(text: string): { isResearching: boolean; waitingForStart: boolean } {
const isResearching = /\bresearching(?:\s+websites?)?\b|research in progress|working on your research|正在研究|研究中/i.test(text);
const waitingForStart = /\bstart(?:\s+deep)?\s+research\b|begin\s+research|generate(?:\s+deep)?\s+research\s+plan|开始研究|开始深度研究|开始调研|生成研究计划|生成调研计划|try again without deep research/i.test(text);
return { isResearching, waitingForStart };
}
export const deepResearchCommand = cli({
site: 'gemini',
name: 'deep-research',
description: 'Start a Gemini Deep Research run and confirm it',
domain: GEMINI_DOMAIN,
strategy: Strategy.COOKIE,
browser: true,
navigateBefore: false,
defaultFormat: 'plain',
timeoutSeconds: 180,
args: [
{ name: 'prompt', positional: true, required: true, help: 'Prompt to send' },
{ name: 'timeout', type: 'int', required: false, help: 'Max seconds to wait for confirm (default: 30)', default: 30 },
{ name: 'tool', required: false, help: 'Override tool label (default: Deep Research)' },
{ name: 'confirm', required: false, help: 'Override confirm button label (default: Start research)' },
],
columns: ['status', 'url'],
func: async (page: IPage, kwargs: any) => {
const prompt = kwargs.prompt as string;
const timeout = parseGeminiPositiveInt(kwargs.timeout, 30);
const submitTimeout = Math.min(Math.max(timeout, 6), 20);
await startNewGeminiChat(page);
const toolLabels = resolveGeminiLabels(kwargs.tool, GEMINI_DEEP_RESEARCH_DEFAULT_TOOL_LABELS);
const confirmLabels = resolveGeminiLabels(kwargs.confirm, GEMINI_DEEP_RESEARCH_DEFAULT_CONFIRM_LABELS);
const toolMatched = await selectGeminiTool(page, toolLabels);
if (!toolMatched) {
const url = await getCurrentGeminiUrl(page);
return [{ status: 'tool-not-found', url }];
}
let baseline = await readGeminiSnapshot(page);
await sendGeminiMessage(page, prompt);
let submitted = await waitForGeminiSubmission(page, baseline, submitTimeout);
if (!submitted) {
// Retry once when submit did not stick (e.g. composer swallowed Enter/click in this UI state).
await selectGeminiTool(page, toolLabels);
baseline = await readGeminiSnapshot(page);
await sendGeminiMessage(page, prompt);
submitted = await waitForGeminiSubmission(page, baseline, submitTimeout);
}
if (!submitted) {
const url = await getCurrentGeminiUrl(page);
return [{ status: 'submit-not-found', url }];
}
const confirmed = await waitForGeminiConfirmButton(page, confirmLabels, timeout);
let url = await getCurrentGeminiUrl(page);
if (confirmed && !isGeminiRootAppUrl(url)) {
return [{ status: 'started', url }];
}
// false-positive confirm click can happen on generic buttons while still at /app root.
{
// Retry once when we are still at the root app URL, which usually means submit did not stick.
if (isGeminiRootAppUrl(url)) {
await selectGeminiTool(page, toolLabels);
// Avoid resending prompt here: it can create a duplicate conversation thread.
const confirmedRetry = await waitForGeminiConfirmButton(page, confirmLabels, timeout);
url = await getCurrentGeminiUrl(page);
if (confirmedRetry && !isGeminiRootAppUrl(url)) {
return [{ status: 'started', url }];
}
}
let response = await getLatestGeminiAssistantResponse(page);
let { isResearching, waitingForStart } = parseDeepResearchProgress(response);
// Some UIs render the plan card first; click confirm one more time without resending prompt.
if (!isResearching && waitingForStart) {
const fallbackConfirmLabels = Array.from(new Set([
...confirmLabels,
...GEMINI_DEEP_RESEARCH_DEFAULT_CONFIRM_LABELS,
]));
const confirmedFallback = await waitForGeminiConfirmButton(page, fallbackConfirmLabels, Math.min(timeout, 8));
if (confirmedFallback) {
url = await getCurrentGeminiUrl(page);
response = await getLatestGeminiAssistantResponse(page);
({ isResearching, waitingForStart } = parseDeepResearchProgress(response));
}
}
if (isResearching && !waitingForStart) {
return [{ status: 'started', url }];
}
return [{ status: 'confirm-not-found', url }];
}
},
});