+ ${escapeHtml(message)}
+ ${retryButton}
+
`);
+ if (focus) {
+ holder.querySelector(retry ? '.urgent-refresh' : '.urgent-action-error')?.focus();
+ }
+ }
+
+ function showUrgentActionError(message) {
+ pendingUrgentActionError = message;
+ if (!urgentModalIsOpen()) return;
+ const holder = document.getElementById('urgentListContainer');
+ if (!holder) return;
+ clearUrgentBusyState(holder);
+ renderUrgentWarning(holder, message, { focus: true });
+ pendingUrgentActionError = null;
+ }
+
+ function attachPendingUrgentActionError(holder) {
+ if (!pendingUrgentActionError || !urgentModalIsOpen() || !holder) return;
+ renderUrgentWarning(holder, pendingUrgentActionError);
+ pendingUrgentActionError = null;
+ }
+
+ function showUrgentRetryState(message) {
+ pendingUrgentRetryMessage = message;
+ const holder = document.getElementById('urgentListContainer');
+ if (!holder || !urgentModalIsOpen()) return;
+ pendingUrgentRetryMessage = null;
+ setClearControlsDisabled(true);
+ clearUrgentBusyState(holder);
+ holder.innerHTML = '';
+ renderUrgentWarning(holder, message, { focus: true, retry: true });
+ $(holder).off('click').on('click', '.urgent-refresh', function (e) {
+ e.preventDefault();
+ showModal();
+ });
+ }
+
+ function showPendingUrgentRetryState() {
+ if (!pendingUrgentRetryMessage || !urgentModalIsOpen()) return false;
+ showUrgentRetryState(pendingUrgentRetryMessage);
+ return true;
+ }
+
+ function urgentModalIsOpen() {
+ return document.getElementById('urgentModal')?.classList.contains('show') === true;
+ }
+
+ function focusUrgentModalFallback() {
+ const modalEl = document.getElementById('urgentModal');
+ if (!modalEl || !urgentModalIsOpen()) return;
+ modalEl
+ .querySelector('.urgent-clear:not(:disabled), #urgentClearAll:not(:disabled), .btn-close:not(:disabled), [data-bs-dismiss="modal"]:not(:disabled)')
+ ?.focus();
+ }
+
+ function refreshUrgentIssues() {
+ showModal();
+ poll();
+ }
+
+ function completeClearAction() {
+ urgentClearState = null;
+ setClearControlsDisabled(clearActionInFlight());
+ refreshUrgentIssues();
+ }
+
+ function startUrgentClear({
+ responseEvent,
+ requestPayload,
+ busyMessage,
+ failureMessage,
+ timeoutMessage,
+ }) {
+ if (clearActionBlocked()) {
+ return;
+ }
+ const requestId = ++urgentRequestId;
+ setClearControlsDisabled(true);
+ showUrgentBusyState(busyMessage);
+ urgentClearState = {
+ busyMessage,
+ cancel: null,
+ };
+ urgentClearState.cancel = listenWsOnceMatchingWithTimeout(
+ wsClient,
+ responseEvent,
+ URGENT_ISSUES_TIMEOUT_MS,
+ (msg) => msg.request_id === requestId,
+ (msg) => {
+ urgentClearState = null;
+ if (msg && msg.ok === false) {
+ setClearControlsDisabled(false);
+ showUrgentActionError(failureMessage);
+ return;
+ }
+ completeClearAction();
+ },
+ () => {
+ urgentClearState = null;
+ setClearControlsDisabled(false);
+ showUrgentActionError(timeoutMessage);
+ }
+ );
+ wsClient.send(requestPayload(requestId));
}
function showModal() {
const modalEl = document.getElementById('urgentModal');
- if (!modalEl) return;
- new bootstrap.Modal(modalEl, { focus: true }).show();
+ if (!modalEl) {
+ return;
+ }
+ bootstrap.Modal.getOrCreateInstance(modalEl, { focus: true }).show();
const holder = document.getElementById('urgentListContainer');
- if (!holder) return;
- holder.innerHTML = `No urgent issues.
';
- return;
- }
- const table = document.createElement('table');
- table.className = 'lqos-table lqos-table-compact mb-0';
- const tbody = document.createElement('tbody');
- items.forEach((it) => {
- const tr = document.createElement('tr');
- const td = document.createElement('td');
- const when = new Date(it.ts * 1000).toLocaleString();
- const sev = it.severity === 'Error' ? 'danger' : 'warning';
- const clearControl = it.clearable === false
- ? 'No urgent issues.
';
+ attachPendingUrgentActionError(holder);
+ setClearControlsDisabled(true);
+ holder.querySelector('[role="status"]')?.focus();
+ return;
+ }
+ const table = document.createElement('table');
+ table.className = 'lqos-table lqos-table-compact mb-0';
+ const tbody = document.createElement('tbody');
+ items.forEach((it) => {
+ const tr = document.createElement('tr');
+ const td = document.createElement('td');
+ const when = new Date(it.ts * 1000).toLocaleString();
+ const sev = it.severity === 'Error' ? 'danger' : 'warning';
+ const clearControl = it.clearable === false
+ ? '
${it.severity}
${it.code}
@@ -1173,26 +1379,44 @@ function initUrgentIssues() {
${it.message}
${it.context ? `
${it.context}` : ''}
`;
- tr.appendChild(td);
- tbody.appendChild(tr);
- });
- table.appendChild(tbody);
- holder.innerHTML = '';
- const tableWrap = document.createElement('div');
- tableWrap.className = 'table-responsive lqos-table-wrap';
- tableWrap.appendChild(table);
- holder.appendChild(tableWrap);
- $(holder).off('click').on('click', '.urgent-clear', function (e) {
- e.preventDefault();
- const id = $(this).data('id');
- listenOnce("UrgentClearResult", () => {
- showModal();
- poll();
+ tr.appendChild(td);
+ tbody.appendChild(tr);
});
- wsClient.send({ UrgentClear: { id } });
- });
- });
- wsClient.send({ UrgentList: {} });
+ table.appendChild(tbody);
+ holder.innerHTML = '';
+ const tableWrap = document.createElement('div');
+ tableWrap.className = 'table-responsive lqos-table-wrap';
+ tableWrap.appendChild(table);
+ holder.appendChild(tableWrap);
+ attachPendingUrgentActionError(holder);
+ $(holder).off('click').on('click', '.urgent-clear', function (e) {
+ e.preventDefault();
+ const id = $(this).data('id');
+ startUrgentClear({
+ responseEvent: 'UrgentClearResult',
+ requestPayload: (requestId) => ({ UrgentClear: { id, request_id: requestId } }),
+ busyMessage: 'Acknowledging urgent issue...',
+ failureMessage: 'Unable to acknowledge urgent issue.',
+ timeoutMessage: 'Timed out while acknowledging urgent issue.',
+ });
+ });
+ setClearControlsDisabled(clearActionInFlight());
+ focusUrgentModalFallback();
+ },
+ () => {
+ if (urgentListActiveRequestId !== requestId) return;
+ urgentListPending = false;
+ urgentListActiveRequestId = null;
+ urgentListCancel = null;
+ if (!urgentModalIsOpen()) {
+ setClearControlsDisabled(clearActionInFlight());
+ return;
+ }
+ showUrgentRetryState('Unable to refresh urgent issues.');
+ setClearControlsDisabled(true);
+ }
+ );
+ wsClient.send({ UrgentList: { request_id: requestId } });
}
if (!document.getElementById(containerId)) {
@@ -1206,11 +1430,31 @@ function initUrgentIssues() {
}
$(document).off('click', '#urgentClearAll').on('click', '#urgentClearAll', () => {
- listenOnce("UrgentClearAllResult", () => {
- showModal();
- poll();
+ startUrgentClear({
+ responseEvent: 'UrgentClearAllResult',
+ requestPayload: (requestId) => ({ UrgentClearAll: { request_id: requestId } }),
+ busyMessage: 'Acknowledging urgent issues...',
+ failureMessage: 'Unable to acknowledge urgent issues.',
+ timeoutMessage: 'Timed out while acknowledging urgent issues.',
});
- wsClient.send({ UrgentClearAll: {} });
+ });
+
+ $(document).off('hidden.bs.modal', '#urgentModal').on('hidden.bs.modal', '#urgentModal', () => {
+ pendingUrgentRetryMessage = null;
+ if (urgentClearState?.cancel) {
+ urgentClearState.cancel();
+ urgentClearState = null;
+ }
+ if (urgentListPending) {
+ if (urgentListCancel) {
+ urgentListCancel();
+ urgentListCancel = null;
+ }
+ urgentListPending = false;
+ urgentListActiveRequestId = null;
+ }
+ clearUrgentBusyState();
+ setClearControlsDisabled(clearActionInFlight());
});
poll();
diff --git a/src/rust/lqosd/src/node_manager/js_build/test-node-manager.sh b/src/rust/lqosd/src/node_manager/js_build/test-node-manager.sh
index 5d093180..20456c61 100755
--- a/src/rust/lqosd/src/node_manager/js_build/test-node-manager.sh
+++ b/src/rust/lqosd/src/node_manager/js_build/test-node-manager.sh
@@ -9,7 +9,9 @@ if ! command -v node >/dev/null 2>&1; then
fi
echo "[test-node-manager] Running frontend contract tests..."
-node --test "${SCRIPT_DIR}/src/config/shaped_device_wire.test.mjs"
+node --test \
+ "${SCRIPT_DIR}/src/config/shaped_device_wire.test.mjs" \
+ "${SCRIPT_DIR}/src/pubsub/ws.test.mjs"
echo "[test-node-manager] Building bundles..."
"${SCRIPT_DIR}/esbuild.sh"
diff --git a/src/rust/lqosd/src/node_manager/ws.rs b/src/rust/lqosd/src/node_manager/ws.rs
index 6b5bb6eb..02766378 100644
--- a/src/rust/lqosd/src/node_manager/ws.rs
+++ b/src/rust/lqosd/src/node_manager/ws.rs
@@ -676,32 +676,37 @@ async fn receive_channel_message(
return true;
}
}
- WsRequest::UrgentStatus => {
+ WsRequest::UrgentStatus { request_id } => {
let response = WsResponse::UrgentStatus {
data: urgent::urgent_status_data(),
+ request_id,
};
if send_ws_response(&tx, response).await {
return true;
}
}
- WsRequest::UrgentList => {
+ WsRequest::UrgentList { request_id } => {
let response = WsResponse::UrgentList {
data: urgent::urgent_list_data(),
+ request_id,
};
if send_ws_response(&tx, response).await {
return true;
}
}
- WsRequest::UrgentClear { id } => {
+ WsRequest::UrgentClear { id, request_id } => {
let ok = urgent::urgent_clear_id(id);
- let response = WsResponse::UrgentClearResult { ok };
+ let response = WsResponse::UrgentClearResult { ok, request_id };
if send_ws_response(&tx, response).await {
return true;
}
}
- WsRequest::UrgentClearAll => {
+ WsRequest::UrgentClearAll { request_id } => {
urgent::urgent_clear_all_data();
- let response = WsResponse::UrgentClearAllResult { ok: true };
+ let response = WsResponse::UrgentClearAllResult {
+ ok: true,
+ request_id,
+ };
if send_ws_response(&tx, response).await {
return true;
}
@@ -2502,7 +2507,9 @@ fn payload_hint(payload: &[u8]) -> &'static str {
#[cfg(test)]
mod tests {
use super::decode_ws_request;
+ use crate::node_manager::local_api::urgent::{UrgentList, UrgentStatus};
use crate::node_manager::ws::messages::WsRequest;
+ use crate::node_manager::ws::messages::{WsResponse, encode_ws_message};
use serde_cbor::Value as CborValue;
use std::collections::BTreeMap;
@@ -2567,6 +2574,163 @@ mod tests {
.expect("valid update payload")
}
+ fn encode_response_value(response: &WsResponse) -> CborValue {
+ let payload = encode_ws_message(response).expect("response should encode");
+ serde_cbor::from_slice(payload.as_ref()).expect("response should decode as CBOR value")
+ }
+
+ fn response_request_id(response: &WsResponse, event_name: &str) -> Option
{
+ let CborValue::Map(entries) = encode_response_value(response) else {
+ panic!("response should encode as a CBOR map");
+ };
+ let event_key = text("event");
+ let request_id_key = text("request_id");
+ assert_eq!(entries.get(&event_key), Some(&text(event_name)));
+ match entries.get(&request_id_key) {
+ Some(CborValue::Integer(value)) => {
+ Some(u64::try_from(*value).expect("request_id is u64"))
+ }
+ Some(other) => panic!("unexpected request_id value: {other:?}"),
+ None => None,
+ }
+ }
+
+ fn response_has_request_id(response: &WsResponse) -> bool {
+ let CborValue::Map(entries) = encode_response_value(response) else {
+ panic!("response should encode as a CBOR map");
+ };
+ entries.contains_key(&text("request_id"))
+ }
+
+ #[test]
+ fn decodes_urgent_status_with_request_id() {
+ let payload = serde_cbor::to_vec(&map(vec![(
+ "UrgentStatus",
+ map(vec![("request_id", integer(42))]),
+ )]))
+ .expect("valid urgent status payload");
+
+ let request = decode_ws_request(&payload).expect("urgent status request should decode");
+ match request {
+ WsRequest::UrgentStatus { request_id } => assert_eq!(request_id, Some(42)),
+ other => panic!("unexpected request: {other:?}"),
+ }
+ }
+
+ #[test]
+ fn decodes_urgent_list_without_request_id() {
+ let payload = serde_cbor::to_vec(&map(vec![("UrgentList", map(vec![]))]))
+ .expect("valid urgent list payload");
+
+ let request = decode_ws_request(&payload).expect("urgent list request should decode");
+ match request {
+ WsRequest::UrgentList { request_id } => assert_eq!(request_id, None),
+ other => panic!("unexpected request: {other:?}"),
+ }
+ }
+
+ #[test]
+ fn decodes_urgent_clear_with_request_id() {
+ let payload = serde_cbor::to_vec(&map(vec![(
+ "UrgentClear",
+ map(vec![("id", integer(7)), ("request_id", integer(42))]),
+ )]))
+ .expect("valid urgent clear payload");
+
+ let request = decode_ws_request(&payload).expect("urgent clear request should decode");
+ match request {
+ WsRequest::UrgentClear { id, request_id } => {
+ assert_eq!(id, 7);
+ assert_eq!(request_id, Some(42));
+ }
+ other => panic!("unexpected request: {other:?}"),
+ }
+ }
+
+ #[test]
+ fn decodes_urgent_clear_all_without_request_id() {
+ let payload = serde_cbor::to_vec(&map(vec![("UrgentClearAll", map(vec![]))]))
+ .expect("valid urgent clear all payload");
+
+ let request = decode_ws_request(&payload).expect("urgent clear all request should decode");
+ match request {
+ WsRequest::UrgentClearAll { request_id } => assert_eq!(request_id, None),
+ other => panic!("unexpected request: {other:?}"),
+ }
+ }
+
+ #[test]
+ fn urgent_responses_echo_request_id() {
+ assert_eq!(
+ response_request_id(
+ &WsResponse::UrgentStatus {
+ data: UrgentStatus {
+ has_urgent: true,
+ count: 1,
+ },
+ request_id: Some(42),
+ },
+ "UrgentStatus",
+ ),
+ Some(42),
+ );
+ assert_eq!(
+ response_request_id(
+ &WsResponse::UrgentList {
+ data: UrgentList { items: Vec::new() },
+ request_id: Some(43),
+ },
+ "UrgentList",
+ ),
+ Some(43),
+ );
+ assert_eq!(
+ response_request_id(
+ &WsResponse::UrgentClearResult {
+ ok: true,
+ request_id: Some(44),
+ },
+ "UrgentClearResult",
+ ),
+ Some(44),
+ );
+ assert_eq!(
+ response_request_id(
+ &WsResponse::UrgentClearAllResult {
+ ok: true,
+ request_id: Some(45),
+ },
+ "UrgentClearAllResult",
+ ),
+ Some(45),
+ );
+ }
+
+ #[test]
+ fn urgent_responses_omit_missing_request_id() {
+ assert!(!response_has_request_id(&WsResponse::UrgentStatus {
+ data: UrgentStatus {
+ has_urgent: false,
+ count: 0,
+ },
+ request_id: None,
+ }));
+ assert!(!response_has_request_id(&WsResponse::UrgentList {
+ data: UrgentList { items: Vec::new() },
+ request_id: None,
+ }));
+ assert!(!response_has_request_id(&WsResponse::UrgentClearResult {
+ ok: true,
+ request_id: None,
+ }));
+ assert!(!response_has_request_id(
+ &WsResponse::UrgentClearAllResult {
+ ok: true,
+ request_id: None,
+ }
+ ));
+ }
+
#[test]
fn decodes_create_shaped_device_with_browser_style_ipv4_bytes() {
let payload = create_shaped_device_payload(device_value(
diff --git a/src/rust/lqosd/src/node_manager/ws/messages.rs b/src/rust/lqosd/src/node_manager/ws/messages.rs
index 37c41c7a..4a851965 100644
--- a/src/rust/lqosd/src/node_manager/ws/messages.rs
+++ b/src/rust/lqosd/src/node_manager/ws/messages.rs
@@ -324,12 +324,19 @@ pub enum WsRequest {
ProtocolFlowTimeline {
protocol: String,
},
- UrgentStatus,
- UrgentList,
+ UrgentStatus {
+ request_id: Option,
+ },
+ UrgentList {
+ request_id: Option,
+ },
UrgentClear {
id: u64,
+ request_id: Option,
+ },
+ UrgentClearAll {
+ request_id: Option,
},
- UrgentClearAll,
UnknownIps,
UnknownIpsClear,
UnknownIpsCsv,
@@ -626,15 +633,23 @@ pub enum WsResponse {
},
UrgentStatus {
data: UrgentStatus,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ request_id: Option,
},
UrgentList {
data: UrgentList,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ request_id: Option,
},
UrgentClearResult {
ok: bool,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ request_id: Option,
},
UrgentClearAllResult {
ok: bool,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ request_id: Option,
},
UnknownIps {
data: Vec,