swarm ui: one review page
The two review tabs, runs and try-out, are one: /review. It is a column of three sections: try a classification and the classifier settings, each a folded bar (the settings' bar says what they are now), then the recent runs, always open. The settings had been pinned under the try-out form; they are now a section of their own. A new Disclosure primitive is the folding bar, a native details wearing the Panel's classes, so the folded and open sections read as the same surface. /review-runs and /review-tryout are gone, with no redirect.
This commit is contained in:
parent
7b1435eaea
commit
a68d73fa74
3 changed files with 223 additions and 45 deletions
|
|
@ -6,7 +6,7 @@ import { SelectField } from "../../ui/select-field/SelectField.js";
|
|||
import { TextAreaField } from "../../ui/text-area-field/TextAreaField.js";
|
||||
import { TextField } from "../../ui/text-field/TextField.js";
|
||||
import type { ClassificationDraft, Polarity } from "./TryOutTypes.js";
|
||||
import "./ReviewTryOutPage.css";
|
||||
import "./ReviewTryOut.css";
|
||||
|
||||
const POLARITY_OPTIONS = [
|
||||
{ value: "positive", label: "positive — the PR should match" },
|
||||
|
|
|
|||
|
|
@ -0,0 +1,64 @@
|
|||
/* The form panel and the result panel under it, apart from each other. */
|
||||
.ui-tryout-page {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 1em;
|
||||
}
|
||||
/* The try-out form: the repo and PR on one line, then one block per
|
||||
classification, then the actions. */
|
||||
.ui-tryout-form {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
.ui-tryout-target {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.75em;
|
||||
}
|
||||
.ui-tryout-target > * {
|
||||
flex: 1 1 14em;
|
||||
}
|
||||
.ui-tryout-target > button {
|
||||
flex: none;
|
||||
align-self: flex-end;
|
||||
}
|
||||
.ui-tryout-loaded {
|
||||
margin: 0;
|
||||
color: var(--muted);
|
||||
}
|
||||
.ui-tryout-classification {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.6em;
|
||||
padding: 0.75em;
|
||||
border: 1px solid var(--border);
|
||||
border-radius: 0.5em;
|
||||
}
|
||||
.ui-tryout-classification-row {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
align-items: flex-end;
|
||||
gap: 0.75em;
|
||||
}
|
||||
.ui-tryout-classification-row > * {
|
||||
flex: 1 1 12em;
|
||||
}
|
||||
.ui-tryout-classification-row > button {
|
||||
flex: none;
|
||||
}
|
||||
.ui-tryout-actions {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
align-items: center;
|
||||
gap: 0.75em;
|
||||
}
|
||||
.ui-tryout-hint {
|
||||
margin: 0;
|
||||
color: var(--muted);
|
||||
}
|
||||
.ui-tryout-running {
|
||||
margin: 0;
|
||||
color: var(--muted);
|
||||
}
|
||||
|
|
@ -0,0 +1,474 @@
|
|||
// <ReviewTryOut> — write a review classification and see how the model
|
||||
// answers it on a real PR, before it goes into a repo's config
|
||||
// (`docs/swarm/review-classifier.md`, "Try-out"). Pick a repo and a PR, write
|
||||
// one or more classifications, run: the page posts them to
|
||||
// swarm-controller's `POST /api/review-classifier/try-out`, which answers
|
||||
// `202 {id}`, and polls `GET .../try-out/{id}` until the run is `done` or
|
||||
// `failed`. A run takes a minute or more, so the page says it is running.
|
||||
//
|
||||
// The repo and PR fields offer the repos that have an open PR and the open PRs
|
||||
// of the repo (`GET /api/pulls/repos`, `GET /api/pulls?repo=…`), and stay free
|
||||
// text: the run also works on a merged or closed PR.
|
||||
//
|
||||
// **load the repo's rules** fills the rows from the rules on the repo's default
|
||||
// branch (`GET /api/review-classifier/rules`), to run as they are or to edit.
|
||||
//
|
||||
// **open a PR** posts the rows to `POST /api/review-classifier/open-pr`, which
|
||||
// has the classifier's forge account push a branch adding them to the repo's
|
||||
// rules file, with the operator as commit author, and links to the forge's page
|
||||
// for opening the PR from that branch.
|
||||
//
|
||||
// The inputs stay as typed after a run, so the operator can edit and run
|
||||
// again. The section keeps nothing you typed and no
|
||||
// result, and a run posts nothing to the forge; the only thing the browser
|
||||
// remembers is the result table's column filters, as for every table in the UI.
|
||||
import { useEffect, useState } from "preact/hooks";
|
||||
import { ApiErrorPanel } from "@hive/shared/api-error-panel.js";
|
||||
import { readApiError, type ProblemDetails } from "@hive/shared/api-error.js";
|
||||
import { Button } from "../../ui/button/Button.js";
|
||||
import { ConfirmDialog } from "../../ui/confirm-dialog/ConfirmDialog.js";
|
||||
import { Disclosure } from "../../ui/disclosure/Disclosure.js";
|
||||
import { Panel } from "../../ui/panel/Panel.js";
|
||||
import { TextField } from "../../ui/text-field/TextField.js";
|
||||
import { ClassificationEditor } from "./ClassificationEditor.js";
|
||||
import { TryOutResult } from "./TryOutResult.js";
|
||||
import {
|
||||
draftFromRule,
|
||||
hasTypedText,
|
||||
prNumber,
|
||||
repoProblem,
|
||||
rowsProblem,
|
||||
runProblem,
|
||||
toBody,
|
||||
type ClassificationDraft,
|
||||
type OpenPrAnswer,
|
||||
type OpenPull,
|
||||
type RulesAnswer,
|
||||
type TryOutResult as Result,
|
||||
} from "./TryOutTypes.js";
|
||||
import "./ReviewTryOut.css";
|
||||
|
||||
const TRY_OUT = "/api/review-classifier/try-out";
|
||||
const RULES = "/api/review-classifier/rules";
|
||||
const OPEN_PR = "/api/review-classifier/open-pr";
|
||||
const PULL_REPOS = "/api/pulls/repos";
|
||||
const PULLS = "/api/pulls";
|
||||
// How long the repo field rests before its PRs are fetched, so typing a repo
|
||||
// does not ask for the PRs of each prefix of it.
|
||||
const PICK_DELAY_MS = 300;
|
||||
const POLL_MS = 2000;
|
||||
// More classifications than this are not offered a row. It is the try-out
|
||||
// endpoint's own cap, which answers a longer list with a 400 that the page
|
||||
// shows as it is.
|
||||
const MAX_CLASSIFICATIONS = 10;
|
||||
|
||||
let nextKey = 0;
|
||||
function blankDraft(): ClassificationDraft {
|
||||
return {
|
||||
key: nextKey++,
|
||||
name: "",
|
||||
description: "",
|
||||
polarity: "positive",
|
||||
threshold: "80",
|
||||
};
|
||||
}
|
||||
|
||||
export function ReviewTryOut() {
|
||||
const [repo, setRepo] = useState("");
|
||||
const [pr, setPr] = useState("");
|
||||
const [drafts, setDrafts] = useState<ClassificationDraft[]>(() => [
|
||||
blankDraft(),
|
||||
]);
|
||||
// The id of the run being polled; null when none is in flight.
|
||||
const [runId, setRunId] = useState<string | null>(null);
|
||||
const [starting, setStarting] = useState(false);
|
||||
const [result, setResult] = useState<Result | null>(null);
|
||||
const [error, setError] = useState<ProblemDetails | null>(null);
|
||||
// Whole seconds since the run started, so a long wait shows it is alive.
|
||||
const [elapsed, setElapsed] = useState(0);
|
||||
|
||||
const [loadingRules, setLoadingRules] = useState(false);
|
||||
const [rulesError, setRulesError] = useState<ProblemDetails | null>(null);
|
||||
// Where the rows came from, until the next load replaces it.
|
||||
const [loaded, setLoaded] = useState<(RulesAnswer & { repo: string }) | null>(
|
||||
null,
|
||||
);
|
||||
const [confirmLoad, setConfirmLoad] = useState(false);
|
||||
|
||||
const [opening, setOpening] = useState(false);
|
||||
const [opened, setOpened] = useState<
|
||||
(OpenPrAnswer & { repo: string }) | null
|
||||
>(null);
|
||||
const [openError, setOpenError] = useState<ProblemDetails | null>(null);
|
||||
|
||||
// What the two fields offer to complete to. The fields stay free text, so a
|
||||
// repo or a PR the lists lack, a merged one say, can still be typed.
|
||||
const [repoChoices, setRepoChoices] = useState<string[]>([]);
|
||||
const [repoChoicesError, setRepoChoicesError] =
|
||||
useState<ProblemDetails | null>(null);
|
||||
const [pulls, setPulls] = useState<OpenPull[]>([]);
|
||||
const [pullsError, setPullsError] = useState<ProblemDetails | null>(null);
|
||||
|
||||
const running = starting || runId !== null;
|
||||
|
||||
// Folded until wanted. What was typed survives a fold, and so does a run's
|
||||
// result, which sits under the form rather than in it.
|
||||
const [open, setOpen] = useState(false);
|
||||
|
||||
// The repos with an open PR, read once when the page opens.
|
||||
useEffect(() => {
|
||||
let cancelled = false;
|
||||
void (async () => {
|
||||
try {
|
||||
const res = await fetch(PULL_REPOS);
|
||||
if (cancelled) return;
|
||||
if (!res.ok) {
|
||||
setRepoChoicesError(await readApiError(res));
|
||||
return;
|
||||
}
|
||||
setRepoChoices((await res.json()) as string[]);
|
||||
} catch (e: unknown) {
|
||||
if (!cancelled) setRepoChoicesError({ detail: String(e) });
|
||||
}
|
||||
})();
|
||||
return () => {
|
||||
cancelled = true;
|
||||
};
|
||||
}, []);
|
||||
|
||||
// The open PRs of the repo once it is typed or picked and has stopped
|
||||
// changing. A repo that is not valid yet has no list.
|
||||
useEffect(() => {
|
||||
setPulls([]);
|
||||
setPullsError(null);
|
||||
const target = repo.trim();
|
||||
if (repoProblem(target) !== null) return;
|
||||
let cancelled = false;
|
||||
const timer = setTimeout(() => {
|
||||
void (async () => {
|
||||
try {
|
||||
const res = await fetch(
|
||||
`${PULLS}?repo=${encodeURIComponent(target)}`,
|
||||
);
|
||||
if (cancelled) return;
|
||||
if (!res.ok) {
|
||||
setPullsError(await readApiError(res));
|
||||
return;
|
||||
}
|
||||
setPulls((await res.json()) as OpenPull[]);
|
||||
} catch (e: unknown) {
|
||||
if (!cancelled) setPullsError({ detail: String(e) });
|
||||
}
|
||||
})();
|
||||
}, PICK_DELAY_MS);
|
||||
return () => {
|
||||
cancelled = true;
|
||||
clearTimeout(timer);
|
||||
};
|
||||
}, [repo]);
|
||||
|
||||
useEffect(() => {
|
||||
if (!running) return;
|
||||
setElapsed(0);
|
||||
const t = setInterval(() => setElapsed((s) => s + 1), 1000);
|
||||
return () => clearInterval(t);
|
||||
}, [running]);
|
||||
|
||||
// Polls the run until it leaves `running`. Cancelled by the next run, or by
|
||||
// leaving the page.
|
||||
useEffect(() => {
|
||||
if (runId === null) return;
|
||||
let cancelled = false;
|
||||
let timer: ReturnType<typeof setTimeout> | undefined;
|
||||
const stop = (problem: ProblemDetails) => {
|
||||
setError(problem);
|
||||
setRunId(null);
|
||||
};
|
||||
async function poll() {
|
||||
try {
|
||||
const res = await fetch(
|
||||
`${TRY_OUT}/${encodeURIComponent(runId ?? "")}`,
|
||||
);
|
||||
if (cancelled) return;
|
||||
if (res.status === 404) {
|
||||
stop({
|
||||
detail:
|
||||
"the result is gone, because it expired or the controller restarted: run it again",
|
||||
});
|
||||
return;
|
||||
}
|
||||
if (!res.ok) {
|
||||
const problem = await readApiError(res);
|
||||
if (!cancelled) stop(problem);
|
||||
return;
|
||||
}
|
||||
const body = (await res.json()) as Result;
|
||||
if (cancelled) return;
|
||||
setResult(body);
|
||||
if (body.state === "running")
|
||||
timer = setTimeout(() => void poll(), POLL_MS);
|
||||
else setRunId(null);
|
||||
} catch (e: unknown) {
|
||||
if (!cancelled) stop({ detail: String(e) });
|
||||
}
|
||||
}
|
||||
void poll();
|
||||
return () => {
|
||||
cancelled = true;
|
||||
if (timer !== undefined) clearTimeout(timer);
|
||||
};
|
||||
}, [runId]);
|
||||
|
||||
const openPrProblem = rowsProblem(repo, drafts);
|
||||
const problem = runProblem(repo, pr, drafts);
|
||||
|
||||
async function run(e: Event) {
|
||||
e.preventDefault();
|
||||
const number = prNumber(pr);
|
||||
if (problem !== null || number === null) return;
|
||||
setStarting(true);
|
||||
setError(null);
|
||||
setResult(null);
|
||||
try {
|
||||
const res = await fetch(TRY_OUT, {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
repo: repo.trim(),
|
||||
pr: number,
|
||||
classifications: drafts.map(toBody),
|
||||
}),
|
||||
});
|
||||
if (!res.ok) {
|
||||
setError(await readApiError(res));
|
||||
return;
|
||||
}
|
||||
setRunId(((await res.json()) as { id: string }).id);
|
||||
} catch (err: unknown) {
|
||||
setError({ detail: String(err) });
|
||||
} finally {
|
||||
setStarting(false);
|
||||
}
|
||||
}
|
||||
|
||||
// Reads the repo's rules from its default branch into the rows. A failed
|
||||
// load leaves the rows as they were.
|
||||
async function loadRules() {
|
||||
const target = repo.trim();
|
||||
setConfirmLoad(false);
|
||||
setLoadingRules(true);
|
||||
setRulesError(null);
|
||||
try {
|
||||
const res = await fetch(`${RULES}?repo=${encodeURIComponent(target)}`);
|
||||
if (!res.ok) {
|
||||
setRulesError(await readApiError(res));
|
||||
return;
|
||||
}
|
||||
const answer = (await res.json()) as RulesAnswer;
|
||||
setDrafts(answer.classifications.map((c) => draftFromRule(c, nextKey++)));
|
||||
setLoaded({ ...answer, repo: target });
|
||||
} catch (err: unknown) {
|
||||
setRulesError({ detail: String(err) });
|
||||
} finally {
|
||||
setLoadingRules(false);
|
||||
}
|
||||
}
|
||||
|
||||
// Pushes the rows on a new branch of the repo and keeps the link to open
|
||||
// the PR from it.
|
||||
async function openPr() {
|
||||
const target = repo.trim();
|
||||
setOpening(true);
|
||||
setOpened(null);
|
||||
setOpenError(null);
|
||||
try {
|
||||
const res = await fetch(OPEN_PR, {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
repo: target,
|
||||
classifications: drafts.map(toBody),
|
||||
}),
|
||||
});
|
||||
if (!res.ok) {
|
||||
setOpenError(await readApiError(res));
|
||||
return;
|
||||
}
|
||||
setOpened({ ...((await res.json()) as OpenPrAnswer), repo: target });
|
||||
} catch (err: unknown) {
|
||||
setOpenError({ detail: String(err) });
|
||||
} finally {
|
||||
setOpening(false);
|
||||
}
|
||||
}
|
||||
|
||||
// Typed rows are the operator's work, so replacing them is asked first.
|
||||
function askLoadRules() {
|
||||
if (hasTypedText(drafts)) setConfirmLoad(true);
|
||||
else void loadRules();
|
||||
}
|
||||
|
||||
function changeDraft(next: ClassificationDraft) {
|
||||
setDrafts((ds) => ds.map((d) => (d.key === next.key ? next : d)));
|
||||
}
|
||||
|
||||
return (
|
||||
<div class="ui-tryout-page">
|
||||
<Disclosure
|
||||
title="try a classification"
|
||||
icon="🧪"
|
||||
hint="run one on a real PR before it goes into a repo's rules"
|
||||
open={open}
|
||||
onToggle={setOpen}
|
||||
>
|
||||
<p>
|
||||
Run a review classification against a real PR and see how the model
|
||||
answers it. A run posts nothing to the forge, and nothing is saved:
|
||||
change the classification and run it again until it answers the way
|
||||
you want. Then open a PR to add it to the repo's rules.
|
||||
</p>
|
||||
<form class="ui-tryout-form" onSubmit={(e) => void run(e)}>
|
||||
<div class="ui-tryout-target">
|
||||
<TextField
|
||||
id="tryout-repo"
|
||||
label="repo"
|
||||
value={repo}
|
||||
placeholder="owner/name"
|
||||
onInput={setRepo}
|
||||
suggestions={repoChoices.map((value) => ({ value }))}
|
||||
/>
|
||||
<TextField
|
||||
id="tryout-pr"
|
||||
label="PR number"
|
||||
value={pr}
|
||||
pattern="[0-9]+"
|
||||
onInput={setPr}
|
||||
suggestions={pulls.map((p) => ({
|
||||
value: String(p.number),
|
||||
label: p.title,
|
||||
}))}
|
||||
/>
|
||||
<Button
|
||||
onClick={askLoadRules}
|
||||
disabled={loadingRules || running || repoProblem(repo) !== null}
|
||||
>
|
||||
{loadingRules ? "loading…" : "load the repo's rules"}
|
||||
</Button>
|
||||
</div>
|
||||
{repoChoicesError ? (
|
||||
<ApiErrorPanel
|
||||
context="the repos with an open PR could not be listed"
|
||||
problem={repoChoicesError}
|
||||
/>
|
||||
) : null}
|
||||
{pullsError ? (
|
||||
<ApiErrorPanel
|
||||
context="the repo's open PRs could not be listed"
|
||||
problem={pullsError}
|
||||
/>
|
||||
) : null}
|
||||
{rulesError ? (
|
||||
<ApiErrorPanel
|
||||
context="the repo's rules could not be loaded"
|
||||
problem={rulesError}
|
||||
/>
|
||||
) : null}
|
||||
{loaded ? (
|
||||
<p class="ui-tryout-loaded">
|
||||
Loaded {loaded.classifications.length} from{" "}
|
||||
<code>{loaded.path}</code> on <code>{loaded.branch}</code> of{" "}
|
||||
{loaded.repo}, read at commit{" "}
|
||||
<code>{loaded.commit.slice(0, 12)}</code>. Edit them below, then
|
||||
run.
|
||||
</p>
|
||||
) : null}
|
||||
{drafts.map((d) => (
|
||||
<ClassificationEditor
|
||||
key={d.key}
|
||||
draft={d}
|
||||
onChange={changeDraft}
|
||||
onRemove={
|
||||
drafts.length > 1
|
||||
? () => setDrafts((ds) => ds.filter((x) => x.key !== d.key))
|
||||
: undefined
|
||||
}
|
||||
/>
|
||||
))}
|
||||
<div class="ui-tryout-actions">
|
||||
<Button
|
||||
onClick={() => setDrafts((ds) => [...ds, blankDraft()])}
|
||||
disabled={drafts.length >= MAX_CLASSIFICATIONS}
|
||||
>
|
||||
add a classification
|
||||
</Button>
|
||||
<Button
|
||||
variant="primary"
|
||||
type="submit"
|
||||
disabled={running || problem !== null}
|
||||
>
|
||||
{running ? "running…" : "run"}
|
||||
</Button>
|
||||
<Button
|
||||
onClick={() => void openPr()}
|
||||
disabled={opening || openPrProblem !== null}
|
||||
>
|
||||
{opening ? "pushing…" : "open a PR"}
|
||||
</Button>
|
||||
</div>
|
||||
{problem !== null ? <p class="ui-tryout-hint">{problem}</p> : null}
|
||||
{openError ? (
|
||||
<ApiErrorPanel
|
||||
context="the branch for the PR could not be pushed"
|
||||
problem={openError}
|
||||
/>
|
||||
) : null}
|
||||
{opened ? (
|
||||
<p class="ui-tryout-loaded">
|
||||
Pushed <code>{opened.branch}</code> to {opened.repo}, changing{" "}
|
||||
<code>{opened.path}</code> with you as the author.{" "}
|
||||
<a href={opened.compare_url} target="_blank" rel="noopener">
|
||||
Open the PR on the forge
|
||||
</a>
|
||||
.
|
||||
</p>
|
||||
) : null}
|
||||
</form>
|
||||
</Disclosure>
|
||||
<ConfirmDialog
|
||||
open={confirmLoad}
|
||||
label="replace the classifications"
|
||||
confirmLabel="replace them"
|
||||
onCancel={() => setConfirmLoad(false)}
|
||||
onConfirm={() => void loadRules()}
|
||||
>
|
||||
<p>
|
||||
Loading the rules of {repo.trim()} replaces the classifications you
|
||||
have written below.
|
||||
</p>
|
||||
</ConfirmDialog>
|
||||
{running || result || error ? (
|
||||
<Panel title="result" icon="📋">
|
||||
{running ? (
|
||||
<p class="ui-tryout-running" role="status">
|
||||
Running — a run takes a minute or more, and up to half an hour for
|
||||
a long list ({elapsed}s so far).
|
||||
</p>
|
||||
) : null}
|
||||
{error ? (
|
||||
<ApiErrorPanel context="the try-out failed" problem={error} />
|
||||
) : null}
|
||||
{result?.state === "failed" ? (
|
||||
<ApiErrorPanel
|
||||
context="the run failed"
|
||||
problem={{
|
||||
title: "the classifier could not finish",
|
||||
detail: result.error ?? "no reason given",
|
||||
}}
|
||||
/>
|
||||
) : null}
|
||||
{result?.state === "done" ? <TryOutResult result={result} /> : null}
|
||||
</Panel>
|
||||
) : null}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
Loading…
Reference in a new issue