Alan-Jowett / sonde / 23506101808

82%

push

github

feat(node): add operational logging requirements and implementation (#462)

* feat(node): add operational logging requirements and implementation

Add ND-1000 through ND-1009 requirements for operational logging covering
boot reason, wake cycle transitions, WAKE/COMMAND exchange, PEER_REQUEST/
PEER_ACK events, BPF execution, deep sleep entry, BLE pairing mode, and
error conditions (RNG failure, transport timeout, HMAC mismatch).

Spec changes:
- node-requirements.md: add section 10 (ND-1000–ND-1009) with acceptance
  criteria for each log event
- node-design.md: add section 17 documenting the logging approach using
  the ESP-IDF \log\ crate, log levels, and log points table
- node-validation.md: add section 11 (T-N1000–T-N1010) with test
  procedures for key log events

Code changes (sonde-node crate):
- wake_cycle.rs: add INFO logs for wake cycle start, WAKE frame sent,
  COMMAND received (with command_type), BPF execution (program_hash and
  result), deep sleep entry (duration and reason); add WARN logs for RNG
  health-check failure, WAKE retries exhausted, COMMAND verification failure
- peer_request.rs: add INFO logs for PEER_REQUEST sent and PEER_ACK
  received
- bin/node.rs: add boot reason detection via \sp_reset_reason()\ and
  INFO log distinguishing power-on from deep-sleep wake

Partial fix for #459 (node component)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

* style: fix cargo fmt violations

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Address PR #462 review findings

- Fix ND-1001 requirement text: remove ambiguous `sequence context` phrase
- Fix log-points table: ND-1008 logs are in `bin/node.rs`, not `esp_ble_pairing.rs`
- Log actual error in WAKE failure path instead of discarding with `Err(_)` (ND-1009)
- Use spec-compliant reason strings for deep-sleep log (ND-1007)
- Remove duplicate deep-sleep log from `bin/node.rs` (alrea... (continued)

40 of 55 new or added lines in 2 files covered. (72.73%)

21538 of 25174 relevant lines covered (85.56%)

164.0 hits per line