mirror of
https://github.com/abhigyanpatwari/GitNexus.git
synced 2026-09-09 22:33:39 +00:00
d91428ad9d
* feat(cli): add `gitnexus publish` for opt-in understand-quickly registry Adds a small, opt-in command that fires a single `repository_dispatch` event at `looptech-ai/understand-quickly` to ask the registry for an instant resync of the current repo's entry. No graph file is uploaded; the registry pulls from raw.githubusercontent.com per the protocol at https://github.com/looptech-ai/understand-quickly/blob/main/docs/integrations/protocol.md. - Pure helpers (id parsing, payload construction, validation) live in `gitnexus-shared/src/integrations/understand-quickly.ts` so the package stays Node-free and the same logic is testable in isolation. - The CLI command lives in `gitnexus/src/cli/publish.ts`. Without `UNDERSTAND_QUICKLY_TOKEN` it is a no-op (exits 0 with one informational line); with the token it POSTs the dispatch and surfaces 204 / 401 / 404 / 5xx distinctly. - The id defaults to `<owner>/<repo>` parsed from the `origin` remote and can be overridden with `--id`. - Refuses to publish when no `.gitnexus/` index exists, with a `gitnexus analyze` hint. Tests: a new vitest unit covers the pure helpers (8 + 8 + 2 cases) and the no-token no-op path with a `fetch` spy that fails the test if the network is touched. README gets a one-paragraph "Publishing to understand-quickly" section near the existing CLI docs. * fix(uq-publish): address review blockers + high-severity items Addresses CodeQL polynomial-regex (HIGH), token-gate ordering, distinct 401/403/404/422 response branches, fetch timeout, expanded test coverage, tightened owner/repo validation, and non-GitHub remote rejection. See response thread on PR #1425 for the per-finding rationale. Signed-off-by: amacsmith <alex.mac@looptech.ai> * fix(publish): address Claude review on PR #1425 - AbortError → TimeoutError: AbortSignal.timeout() throws a DOMException with name 'TimeoutError', not Error{name:'AbortError'}. Match the pattern used in core/embeddings/http-client.ts so the user-facing "timed out after 15000ms" message actually fires. Update the regression test to throw a real DOMException — the previous fake was a false-green. - isValidOwnerRepo: forbid trailing hyphen in the owner segment. GitHub rejects this at account-creation time; allowing it here meant hand-typed --id values like 'my-org-/repo' would pass our regex and 422 from GitHub. - Add publish-command coverage to cli-index-help.test.ts (asserts on --id, --skip-git, the registry name, and the token env var) and cli-commands.test.ts (asserts publishCommand is exported as a function). Catches accidental command-registration deletion. --------- Signed-off-by: amacsmith <alex.mac@looptech.ai> Co-authored-by: Gergő Magyar <gergomagyar@icloud.com>
79 lines
3 KiB
TypeScript
79 lines
3 KiB
TypeScript
import { spawnSync } from 'node:child_process';
|
|
import path from 'node:path';
|
|
import { fileURLToPath } from 'node:url';
|
|
import { describe, expect, it } from 'vitest';
|
|
|
|
const testDir = path.dirname(fileURLToPath(import.meta.url));
|
|
const repoRoot = path.resolve(testDir, '../..');
|
|
const cliEntry = path.join(repoRoot, 'src/cli/index.ts');
|
|
|
|
function runHelp(command: string) {
|
|
return spawnSync(process.execPath, ['--import', 'tsx', cliEntry, command, '--help'], {
|
|
cwd: repoRoot,
|
|
encoding: 'utf8',
|
|
});
|
|
}
|
|
|
|
describe('CLI help surface', () => {
|
|
it('query help keeps advanced search options without importing analyze deps', () => {
|
|
const result = runHelp('query');
|
|
|
|
expect(result.status).toBe(0);
|
|
expect(result.stdout).toContain('--context <text>');
|
|
expect(result.stdout).toContain('--goal <text>');
|
|
expect(result.stdout).toContain('--content');
|
|
expect(result.stderr).not.toContain('tree-sitter-kotlin');
|
|
});
|
|
|
|
it('context help keeps optional name and disambiguation flags', () => {
|
|
const result = runHelp('context');
|
|
|
|
expect(result.status).toBe(0);
|
|
expect(result.stdout).toContain('context [options] [name]');
|
|
expect(result.stdout).toContain('--uid <uid>');
|
|
expect(result.stdout).toContain('--file <path>');
|
|
});
|
|
|
|
it('impact help keeps repo and include-tests flags', () => {
|
|
const result = runHelp('impact');
|
|
|
|
expect(result.status).toBe(0);
|
|
expect(result.stdout).toContain('--depth <n>');
|
|
expect(result.stdout).toContain('--include-tests');
|
|
expect(result.stdout).toContain('--repo <name>');
|
|
});
|
|
|
|
it('detect-changes help exposes compare scope and base-ref flags', () => {
|
|
const result = runHelp('detect-changes');
|
|
|
|
expect(result.status).toBe(0);
|
|
expect(result.stdout).toContain('gitnexus detect-changes|detect_changes [options]');
|
|
expect(result.stdout).toContain('--scope <scope>');
|
|
expect(result.stdout).toContain('--base-ref <ref>');
|
|
expect(result.stdout).toContain('--repo <name>');
|
|
});
|
|
|
|
it('wiki help shows provider, review, and verbose flags', () => {
|
|
const result = runHelp('wiki');
|
|
|
|
expect(result.status).toBe(0);
|
|
expect(result.stdout).toContain('--provider <provider>');
|
|
expect(result.stdout).toContain('--review');
|
|
expect(result.stdout).toContain('-v, --verbose');
|
|
expect(result.stdout).toContain('--model <model>');
|
|
expect(result.stdout).toContain('--gist');
|
|
});
|
|
|
|
it('publish help names the registry, the token env var, and the opt-out behaviour', () => {
|
|
const result = runHelp('publish');
|
|
|
|
expect(result.status).toBe(0);
|
|
expect(result.stdout).toContain('--id <owner/repo>');
|
|
expect(result.stdout).toContain('--skip-git');
|
|
// Discoverability contract: a contributor scanning `--help` must see
|
|
// (a) which registry this dispatches to, and (b) the env var that
|
|
// gates the opt-in. Both are part of the no-token contract.
|
|
expect(result.stdout).toContain('understand-quickly');
|
|
expect(result.stdout).toContain('UNDERSTAND_QUICKLY_TOKEN');
|
|
});
|
|
});
|