Draft
Conversation
This commit introduces support for `NodeInfoBatch` messages, allowing the application to receive and process multiple node records efficiently during the second stage of the device handshake. This replaces the legacy approach of sending node information individually, improving synchronization performance.
Key changes include:
- **Handshake Protocol:**
- Added `BATCH_NODE_INFO_NONCE` to `HandshakeConstants`.
- Updated `MeshConnectionManagerImpl` to request batched node information by default during the handshake process.
- Updated `MeshConfigFlowManagerImpl` to handle the batch-specific completion nonce, ensuring Stage 2 of the handshake finalizes correctly.
- **Packet Handling:**
- Enhanced `FromRadioPacketHandlerImpl` to detect `node_info_batch` packets.
- Implemented logic to iterate through batched items and process each `NodeInfo` record via the `MeshConfigFlowManager`.
- Updated connection progress reporting to reflect the count of nodes received within a batch.
- **Testing and Simulation:**
- Updated `MockInterface` to simulate batched node delivery, refactoring the mock response logic into distinct Stage 1 (config) and Stage 2 (node info) phases.
- Added a unit test in `FromRadioPacketHandlerImplTest` to verify that batched items are correctly routed and that the UI connection status is updated.
Specific changes:
- Modified `HandshakeConstants` to document the transition to batched NodeInfo delivery in Stage 2.
- Updated `MeshConnectionManagerImpl.startNodeInfoOnly()` to use the new batch nonce.
- Added `nodeInfoBatch` processing branch to the `handleFromRadio` logic.
This commit optimizes the mesh handshake protocol by introducing explicit support for `NodeInfoBatch` messages. It updates the configuration flow to handle both primary batched node delivery and legacy single-node delivery for backwards compatibility with older firmware.
Key changes include:
- **Batch Processing Optimization:**
- Added `handleNodeInfoBatch` to the `MeshConfigFlowManager` interface to allow bulk processing of node information, reducing per-item overhead during the initial handshake.
- Updated `MeshConfigFlowManagerImpl` to accumulate batched nodes efficiently using `addAll`.
- Refactored `FromRadioPacketHandlerImpl` to delegate batch processing directly to the manager instead of iterating through individual items.
- **Handshake Protocol Updates:**
- Updated `HandshakeConstants` to distinguish between `BATCH_NODE_INFO_NONCE` (primary Stage 2) and `NODE_INFO_NONCE` (legacy Stage 2).
- Modified `handleConfigComplete` logic to trigger Stage 2 completion for both batched and legacy nonces.
- Ensured `MeshConnectionManager` prioritizes the batch nonce when requesting node information.
- **Testing & Simulation:**
- Created `MeshConfigFlowManagerImplTest` to validate node accumulation, batch handling, and handshake nonce routing.
- Improved `MockInterface` to better simulate real-world packet ordering by delaying live traffic until after the handshake completion coroutine has processed the node database.
- Added verification tests to ensure the connection manager uses the correct batching nonces.
Specific changes:
- Added `handleNodeInfoBatch` implementation to `MeshConfigFlowManagerImpl`.
- Updated documentation in `HandshakeConstants` regarding two-stage mesh handshake protocol.
- Refactored `MockInterface.sendStage2NodeInfoResponse` to handle packet encoding and simulation delays.
- Added unit tests covering edge cases for empty and mixed node info batches.
jamesarich
force-pushed
the
feat/batch-nodeinfos
branch
from
aa6d47b to
a74d5d4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds support for batch processing of node information, improving the efficiency and reliability of node info synchronization in the mesh network. The changes update the handshake to use a new batch nonce, introduce handling for
NodeInfoBatchmessages, and include comprehensive tests for both batch and legacy flows.Batch node info handling and handshake updates:
NodeInfoBatchinFromRadioPacketHandlerImpl, routing it to the newhandleNodeInfoBatchmethod and updating connection progress accordingly. [1] [2]MeshConfigFlowManagerImplto accumulate nodes from batches, handle both legacy and batch nonces for config completion, and provide a newhandleNodeInfoBatchmethod for bulk node addition. [1] [2] [3]MeshConnectionManagerImplso thatstartNodeInfoOnlynow requests the batch node info nonce (BATCH_NODE_INFO_NONCE) instead of the legacy one.Testing improvements:
MeshConfigFlowManagerImplTestcovering batch and legacy node info flows, nonce handling, and edge cases like empty batches.FromRadioPacketHandlerImplTestto verify correct handling and status updates when receiving aNodeInfoBatch. [1] [2]MeshConnectionManagerImplTestto check thatstartNodeInfoOnlyuses the correct batch nonce and to clean up redundant code. [1] [2] [3] [4]Mock and utility updates: