Merge remote-tracking branch 'fork/phase6/webconfig-batch-seam' into HEAD
# Conflicts: # STABILITY_TESTABILITY_HANDOFF.md
This commit is contained in:
commit
0e7a07afff
9 files changed
+559
-15
No files matched your search
@@ -86,6 +86,35 @@ static inline bool circuitBreakerProbeDue(uint32_t now, uint32_t last_attempt) {
|
||||
return elapsedMs(now, last_attempt) >= kCircuitBreakerProbeMs;
|
||||
}
|
||||
|
||||
// WiFi station reconnect backoff. The bridge drives its own STA reconnect loop
|
||||
// separate from the per-slot MQTT reconnects, with a slightly longer first rung
|
||||
// (15 s vs the slot ladder's 10 s). Extracted from handleWiFiConnection() so the
|
||||
// ladder and its wrap-safe timing are exercised by host tests instead of a
|
||||
// second inline copy of the backoff math.
|
||||
static inline uint32_t wifiReconnectBackoffMs(uint8_t attempt) {
|
||||
static const uint32_t kBackoffMs[] = {
|
||||
15000UL, 30000UL, 60000UL, 120000UL, 300000UL
|
||||
};
|
||||
const uint8_t index = attempt < 5 ? attempt : 4;
|
||||
return kBackoffMs[index];
|
||||
}
|
||||
|
||||
// A reconnect is due only once the link has been down for the current rung AND
|
||||
// no attempt has been made within that rung (both measured wrap-safely). This
|
||||
// mirrors the two-part guard the bridge applied inline.
|
||||
static inline bool wifiReconnectDue(uint32_t now, uint32_t disconnected_since,
|
||||
uint32_t last_attempt, uint8_t attempt) {
|
||||
const uint32_t delay = wifiReconnectBackoffMs(attempt);
|
||||
return elapsedMs(now, disconnected_since) >= delay &&
|
||||
elapsedMs(now, last_attempt) >= delay;
|
||||
}
|
||||
|
||||
// The attempt counter climbs to 5 and then saturates; the index clamp in
|
||||
// wifiReconnectBackoffMs() holds it at the 300 s rung.
|
||||
static inline uint8_t nextWifiBackoffAttempt(uint8_t attempt) {
|
||||
return attempt < 5 ? static_cast<uint8_t>(attempt + 1) : attempt;
|
||||
}
|
||||
|
||||
// Each later slot expires up to five percent of the base lifetime earlier,
|
||||
// capped at five minutes per slot. Runtime slot indexes are bounded by the
|
||||
// persisted MQTT slot count; the final clamp also prevents underflow if this
|
||||
|
||||
@@ -87,6 +87,17 @@ struct RetryDecision {
|
||||
uint32_t next_retry_ms;
|
||||
};
|
||||
|
||||
// A queued packet counts as delivered if EITHER its structured-packet publish
|
||||
// or its raw-frame publish reached at least one slot. Partial success (one
|
||||
// succeeds while the other fails or was not attempted) is still success — the
|
||||
// packet completes and is not retried. This is the (packet, raw) outcome pairing
|
||||
// fed to retryDecision(); naming it keeps the "partial publish = done" contract
|
||||
// explicit and host-tested rather than inline in the bridge's queue drain.
|
||||
static inline bool queuedPacketPublished(bool packet_published,
|
||||
bool raw_published) {
|
||||
return packet_published || raw_published;
|
||||
}
|
||||
|
||||
static inline RetryDecision retryDecision(bool any_published,
|
||||
uint8_t retry_attempts,
|
||||
uint32_t now) {
|
||||
|
||||
@@ -0,0 +1,195 @@
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
// Fork-owned, dependency-free spec for the WebConfig "config batch / reboot /
|
||||
// stop" decision + timing core, plus its host tests (test/test_webconfig_batch/).
|
||||
//
|
||||
// This is the Phase 6 counterpart of MQTTLifecycle.h: a PURE state machine that
|
||||
// captures exactly what src/helpers/esp32/WebConfigServer.cpp decides today, so
|
||||
// the POST-accept / drain / result-read / reboot / stop transitions can be
|
||||
// exercised deterministically without AsyncWebServer, ArduinoJson, WiFi, or the
|
||||
// FreeRTOS mutex/refcount.
|
||||
//
|
||||
// Scope boundary (spec-first, exactly like Phase 4's MQTTLifecycle.h): this
|
||||
// header is the SPEC and the test seam. It is NOT yet wired into
|
||||
// WebConfigServer.cpp. The batch/reboot/stop state machine there is
|
||||
// hardware-tuned (it was debugged against real iOS captive-portal behavior,
|
||||
// HTTP caching, and route ordering), so the production rewiring that makes these
|
||||
// functions load-bearing is a deliberately separate, hardware-validated
|
||||
// follow-up. Until then, keep this in sync with WebConfigServer.cpp by hand; the
|
||||
// file:line references below point at the behavior each function mirrors.
|
||||
//
|
||||
// Behavior source (all line refs against WebConfigServer.{h,cpp} at the time of
|
||||
// writing): constants at .h:90-96,155-161; POST accept at .cpp:610-719; drain at
|
||||
// .cpp:289-334; result read at .cpp:721-791; reboot fire at .cpp:262-265;
|
||||
// isRebootPending at .cpp:70-74; stop gating at .cpp:185-255.
|
||||
namespace WebConfigBatch {
|
||||
|
||||
// Constants, verbatim from WebConfigServer.
|
||||
static const int kMaxBatch = 24; // .h:90 MAX_BATCH
|
||||
static const uint32_t kDrainPacingMs = 25; // .cpp:296 inter-command gap
|
||||
static const uint32_t kRebootFallbackMs = 30000; // .cpp:331 drain-finish fallback
|
||||
static const uint32_t kRebootConfirmMs = 3000; // .cpp:784 first result-read arm
|
||||
static const uint32_t kStopWarnMs = 10000; // .h:95 STOP_WARN_MS
|
||||
|
||||
// The batch lifecycle. A fresh POST moves Idle->Pending; the drainer moves
|
||||
// Pending->Done; Done stays re-readable until the next POST claims the slot;
|
||||
// finalizeTeardown() resets to Idle.
|
||||
enum class State : uint8_t {
|
||||
Idle = 0,
|
||||
Pending,
|
||||
Done,
|
||||
};
|
||||
|
||||
// millis() idioms. elapsedMs uses unsigned wraparound (correct across one 32-bit
|
||||
// rollover). scheduleAt mirrors the production wrap-guard: every _reboot_at /
|
||||
// _stop_warn_at assignment does `if (t == 0) t = 1;` so 0 keeps meaning
|
||||
// "unscheduled" even when the deadline lands exactly on the rollover boundary.
|
||||
static inline uint32_t elapsedMs(uint32_t now, uint32_t then) { return now - then; }
|
||||
static inline uint32_t scheduleAt(uint32_t now, uint32_t delay) {
|
||||
const uint32_t t = now + delay;
|
||||
return t == 0 ? 1u : t;
|
||||
}
|
||||
// Signed wrap-safe "deadline reached", matching the production
|
||||
// `(int32_t)(now - deadline) >= 0` comparisons.
|
||||
static inline bool deadlineReached(uint32_t now, uint32_t deadline) {
|
||||
return (int32_t)(now - deadline) >= 0;
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// POST accept classification (.cpp:637-718). Precedence, verbatim from the
|
||||
// source: an in-flight/finished batch with the SAME reqid is an idempotent
|
||||
// replay (commands are NOT re-applied); a DIFFERENT reqid while a batch is still
|
||||
// PENDING is rejected as busy; otherwise a batch with no changes and no reboot
|
||||
// is a no-op, and anything else is accepted. Note the asymmetry: a different
|
||||
// reqid while DONE is NOT busy — the new batch overwrites the DONE slot.
|
||||
//
|
||||
// Assumes the request already passed reqid grammar (WebConfigKeys::wcIsValidReqId)
|
||||
// and per-key allowlist/secret validation, which are covered by test_webconfig_keys.
|
||||
// --------------------------------------------------------------------------
|
||||
enum class PostOutcome : uint8_t {
|
||||
Replay, // 202; reqid matches the current batch, commands not re-applied
|
||||
Busy, // 409; a different batch is still PENDING
|
||||
Accept, // 202; a new batch is accepted (from Idle, or overwriting a Done slot)
|
||||
NoChanges, // 400; nothing to do (no changes and no reboot requested)
|
||||
};
|
||||
|
||||
static inline PostOutcome classifyPost(State state, bool reqid_matches_current,
|
||||
int change_count, bool reboot_after) {
|
||||
if (state != State::Idle && reqid_matches_current) return PostOutcome::Replay;
|
||||
if (state == State::Pending) return PostOutcome::Busy; // reqid differs (match handled above)
|
||||
if (change_count <= 0 && !reboot_after) return PostOutcome::NoChanges;
|
||||
return PostOutcome::Accept;
|
||||
}
|
||||
|
||||
// The state string a Replay body reports mirrors the batch state (.cpp:640):
|
||||
// "done" when the matched batch already finished, else "pending".
|
||||
static inline const char* replayStateName(State state) {
|
||||
return state == State::Done ? "done" : "pending";
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// Drain (.cpp:289-333). One command per tick.
|
||||
// --------------------------------------------------------------------------
|
||||
|
||||
// The drainer waits only BETWEEN commands: never before the first (batch_next
|
||||
// == 0 runs immediately and fires onConfigBatchStart), never after the last, and
|
||||
// otherwise until the 25 ms pacing gap elapses. The pacing compare is SIGNED to
|
||||
// mirror the source verbatim (.cpp:296 `(int32_t)(now - _batch_last_cmd) < 25`),
|
||||
// matching deadlineReached()'s signedness; for all reachable inputs (elapsed
|
||||
// 0..25 ms) it is identical to the unsigned form.
|
||||
static inline bool drainMustWait(int batch_next, int batch_count,
|
||||
uint32_t now, uint32_t last_cmd_ms) {
|
||||
return batch_next > 0 && batch_next < batch_count &&
|
||||
(int32_t)(now - last_cmd_ms) < (int32_t)kDrainPacingMs;
|
||||
}
|
||||
|
||||
// all_ok is a sticky AND across command replies; a reply counts as ok iff it
|
||||
// begins with "OK" (.cpp:314). Once false it stays false.
|
||||
static inline bool nextAllOk(bool prev_all_ok, bool reply_is_ok) {
|
||||
return prev_all_ok && reply_is_ok;
|
||||
}
|
||||
|
||||
// The batch is finished once the post-increment drain index reaches the count
|
||||
// (.cpp:319-321).
|
||||
static inline bool drainFinished(int batch_next_after_increment, int batch_count) {
|
||||
return batch_next_after_increment >= batch_count;
|
||||
}
|
||||
|
||||
// On finish, a reboot-requested + all-ok batch arms the 30 s fallback deadline;
|
||||
// a partially-failed batch (all_ok == false) never reboots (.cpp:324-333).
|
||||
// Returns the reboot_at deadline, or 0 for "no reboot scheduled".
|
||||
static inline uint32_t finishRebootAt(bool batch_reboot, bool batch_all_ok, uint32_t now) {
|
||||
return (batch_reboot && batch_all_ok) ? scheduleAt(now, kRebootFallbackMs) : 0u;
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// Result read (.cpp:738-786).
|
||||
// --------------------------------------------------------------------------
|
||||
enum class ResultOutcome : uint8_t {
|
||||
Idle, // 200 "idle" — no batch; any valid reqid is echoed
|
||||
Unknown, // 404 — a batch exists but the reqid does not match it
|
||||
Pending, // 200 "pending"
|
||||
Done, // 200 "done" (+ per-command results)
|
||||
};
|
||||
|
||||
static inline ResultOutcome classifyResult(State state, bool reqid_matches_current) {
|
||||
if (state == State::Idle) return ResultOutcome::Idle; // no reqid check while idle
|
||||
if (!reqid_matches_current) return ResultOutcome::Unknown;
|
||||
return state == State::Pending ? ResultOutcome::Pending : ResultOutcome::Done;
|
||||
}
|
||||
|
||||
// The "reboot" flag reported in a Done body (.cpp:767): only a fully-OK,
|
||||
// reboot-requested batch advertises a pending reboot.
|
||||
static inline bool doneReportsReboot(bool batch_reboot, bool batch_all_ok) {
|
||||
return batch_reboot && batch_all_ok;
|
||||
}
|
||||
|
||||
// The first Done read arms the confirmed (3 s) reboot exactly once (.cpp:777-786):
|
||||
// the !already_armed guard makes later reads idempotent, so polling cannot push
|
||||
// the deadline out. When this returns true the caller sets armed = true and
|
||||
// reboot_at = confirmRebootAt(now).
|
||||
static inline bool shouldArmConfirmReboot(State state, bool batch_reboot,
|
||||
bool batch_all_ok, bool already_armed) {
|
||||
return state == State::Done && batch_reboot && batch_all_ok && !already_armed;
|
||||
}
|
||||
static inline uint32_t confirmRebootAt(uint32_t now) {
|
||||
return scheduleAt(now, kRebootConfirmMs);
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// Reboot fire (.cpp:262-265) and isRebootPending (.cpp:70-74).
|
||||
// --------------------------------------------------------------------------
|
||||
static inline bool rebootDue(uint32_t reboot_at, uint32_t now) {
|
||||
return reboot_at != 0 && deadlineReached(now, reboot_at);
|
||||
}
|
||||
|
||||
// isRebootPending() reports true only for a config-save reboot in the Done
|
||||
// state, so the manual /api/reboot path (batch_reboot == false) is deliberately
|
||||
// NOT reported as pending even though _reboot_at is set.
|
||||
static inline bool isConfigRebootPending(uint32_t reboot_at, bool batch_reboot, State state) {
|
||||
return reboot_at != 0 && batch_reboot && state == State::Done;
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// Stop gating (.cpp:244-255). Teardown waits indefinitely for in-flight async
|
||||
// handlers to drain (refs == 0); the STOP_WARN_MS timer only triggers a one-time
|
||||
// diagnostic — it never forces teardown.
|
||||
// --------------------------------------------------------------------------
|
||||
enum class StopAction : uint8_t {
|
||||
Finalize, // refs == 0: finalizeTeardown() may run now
|
||||
Warn, // refs > 0 and the warn deadline passed, not yet warned: log once
|
||||
Wait, // refs > 0: keep the session alive and wait
|
||||
};
|
||||
|
||||
static inline StopAction stopStep(uint32_t handler_refs, bool already_warned,
|
||||
uint32_t stop_warn_at, uint32_t now) {
|
||||
if (handler_refs == 0) return StopAction::Finalize;
|
||||
if (!already_warned && stop_warn_at != 0 && deadlineReached(now, stop_warn_at)) {
|
||||
return StopAction::Warn;
|
||||
}
|
||||
return StopAction::Wait;
|
||||
}
|
||||
|
||||
} // namespace WebConfigBatch
|
||||
@@ -2367,18 +2367,17 @@ bool MQTTBridge::handleWiFiConnection(unsigned long now) {
|
||||
}
|
||||
}
|
||||
} else if (_wifi_disconnected_time > 0) {
|
||||
unsigned long disconnected_duration = now - _wifi_disconnected_time;
|
||||
static const unsigned long WIFI_BACKOFF_MS[] = { 15000, 30000, 60000, 120000, 300000 };
|
||||
unsigned int idx = (_wifi_reconnect_backoff_attempt < 5) ? _wifi_reconnect_backoff_attempt : 4;
|
||||
unsigned long delay_ms = WIFI_BACKOFF_MS[idx];
|
||||
unsigned long elapsed_since_attempt = (now >= _last_wifi_reconnect_attempt)
|
||||
? (now - _last_wifi_reconnect_attempt)
|
||||
: (ULONG_MAX - _last_wifi_reconnect_attempt + now + 1);
|
||||
if (disconnected_duration >= delay_ms && elapsed_since_attempt >= delay_ms) {
|
||||
// Backoff ladder + wrap-safe timing live in MQTTConnectionPolicy (Phase 6),
|
||||
// exercised by host tests. Behavior is unchanged: both the link-down
|
||||
// duration and the since-last-attempt interval must clear the current rung
|
||||
// (elapsedMs is the wrap-safe form of the old ULONG_MAX branch).
|
||||
if (MQTTConnectionPolicy::wifiReconnectDue(
|
||||
(uint32_t)now, (uint32_t)_wifi_disconnected_time,
|
||||
(uint32_t)_last_wifi_reconnect_attempt,
|
||||
_wifi_reconnect_backoff_attempt)) {
|
||||
_last_wifi_reconnect_attempt = now;
|
||||
if (_wifi_reconnect_backoff_attempt < 5) {
|
||||
_wifi_reconnect_backoff_attempt++;
|
||||
}
|
||||
_wifi_reconnect_backoff_attempt =
|
||||
MQTTConnectionPolicy::nextWifiBackoffAttempt(_wifi_reconnect_backoff_attempt);
|
||||
WiFi.disconnect();
|
||||
WiFi.begin(_obs->wifi_ssid, _obs->wifi_password);
|
||||
}
|
||||
@@ -2697,7 +2696,7 @@ void MQTTBridge::processPacketQueue() {
|
||||
raw_published = publishRaw(&queued.packet_copy);
|
||||
}
|
||||
|
||||
bool any_published = packet_published || raw_published;
|
||||
bool any_published = MQTTPacketQueuePolicy::queuedPacketPublished(packet_published, raw_published);
|
||||
const MQTTPacketQueuePolicy::RetryDecision retry =
|
||||
MQTTPacketQueuePolicy::retryDecision(
|
||||
any_published, queued.retry_attempts,
|
||||
@@ -2823,7 +2822,7 @@ void MQTTBridge::processPacketQueue() {
|
||||
raw_published = publishRaw(&queued.packet_copy);
|
||||
}
|
||||
|
||||
bool any_published = packet_published || raw_published;
|
||||
bool any_published = MQTTPacketQueuePolicy::queuedPacketPublished(packet_published, raw_published);
|
||||
const MQTTPacketQueuePolicy::RetryDecision retry =
|
||||
MQTTPacketQueuePolicy::retryDecision(
|
||||
any_published, queued.retry_attempts,
|
||||
|
||||
Reference in new issue
Block a user