File size: 8,961 Bytes
98c8696 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | import { useEffect, useId, useRef, useState } from "react";
import { BodyPortal, useOverlayLayer } from "../customer-grid/OverlaySurface";
import { readWorkbookChecks } from "./sheetApi";
import type { WorkbookCheck, WorkbookCheckRef, WorkbookChecksState } from "./sheetApi";
import type { Workbook } from "./types";
import "../styles/sdlc73/sheet.css";
type DraftCheck = Omit<WorkbookCheck, "id"> & { id?: string };
type SaveChecks = (rules: DraftCheck[], revision: number) => Promise<WorkbookChecksState>;
const comparisons = { equals: "Equals", at_least: "At least", at_most: "At most", within: "Within a tolerance" };
const display = (value: unknown) => value === null || value === undefined ? "Blank" : String(value);
export default function WorkbookChecks({ book, canEdit, busy, onSave }: {
book: Workbook; canEdit: boolean; busy: boolean; onSave: SaveChecks;
}) {
const [open, setOpen] = useState(false);
const [state, setState] = useState<WorkbookChecksState>({ rev: book.rev, checks: [], checkResults: null });
const [error, setError] = useState("");
const [saving, setSaving] = useState(false);
const [loaded, setLoaded] = useState(false);
const [reload, setReload] = useState(0);
const live = useRef(true);
useEffect(() => { live.current = true; return () => { live.current = false; }; }, []);
useEffect(() => {
if (busy || saving) return;
const controller = new AbortController();
let active = true;
void readWorkbookChecks(book.id, controller.signal).then(result => {
if (!active) return;
if (result.ok) { setState(result.value); setLoaded(true); }
else { setLoaded(false); setState({ rev: book.rev, checks: [], checkResults: null }); setError(result.message); }
});
return () => { active = false; controller.abort(); };
}, [book.id, book.rev, busy, saving, reload]);
const save = async (rules: DraftCheck[]) => {
if (busy || saving || !canEdit || !loaded) return;
setSaving(true);
try {
const saved = await onSave(rules, state.rev);
if (live.current) { setState(saved); setError(""); }
} catch (reason) {
if (live.current) setError(reason instanceof Error ? reason.message : "Checks could not be saved.");
} finally {
if (live.current) { setSaving(false); setReload(value => value + 1); }
}
};
const failed = state.checkResults?.results.filter(row => !row.passed).length ?? 0;
const tested = state.checkResults?.results.length ?? 0;
return <>
<button type="button" className="sheet-workbook-checks-trigger" aria-haspopup="dialog"
aria-expanded={open} onClick={() => setOpen(true)}>
{failed ? `${failed} failed` : tested ? `${tested} passed` : "Checks"}
</button>
{open && <ChecksPanel book={book} state={state} error={error} busy={busy || saving || !loaded}
canEdit={canEdit} onSave={save} onClose={() => setOpen(false)} />}
</>;
}
export function ChecksPanel({ book, state, error, busy, canEdit, onSave, onClose }: {
book: Workbook; state: WorkbookChecksState; error: string; busy: boolean; canEdit: boolean;
onSave: (rules: DraftCheck[]) => Promise<void>; onClose: () => void;
}) {
const panelRef = useRef<HTMLDivElement>(null);
const titleId = useId();
const first = book.sheets[0]?.id ?? "";
const [sheetId, setSheetId] = useState(first);
const [address, setAddress] = useState("A1");
const [op, setOp] = useState<WorkbookCheck["op"]>("equals");
const [kind, setKind] = useState("number");
const [expected, setExpected] = useState("0");
const [expectedSheet, setExpectedSheet] = useState(first);
const [tolerance, setTolerance] = useState("0");
const [invalid, setInvalid] = useState("");
useOverlayLayer({ panelRef, onDismiss: onClose, dismissOnOutside: false,
initialFocus: "[data-overlay-autofocus]", restoreFocus: true, trapFocus: true });
const label = (ref: WorkbookCheckRef) => `${book.sheets.find(tab => tab.id === ref.sheetId)?.name ?? "Missing sheet"}!${ref.address}`;
const add = async (event: React.FormEvent) => {
event.preventDefault();
const cellAddress = address.trim().toUpperCase();
if (!/^[A-Z]{1,3}[1-9][0-9]*$/.test(cellAddress)
|| kind === "cell" && !/^[A-Z]{1,3}[1-9][0-9]*$/.test(expected.trim().toUpperCase())
|| kind === "number" && (!expected.trim() || !Number.isFinite(Number(expected)))
|| op === "within" && (!tolerance.trim() || !Number.isFinite(Number(tolerance)) || Number(tolerance) < 0)) {
setInvalid("Enter a valid cell, expected value and tolerance."); return;
}
setInvalid("");
const rule: DraftCheck = { cell: { sheetId, address: cellAddress }, op,
expected: kind === "cell" ? { cell: { sheetId: expectedSheet, address: expected.trim().toUpperCase() } }
: { value: kind === "number" ? Number(expected) : kind === "blank" ? null
: kind === "true" ? true : kind === "false" ? false : expected },
...(op === "within" ? { tolerance: Number(tolerance) } : {}) };
await onSave([...state.checks, rule]);
};
const sheetOptions = book.sheets.map(tab => <option key={tab.id} value={tab.id}>{tab.name}</option>);
return <BodyPortal><div className="lp-dialog-scrim sheet-activity-scrim">
<div ref={panelRef} className="lp-dialog sheet-activity-panel sheet-workbook-checks" role="dialog"
aria-modal="true" aria-labelledby={titleId}>
<div className="lp-dialog-head">
<h2 id={titleId} className="lp-dialog-title">Workbook checks</h2>
<button type="button" className="lp-dialog-btn lp-dialog-btn-quiet" data-overlay-autofocus=""
onClick={onClose}>Close</button>
</div>
<div className="lp-dialog-body sheet-activity-body">
{(error || invalid) && <p role="alert">{error || invalid}</p>}
{state.checkResults && <p className="sheet-activity-detail">Last checked: <time
dateTime={state.checkResults.at}>{new Date(state.checkResults.at).toLocaleString()}</time></p>}
{!state.checks.length && <p className="sheet-activity-detail">No checks saved</p>}
<ol className="sheet-activity-list">
{state.checks.map(rule => {
const result = state.checkResults?.results.find(row => row.rule.id === rule.id);
return <li key={rule.id} className="sheet-activity-write" data-check-state={result ? result.passed ? "passed" : "failed" : "pending"}>
<strong>{label(rule.cell)} · {result ? result.passed ? "Passed" : "Failed" : "Awaiting refresh"}</strong>
<span>{comparisons[rule.op]}{rule.op === "within" ? ` ${rule.tolerance} of` : ""} {"cell" in rule.expected
? label(rule.expected.cell) : display(rule.expected.value)}</span>
{result && <span>Expected {display(result.expected)} · Actual {display(result.actual)}</span>}
{result?.reason && <span className="sheet-activity-detail">{result.reason}</span>}
{canEdit && <button type="button" className="lp-dialog-btn lp-dialog-btn-quiet"
disabled={busy} onClick={() => { void onSave(state.checks.filter(row => row.id !== rule.id)); }}>Remove</button>}
</li>;
})}
</ol>
{canEdit && <form className="sheet-workbook-check-form" onSubmit={add}>
<label>Sheet<select value={sheetId} onChange={event => setSheetId(event.target.value)}>{sheetOptions}</select></label>
<label>Cell<input value={address} onChange={event => setAddress(event.target.value)} required /></label>
<label>Comparison<select value={op} onChange={event => setOp(event.target.value as WorkbookCheck["op"])}>
{Object.entries(comparisons).map(([value, text]) => <option key={value} value={value}>{text}</option>)}
</select></label>
<label>Expected type<select value={kind} onChange={event => { setKind(event.target.value); setExpected(event.target.value === "cell" ? "A1" : "0"); }}>
<option value="number">Number</option><option value="text">Text</option><option value="cell">Cell</option>
<option value="blank">Blank</option><option value="true">True</option><option value="false">False</option>
</select></label>
{kind === "cell" && <label>Expected sheet<select value={expectedSheet}
onChange={event => setExpectedSheet(event.target.value)}>{sheetOptions}</select></label>}
{["cell", "number", "text"].includes(kind) && <label>Expected {kind === "cell" ? "cell" : "value"}<input
value={expected} onChange={event => setExpected(event.target.value)} /></label>}
{op === "within" && <label>Tolerance<input type="number" min="0" step="any"
value={tolerance} onChange={event => setTolerance(event.target.value)} required /></label>}
<button type="submit" className="lp-dialog-btn lp-dialog-btn-primary" disabled={busy}>Save check</button>
</form>}
</div>
</div>
</div></BodyPortal>;
}
|