Repository Public
1"use client";2import Link from "next/link";3import { useRouter } from "next/navigation";4import { createContext, useCallback, useContext, useMemo, useRef, useState, type ReactNode } from "react";5import { apiPost, type Schemas } from "@/api/client";6import { ApiError } from "@/api/errors";7import { useApiQuery } from "@/api/query";8import { useI18n, type I18n, type TKey } from "@/i18n";9import { IdempotencyIntent } from "@/lib/idempotency";10import { initialValues, schemaToFields, validateForm, type FieldError, type FormValues } from "@/lib/schemaForm";11import { useSession } from "@/shell/session";12import { Badge, Banner, Button, Checkbox, Dialog, ErrorState, Icon, KeyValue, SchemaForm, Skeleton, TextAreaField, TextField, Tooltip, criticalityTone, useToast, type ButtonProps, type IconName } from "@/ui";1314type ActionType = Schemas["ActionType"];15type Action = Schemas["Action"];1617export interface ActionRequest {18 type: string;19 target: Schemas["ActionTarget"];20 /** Human name of the target shown in the dialog (node alias, service name). Display only. */21 targetLabel: string;22 /** Pre-filled parameters (still editable unless `lockParams`). */23 params?: Record<string, unknown>;24 lockParams?: boolean;25 /** Stay on the current screen after submission instead of opening the live action view. */26 stay?: boolean;27 onCreated?: (action: Action) => void;28}2930const Ctx = createContext<((r: ActionRequest) => void) | null>(null);3132/** `const launch = useActionLauncher(); launch({ type: "service.restart", target, targetLabel })` */33export function useActionLauncher(): (r: ActionRequest) => void {34 const v = useContext(Ctx);35 if (!v) throw new Error("useActionLauncher outside ActionFlowProvider");36 return v;37}3839export function useActionTypes() {40 const { can } = useSession();41 return useApiQuery("/action-types", undefined, { enabled: can("actions.read"), staleTime: 5 * 60_000 });42}4344const KNOWN_TYPES = new Set(["inventory.refresh", "diagnostic.run", "service.health_check", "service.logs.tail", "service.restart", "service.start", "service.stop", "agent.restart", "cache.purge", "node.maintenance.set", "job.run", "job.cancel", "model.server.start", "model.server.stop", "deploy.release", "system.update.schedule", "system.reboot", "system.shutdown"]);4546/** Localised title of an action type; a type this client does not know yet keeps the title given by the catalog. */47export function actionTitle(t: I18n["t"], type: { type: string; title?: string }): string {48 return KNOWN_TYPES.has(type.type) ? t(`actions.types.${type.type.replace(/\./g, "_")}` as TKey) : (type.title ?? type.type);49}5051/** Permission the server will require for a type: the declared one, plus the criticality tier. */52export function requiredPermissions(type: ActionType): string[] {53 return [...new Set([type.permission, `actions.run.${type.criticality}`, ...(type.extra_permissions ?? [])])];54}5556export function ActionFlowProvider({ children }: { children: ReactNode }) {57 const [request, setRequest] = useState<ActionRequest | null>(null);58 const launch = useCallback((r: ActionRequest) => setRequest(r), []);59 return (60 <Ctx.Provider value={launch}>61 {children}62 {request ? <ActionDialog key={`${request.type}:${request.target.id}`} request={request} onClose={() => setRequest(null)} /> : null}63 </Ctx.Provider>64 );65}6667function ActionDialog({ request, onClose }: { request: ActionRequest; onClose: () => void }) {68 const { t, fmt } = useI18n();69 const router = useRouter();70 const toast = useToast();71 const session = useSession();72 const types = useActionTypes();73 const type = types.data?.items.find((x) => x.type === request.type);74 const fields = useMemo(() => schemaToFields(type?.params_schema), [type]);75 const [values, setValues] = useState<FormValues | null>(null);76 const [justification, setJustification] = useState("");77 const [confirm, setConfirm] = useState("");78 const [fieldErrors, setFieldErrors] = useState<FieldError[]>([]);79 const [missing, setMissing] = useState<{ justification?: boolean; confirm?: boolean }>({});80 const [busy, setBusy] = useState(false);81 const [failure, setFailure] = useState<ApiError | null>(null);82 // offered only after the server refused because the node is in maintenance: an explicit, audited override83 const [override, setOverride] = useState(false);84 const [maintenanceRefused, setMaintenanceRefused] = useState(false);85 const intent = useRef(new IdempotencyIntent());8687 const current = values ?? { ...initialValues(fields), ...request.params };88 const lacking = type ? requiredPermissions(type).filter((p) => !session.can(p)) : [];8990 const submit = async () => {91 if (!type) return;92 const result = validateForm(fields, current);93 const need = { justification: type.requires_justification && justification.trim() === "", confirm: type.requires_confirmation && confirm.trim() === "" };94 setFieldErrors(result.errors);95 setMissing(need);96 if (result.errors.length > 0 || need.justification || need.confirm) return;97 const body: Schemas["CreateActionRequest"] = {98 type: type.type,99 target: request.target,100 ...(Object.keys(result.params).length > 0 ? { params: result.params } : {}),101 ...(justification.trim() ? { justification: justification.trim() } : {}),102 // the server compares `confirm` with the alias of the target; the UI only collects what was typed103 ...(type.requires_confirmation ? { confirm: confirm.trim() } : {}),104 override_maintenance: override,105 };106 setBusy(true);107 setFailure(null);108 try {109 const action = await apiPost("/actions", { body, headers: { "Idempotency-Key": intent.current.keyFor(body) } });110 intent.current.complete();111 toast({ tone: action.state === "pending_approval" ? "info" : "ok", title: action.state === "pending_approval" ? t("actions.toast.pendingApproval") : t("actions.toast.created", { title: actionTitle(t, type) }) });112 request.onCreated?.(action);113 onClose();114 if (!request.stay) router.push(`/actions/${action.id}`);115 } catch (e) {116 setBusy(false);117 if (e instanceof ApiError && e.code === "node_in_maintenance") setMaintenanceRefused(true);118 setFailure(e instanceof ApiError ? e : new ApiError({ status: 0, code: "network", message: "network" }));119 }120 };121122 const title = type ? actionTitle(t, type) : request.type;123 return (124 <Dialog125 open126 onClose={onClose}127 title={title}128 description={type?.description}129 size="wide"130 dismissable={!busy}131 footer={132 <>133 <Button onClick={onClose} disabled={busy}>{t("common.cancel")}</Button>134 <Button variant={type && (type.criticality === "high" || type.criticality === "critical") ? "danger" : "primary"} onClick={() => void submit()} loading={busy} disabled={!type || !type.available} data-testid="action-submit">135 {type?.requires_approval ? t("actions.submitForApproval") : t("actions.submit")}136 </Button>137 </>138 }139 >140 {types.isLoading ? <div className="stack" role="status" aria-label={t("common.loading")}><Skeleton width="60" /><Skeleton width="80" /></div> : null}141 {types.isError ? <ErrorState error={types.error} onRetry={() => void types.refetch()} compact /> : null}142 {types.data && !type ? <Banner tone="warning" role="alert">{t("actions.unknownType", { type: request.type })}</Banner> : null}143 {type ? (144 <>145 <KeyValue146 items={[147 { label: t("actions.target"), value: <span className="mono" data-testid="action-target">{request.targetLabel}</span> },148 { label: t("actions.criticality"), value: <Badge tone={criticalityTone(type.criticality)}>{t(`states.criticality.${type.criticality}`)}</Badge> },149 { label: t("actions.type"), value: <span className="mono">{type.type}</span> },150 { label: t("actions.timeout"), value: fmt.duration(type.timeout_s) },151 ]}152 />153 {!type.available ? <Banner tone="offline" role="alert">{t("actions.unavailable")} {type.unavailable_reason ?? ""}</Banner> : null}154 {lacking.length > 0 ? <Banner tone="warning">{t("actions.lacking", { permissions: lacking.join(", ") })}</Banner> : null}155 <section className="stack-sm" aria-label={t("actions.requirements.title")}>156 <h3>{t("actions.requirements.title")}</h3>157 <ul className="stack-sm muted">158 <Requirement on icon="check" text={t("actions.requirements.prechecks")} />159 <Requirement on={type.requires_step_up} icon="passkey" text={t("actions.requirements.stepUp")} />160 <Requirement on={type.requires_justification} icon="note" text={t("actions.requirements.justification")} />161 <Requirement on={type.requires_confirmation} icon="edit" text={t("actions.requirements.confirmation")} />162 <Requirement on={type.requires_approval} icon="users" text={t("actions.requirements.approval")} />163 <Requirement on={type.lock_scope !== "none"} icon="lock" text={t("actions.requirements.lock", { scope: t(`actions.lock.${type.lock_scope}`) })} />164 </ul>165 </section>166 {fields.length > 0 ? (167 <section className="stack-sm" aria-label={t("actions.params")}>168 <h3>{t("actions.params")}</h3>169 <SchemaForm schema={type.params_schema} values={current} onChange={setValues} errors={fieldErrors} disabled={busy || !!request.lockParams} />170 </section>171 ) : null}172 <TextAreaField173 label={t("actions.justification")}174 hint={type.requires_justification ? t("actions.justificationRequired") : t("actions.justificationOptional")}175 required={type.requires_justification}176 value={justification}177 onChange={setJustification}178 maxLength={500}179 disabled={busy}180 error={missing.justification ? t("ui.schema.required", { limit: "" }) : undefined}181 />182 {type.requires_confirmation ? (183 <TextField184 label={t("actions.confirmLabel")}185 hint={t("actions.confirmHint", { target: request.targetLabel })}186 required187 mono188 value={confirm}189 onChange={setConfirm}190 autoComplete="off"191 autoCapitalize="none"192 spellCheck={false}193 disabled={busy}194 error={missing.confirm ? t("ui.schema.required", { limit: "" }) : undefined}195 data-testid="action-confirm"196 />197 ) : null}198 {failure ? <ActionFailure error={failure} /> : null}199 {maintenanceRefused ? <Checkbox checked={override} onChange={setOverride} disabled={busy} label={t("actions.overrideMaintenance")} hint={t("actions.overrideMaintenanceHint")} /> : null}200 </>201 ) : null}202 </Dialog>203 );204}205206function Requirement({ on, icon, text }: { on: boolean; icon: IconName; text: string }) {207 if (!on) return null;208 return <li className="row"><Icon name={icon} size={14} />{text}</li>;209}210211/** Explains a refused action using the contract's error codes. */212export function ActionFailure({ error }: { error: ApiError }) {213 const { t } = useI18n();214 const known = ["precheck_failed", "confirmation_mismatch", "justification_required", "agent_offline", "capability_missing", "node_in_maintenance", "action_unavailable", "target_locked", "idempotency_conflict", "orchestrator_frozen", "forbidden", "step_up_required", "not_implemented", "network", "validation_failed", "rate_limited"] as const;215 const code = (known as readonly string[]).includes(error.code) ? (error.code as (typeof known)[number]) : null;216 const check = typeof error.details?.check === "string" ? error.details.check : undefined;217 const holder = typeof error.details?.action_id === "string" ? error.details.action_id : undefined;218 return (219 <Banner tone={error.status === 422 || error.status === 409 ? "warning" : "critical"} role="alert">220 <span data-testid="action-error" data-code={error.code}>221 <strong>{code ? t(`actions.error.${code}`) : t("errors.requestFailed")}</strong>222 {check ? <> — <span className="mono">{check}</span></> : null}223 {error.missingPermission ? <> — <span className="mono">{error.missingPermission}</span></> : null}224 {!code || code === "precheck_failed" || code === "validation_failed" ? <> {error.message}</> : null}225 {holder ? <> <Link href={`/actions/${holder}`}>{t("actions.error.viewHolder")}</Link></> : null}226 </span>227 {error.correlationId ? <div className="faint mono">{t("errors.reference", { id: error.correlationId })}</div> : null}228 </Banner>229 );230}231232/**233 * Button that opens the action flow. It is disabled (with the reason) when GET /me shows the permission is missing234 * or the catalog says the type is unavailable; the server re-checks everything on submission.235 */236export function ActionButton({ request, children, icon, variant, size }: { request: ActionRequest; children: ReactNode; icon?: IconName; variant?: ButtonProps["variant"]; size?: ButtonProps["size"] }) {237 const { t } = useI18n();238 const launch = useActionLauncher();239 const session = useSession();240 const types = useActionTypes();241 const type = types.data?.items.find((x) => x.type === request.type);242 const lacking = type ? requiredPermissions(type).filter((p) => !session.can(p)) : [];243 const reason = !session.can("actions.read") ? t("actions.disabled.noRead")244 : types.isError ? (types.error.notImplemented ? t("actions.disabled.notAvailable") : t("actions.disabled.catalogError"))245 : types.data && !type ? t("actions.disabled.unknown")246 : type && !type.available ? `${t("actions.unavailable")} ${type.unavailable_reason ?? ""}`.trim()247 : lacking.length > 0 ? t("actions.lacking", { permissions: lacking.join(", ") })248 : null;249 const button = (250 <Button {...(icon ? { icon } : {})} {...(variant ? { variant } : {})} {...(size ? { size } : {})} disabled={reason !== null || types.isLoading} onClick={() => launch(request)} data-action-type={request.type}>251 {children}252 </Button>253 );254 return reason ? <Tooltip content={reason} focusable>{button}</Tooltip> : button;255}256