dohertj2/mxaccessgw
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

clients/rust: SDK methods for AcknowledgeAlarm + QueryActiveAlarms (PR E.6) #110

Merged
dohertj2 merged 1 commits from track-e6-rust-alarm-sdk into main 2026-04-30 17:08:39 -04:00
Conversation 0 Commits 1 Files Changed 3
+149 -7
dohertj2 commented 2026-04-30 17:08:35 -04:00
Owner
Copy Link
Copy Source

Summary

Eleventh PR of the alarms-over-gateway epic (docs/plans/alarms-over-gateway.md). Mirrors PR E.2's .NET surface on the Rust async SDK. Depends on PR E.1 (#105, merged).

  • GatewayClient::acknowledge_alarm — async unary call. Uses the existing unary_request helper (call timeout) and routes failures through Error mapping; non-OK protocol status promotes to Error::ProtocolStatus via ensure_protocol_success.
  • GatewayClient::query_active_alarms — async server-streaming call returning a new ActiveAlarmStream type alias (parallel to EventStream). Errors are pre-mapped from tonic::Status; dropping the stream cancels the call cooperatively.
  • GATEWAY_PROTOCOL_VERSION bumped 2 → 3 to match the .NET contract.
  • FakeGateway test impl extends to satisfy the new trait methods so client_behavior.rs builds. Two new integration tests cover the new SDK methods.

Test plan

  • 12 unit + 10 client_behavior + 4 proto_fixtures = 26 tests, all pass under cargo test
  • cargo build clean (2 pre-existing missing-doc warnings, unrelated to this change)

This closes the per-language Track E SDK work (E.2 .NET → E.6 Rust). E.7 (lmxopcua OPC UA-facing client refresh) is still pending and depends on B.2 + B.3.

## Summary Eleventh PR of the **alarms-over-gateway** epic (docs/plans/alarms-over-gateway.md). Mirrors PR E.2's .NET surface on the Rust async SDK. Depends on PR E.1 (#105, merged). - `GatewayClient::acknowledge_alarm` — async unary call. Uses the existing `unary_request` helper (call timeout) and routes failures through `Error` mapping; non-OK protocol status promotes to `Error::ProtocolStatus` via `ensure_protocol_success`. - `GatewayClient::query_active_alarms` — async server-streaming call returning a new `ActiveAlarmStream` type alias (parallel to `EventStream`). Errors are pre-mapped from `tonic::Status`; dropping the stream cancels the call cooperatively. - `GATEWAY_PROTOCOL_VERSION` bumped 2 → 3 to match the .NET contract. - `FakeGateway` test impl extends to satisfy the new trait methods so `client_behavior.rs` builds. Two new integration tests cover the new SDK methods. ## Test plan - [x] 12 unit + 10 `client_behavior` + 4 `proto_fixtures` = 26 tests, all pass under `cargo test` - [x] `cargo build` clean (2 pre-existing missing-doc warnings, unrelated to this change) This closes the per-language Track E SDK work (E.2 .NET → E.6 Rust). E.7 (lmxopcua OPC UA-facing client refresh) is still pending and depends on B.2 + B.3.
dohertj2 added 1 commit 2026-04-30 17:08:36 -04:00
clients/rust: SDK methods for AcknowledgeAlarm + QueryActiveAlarms (PR E.6) fe19c478c0 
Eleventh PR of the alarms-over-gateway epic
(docs/plans/alarms-over-gateway.md). Mirrors PR E.2's .NET surface
on the Rust async SDK. Depends on PR E.1 (regen, merged).

- GatewayClient::acknowledge_alarm — async unary call. Uses the
  existing unary_request helper (call timeout) and routes failures
  through Error mapping; non-OK protocol status promotes to
  Error::ProtocolStatus via ensure_protocol_success.
- GatewayClient::query_active_alarms — async server-streaming call
  returning a new ActiveAlarmStream type alias (parallel to
  EventStream). Errors are pre-mapped from tonic::Status; dropping
  the stream cancels the call cooperatively.
- GATEWAY_PROTOCOL_VERSION bumped 2 → 3 to match the .NET contract.
- FakeGateway test impl extends to satisfy the new trait methods so
  client_behavior.rs builds. Two new integration tests cover the
  new SDK methods.

Tests:
- 12 unit + 10 client_behavior + 4 proto_fixtures = 26 tests, all
  pass under cargo test (Rust 1.x via existing toolchain).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
dohertj2 merged commit 9ca200f814 into main 2026-04-30 17:08:39 -04:00
dohertj2 deleted branch track-e6-rust-alarm-sdk 2026-04-30 17:08:39 -04:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
area:auth
Authentication and authorization
 area:client-dotnet
.NET client library
 area:client-go
Go client library
 area:client-java
Java client library
 area:client-python
Python client library
 area:client-rust
Rust client library
 area:contracts
Protocol and generated contract work
 area:dashboard
Blazor dashboard work
 area:docs
Documentation
 area:gateway
Gateway server work
 area:tests
Automated and live tests
 area:worker
MXAccess worker process work
 blocked
Blocked by dependency
 priority:p0
Must-have / blocking
 priority:p1
High priority
 priority:p2
Normal priority
 type:docs
Documentation work
 type:feature
Feature implementation
 type:infra
Infrastructure and scaffolding
 type:test
Test work
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
dohertj2 (dohertj2)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: dohertj2/mxaccessgw#110
Delete Branch "track-e6-rust-alarm-sdk"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?