Spaces:
Sleeping
Sleeping
File size: 8,130 Bytes
7596726 | 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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | //! SSE payload serialization for retained solver lifecycle events.
//!
//! `SolverService` owns job orchestration; this module owns the exact JSON shape
//! that the stock browser controller consumes over the `/events` stream and
//! during reconnect bootstrap.
use serde::Serialize;
use std::time::Duration;
use solverforge::{
HardSoftDecimalScore, SolverEventMetadata, SolverLifecycleState, SolverSnapshot, SolverStatus,
SolverTelemetry, SolverTerminalReason,
};
use crate::api::PlanDto;
use crate::domain::Plan;
/// UI-facing telemetry shape derived from exact runtime telemetry.
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct TelemetryPayload {
elapsed_ms: u64,
step_count: u64,
moves_generated: u64,
moves_evaluated: u64,
moves_accepted: u64,
score_calculations: u64,
generation_ms: u64,
evaluation_ms: u64,
moves_per_second: u64,
acceptance_rate: f64,
}
/// One serialized lifecycle event sent over SSE.
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct JobEventPayload {
id: String,
job_id: String,
event_type: &'static str,
event_sequence: u64,
lifecycle_state: &'static str,
terminal_reason: Option<&'static str>,
telemetry: TelemetryPayload,
current_score: Option<String>,
best_score: Option<String>,
snapshot_revision: Option<u64>,
solution: Option<PlanDto>,
error: Option<String>,
}
/// Builds the synthetic event used when a client asks for current job state.
pub(super) fn status_event_payload(
job_id: usize,
event_type: &'static str,
status: &SolverStatus<HardSoftDecimalScore>,
) -> String {
serialize_payload(JobEventPayload {
id: job_id.to_string(),
job_id: job_id.to_string(),
event_type,
event_sequence: status.event_sequence,
lifecycle_state: lifecycle_state_label(status.lifecycle_state),
terminal_reason: status.terminal_reason.map(terminal_reason_label),
telemetry: telemetry_payload(&status.telemetry),
current_score: status.current_score.map(|score| score.to_string()),
best_score: status.best_score.map(|score| score.to_string()),
snapshot_revision: status.latest_snapshot_revision,
solution: None,
error: None,
})
}
/// Builds a reconnect bootstrap event from current runtime status plus snapshot content.
pub(super) fn snapshot_status_event_payload(
job_id: usize,
event_type: &'static str,
status: &SolverStatus<HardSoftDecimalScore>,
snapshot: &SolverSnapshot<Plan>,
) -> String {
serialize_payload(JobEventPayload {
id: job_id.to_string(),
job_id: job_id.to_string(),
event_type,
event_sequence: status.event_sequence,
lifecycle_state: lifecycle_state_label(status.lifecycle_state),
terminal_reason: status.terminal_reason.map(terminal_reason_label),
telemetry: telemetry_payload(&status.telemetry),
current_score: status
.current_score
.or(snapshot.current_score)
.map(|score| score.to_string()),
best_score: status
.best_score
.or(snapshot.best_score)
.map(|score| score.to_string()),
snapshot_revision: Some(snapshot.snapshot_revision),
solution: Some(PlanDto::from_plan(&snapshot.solution)),
error: None,
})
}
/// Chooses the bootstrap event name that best matches the current lifecycle state.
pub(super) fn bootstrap_event_type(state: SolverLifecycleState) -> &'static str {
match state {
SolverLifecycleState::Solving => "progress",
SolverLifecycleState::PauseRequested => "pause_requested",
SolverLifecycleState::Paused => "paused",
SolverLifecycleState::Completed => "completed",
SolverLifecycleState::Cancelled => "cancelled",
SolverLifecycleState::Failed => "failed",
}
}
/// Reconnecting to a live job with a retained snapshot should render that snapshot first.
pub(super) fn bootstrap_snapshot_event_type(state: SolverLifecycleState) -> &'static str {
match state {
SolverLifecycleState::Solving => "best_solution",
other => bootstrap_event_type(other),
}
}
/// Converts one stock runtime event into the transport payload consumed by the UI.
pub(super) fn event_payload(
job_id: usize,
event_type: &'static str,
metadata: &SolverEventMetadata<HardSoftDecimalScore>,
solution: Option<&Plan>,
error: Option<&str>,
) -> String {
serialize_payload(JobEventPayload {
id: job_id.to_string(),
job_id: job_id.to_string(),
event_type,
event_sequence: metadata.event_sequence,
lifecycle_state: lifecycle_state_label(metadata.lifecycle_state),
terminal_reason: metadata.terminal_reason.map(terminal_reason_label),
telemetry: telemetry_payload(&metadata.telemetry),
current_score: metadata.current_score.map(|score| score.to_string()),
best_score: metadata.best_score.map(|score| score.to_string()),
snapshot_revision: metadata.snapshot_revision,
solution: solution.map(PlanDto::from_plan),
error: error.map(ToOwned::to_owned),
})
}
/// Centralizes JSON serialization so every event payload uses one encoding path.
fn serialize_payload(payload: JobEventPayload) -> String {
serde_json::to_string(&payload).expect("failed to serialize solver lifecycle payload")
}
/// Derives the browser telemetry summary from exact runtime telemetry.
fn telemetry_payload(telemetry: &SolverTelemetry) -> TelemetryPayload {
TelemetryPayload {
elapsed_ms: duration_to_millis(telemetry.elapsed),
step_count: telemetry.step_count,
moves_generated: telemetry.moves_generated,
moves_evaluated: telemetry.moves_evaluated,
moves_accepted: telemetry.moves_accepted,
score_calculations: telemetry.score_calculations,
generation_ms: duration_to_millis(telemetry.generation_time),
evaluation_ms: duration_to_millis(telemetry.evaluation_time),
moves_per_second: whole_units_per_second(telemetry.moves_evaluated, telemetry.elapsed),
acceptance_rate: derive_acceptance_rate(
telemetry.moves_accepted,
telemetry.moves_evaluated,
),
}
}
/// Keeps lifecycle labels aligned with the stock runtime enums.
fn lifecycle_state_label(state: SolverLifecycleState) -> &'static str {
match state {
SolverLifecycleState::Solving => "SOLVING",
SolverLifecycleState::PauseRequested => "PAUSE_REQUESTED",
SolverLifecycleState::Paused => "PAUSED",
SolverLifecycleState::Completed => "COMPLETED",
SolverLifecycleState::Cancelled => "CANCELLED",
SolverLifecycleState::Failed => "FAILED",
}
}
/// Keeps terminal-reason labels aligned with the stock runtime enums.
fn terminal_reason_label(reason: SolverTerminalReason) -> &'static str {
match reason {
SolverTerminalReason::Completed => "completed",
SolverTerminalReason::TerminatedByConfig => "terminated_by_config",
SolverTerminalReason::Cancelled => "cancelled",
SolverTerminalReason::Failed => "failed",
}
}
/// Converts a duration into the millisecond integer used by the UI.
fn duration_to_millis(duration: Duration) -> u64 {
duration.as_millis().min(u128::from(u64::MAX)) as u64
}
/// Reports whole evaluated moves per second for display in the status bar.
fn whole_units_per_second(count: u64, elapsed: Duration) -> u64 {
let nanos = elapsed.as_nanos();
if nanos == 0 {
0
} else {
let per_second = u128::from(count)
.saturating_mul(1_000_000_000)
.checked_div(nanos)
.unwrap_or(0);
per_second.min(u128::from(u64::MAX)) as u64
}
}
/// Reports acceptance as a display-ready fraction rather than a percentage string.
fn derive_acceptance_rate(moves_accepted: u64, moves_evaluated: u64) -> f64 {
if moves_evaluated == 0 {
0.0
} else {
moves_accepted as f64 / moves_evaluated as f64
}
}
#[cfg(test)]
mod tests;
|