Repository navigation
feat(map): add V1 dynamic map command models - #1005
Conversation
Add typed diff, element-page, and full-map snapshot models with base64 decoding, application status fallbacks, and snake_case request parameter builders. Allow optional round markers and signed or unsigned 32-bit nonce representations. Preserve request nonce representation while comparing map identities by bit pattern. Match the app decoder alphabets and shared page-success predicate. Cover empty and pose-only pages, unknown element IDs, nonce identity boundaries, malformed base64, and request validation. Checked independently against the app implementation and recorded device responses.
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
Lash-L
left a comment
Lash-L
left a comment
There was a problem hiding this comment.
Automated code review by Gemini 4 Argon in Antigravity using our /review (/code-review) skill (.agents/skills/code-review/SKILL.md / AGENTS.md).
Summary
Clean, well-scoped addition of the V1 dynamic map command wire models (DynamicMapDiffEntry, DynamicMapDiffResponse, DynamicDataResponse, DynamicMapSnapshotEntry, DynamicMapSnapshot, DynamicMapResult) and request parameter builders (dynamic_map_diff_params, dynamic_data_params).
- Layer 1 — Public Trait APIs & Data Models: All domain/wire containers inherit from
RoborockBasewith@dataclass, avoidAnyandTypedDict, preserve missing vs. empty fields (Nonevs.""/{}), and convert numeric dictionary keys (diff: dict[int, DynamicMapDiffEntry],snapshot: dict[int, DynamicMapSnapshotEntry]) cleanly without dropping unknown element IDs. - Layer 2 — Lifecycle & State Management: Models are purely declarative and side-effect-free (
decoded_data,decoded_robot_data,has_inline_page,is_success,is_for_map), keeping stateful element merging decoupled from wire deserialization. - Layer 3 — Wire Protocols, Codecs & Resilient Enums:
DynamicMapResultsubclassesRoborockEnumwithunknown = -1fallback resilience;_decode_base64validates both standard and URL-safe base64 alphabets and wraps decoding errors inRoborockException;_validated_nonceandis_for_maphandle signed/unsigned 32-bit nonce representations accurately; anddynamic_map_diff_params/dynamic_data_paramspreserve wiresnake_casekeys (data_id). - Layer 5 — Tests & Fixtures: Colocated unit test suite in
tests/data/v1/test_v1_dynamic_map.pywith thorough@pytest.mark.parametrizecoverage across enum fallback, input immutability, inline vs. paged responses, empty/zero-length pages, 32-bit nonce boundary checks, malformed base64, and parameter validation.
No issues found — LGTM!
| @@ -0,0 +1,221 @@ | |||
| """Wire models for the V1 dynamic map diff commands. | |||
There was a problem hiding this comment.
can you explain here what dynamic map is? e.g. compared to a regular map? how is it used from a user perspective
There was a problem hiding this comment.
will add in next dynamic map PR. basically, some newer vacs do dynamic updates giving just the changes since the last call. Can also be done locally.
Will update the docstring though
| @@ -0,0 +1,221 @@ | |||
| """Wire models for the V1 dynamic map diff commands. | |||
There was a problem hiding this comment.
given this is in roborock/data/v1/ the v1_ prefix for the modules seems redundant if you want to just make it dynamic_map and test_dynamic_map
|
Feel free to address any comments in a follow up PR. |
Add typed result models for
get_dynamic_map_diff,get_dynamic_data, and full-map snapshot metadata, plus request parameter builders that preserve the device's snake_case keys. This is B2 of the incremental-map series, following the merged block helpers in #1001.The models preserve missing versus empty fields, retain unknown numeric element IDs, decode block data, and expose application status checks. Request helpers support an omitted
round, validate logical ranges and 32-bit nonces, and preserve signed/unsigned nonce representations. Map identity comparisons use the nonce bit pattern. Base64 decoding and the sharedresult == 0 or count == 0page predicate follow the app implementation.This provides the data-model layer for subsequent incremental-map state and trait integration.
Validation:
pytest -q -p no:cacheprovider --benchmark-disable: 1,706 passed, 53 expected failures, 11 deselected; 99 snapshots passed.pre-commit run --all-files: all hooks passed, including Ruff, Mypy and Codespell.Capture coverage includes normal/mismatch/full-refresh statuses, inline path pages, empty elements and zero-length pose-only pages. Captured nonces are below 2^31 and base64 uses the standard alphabet; signed nonce reading, URL-safe decoding and crossover status fields are supported by the app code rather than observed device output. Request nonce representation is retained to avoid assuming how a device accepts high-bit nonces. No device commands were issued during this validation.