docs: stop asserting DagView/NodeView after their deletion
The deletion PR removed the types but left ~10 sites still describing
them. Two are real breakage rather than staleness: rustdoc intra-doc
links to deleted items ([NodeView::kind] and [Self::snapshot] in
job_queue/mod.rs). Neither clippy --all-targets -D warnings nor cargo
test resolves intra-doc links, so the tree was green with both already
dangling.
The rest reassert facts the deletion made false: docs/coordinator.md
documented the event as RebuildQueueChanged { seq, queue: [DagView...] }
with a per-node field list, and three sites pointed at the removed
/api/state.rebuild_queue endpoint.
One is pointer rot rather than a rename, and no grep for a deleted name
finds it: SchedulesChanged justified itself as "same snapshot-shape
rationale as RebuildQueueChanged" -- which the deletion turned into the
one event that is not a snapshot. Repointed at TombstonesChanged /
MetaInputsChanged, in both the Rust doc and the dashboard doc.
Two are pre-existing and strictly out of scope, swept under the
pfadfinderregel because the same grep surfaced them: hive-sh4re/README
advertised a jobs module that crate has not had since the host-sock
split, and hive-host-sock/README claimed its own payload types live in
hive-sh4re.
Docs and comments only -- no behaviour, no API, no test changes.
This commit is contained in:
parent
f707c60f90
commit
730c923a97
10 changed files with 67 additions and 47 deletions
|
|
@ -635,10 +635,14 @@ impl Coordinator {
|
|||
}
|
||||
}
|
||||
|
||||
/// Emit a `RebuildQueueChanged` snapshot event. Called from the
|
||||
/// queue mutation helpers (`enqueue` / `finish` / `cancel`-adjacent
|
||||
/// wrappers below) and the worker so every state transition
|
||||
/// surfaces on the dashboard without extra plumbing.
|
||||
/// Emit a `RebuildQueueChanged` tick. Called from the queue mutation
|
||||
/// helpers (`enqueue` / `finish` / `cancel`-adjacent wrappers below) and
|
||||
/// the worker so every state transition surfaces on the dashboard without
|
||||
/// extra plumbing.
|
||||
///
|
||||
/// Carries no queue payload — clients refetch `/api/jobq/graph`. The name
|
||||
/// keeps `snapshot` because *that* is still what a client ends up with;
|
||||
/// what changed is who serves it.
|
||||
pub fn emit_rebuild_queue_snapshot(self: &Arc<Self>) {
|
||||
self.emit_dashboard_event(DashboardEvent::RebuildQueueChanged {
|
||||
seq: self.next_seq(),
|
||||
|
|
|
|||
|
|
@ -136,7 +136,7 @@ pub(super) async fn get_build_log_full(
|
|||
///
|
||||
/// Same `BuildLogFull` JSON (`stdout` / `stderr` + header) as
|
||||
/// `get_build_log_full`; HTTP 404 when the node has no linked log (the
|
||||
/// client gates the request on `NodeView.build_log_id`, but a vacuum
|
||||
/// client gates the request on the wire node's `build_log_id`, but a vacuum
|
||||
/// race can still 404). This is the on-demand live-log-panel fetch,
|
||||
/// distinct from the `build_log_id` on the wire — that id is for
|
||||
/// deep-linking to the BUILD L0GS tab's full history view, not for
|
||||
|
|
|
|||
|
|
@ -233,7 +233,8 @@ pub enum DashboardEvent {
|
|||
/// Full snapshot of all scheduled prompts. Emitted after every
|
||||
/// operator mutation (new / edit / cancel / fire-now) and after the
|
||||
/// worker fires or rearms a row. Same snapshot-shape rationale as
|
||||
/// `RebuildQueueChanged` — the list is small and the client's
|
||||
/// `TombstonesChanged` / `MetaInputsChanged` — the list is small and the
|
||||
/// client's
|
||||
/// per-target `last_result` / `last_fired_at_unix` fields are most
|
||||
/// naturally re-derived from the full list.
|
||||
SchedulesChanged {
|
||||
|
|
|
|||
|
|
@ -308,9 +308,10 @@ impl JobQueue {
|
|||
/// so both are running and both name `a`. Anything keying this set by agent
|
||||
/// alone will silently drop one — see [`super::scheduler`].
|
||||
///
|
||||
/// `label` is the node's own wire tag ([`NodeKind::as_str`]), the vocabulary
|
||||
/// [`NodeView::kind`] already ships, so a pill and a DAG node name an
|
||||
/// operation identically. `takes_container_down` is the crash watcher's
|
||||
/// `label` is the node's own wire tag ([`NodeKind::as_str`]), the same
|
||||
/// vocabulary the graph wire ships as a node's label, so a pill and a
|
||||
/// graph node name an operation identically. `takes_container_down` is the
|
||||
/// crash watcher's
|
||||
/// input and does **not** ride the wire to the frontend — a `Start` pill and
|
||||
/// a `Stop` pill are both pills; only one means a vanished container is
|
||||
/// expected.
|
||||
|
|
@ -381,10 +382,10 @@ impl JobQueue {
|
|||
|
||||
/// One or more nodes plus their live subtrees, as generic wire nodes —
|
||||
/// the `QueueNodes` polling surface behind `hivectl`'s wait/progress
|
||||
/// loop. Sibling of [`Self::snapshot`] (which serves the same graph
|
||||
/// through the typed `DagView`/`NodeView` projection for the
|
||||
/// dashboard's `/api/state.rebuild_queue`), this one goes through
|
||||
/// [`GraphWire::wire_snapshot`] instead — no `Done`-node filtering, no
|
||||
/// loop. Goes through [`GraphWire::wire_snapshot`] — the same projection
|
||||
/// [`Self::graph_snapshot`] serves the dashboard with, differing only in
|
||||
/// *which* nodes it selects (caller-named ids and their subtrees, rather
|
||||
/// than every visible root). No `Done`-node filtering, no
|
||||
/// roll-up field (a node's own `state` answers that, see
|
||||
/// `hive_jobq_wire`'s doc comment). Looks each id up by identity
|
||||
/// alone — no assumption that it names a DAG container or a root;
|
||||
|
|
|
|||
|
|
@ -322,7 +322,8 @@ impl hive_jobq_wire::WireNode for NodeKind {
|
|||
}
|
||||
|
||||
impl NodeKind {
|
||||
/// Wire string for `NodeView.kind`.
|
||||
/// Wire string for the node's label on the graph wire
|
||||
/// ([`hive_jobq_wire::WireNode::label`]).
|
||||
pub fn as_str(&self) -> &'static str {
|
||||
match self {
|
||||
NodeKind::MetaSync { .. } => "meta_sync",
|
||||
|
|
|
|||
Loading…
Reference in a new issue