mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-07-31 04:12:10 +03:00
feat(discovery): Phase 2 — reporter, /api/discovery/* routes (strict loopback-only) + dashboard UI (#5939)
* feat(discovery): Phase 2 reporter — discoveryResults DB module + service wiring
Adds src/lib/db/discoveryResults.ts (CRUD over the discovery_results table
from migration 074) and wires the opt-in discovery service to persist and read
findings through it: persistDiscoveryResult / getDiscoveryResults /
getDiscoveryResultById / markVerified / deleteDiscoveryResult, with
(provider, method, endpoint) upsert de-duplication. Re-exported from localDb.
The service stays opt-in / default-off. The /api/discovery/* routes and the
dashboard UI tab are intentionally deferred to Phase 2b — they need the
local-only enforcement model (Hard Rules #15/#17 territory) decided first.
TDD: tests/unit/db/discovery-results.test.ts (8 cases, DB + service delegation),
isolated DATA_DIR with resetDbInstance cleanup.
* feat(discovery): Phase 2b — /api/discovery/* routes (strict loopback-only)
Adds the discovery HTTP surface on top of the reporter DB module:
GET /api/discovery/results list findings (optional ?providerId)
GET /api/discovery/results/:id one finding (404 if absent)
DELETE /api/discovery/results/:id delete a finding
POST /api/discovery/scan scan a provider + persist findings
POST /api/discovery/verify/:id mark a finding verified
Authorization: strict loopback-only. "/api/discovery/" is added to
LOCAL_ONLY_API_PREFIXES so the central authz pipeline (proxy.ts →
runAuthzPipeline → managementPolicy) rejects non-loopback callers with a 403
LOCAL_ONLY before any handler runs. It is deliberately NOT in
LOCAL_ONLY_MANAGE_SCOPE_BYPASS_PREFIXES — no remote manage-scope bypass —
because POST /scan issues outbound probes to provider endpoints (SSRF-adjacent)
and must never be tunnel-reachable. Handlers also call requireManagementAuth
(defense in depth) and return sanitized errors via createErrorResponse.
Tests:
- tests/unit/authz/discovery-routes-local-only.test.ts (8) — security guard:
isLocalOnlyPath true + not manage-scope-bypassable for all four paths.
- tests/unit/api/discovery-routes.test.ts (6) — handler integration over an
isolated DATA_DIR: list/filter, by-id 200/404/400, scan persist + 400 on
empty/malformed body, verify 200/404, delete 200/404, no stack-trace leak.
* feat(discovery): Phase 2c — dashboard UI tab (Tools → Discovery)
Adds the /dashboard/discovery page (DiscoveryPageClient) that consumes the
Phase 2b /api/discovery/* routes: scan a provider, list findings, verify or
delete them. Registered in the sidebar under the Tools group (icon
travel_explore) and given a "discovery" i18n namespace + sidebar keys in
en.json (other locales fall back to en via next-intl until synced — the
locale files are in a pre-existing coverage deficit unrelated to this change).
Registers the UI test path in vitest.config.ts (advisory ui suite).
Tests: src/app/(dashboard)/dashboard/discovery/__tests__/DiscoveryPageClient.test.tsx
(3 cases: loads+renders results, empty state, fetches /api/discovery/results on
mount; stable useTranslations mock to avoid the fetch-loop). NOTE: the ui vitest
suite cannot run in this workspace — @testing-library/dom (a @testing-library/
react peer dep) is absent from node_modules, which fails ALL existing ui tests
equally; the test runs in CI. Component verified locally via typecheck + lint.
* test(discovery): register discovery-routes-local-only in stryker tap.testFiles
The mutation-test-coverage gate (--strict) flags any unit test covering a
mutated module that isn't listed in stryker.conf.json tap.testFiles. This PR's
tests/unit/authz/discovery-routes-local-only.test.ts covers src/server/authz/
routeGuard.ts (a mutated module, which this PR edits by adding the
/api/discovery/ local-only prefix), so it must be registered for its mutant
kills to count. No behavior change.
* refactor(discovery): split DiscoveryPageClient to satisfy max-lines-per-function
The complexity ratchet (max-lines-per-function: 80) flagged the single
184-line DiscoveryPageClient function (+1 over baseline). Extract the data
layer into two hooks (useDiscoveryResults for list/loading/feedback,
useDiscoveryActions for scan/verify/delete), a shared callApi helper, and two
presentational sub-components (DiscoveryScanForm, DiscoveryResultCard). Every
function is now under the 80-line ceiling; complexity gate back to baseline
1995. No behavior change — same exported component, same endpoints, same props.
* test(sidebar): include discovery in omni-proxy item-order snapshot
Adding the Discovery item to the Tools group (this PR's sidebar entry) extends
the ordered omni-proxy section list. Update the exact-match deepEqual snapshot
in sidebar-visibility.test.ts to include "discovery" in its position (after
traffic-inspector). The assertion stays exact — this reflects the intentional
new item, it does not weaken the check.
* docs(changelog): restore release bullets eaten by merge auto-resolve; re-add discovery bullet additively
* chore(quality): bump testFrozen for translator-openai-responses-req.test.ts (1097 -> 1172)
Base-red inherited from #5933, which grew the test file to 1171 lines
(Hard Rule #18 regression tests) without adjusting the frozen cap. The
release tip itself fails check:file-size; this unblocks every PR into
release/v3.8.44. File untouched by this PR.
* chore(quality): restore stryker tap.testFiles entries eaten by merge auto-resolve
The merge of origin/release/v3.8.44 silently dropped the 3 entries added
on the release side (#5903, clinepass, #5923). Took the release version
verbatim and re-added only this PR's entry (discovery-routes-local-only)
in alphabetical order. check:mutation-test-coverage green locally.
* chore(quality): reconcile inherited v3.8.44 merge-burst drift + include discovery in tools-group order test
- complexity 1995->2003 and cognitive 856->859: both measure IDENTICAL on
the pristine release tip (3a3d618fe) and this PR's merged HEAD — the PR
is complexity-net-zero; drift is from the 2026-07-02 merge burst
(notes added to both baselines, same family as prior reconciliations).
- sidebar-tools-group.test.ts: append 'discovery' to the expected
TOOLS_GROUP order — the intentional new sidebar item this PR adds
(same expected-value update already made in sidebar-visibility.test.ts).
This commit is contained in:
committed by
GitHub
parent
9e5d2d1480
commit
0965c54245
@@ -9,6 +9,7 @@
|
||||
### ✨ New Features
|
||||
|
||||
- **feat(api):** add `/v1/ocr` endpoint (Mistral OCR), an OCR provider category, and Mistral moderation support. (thanks @waguriagentic)
|
||||
- **Discovery tool (Phase 2):** add the `discoveryResults` DB module (CRUD over the `discovery_results` table, migration 074) and wire the opt-in provider-discovery service to persist and read findings through it (`persistDiscoveryResult`, `getDiscoveryResults`, `getDiscoveryResultById`, `markVerified`, `deleteDiscoveryResult`) with `(provider, method, endpoint)` upsert de-duplication. Adds the `/api/discovery/*` HTTP surface — `GET /results`, `GET|DELETE /results/:id`, `POST /scan`, `POST /verify/:id` — under **strict loopback-only** authorization (`/api/discovery/` is in `LOCAL_ONLY_API_PREFIXES` and is NOT manage-scope-bypassable, so the `scan` route's outbound probes can never be reached from a tunnel/remote origin). Adds a **dashboard UI tab** (Tools → Discovery, `/dashboard/discovery`) to run scans and review, verify, or delete findings. The service stays **opt-in / default-off**.
|
||||
|
||||
### 🔧 Bug Fixes
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
{
|
||||
"_comment": "Catraca de complexidade (check-complexity.mjs, ESLint core rules complexity>=15 e max-lines-per-function>80 sobre src+open-sse+electron+bin via eslint.complexity.config.mjs). Conta total de violacoes; so pode cair. --update ratcheta.",
|
||||
"count": 1995,
|
||||
"count": 2003,
|
||||
"_rebaseline_2026_07_02_v3844_merge_burst": "1995->2003 (+8). Inherited v3.8.44 cycle drift surfaced by PR #5939: check:complexity measures 2003 on BOTH the pristine release tip (3a3d618fe) and this PR's merged HEAD — identical, so all +8 came from the 2026-07-02 merge burst into release/v3.8.44 (#5933 codex schema, #5950 OCR, #5904/#5920 combo, #6000/#6008 executor refactors, etc.) merged while the fast-gates queue was base-red (file-size #5933). PR #5939 itself was verified complexity-net-zero during its own CI cycle (DiscoveryPageClient refactored into hooks/sub-components to stay under max-lines-per-function). Tighten via --update next cycle.",
|
||||
"_rebaseline_2026_07_02_5798_release_green": "1982->1995 (+13). Inherited v3.8.43 cycle drift surfaced by the release-green unblock #5798 / PR #5896: check:complexity measures 1995 on BOTH the pristine release tip (0d3875a98) and this PR's HEAD — identical, so all +13 came from the 2026-07-01/02 merge burst (providers/usage/dashboard fixes merged via --admin while the fast-gates queue was base-red). This PR touches only gate scripts, docs, baselines and test files — 0 production logic. Tighten via --update next cycle.",
|
||||
"_rebaseline_2026_07_01_v3843_release": "1981->1982 (+1). v3.8.43 cycle drift, surfaced after check:mutation-test-coverage was fixed (it was masked behind that earlier step in the Fast Quality Gates chain). 1982 = the value measured by check:complexity on BOTH fce85136c (release tip) and 6d7060e21 (release + the 5 CI fixes) — identical, so all +1 is inherited cycle drift; the fixes touch only test files + linkify.ts safeHttpHref (cyclomatic ~4, well under the >=15 threshold, 0 new violations) + config JSON. Tighten via --update next cycle.",
|
||||
"_rebaseline_2026_06_28_v3840_5237_reconcile": "1980->1981 (+1). Inherited release/v3.8.40 drift surfaced while merging PR #5237 (impersonation-UA refresh) — the +1 is present on the pristine release tip (d8a392a47) WITHOUT #5237's changes, so it is #5222 (antigravity fallback-LRU retry) / #5221 (command-code) growth that merged via --admin without ratcheting complexity (the PR->release fast-gates do not run check:complexity). #5237 itself is complexity-net-zero: its only edits are a single UA constant, a regenerated golden snapshot, and baseline JSONs. Structural reduction tracked in #3501.",
|
||||
|
||||
@@ -315,7 +315,7 @@
|
||||
"tests/unit/usage-service-hardening.test.ts": 1633,
|
||||
"tests/unit/vscode-token-routes.test.ts": 1212,
|
||||
"tests/unit/combo-config.test.ts": 881,
|
||||
"_rebaseline_2026_07_02_5928_base_red": "web-cookie-providers-new.test.ts 845->850: #5928 (test(security) Kimi Web URL host parse, CodeQL #689) grew the file +5 lines and merged into release/v3.8.44 WITHOUT rebaselining, leaving a fast-gates base-red that blocked every subsequent PR->release. Test growth is legitimate (a security regression test); maintainer absorbs the drift here. Frozen at 850.",
|
||||
"_rebaseline_2026_07_02_5928_base_red": "web-cookie-providers-new.test.ts 845->850: #5928 (test(security) Kimi Web URL host parse, CodeQL #689) grew the file +5 lines and merged into release/v3.8.44 WITHOUT rebaselining, leaving a fast-gates base-red that blocked every subsequent PR->release. Test growth is legitimate (a security regression test); maintainer absorbs the drift here. Frozen at 850.",
|
||||
"tests/unit/web-cookie-providers-new.test.ts": 850,
|
||||
"tests/unit/response-sanitizer.test.ts": 906
|
||||
},
|
||||
|
||||
@@ -114,7 +114,8 @@
|
||||
"_rebaseline_2026_06_26_v3837_release": "343->345. v3.8.37 cycle drift surfaced by the release-green pre-flight (the Quality Ratchet does NOT run on PR->release fast-gates, so warnings/complexity accrued unmeasured across this cycle's 76 commits — provider adds DGrid/Pioneer/xAI, headroom proxy lifecycle #4649, ~50 SSE/translator fixes, Engine Combos #5062). Trust-but-verify: this release-finalize working tree touches ONLY CHANGELOG.md, docs/i18n/*/CHANGELOG.md mirrors, and these baselines — 0 production-code change, so all drift is inherited cycle drift (`any` warn-allowed in open-sse/ + tests/). Tighten via --require-tighten next cycle."
|
||||
},
|
||||
"cognitiveComplexity": {
|
||||
"value": 856,
|
||||
"value": 859,
|
||||
"_rebaseline_2026_07_02_v3844_merge_burst": "856->859 (+3). Inherited v3.8.44 cycle drift surfaced by PR #5939: check:cognitive-complexity measures 859 on BOTH the pristine release tip (3a3d618fe) and this PR's merged HEAD — identical, so the PR is cognitive-net-zero (its DiscoveryPageClient was refactored into hooks/sub-components during its own CI cycle). Drift from the 2026-07-02 merge burst into release/v3.8.44. Tighten via --update next cycle.",
|
||||
"_rebaseline_2026_07_02_5798_release_green": "845->856 (+11). Inherited v3.8.43 cycle drift surfaced by the release-green unblock #5798 / PR #5896: check:cognitive-complexity measures 856 on BOTH the pristine release tip (0d3875a98) and this PR's HEAD — identical, so the PR is cognitive-net-zero (it touches only gate scripts, docs, baselines and test files). Drift from the 2026-07-01/02 merge burst. Tighten via --update next cycle.",
|
||||
"direction": "down",
|
||||
"_rebaseline_2026_07_01_v3843_release": "842->845 (+3). v3.8.43 cycle drift, surfaced after check:mutation-test-coverage was fixed (masked behind it in the Fast Quality Gates chain). 845 = measured by check:cognitive-complexity on BOTH fce85136c and 6d7060e21 (identical) — all +3 is inherited cycle drift; the 5 CI fixes add 0 (safeHttpHref cognitive ~2, under the 15 threshold). Tighten via --update next cycle.",
|
||||
|
||||
329
src/app/(dashboard)/dashboard/discovery/DiscoveryPageClient.tsx
Normal file
329
src/app/(dashboard)/dashboard/discovery/DiscoveryPageClient.tsx
Normal file
@@ -0,0 +1,329 @@
|
||||
"use client";
|
||||
|
||||
import { useCallback, useEffect, useState } from "react";
|
||||
import { useTranslations } from "next-intl";
|
||||
import { Card, Button, Input, Badge, EmptyState, Spinner, ConfirmModal } from "@/shared/components";
|
||||
|
||||
interface DiscoveryResult {
|
||||
id: number;
|
||||
providerId: string;
|
||||
method: string;
|
||||
endpoint?: string | null;
|
||||
authType: string;
|
||||
models?: string[];
|
||||
rateLimit?: string | null;
|
||||
feasibility: number;
|
||||
riskLevel: string;
|
||||
status: string;
|
||||
notes?: string | null;
|
||||
discoveredAt?: string;
|
||||
verifiedAt?: string | null;
|
||||
}
|
||||
|
||||
type Feedback = { type: "success" | "error"; message: string } | null;
|
||||
type Translate = ReturnType<typeof useTranslations>;
|
||||
|
||||
type BadgeVariant = "default" | "success" | "warning" | "error";
|
||||
|
||||
const RISK_VARIANT: Record<string, BadgeVariant> = {
|
||||
none: "success",
|
||||
low: "success",
|
||||
medium: "warning",
|
||||
high: "error",
|
||||
critical: "error",
|
||||
};
|
||||
|
||||
const STATUS_VARIANT: Record<string, BadgeVariant> = {
|
||||
verified: "success",
|
||||
testing: "warning",
|
||||
pending: "default",
|
||||
rejected: "error",
|
||||
};
|
||||
|
||||
/** Run a fetch, surface a localized error via `setFeedback`, and report success. */
|
||||
async function callApi(
|
||||
fn: () => Promise<Response>,
|
||||
t: Translate,
|
||||
failKey: string,
|
||||
setFeedback: (f: Feedback) => void
|
||||
): Promise<boolean> {
|
||||
setFeedback(null);
|
||||
try {
|
||||
const res = await fn();
|
||||
const data = await res.json().catch(() => ({}));
|
||||
if (!res.ok) throw new Error(data?.error?.message || t(failKey));
|
||||
return true;
|
||||
} catch (err) {
|
||||
setFeedback({ type: "error", message: err instanceof Error ? err.message : t(failKey) });
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/** Results list + loading + feedback state, plus the reload function. */
|
||||
function useDiscoveryResults(t: Translate) {
|
||||
const [results, setResults] = useState<DiscoveryResult[]>([]);
|
||||
const [loading, setLoading] = useState(true);
|
||||
const [feedback, setFeedback] = useState<Feedback>(null);
|
||||
|
||||
const load = useCallback(async () => {
|
||||
setLoading(true);
|
||||
try {
|
||||
const res = await fetch("/api/discovery/results");
|
||||
const data = await res.json().catch(() => ({}));
|
||||
if (!res.ok) throw new Error(data?.error?.message || t("loadFailed"));
|
||||
setResults(Array.isArray(data.results) ? data.results : []);
|
||||
} catch (err) {
|
||||
setFeedback({ type: "error", message: err instanceof Error ? err.message : t("loadFailed") });
|
||||
} finally {
|
||||
setLoading(false);
|
||||
}
|
||||
}, [t]);
|
||||
|
||||
useEffect(() => {
|
||||
void load();
|
||||
}, [load]);
|
||||
|
||||
return { results, loading, feedback, setFeedback, load };
|
||||
}
|
||||
|
||||
/** Scan / verify / delete actions and their transient state. */
|
||||
function useDiscoveryActions(
|
||||
t: Translate,
|
||||
load: () => Promise<void>,
|
||||
setFeedback: (f: Feedback) => void
|
||||
) {
|
||||
const [scanTarget, setScanTarget] = useState("");
|
||||
const [scanning, setScanning] = useState(false);
|
||||
const [busyId, setBusyId] = useState<number | null>(null);
|
||||
const [deleteTarget, setDeleteTarget] = useState<DiscoveryResult | null>(null);
|
||||
|
||||
const scan = useCallback(async () => {
|
||||
const providerId = scanTarget.trim();
|
||||
if (!providerId) return;
|
||||
setScanning(true);
|
||||
const ok = await callApi(
|
||||
() =>
|
||||
fetch("/api/discovery/scan", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({ providerId }),
|
||||
}),
|
||||
t,
|
||||
"scanFailed",
|
||||
setFeedback
|
||||
);
|
||||
setScanning(false);
|
||||
if (ok) {
|
||||
setScanTarget("");
|
||||
setFeedback({ type: "success", message: t("scanQueued", { provider: providerId }) });
|
||||
await load();
|
||||
}
|
||||
}, [scanTarget, t, load, setFeedback]);
|
||||
|
||||
const verify = useCallback(
|
||||
async (row: DiscoveryResult) => {
|
||||
setBusyId(row.id);
|
||||
const ok = await callApi(
|
||||
() => fetch(`/api/discovery/verify/${row.id}`, { method: "POST" }),
|
||||
t,
|
||||
"verifyFailed",
|
||||
setFeedback
|
||||
);
|
||||
setBusyId(null);
|
||||
if (ok) await load();
|
||||
},
|
||||
[t, load, setFeedback]
|
||||
);
|
||||
|
||||
const remove = useCallback(async () => {
|
||||
if (!deleteTarget) return;
|
||||
setBusyId(deleteTarget.id);
|
||||
const ok = await callApi(
|
||||
() => fetch(`/api/discovery/results/${deleteTarget.id}`, { method: "DELETE" }),
|
||||
t,
|
||||
"deleteFailed",
|
||||
setFeedback
|
||||
);
|
||||
setBusyId(null);
|
||||
if (ok) {
|
||||
setDeleteTarget(null);
|
||||
await load();
|
||||
}
|
||||
}, [deleteTarget, t, load, setFeedback]);
|
||||
|
||||
return {
|
||||
scanTarget,
|
||||
setScanTarget,
|
||||
scanning,
|
||||
busyId,
|
||||
deleteTarget,
|
||||
setDeleteTarget,
|
||||
scan,
|
||||
verify,
|
||||
remove,
|
||||
};
|
||||
}
|
||||
|
||||
/** State + data orchestration for the discovery page, kept out of the view. */
|
||||
function useDiscovery() {
|
||||
const t = useTranslations("discovery");
|
||||
const { results, loading, feedback, setFeedback, load } = useDiscoveryResults(t);
|
||||
const actions = useDiscoveryActions(t, load, setFeedback);
|
||||
return { t, results, loading, feedback, ...actions };
|
||||
}
|
||||
|
||||
function DiscoveryScanForm({
|
||||
t,
|
||||
value,
|
||||
onChange,
|
||||
onScan,
|
||||
scanning,
|
||||
}: {
|
||||
t: Translate;
|
||||
value: string;
|
||||
onChange: (v: string) => void;
|
||||
onScan: () => void;
|
||||
scanning: boolean;
|
||||
}) {
|
||||
return (
|
||||
<Card className="p-4">
|
||||
<div className="flex flex-col gap-3 sm:flex-row sm:items-end">
|
||||
<div className="flex-1">
|
||||
<label className="mb-1 block text-sm font-medium" htmlFor="discovery-scan-target">
|
||||
{t("scanLabel")}
|
||||
</label>
|
||||
<Input
|
||||
id="discovery-scan-target"
|
||||
value={value}
|
||||
placeholder={t("scanPlaceholder")}
|
||||
onChange={(e) => onChange(e.target.value)}
|
||||
onKeyDown={(e) => {
|
||||
if (e.key === "Enter") onScan();
|
||||
}}
|
||||
/>
|
||||
</div>
|
||||
<Button onClick={onScan} disabled={scanning || !value.trim()}>
|
||||
{scanning ? t("scanning") : t("scan")}
|
||||
</Button>
|
||||
</div>
|
||||
<p className="mt-2 text-xs text-muted-foreground">{t("localOnlyNote")}</p>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
|
||||
function DiscoveryResultCard({
|
||||
t,
|
||||
row,
|
||||
busy,
|
||||
onVerify,
|
||||
onDelete,
|
||||
}: {
|
||||
t: Translate;
|
||||
row: DiscoveryResult;
|
||||
busy: boolean;
|
||||
onVerify: () => void;
|
||||
onDelete: () => void;
|
||||
}) {
|
||||
return (
|
||||
<Card className="p-4">
|
||||
<div className="flex flex-wrap items-start justify-between gap-3">
|
||||
<div className="space-y-1">
|
||||
<div className="flex items-center gap-2">
|
||||
<span className="font-medium">{row.providerId}</span>
|
||||
<Badge variant={STATUS_VARIANT[row.status] ?? "default"}>{row.status}</Badge>
|
||||
<Badge variant={RISK_VARIANT[row.riskLevel] ?? "default"}>
|
||||
{t("risk")}: {row.riskLevel}
|
||||
</Badge>
|
||||
</div>
|
||||
<div className="text-xs text-muted-foreground">
|
||||
{t("method")}: {row.method} · {t("auth")}: {row.authType} · {t("feasibility")}:{" "}
|
||||
{row.feasibility}/5
|
||||
</div>
|
||||
{row.endpoint && (
|
||||
<div className="text-xs text-muted-foreground break-all">{row.endpoint}</div>
|
||||
)}
|
||||
{row.models && row.models.length > 0 && (
|
||||
<div className="text-xs text-muted-foreground">
|
||||
{t("models")}: {row.models.join(", ")}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
<div className="flex gap-2">
|
||||
{row.status !== "verified" && (
|
||||
<Button variant="secondary" onClick={onVerify} disabled={busy}>
|
||||
{t("verify")}
|
||||
</Button>
|
||||
)}
|
||||
<Button variant="danger" onClick={onDelete} disabled={busy}>
|
||||
{t("delete")}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
|
||||
export function DiscoveryPageClient() {
|
||||
const d = useDiscovery();
|
||||
|
||||
return (
|
||||
<div className="space-y-6">
|
||||
<header className="space-y-1">
|
||||
<h1 className="text-2xl font-semibold">{d.t("title")}</h1>
|
||||
<p className="text-sm text-muted-foreground">{d.t("subtitle")}</p>
|
||||
</header>
|
||||
|
||||
<DiscoveryScanForm
|
||||
t={d.t}
|
||||
value={d.scanTarget}
|
||||
onChange={d.setScanTarget}
|
||||
onScan={() => void d.scan()}
|
||||
scanning={d.scanning}
|
||||
/>
|
||||
|
||||
{d.feedback && (
|
||||
<div
|
||||
role="status"
|
||||
className={
|
||||
d.feedback.type === "error"
|
||||
? "rounded-md border border-red-300 bg-red-50 px-3 py-2 text-sm text-red-700"
|
||||
: "rounded-md border border-green-300 bg-green-50 px-3 py-2 text-sm text-green-700"
|
||||
}
|
||||
>
|
||||
{d.feedback.message}
|
||||
</div>
|
||||
)}
|
||||
|
||||
{d.loading ? (
|
||||
<div className="flex justify-center py-10">
|
||||
<Spinner />
|
||||
</div>
|
||||
) : d.results.length === 0 ? (
|
||||
<EmptyState title={d.t("emptyTitle")} description={d.t("emptyDescription")} />
|
||||
) : (
|
||||
<ul className="space-y-3">
|
||||
{d.results.map((row) => (
|
||||
<li key={row.id}>
|
||||
<DiscoveryResultCard
|
||||
t={d.t}
|
||||
row={row}
|
||||
busy={d.busyId === row.id}
|
||||
onVerify={() => void d.verify(row)}
|
||||
onDelete={() => d.setDeleteTarget(row)}
|
||||
/>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
)}
|
||||
|
||||
<ConfirmModal
|
||||
isOpen={d.deleteTarget !== null}
|
||||
title={d.t("deleteTitle")}
|
||||
message={d.t("deleteConfirm", { provider: d.deleteTarget?.providerId ?? "" })}
|
||||
confirmText={d.t("delete")}
|
||||
onConfirm={() => void d.remove()}
|
||||
onClose={() => d.setDeleteTarget(null)}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
// @vitest-environment jsdom
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
|
||||
import { render, screen, waitFor } from "@testing-library/react";
|
||||
import React from "react";
|
||||
import { DiscoveryPageClient } from "../DiscoveryPageClient";
|
||||
|
||||
// Stable `t` reference: useTranslations must return the SAME function across
|
||||
// renders, otherwise the `load` useCallback (dep [t]) changes every render and
|
||||
// the fetch-on-mount useEffect loops forever.
|
||||
const t = (key: string, vars?: Record<string, unknown>) =>
|
||||
vars ? `${key}:${JSON.stringify(vars)}` : key;
|
||||
|
||||
vi.mock("next-intl", () => ({
|
||||
useTranslations: () => t,
|
||||
}));
|
||||
|
||||
function mockFetchOnce(results: unknown[]) {
|
||||
const fetchMock = vi.fn(async () =>
|
||||
new Response(JSON.stringify({ results }), {
|
||||
status: 200,
|
||||
headers: { "content-type": "application/json" },
|
||||
})
|
||||
);
|
||||
vi.stubGlobal("fetch", fetchMock);
|
||||
return fetchMock;
|
||||
}
|
||||
|
||||
describe("DiscoveryPageClient", () => {
|
||||
beforeEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
afterEach(() => {
|
||||
vi.unstubAllGlobals();
|
||||
});
|
||||
|
||||
it("loads and renders discovery results from the API", async () => {
|
||||
mockFetchOnce([
|
||||
{
|
||||
id: 1,
|
||||
providerId: "huggingchat",
|
||||
method: "free_tier",
|
||||
authType: "none",
|
||||
feasibility: 5,
|
||||
riskLevel: "none",
|
||||
status: "verified",
|
||||
models: ["mixtral"],
|
||||
},
|
||||
]);
|
||||
|
||||
render(<DiscoveryPageClient />);
|
||||
|
||||
await waitFor(() => {
|
||||
expect(screen.getByText("huggingchat")).toBeInTheDocument();
|
||||
});
|
||||
// status + risk badges render (mocked t returns the key)
|
||||
expect(screen.getByText("verified")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("shows the empty state when there are no results", async () => {
|
||||
mockFetchOnce([]);
|
||||
|
||||
render(<DiscoveryPageClient />);
|
||||
|
||||
await waitFor(() => {
|
||||
expect(screen.getByText("emptyTitle")).toBeInTheDocument();
|
||||
});
|
||||
});
|
||||
|
||||
it("calls the discovery results endpoint on mount", async () => {
|
||||
const fetchMock = mockFetchOnce([]);
|
||||
render(<DiscoveryPageClient />);
|
||||
await waitFor(() => {
|
||||
expect(fetchMock).toHaveBeenCalledWith("/api/discovery/results");
|
||||
});
|
||||
});
|
||||
});
|
||||
5
src/app/(dashboard)/dashboard/discovery/page.tsx
Normal file
5
src/app/(dashboard)/dashboard/discovery/page.tsx
Normal file
@@ -0,0 +1,5 @@
|
||||
import { DiscoveryPageClient } from "./DiscoveryPageClient";
|
||||
|
||||
export default function DiscoveryPage() {
|
||||
return <DiscoveryPageClient />;
|
||||
}
|
||||
62
src/app/api/discovery/results/[id]/route.ts
Normal file
62
src/app/api/discovery/results/[id]/route.ts
Normal file
@@ -0,0 +1,62 @@
|
||||
/**
|
||||
* Discovery result by id — GET / DELETE /api/discovery/results/:id
|
||||
*
|
||||
* Auth: Tier 3 MANAGEMENT + strict local-only (see ../route.ts for the model).
|
||||
*/
|
||||
|
||||
import { requireManagementAuth } from "@/lib/api/requireManagementAuth";
|
||||
import { createErrorResponse, createErrorResponseFromUnknown } from "@/lib/api/errorResponse";
|
||||
import { getDiscoveryResultById, deleteDiscoveryResult } from "@/lib/db/discoveryResults";
|
||||
|
||||
function parseId(raw: string): number | null {
|
||||
const id = Number(raw);
|
||||
return Number.isInteger(id) && id > 0 ? id : null;
|
||||
}
|
||||
|
||||
export async function GET(
|
||||
request: Request,
|
||||
{ params }: { params: Promise<{ id: string }> }
|
||||
): Promise<Response> {
|
||||
const authError = await requireManagementAuth(request);
|
||||
if (authError) return authError;
|
||||
|
||||
const { id: rawId } = await params;
|
||||
const id = parseId(rawId);
|
||||
if (id === null) {
|
||||
return createErrorResponse({ status: 400, message: "Invalid discovery result id" });
|
||||
}
|
||||
|
||||
try {
|
||||
const result = getDiscoveryResultById(id);
|
||||
if (!result) {
|
||||
return createErrorResponse({ status: 404, message: "Discovery result not found" });
|
||||
}
|
||||
return Response.json({ result });
|
||||
} catch (error) {
|
||||
return createErrorResponseFromUnknown(error, "Failed to read discovery result");
|
||||
}
|
||||
}
|
||||
|
||||
export async function DELETE(
|
||||
request: Request,
|
||||
{ params }: { params: Promise<{ id: string }> }
|
||||
): Promise<Response> {
|
||||
const authError = await requireManagementAuth(request);
|
||||
if (authError) return authError;
|
||||
|
||||
const { id: rawId } = await params;
|
||||
const id = parseId(rawId);
|
||||
if (id === null) {
|
||||
return createErrorResponse({ status: 400, message: "Invalid discovery result id" });
|
||||
}
|
||||
|
||||
try {
|
||||
const removed = deleteDiscoveryResult(id);
|
||||
if (!removed) {
|
||||
return createErrorResponse({ status: 404, message: "Discovery result not found" });
|
||||
}
|
||||
return Response.json({ deleted: true, id });
|
||||
} catch (error) {
|
||||
return createErrorResponseFromUnknown(error, "Failed to delete discovery result");
|
||||
}
|
||||
}
|
||||
29
src/app/api/discovery/results/route.ts
Normal file
29
src/app/api/discovery/results/route.ts
Normal file
@@ -0,0 +1,29 @@
|
||||
/**
|
||||
* Discovery results — GET /api/discovery/results
|
||||
*
|
||||
* Lists persisted discovery findings, optionally filtered by `?providerId=`.
|
||||
*
|
||||
* Auth: Tier 3 MANAGEMENT (requireManagementAuth) + strict local-only. The
|
||||
* `/api/discovery/` prefix is in `LOCAL_ONLY_API_PREFIXES` (routeGuard.ts), so
|
||||
* the central authz pipeline (src/proxy.ts → runAuthzPipeline → managementPolicy)
|
||||
* blocks non-loopback callers with a 403 LOCAL_ONLY before this handler runs.
|
||||
* It is NOT in the manage-scope bypass list — strict loopback, no remote bypass.
|
||||
*/
|
||||
|
||||
import { requireManagementAuth } from "@/lib/api/requireManagementAuth";
|
||||
import { createErrorResponseFromUnknown } from "@/lib/api/errorResponse";
|
||||
import { getDiscoveryResults } from "@/lib/db/discoveryResults";
|
||||
|
||||
export async function GET(request: Request): Promise<Response> {
|
||||
const authError = await requireManagementAuth(request);
|
||||
if (authError) return authError;
|
||||
|
||||
try {
|
||||
const url = new URL(request.url);
|
||||
const providerId = url.searchParams.get("providerId") || undefined;
|
||||
const results = getDiscoveryResults(providerId);
|
||||
return Response.json({ results });
|
||||
} catch (error) {
|
||||
return createErrorResponseFromUnknown(error, "Failed to list discovery results");
|
||||
}
|
||||
}
|
||||
54
src/app/api/discovery/scan/route.ts
Normal file
54
src/app/api/discovery/scan/route.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
/**
|
||||
* Discovery scan — POST /api/discovery/scan
|
||||
*
|
||||
* Triggers a scan for one provider and persists the findings. Body:
|
||||
* `{ "providerId": "<id>" }`.
|
||||
*
|
||||
* Auth: Tier 3 MANAGEMENT + strict local-only (see ../results/route.ts). The
|
||||
* strict-loopback classification matters here specifically: `scanProvider` may
|
||||
* probe outbound provider endpoints (SSRF-adjacent), so the surface must never
|
||||
* be reachable from a tunnel/remote origin.
|
||||
*/
|
||||
|
||||
import { z } from "zod";
|
||||
import { requireManagementAuth } from "@/lib/api/requireManagementAuth";
|
||||
import { createErrorResponse, createErrorResponseFromUnknown } from "@/lib/api/errorResponse";
|
||||
import { isValidationFailure, validateBody } from "@/shared/validation/helpers";
|
||||
import { scanProvider, persistDiscoveryResult } from "@/lib/discovery/index";
|
||||
|
||||
const scanRequestSchema = z.object({
|
||||
providerId: z.string().min(1).max(200),
|
||||
});
|
||||
|
||||
export async function POST(request: Request): Promise<Response> {
|
||||
const authError = await requireManagementAuth(request);
|
||||
if (authError) return authError;
|
||||
|
||||
let raw: unknown;
|
||||
try {
|
||||
raw = await request.json();
|
||||
} catch {
|
||||
return createErrorResponse({
|
||||
status: 400,
|
||||
message: "Invalid request",
|
||||
details: [{ field: "body", message: "Invalid JSON body" }],
|
||||
});
|
||||
}
|
||||
|
||||
const validation = validateBody(scanRequestSchema, raw);
|
||||
if (isValidationFailure(validation)) {
|
||||
return createErrorResponse({
|
||||
status: 400,
|
||||
message: validation.error.message,
|
||||
details: validation.error.details,
|
||||
});
|
||||
}
|
||||
|
||||
try {
|
||||
const found = await scanProvider(validation.data.providerId);
|
||||
const persisted = found.map((result) => persistDiscoveryResult(result));
|
||||
return Response.json({ results: persisted });
|
||||
} catch (error) {
|
||||
return createErrorResponseFromUnknown(error, "Failed to scan provider");
|
||||
}
|
||||
}
|
||||
35
src/app/api/discovery/verify/[id]/route.ts
Normal file
35
src/app/api/discovery/verify/[id]/route.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
/**
|
||||
* Discovery verify — POST /api/discovery/verify/:id
|
||||
*
|
||||
* Marks a discovery finding as verified (status='verified', stamps verified_at).
|
||||
*
|
||||
* Auth: Tier 3 MANAGEMENT + strict local-only (see ../../results/route.ts).
|
||||
*/
|
||||
|
||||
import { requireManagementAuth } from "@/lib/api/requireManagementAuth";
|
||||
import { createErrorResponse, createErrorResponseFromUnknown } from "@/lib/api/errorResponse";
|
||||
import { markVerified } from "@/lib/db/discoveryResults";
|
||||
|
||||
export async function POST(
|
||||
request: Request,
|
||||
{ params }: { params: Promise<{ id: string }> }
|
||||
): Promise<Response> {
|
||||
const authError = await requireManagementAuth(request);
|
||||
if (authError) return authError;
|
||||
|
||||
const { id: rawId } = await params;
|
||||
const id = Number(rawId);
|
||||
if (!Number.isInteger(id) || id <= 0) {
|
||||
return createErrorResponse({ status: 400, message: "Invalid discovery result id" });
|
||||
}
|
||||
|
||||
try {
|
||||
const result = markVerified(id);
|
||||
if (!result) {
|
||||
return createErrorResponse({ status: 404, message: "Discovery result not found" });
|
||||
}
|
||||
return Response.json({ result });
|
||||
} catch (error) {
|
||||
return createErrorResponseFromUnknown(error, "Failed to verify discovery result");
|
||||
}
|
||||
}
|
||||
@@ -1117,7 +1117,9 @@
|
||||
"dragReorderItem": "Drag to reorder",
|
||||
"cannotHide": "This item cannot be hidden",
|
||||
"alwaysVisible": "Always visible",
|
||||
"groupSeparatorLabel": "Separator"
|
||||
"groupSeparatorLabel": "Separator",
|
||||
"discovery": "Discovery",
|
||||
"discoverySubtitle": "Scan providers for free access"
|
||||
},
|
||||
"webhooks": {
|
||||
"title": "Webhooks",
|
||||
@@ -4687,7 +4689,7 @@
|
||||
"totalKeysRotating": "{count, plural, one {1 key rotating} other {# keys rotating}}",
|
||||
"unhideModel": "Unhide Model",
|
||||
"upstreamProxyProviders": "Upstream Proxy Providers",
|
||||
"validationModelIdHint": "Model used to verify the API key. Leave blank to use the provider\u2019s first available model.",
|
||||
"validationModelIdHint": "Model used to verify the API key. Leave blank to use the provider’s first available model.",
|
||||
"validationModelIdLabel": "Validation Model",
|
||||
"validationModelIdPlaceholder": "e.g. meta-llama/llama-3.1-8b-instruct",
|
||||
"vertexServiceAccountPlaceholder": "Paste your Service Account JSON ({\"type\":\"service_account\",\"project_id\":\"…\",\"client_email\":\"…\",\"private_key\":\"…\"}) or an OAuth access_token",
|
||||
@@ -8992,5 +8994,30 @@
|
||||
"colAvgScore": "Avg Score",
|
||||
"colModels": "Models",
|
||||
"colType": "Type"
|
||||
},
|
||||
"discovery": {
|
||||
"title": "Provider Discovery",
|
||||
"subtitle": "Scan providers for free/unlimited access methods and review findings. Opt-in, local-only.",
|
||||
"scanLabel": "Provider to scan",
|
||||
"scanPlaceholder": "e.g. huggingchat",
|
||||
"scan": "Scan",
|
||||
"scanning": "Scanning…",
|
||||
"scanQueued": "Scan complete for {provider}.",
|
||||
"scanFailed": "Scan failed.",
|
||||
"loadFailed": "Failed to load discovery results.",
|
||||
"localOnlyNote": "This tool is local-only (loopback). Scans run from this machine and are never reachable remotely.",
|
||||
"verify": "Verify",
|
||||
"verifyFailed": "Failed to verify finding.",
|
||||
"delete": "Delete",
|
||||
"deleteFailed": "Failed to delete finding.",
|
||||
"deleteTitle": "Delete discovery result",
|
||||
"deleteConfirm": "Delete the discovery finding for {provider}? This cannot be undone.",
|
||||
"emptyTitle": "No discovery results yet",
|
||||
"emptyDescription": "Run a scan above to look for free access methods on a provider.",
|
||||
"risk": "Risk",
|
||||
"method": "Method",
|
||||
"auth": "Auth",
|
||||
"feasibility": "Feasibility",
|
||||
"models": "Models"
|
||||
}
|
||||
}
|
||||
|
||||
176
src/lib/db/discoveryResults.ts
Normal file
176
src/lib/db/discoveryResults.ts
Normal file
@@ -0,0 +1,176 @@
|
||||
/**
|
||||
* Database module: Discovery Results
|
||||
*
|
||||
* CRUD for the automated provider-discovery tool (opt-in, default off). Rows
|
||||
* live in the `discovery_results` table (migration 074). The Discovery service
|
||||
* (`src/lib/discovery/`) writes findings here via {@link upsertDiscoveryResult};
|
||||
* the `/api/discovery/*` routes read/verify/delete them.
|
||||
*
|
||||
* See `_tasks/features-v3.8.42/gaps/DISCOVERY_TOOL_DESIGN.md` for the design.
|
||||
*/
|
||||
|
||||
import { getDbInstance } from "./core";
|
||||
|
||||
export type DiscoveryMethod =
|
||||
| "free_tier"
|
||||
| "web_cookie"
|
||||
| "auto_register"
|
||||
| "trial"
|
||||
| "public_api";
|
||||
export type DiscoveryAuthType = "none" | "cookie" | "api_key" | "oauth";
|
||||
export type DiscoveryRiskLevel = "none" | "low" | "medium" | "high" | "critical";
|
||||
export type DiscoveryStatus = "pending" | "testing" | "verified" | "rejected";
|
||||
|
||||
export interface DiscoveryResult {
|
||||
id?: number;
|
||||
providerId: string;
|
||||
method: DiscoveryMethod;
|
||||
endpoint?: string | null;
|
||||
authType: DiscoveryAuthType;
|
||||
models?: string[];
|
||||
rateLimit?: string | null;
|
||||
feasibility: number;
|
||||
riskLevel: DiscoveryRiskLevel;
|
||||
status: DiscoveryStatus;
|
||||
notes?: string | null;
|
||||
discoveredAt?: string;
|
||||
verifiedAt?: string | null;
|
||||
}
|
||||
|
||||
interface DiscoveryRow {
|
||||
id: number;
|
||||
provider_id: string;
|
||||
method: string;
|
||||
endpoint: string | null;
|
||||
auth_type: string | null;
|
||||
models: string | null;
|
||||
rate_limit: string | null;
|
||||
feasibility: number | null;
|
||||
risk_level: string | null;
|
||||
status: string;
|
||||
notes: string | null;
|
||||
discovered_at: string;
|
||||
verified_at: string | null;
|
||||
}
|
||||
|
||||
function rowToResult(row: DiscoveryRow): DiscoveryResult {
|
||||
let models: string[] | undefined;
|
||||
if (row.models) {
|
||||
try {
|
||||
const parsed = JSON.parse(row.models);
|
||||
if (Array.isArray(parsed)) models = parsed.map(String);
|
||||
} catch {
|
||||
models = undefined;
|
||||
}
|
||||
}
|
||||
return {
|
||||
id: row.id,
|
||||
providerId: row.provider_id,
|
||||
method: row.method as DiscoveryMethod,
|
||||
endpoint: row.endpoint,
|
||||
authType: (row.auth_type as DiscoveryAuthType) ?? "none",
|
||||
models,
|
||||
rateLimit: row.rate_limit,
|
||||
feasibility: row.feasibility ?? 0,
|
||||
riskLevel: (row.risk_level as DiscoveryRiskLevel) ?? "none",
|
||||
status: row.status as DiscoveryStatus,
|
||||
notes: row.notes,
|
||||
discoveredAt: row.discovered_at,
|
||||
verifiedAt: row.verified_at,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Insert or update a discovery finding. Uniqueness is keyed on
|
||||
* `(provider_id, method, endpoint)` (the table's UNIQUE constraint), so
|
||||
* re-discovering the same endpoint updates the existing row rather than
|
||||
* duplicating it. Returns the persisted row (with its id).
|
||||
*/
|
||||
export function upsertDiscoveryResult(result: DiscoveryResult): DiscoveryResult {
|
||||
const db = getDbInstance();
|
||||
const models = result.models ? JSON.stringify(result.models) : null;
|
||||
db.prepare(
|
||||
`INSERT INTO discovery_results
|
||||
(provider_id, method, endpoint, auth_type, models, rate_limit, feasibility, risk_level, status, notes)
|
||||
VALUES (@provider_id, @method, @endpoint, @auth_type, @models, @rate_limit, @feasibility, @risk_level, @status, @notes)
|
||||
ON CONFLICT(provider_id, method, endpoint) DO UPDATE SET
|
||||
auth_type = excluded.auth_type,
|
||||
models = excluded.models,
|
||||
rate_limit = excluded.rate_limit,
|
||||
feasibility = excluded.feasibility,
|
||||
risk_level = excluded.risk_level,
|
||||
status = excluded.status,
|
||||
notes = excluded.notes`
|
||||
).run({
|
||||
provider_id: result.providerId,
|
||||
method: result.method,
|
||||
endpoint: result.endpoint ?? null,
|
||||
auth_type: result.authType,
|
||||
models,
|
||||
rate_limit: result.rateLimit ?? null,
|
||||
feasibility: result.feasibility,
|
||||
risk_level: result.riskLevel,
|
||||
status: result.status,
|
||||
notes: result.notes ?? null,
|
||||
});
|
||||
|
||||
const row = db
|
||||
.prepare(
|
||||
`SELECT * FROM discovery_results
|
||||
WHERE provider_id = ? AND method = ? AND ifnull(endpoint, '') = ifnull(?, '')`
|
||||
)
|
||||
.get(result.providerId, result.method, result.endpoint ?? null) as DiscoveryRow | undefined;
|
||||
// The row was just written, so it must exist.
|
||||
return rowToResult(row!);
|
||||
}
|
||||
|
||||
/**
|
||||
* List discovery results, optionally filtered to a single provider. Newest
|
||||
* findings first.
|
||||
*/
|
||||
export function getDiscoveryResults(providerId?: string): DiscoveryResult[] {
|
||||
const db = getDbInstance();
|
||||
const rows = providerId
|
||||
? (db
|
||||
.prepare(
|
||||
"SELECT * FROM discovery_results WHERE provider_id = ? ORDER BY discovered_at DESC, id DESC"
|
||||
)
|
||||
.all(providerId) as DiscoveryRow[])
|
||||
: (db
|
||||
.prepare("SELECT * FROM discovery_results ORDER BY discovered_at DESC, id DESC")
|
||||
.all() as DiscoveryRow[]);
|
||||
return rows.map(rowToResult);
|
||||
}
|
||||
|
||||
export function getDiscoveryResultById(id: number): DiscoveryResult | null {
|
||||
const db = getDbInstance();
|
||||
const row = db.prepare("SELECT * FROM discovery_results WHERE id = ?").get(id) as
|
||||
| DiscoveryRow
|
||||
| undefined;
|
||||
return row ? rowToResult(row) : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark a finding as verified, stamping `verified_at`. Returns the updated row,
|
||||
* or null if no row with that id exists.
|
||||
*/
|
||||
export function markVerified(id: number): DiscoveryResult | null {
|
||||
const db = getDbInstance();
|
||||
const info = db
|
||||
.prepare(
|
||||
"UPDATE discovery_results SET status = 'verified', verified_at = datetime('now') WHERE id = ?"
|
||||
)
|
||||
.run(id);
|
||||
if (info.changes === 0) return null;
|
||||
return getDiscoveryResultById(id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a finding. Returns true if a row was removed, false if the id was not
|
||||
* found.
|
||||
*/
|
||||
export function deleteDiscoveryResult(id: number): boolean {
|
||||
const db = getDbInstance();
|
||||
const info = db.prepare("DELETE FROM discovery_results WHERE id = ?").run(id);
|
||||
return info.changes > 0;
|
||||
}
|
||||
@@ -11,6 +11,11 @@
|
||||
*/
|
||||
|
||||
import { logger } from "../../../open-sse/utils/logger.ts";
|
||||
import {
|
||||
upsertDiscoveryResult as dbUpsertDiscoveryResult,
|
||||
getDiscoveryResults as dbGetDiscoveryResults,
|
||||
type DiscoveryResult as DbDiscoveryResult,
|
||||
} from "../db/discoveryResults";
|
||||
|
||||
const log = logger("DISCOVERY");
|
||||
|
||||
@@ -102,13 +107,24 @@ export async function scanProvider(
|
||||
];
|
||||
}
|
||||
|
||||
// ── Results ──
|
||||
// ── Results (Reporter — Phase 2) ──
|
||||
|
||||
/**
|
||||
* Get discovery results. Phase 1 stub — returns empty array.
|
||||
* Persist a discovery finding to the `discovery_results` table via the DB
|
||||
* module. Uniqueness is keyed on `(providerId, method, endpoint)`, so
|
||||
* re-discovering the same endpoint updates the existing row. Returns the
|
||||
* persisted row (with its id).
|
||||
*/
|
||||
export function getDiscoveryResults(_providerId?: string): DiscoveryResult[] {
|
||||
return [];
|
||||
export function persistDiscoveryResult(result: DiscoveryResult): DiscoveryResult {
|
||||
return dbUpsertDiscoveryResult(result as DbDiscoveryResult) as DiscoveryResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get discovery results from the DB, optionally filtered to one provider.
|
||||
* Newest findings first.
|
||||
*/
|
||||
export function getDiscoveryResults(providerId?: string): DiscoveryResult[] {
|
||||
return dbGetDiscoveryResults(providerId) as DiscoveryResult[];
|
||||
}
|
||||
|
||||
// ── Config ──
|
||||
|
||||
@@ -321,6 +321,22 @@ export {
|
||||
export type { Webhook, WebhookKind } from "./db/webhooks";
|
||||
|
||||
export { insertDelivery, getDeliveries } from "./db/webhookDeliveries";
|
||||
|
||||
export {
|
||||
upsertDiscoveryResult,
|
||||
getDiscoveryResults,
|
||||
getDiscoveryResultById,
|
||||
markVerified,
|
||||
deleteDiscoveryResult,
|
||||
} from "./db/discoveryResults";
|
||||
|
||||
export type {
|
||||
DiscoveryResult,
|
||||
DiscoveryMethod,
|
||||
DiscoveryAuthType,
|
||||
DiscoveryRiskLevel,
|
||||
DiscoveryStatus,
|
||||
} from "./db/discoveryResults";
|
||||
export type { WebhookDelivery } from "./db/webhookDeliveries";
|
||||
|
||||
export {
|
||||
|
||||
@@ -42,6 +42,7 @@ export const LOCAL_ONLY_API_PREFIXES: ReadonlyArray<string> = [
|
||||
"/api/headroom/start", // Headroom token-saver proxy lifecycle: spawns headroom-ai python CLI (Hard Rules #15 + #17)
|
||||
"/api/headroom/stop", // Headroom token-saver proxy lifecycle: sends SIGTERM/SIGKILL to managed PID (Hard Rules #15 + #17)
|
||||
"/api/oauth/cursor/auto-import", // spawns `execFile("which", ["cursor"])` to verify a local Cursor install before importing creds — RCE-via-tunnel surface (Hard Rules #15 + #17, found by 6A.8 route-guard gate). Specific path only: the rest of /api/oauth/ (browser redirect/callback flows) must stay remote-reachable.
|
||||
"/api/discovery/", // Discovery tool (opt-in provider scanner): the scan route makes outbound probes to provider endpoints (SSRF-adjacent) and the whole surface is an admin research tool — strict-loopback only, no manage-scope bypass (NOT in LOCAL_ONLY_MANAGE_SCOPE_BYPASS_PREFIXES). See _tasks/features-v3.8.42/gaps/DISCOVERY_TOOL_DESIGN.md.
|
||||
];
|
||||
|
||||
/**
|
||||
|
||||
@@ -229,6 +229,13 @@ const TOOLS_GROUP: SidebarItemGroup = {
|
||||
subtitleKey: "trafficInspectorSubtitle",
|
||||
icon: "network_check",
|
||||
},
|
||||
{
|
||||
id: "discovery",
|
||||
href: "/dashboard/discovery",
|
||||
i18nKey: "discovery",
|
||||
subtitleKey: "discoverySubtitle",
|
||||
icon: "travel_explore",
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
|
||||
@@ -29,6 +29,7 @@ export const HIDEABLE_SIDEBAR_ITEM_IDS = [
|
||||
"cloud-agents",
|
||||
"agent-bridge",
|
||||
"traffic-inspector",
|
||||
"discovery",
|
||||
// OmniProxy > Integrations
|
||||
"api-endpoints",
|
||||
"webhooks",
|
||||
|
||||
@@ -187,6 +187,7 @@
|
||||
"tests/unit/antigravity-429-quota-tdd.test.ts",
|
||||
"tests/unit/auth-antigravity-account-retry-v2.test.ts",
|
||||
"tests/unit/middleware-header-strip-5849.test.ts",
|
||||
"tests/unit/authz/discovery-routes-local-only.test.ts",
|
||||
"tests/unit/authz/route-guard-local-prefix.test.ts",
|
||||
"tests/unit/authz/route-guard-version-get-exemption.test.ts",
|
||||
"tests/unit/chat-combo-live-test.test.ts",
|
||||
|
||||
155
tests/unit/api/discovery-routes.test.ts
Normal file
155
tests/unit/api/discovery-routes.test.ts
Normal file
@@ -0,0 +1,155 @@
|
||||
import { describe, test, before, after } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
// Isolated DB + auth disabled so requireManagementAuth passes (no key configured).
|
||||
let tmpDataDir: string;
|
||||
let core: typeof import("@/lib/db/core");
|
||||
let db: typeof import("@/lib/db/discoveryResults");
|
||||
let resultsRoute: typeof import("@/app/api/discovery/results/route");
|
||||
let resultByIdRoute: typeof import("@/app/api/discovery/results/[id]/route");
|
||||
let scanRoute: typeof import("@/app/api/discovery/scan/route");
|
||||
let verifyRoute: typeof import("@/app/api/discovery/verify/[id]/route");
|
||||
|
||||
function req(method: string, url: string, body?: unknown): Request {
|
||||
return new Request(`http://localhost${url}`, {
|
||||
method,
|
||||
headers: { "content-type": "application/json" },
|
||||
body: body === undefined ? undefined : JSON.stringify(body),
|
||||
});
|
||||
}
|
||||
|
||||
before(async () => {
|
||||
tmpDataDir = mkdtempSync(join(tmpdir(), "omniroute-discovery-routes-"));
|
||||
process.env.DATA_DIR = tmpDataDir;
|
||||
delete process.env.REQUIRE_API_KEY;
|
||||
process.env.OMNIROUTE_DISABLE_AUTH = "1";
|
||||
core = await import("@/lib/db/core");
|
||||
core.resetDbInstance();
|
||||
core.getDbInstance();
|
||||
db = await import("@/lib/db/discoveryResults");
|
||||
resultsRoute = await import("@/app/api/discovery/results/route");
|
||||
resultByIdRoute = await import("@/app/api/discovery/results/[id]/route");
|
||||
scanRoute = await import("@/app/api/discovery/scan/route");
|
||||
verifyRoute = await import("@/app/api/discovery/verify/[id]/route");
|
||||
});
|
||||
|
||||
after(() => {
|
||||
core.resetDbInstance();
|
||||
if (tmpDataDir) rmSync(tmpDataDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe("discovery API routes", () => {
|
||||
test("GET /results lists persisted findings (and filters by providerId)", async () => {
|
||||
db.upsertDiscoveryResult({
|
||||
providerId: "acme",
|
||||
method: "free_tier",
|
||||
authType: "none",
|
||||
feasibility: 3,
|
||||
riskLevel: "none",
|
||||
status: "pending",
|
||||
});
|
||||
const res = await resultsRoute.GET(req("GET", "/api/discovery/results?providerId=acme"));
|
||||
assert.equal(res.status, 200);
|
||||
const body = await res.json();
|
||||
assert.ok(Array.isArray(body.results));
|
||||
assert.ok(body.results.some((r: { providerId: string }) => r.providerId === "acme"));
|
||||
});
|
||||
|
||||
test("GET /results/:id returns the row, 404 when missing, 400 on bad id", async () => {
|
||||
const created = db.upsertDiscoveryResult({
|
||||
providerId: "beta",
|
||||
method: "trial",
|
||||
authType: "api_key",
|
||||
feasibility: 2,
|
||||
riskLevel: "low",
|
||||
status: "pending",
|
||||
});
|
||||
const ok = await resultByIdRoute.GET(req("GET", `/api/discovery/results/${created.id}`), {
|
||||
params: Promise.resolve({ id: String(created.id) }),
|
||||
});
|
||||
assert.equal(ok.status, 200);
|
||||
|
||||
const missing = await resultByIdRoute.GET(req("GET", "/api/discovery/results/999999"), {
|
||||
params: Promise.resolve({ id: "999999" }),
|
||||
});
|
||||
assert.equal(missing.status, 404);
|
||||
|
||||
const bad = await resultByIdRoute.GET(req("GET", "/api/discovery/results/abc"), {
|
||||
params: Promise.resolve({ id: "abc" }),
|
||||
});
|
||||
assert.equal(bad.status, 400);
|
||||
});
|
||||
|
||||
test("POST /scan persists findings; rejects an empty providerId with 400", async () => {
|
||||
const res = await scanRoute.POST(req("POST", "/api/discovery/scan", { providerId: "gamma" }));
|
||||
assert.equal(res.status, 200);
|
||||
const body = await res.json();
|
||||
assert.ok(Array.isArray(body.results) && body.results.length > 0);
|
||||
assert.ok(body.results[0].id > 0);
|
||||
// the persisted row is now queryable
|
||||
assert.ok(db.getDiscoveryResults("gamma").length > 0);
|
||||
|
||||
const invalid = await scanRoute.POST(req("POST", "/api/discovery/scan", { providerId: "" }));
|
||||
assert.equal(invalid.status, 400);
|
||||
|
||||
const malformed = new Request("http://localhost/api/discovery/scan", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: "{not json",
|
||||
});
|
||||
const malformedRes = await scanRoute.POST(malformed);
|
||||
assert.equal(malformedRes.status, 400);
|
||||
});
|
||||
|
||||
test("POST /verify/:id marks verified, 404 when missing", async () => {
|
||||
const created = db.upsertDiscoveryResult({
|
||||
providerId: "delta",
|
||||
method: "public_api",
|
||||
authType: "api_key",
|
||||
feasibility: 5,
|
||||
riskLevel: "none",
|
||||
status: "pending",
|
||||
});
|
||||
const res = await verifyRoute.POST(req("POST", `/api/discovery/verify/${created.id}`), {
|
||||
params: Promise.resolve({ id: String(created.id) }),
|
||||
});
|
||||
assert.equal(res.status, 200);
|
||||
const body = await res.json();
|
||||
assert.equal(body.result.status, "verified");
|
||||
|
||||
const missing = await verifyRoute.POST(req("POST", "/api/discovery/verify/999999"), {
|
||||
params: Promise.resolve({ id: "999999" }),
|
||||
});
|
||||
assert.equal(missing.status, 404);
|
||||
});
|
||||
|
||||
test("DELETE /results/:id removes the row, 404 on second delete", async () => {
|
||||
const created = db.upsertDiscoveryResult({
|
||||
providerId: "epsilon",
|
||||
method: "free_tier",
|
||||
authType: "none",
|
||||
feasibility: 1,
|
||||
riskLevel: "none",
|
||||
status: "pending",
|
||||
});
|
||||
const first = await resultByIdRoute.DELETE(req("DELETE", `/api/discovery/results/${created.id}`), {
|
||||
params: Promise.resolve({ id: String(created.id) }),
|
||||
});
|
||||
assert.equal(first.status, 200);
|
||||
const second = await resultByIdRoute.DELETE(req("DELETE", `/api/discovery/results/${created.id}`), {
|
||||
params: Promise.resolve({ id: String(created.id) }),
|
||||
});
|
||||
assert.equal(second.status, 404);
|
||||
});
|
||||
|
||||
test("error responses do not leak stack traces", async () => {
|
||||
const missing = await resultByIdRoute.GET(req("GET", "/api/discovery/results/424242"), {
|
||||
params: Promise.resolve({ id: "424242" }),
|
||||
});
|
||||
const body = await missing.json();
|
||||
assert.ok(!String(body.error?.message ?? "").includes("at /"));
|
||||
});
|
||||
});
|
||||
27
tests/unit/authz/discovery-routes-local-only.test.ts
Normal file
27
tests/unit/authz/discovery-routes-local-only.test.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { describe, test } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import {
|
||||
isLocalOnlyPath,
|
||||
isLocalOnlyBypassableByManageScope,
|
||||
} from "@/server/authz/routeGuard";
|
||||
|
||||
// Security guard: the discovery surface must be strict-loopback only. If someone
|
||||
// removes "/api/discovery/" from LOCAL_ONLY_API_PREFIXES, or adds it to the
|
||||
// manage-scope bypass list, these assertions fail — the scan route makes
|
||||
// outbound probes (SSRF-adjacent) and must never be tunnel-reachable.
|
||||
describe("discovery routes are strict local-only", () => {
|
||||
for (const path of [
|
||||
"/api/discovery/results",
|
||||
"/api/discovery/results/42",
|
||||
"/api/discovery/scan",
|
||||
"/api/discovery/verify/42",
|
||||
]) {
|
||||
test(`isLocalOnlyPath("${path}") === true`, () => {
|
||||
assert.equal(isLocalOnlyPath(path), true);
|
||||
});
|
||||
|
||||
test(`"${path}" is NOT bypassable by manage-scope (strict loopback)`, () => {
|
||||
assert.equal(isLocalOnlyBypassableByManageScope(path), false);
|
||||
});
|
||||
}
|
||||
});
|
||||
143
tests/unit/db/discovery-results.test.ts
Normal file
143
tests/unit/db/discovery-results.test.ts
Normal file
@@ -0,0 +1,143 @@
|
||||
import { describe, test, before, after } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
// Isolate the DB into a throwaway DATA_DIR so migrations run against a fresh file.
|
||||
let tmpDataDir: string;
|
||||
let mod: typeof import("@/lib/db/discoveryResults");
|
||||
let core: typeof import("@/lib/db/core");
|
||||
|
||||
before(async () => {
|
||||
tmpDataDir = mkdtempSync(join(tmpdir(), "omniroute-discovery-"));
|
||||
process.env.DATA_DIR = tmpDataDir;
|
||||
core = await import("@/lib/db/core");
|
||||
core.resetDbInstance();
|
||||
// Touch the instance so migrations (incl. 074_discovery_results) apply.
|
||||
core.getDbInstance();
|
||||
mod = await import("@/lib/db/discoveryResults");
|
||||
});
|
||||
|
||||
after(() => {
|
||||
core.resetDbInstance();
|
||||
if (tmpDataDir) rmSync(tmpDataDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe("discoveryResults DB module", () => {
|
||||
test("upsert inserts a new row and returns it with an id", () => {
|
||||
const row = mod.upsertDiscoveryResult({
|
||||
providerId: "acme",
|
||||
method: "free_tier",
|
||||
authType: "none",
|
||||
feasibility: 4,
|
||||
riskLevel: "low",
|
||||
status: "pending",
|
||||
models: ["acme-large", "acme-small"],
|
||||
endpoint: "https://acme.example/api",
|
||||
});
|
||||
assert.ok(typeof row.id === "number" && row.id > 0);
|
||||
assert.equal(row.providerId, "acme");
|
||||
assert.deepEqual(row.models, ["acme-large", "acme-small"]);
|
||||
assert.equal(row.status, "pending");
|
||||
});
|
||||
|
||||
test("upsert on the same (provider, method, endpoint) updates instead of duplicating", () => {
|
||||
const first = mod.upsertDiscoveryResult({
|
||||
providerId: "beta",
|
||||
method: "web_cookie",
|
||||
authType: "cookie",
|
||||
feasibility: 3,
|
||||
riskLevel: "medium",
|
||||
status: "pending",
|
||||
endpoint: "https://beta.example/chat",
|
||||
});
|
||||
const second = mod.upsertDiscoveryResult({
|
||||
providerId: "beta",
|
||||
method: "web_cookie",
|
||||
authType: "cookie",
|
||||
feasibility: 5,
|
||||
riskLevel: "medium",
|
||||
status: "testing",
|
||||
endpoint: "https://beta.example/chat",
|
||||
});
|
||||
assert.equal(second.id, first.id);
|
||||
assert.equal(second.feasibility, 5);
|
||||
assert.equal(second.status, "testing");
|
||||
const all = mod.getDiscoveryResults("beta");
|
||||
assert.equal(all.length, 1);
|
||||
});
|
||||
|
||||
test("getDiscoveryResults filters by providerId and returns all when omitted", () => {
|
||||
const beta = mod.getDiscoveryResults("beta");
|
||||
assert.ok(beta.every((r) => r.providerId === "beta"));
|
||||
const all = mod.getDiscoveryResults();
|
||||
assert.ok(all.length >= 2);
|
||||
});
|
||||
|
||||
test("getDiscoveryResultById returns the row or null", () => {
|
||||
const created = mod.upsertDiscoveryResult({
|
||||
providerId: "gamma",
|
||||
method: "trial",
|
||||
authType: "api_key",
|
||||
feasibility: 2,
|
||||
riskLevel: "low",
|
||||
status: "pending",
|
||||
});
|
||||
const found = mod.getDiscoveryResultById(created.id!);
|
||||
assert.equal(found?.providerId, "gamma");
|
||||
assert.equal(mod.getDiscoveryResultById(999999), null);
|
||||
});
|
||||
|
||||
test("markVerified sets status=verified and stamps verified_at", () => {
|
||||
const created = mod.upsertDiscoveryResult({
|
||||
providerId: "delta",
|
||||
method: "public_api",
|
||||
authType: "api_key",
|
||||
feasibility: 5,
|
||||
riskLevel: "none",
|
||||
status: "pending",
|
||||
});
|
||||
const updated = mod.markVerified(created.id!);
|
||||
assert.equal(updated?.status, "verified");
|
||||
assert.ok(updated?.verifiedAt);
|
||||
});
|
||||
|
||||
test("markVerified on a missing id returns null", () => {
|
||||
assert.equal(mod.markVerified(999999), null);
|
||||
});
|
||||
|
||||
test("deleteDiscoveryResult removes the row and returns true, false if absent", () => {
|
||||
const created = mod.upsertDiscoveryResult({
|
||||
providerId: "epsilon",
|
||||
method: "free_tier",
|
||||
authType: "none",
|
||||
feasibility: 1,
|
||||
riskLevel: "none",
|
||||
status: "pending",
|
||||
});
|
||||
assert.equal(mod.deleteDiscoveryResult(created.id!), true);
|
||||
assert.equal(mod.getDiscoveryResultById(created.id!), null);
|
||||
assert.equal(mod.deleteDiscoveryResult(created.id!), false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("discovery service reporter delegation", () => {
|
||||
test("persistDiscoveryResult writes through and getDiscoveryResults reads it back", async () => {
|
||||
const svc = await import("@/lib/discovery/index");
|
||||
const saved = svc.persistDiscoveryResult({
|
||||
providerId: "zeta",
|
||||
method: "public_api",
|
||||
authType: "api_key",
|
||||
feasibility: 5,
|
||||
riskLevel: "none",
|
||||
status: "verified",
|
||||
models: ["zeta-1"],
|
||||
});
|
||||
assert.ok(saved.id! > 0);
|
||||
const read = svc.getDiscoveryResults("zeta");
|
||||
assert.equal(read.length, 1);
|
||||
assert.equal(read[0].providerId, "zeta");
|
||||
assert.deepEqual(read[0].models, ["zeta-1"]);
|
||||
});
|
||||
});
|
||||
@@ -25,14 +25,22 @@ function getToolsGroup() {
|
||||
};
|
||||
}
|
||||
|
||||
test("TOOLS_GROUP items follow plan 14 order: cli-code → cli-agents → acp-agents → cloud-agents → agent-bridge → traffic-inspector", () => {
|
||||
test("TOOLS_GROUP items follow plan 14 order: cli-code → cli-agents → acp-agents → cloud-agents → agent-bridge → traffic-inspector → discovery", () => {
|
||||
const toolsGroup = getToolsGroup();
|
||||
const itemIds = toolsGroup.items.map((item) => item.id);
|
||||
// cli-code/cli-agents/acp-agents/cloud-agents from plan 14 (#2839); agent-bridge/traffic-inspector from plans 11/12 (#2858).
|
||||
// cli-code/cli-agents/acp-agents/cloud-agents from plan 14 (#2839); agent-bridge/traffic-inspector from plans 11/12 (#2858); discovery from #5939.
|
||||
assert.deepEqual(
|
||||
itemIds,
|
||||
["cli-code", "cli-agents", "acp-agents", "cloud-agents", "agent-bridge", "traffic-inspector"],
|
||||
"TOOLS_GROUP items order must be cli-code, cli-agents, acp-agents, cloud-agents, agent-bridge, traffic-inspector"
|
||||
[
|
||||
"cli-code",
|
||||
"cli-agents",
|
||||
"acp-agents",
|
||||
"cloud-agents",
|
||||
"agent-bridge",
|
||||
"traffic-inspector",
|
||||
"discovery",
|
||||
],
|
||||
"TOOLS_GROUP items order must be cli-code, cli-agents, acp-agents, cloud-agents, agent-bridge, traffic-inspector, discovery"
|
||||
);
|
||||
});
|
||||
|
||||
|
||||
@@ -63,6 +63,7 @@ test("primary sidebar items place limits after cache", () => {
|
||||
"cloud-agents",
|
||||
"agent-bridge",
|
||||
"traffic-inspector",
|
||||
"discovery",
|
||||
"api-endpoints",
|
||||
"webhooks",
|
||||
"proxy",
|
||||
|
||||
@@ -15,6 +15,7 @@ export default defineConfig({
|
||||
"src/app/**/dashboard/endpoint/__tests__/**/*.test.tsx",
|
||||
"src/app/**/dashboard/providers/**/__tests__/**/*.test.tsx",
|
||||
"src/app/**/dashboard/webhooks/__tests__/**/*.test.tsx",
|
||||
"src/app/**/dashboard/discovery/__tests__/**/*.test.tsx",
|
||||
"src/shared/hooks/__tests__/**/*.test.tsx",
|
||||
"src/lib/memory/__tests__/**/*.test.ts",
|
||||
"src/lib/skills/__tests__/**/*.test.ts",
|
||||
|
||||
Reference in New Issue
Block a user