Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| cf20142634 | |||
| b995c174eb | |||
| ac2787f619 | |||
| d543679044 |
@@ -0,0 +1,481 @@
|
|||||||
|
# MXAccess Gateway Agent Guide
|
||||||
|
|
||||||
|
Repository: https://gitea.dohertylan.com/dohertj2/mxaccessgw
|
||||||
|
|
||||||
|
This project builds a gateway that gives modern clients full MXAccess parity
|
||||||
|
without requiring those clients to load MXAccess COM, run as x86, or own an STA
|
||||||
|
message pump. Treat the installed MXAccess COM component as the compatibility
|
||||||
|
baseline.
|
||||||
|
|
||||||
|
Toolchain paths, versions, and external analysis locations are recorded in
|
||||||
|
`docs/toolchain-links.md`. Use that file before searching for compilers,
|
||||||
|
runtimes, protobuf tools, MXAccess notes, or Galaxy Repository SQL notes.
|
||||||
|
|
||||||
|
Implementation planning is recorded in `docs/implementation-plan-index.md`.
|
||||||
|
Follow the order there unless the user explicitly reprioritizes: gateway first,
|
||||||
|
MXAccess worker instance second, clients third.
|
||||||
|
|
||||||
|
## Core Contract
|
||||||
|
|
||||||
|
Preserve MXAccess behavior first:
|
||||||
|
|
||||||
|
- public MXAccess command semantics,
|
||||||
|
- native MXAccess event families,
|
||||||
|
- STA/message-pump delivery behavior,
|
||||||
|
- installed-provider quirks,
|
||||||
|
- HRESULT/status/value marshaling,
|
||||||
|
- per-client isolation.
|
||||||
|
|
||||||
|
Do not simplify, normalize, or "fix" MXAccess behavior unless an explicit
|
||||||
|
non-parity mode is being implemented and tested. `MxAsbClient` and managed NMX
|
||||||
|
are future acceleration paths only; they do not define the parity contract.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
The intended split is:
|
||||||
|
|
||||||
|
```text
|
||||||
|
client
|
||||||
|
-> gRPC over TCP
|
||||||
|
-> .NET 10 x64 gateway
|
||||||
|
-> session manager
|
||||||
|
-> per-session .NET Framework 4.8 x86 worker process
|
||||||
|
-> dedicated STA thread
|
||||||
|
-> MXAccess COM instance
|
||||||
|
-> Windows/COM message pump
|
||||||
|
-> command queue
|
||||||
|
-> event sink
|
||||||
|
```
|
||||||
|
|
||||||
|
The gateway must never instantiate or call MXAccess directly. All MXAccess COM
|
||||||
|
interaction belongs in the worker process on its dedicated STA thread.
|
||||||
|
|
||||||
|
The worker must not host public gRPC. Gateway-to-worker communication should use
|
||||||
|
a small local IPC protocol, with named pipes and protobuf-framed messages as the
|
||||||
|
default design.
|
||||||
|
|
||||||
|
## Runtime Targets
|
||||||
|
|
||||||
|
- Gateway: .NET 10, C#, x64 preferred, ASP.NET Core gRPC.
|
||||||
|
- Worker: .NET Framework 4.8, C#, x86 by default.
|
||||||
|
- Worker IPC: one bidirectional named pipe per worker.
|
||||||
|
- Worker process model: one external client session maps to one worker by
|
||||||
|
default.
|
||||||
|
|
||||||
|
## Style Guides
|
||||||
|
|
||||||
|
Follow the project documentation guide and the language guide for every changed
|
||||||
|
area:
|
||||||
|
|
||||||
|
| Area | Style guide |
|
||||||
|
|------|-------------|
|
||||||
|
| Documentation | `StyleGuide.md` |
|
||||||
|
| Gateway, worker, .NET client, and C# tests | `docs/style-guides/CSharpStyleGuide.md` |
|
||||||
|
| Public gRPC and worker IPC contracts | `docs/style-guides/ProtobufStyleGuide.md` |
|
||||||
|
| Go client | `docs/style-guides/GoStyleGuide.md` |
|
||||||
|
| Rust client | `docs/style-guides/RustStyleGuide.md` |
|
||||||
|
| Python client | `docs/style-guides/PythonStyleGuide.md` |
|
||||||
|
| Java client | `docs/style-guides/JavaStyleGuide.md` |
|
||||||
|
|
||||||
|
When a change crosses languages, apply every affected style guide. Generated
|
||||||
|
code follows its generator output; do not hand-edit it to match handwritten
|
||||||
|
style.
|
||||||
|
|
||||||
|
## Expected Layout
|
||||||
|
|
||||||
|
Prefer this structure unless there is a strong reason to adjust it:
|
||||||
|
|
||||||
|
```text
|
||||||
|
src/MxGateway.Contracts/
|
||||||
|
Protos/
|
||||||
|
mxaccess_gateway.proto
|
||||||
|
mxaccess_worker.proto
|
||||||
|
Generated/
|
||||||
|
|
||||||
|
src/MxGateway.Server/
|
||||||
|
Program.cs
|
||||||
|
Sessions/
|
||||||
|
Workers/
|
||||||
|
Grpc/
|
||||||
|
Dashboard/
|
||||||
|
Metrics/
|
||||||
|
|
||||||
|
src/MxGateway.Worker/
|
||||||
|
Program.cs
|
||||||
|
Ipc/
|
||||||
|
Sta/
|
||||||
|
MxAccess/
|
||||||
|
Conversion/
|
||||||
|
|
||||||
|
src/MxGateway.Tests/
|
||||||
|
contract tests
|
||||||
|
gateway session tests
|
||||||
|
fake worker tests
|
||||||
|
|
||||||
|
src/MxGateway.Worker.Tests/
|
||||||
|
value/status conversion tests
|
||||||
|
STA queue tests
|
||||||
|
|
||||||
|
src/MxGateway.IntegrationTests/
|
||||||
|
optional live MXAccess tests
|
||||||
|
|
||||||
|
clients/dotnet/
|
||||||
|
.NET 10 C# client library, test CLI, and tests
|
||||||
|
|
||||||
|
clients/go/
|
||||||
|
Go client module, test CLI, and tests
|
||||||
|
|
||||||
|
clients/rust/
|
||||||
|
Rust client crate, test CLI, and tests
|
||||||
|
|
||||||
|
clients/python/
|
||||||
|
Python client package, test CLI, and tests
|
||||||
|
|
||||||
|
clients/java/
|
||||||
|
Java client library, test CLI, and tests
|
||||||
|
```
|
||||||
|
|
||||||
|
The contracts project may multi-target, or the `.proto` files may be shared as
|
||||||
|
source inputs to both gateway and worker builds.
|
||||||
|
|
||||||
|
## Public API Shape
|
||||||
|
|
||||||
|
The external API should be session-oriented. Initial rollout should prefer
|
||||||
|
unary `OpenSession`, `CloseSession`, and `Invoke`, plus server-streaming
|
||||||
|
`StreamEvents`. Add a bidirectional `Session` stream after the command and event
|
||||||
|
model is stable.
|
||||||
|
|
||||||
|
Do not compress MXAccess into generic verbs too early. Use a command enum with
|
||||||
|
method-specific payloads so parity can be tested method by method.
|
||||||
|
|
||||||
|
Core MXAccess commands to represent:
|
||||||
|
|
||||||
|
- `Register`
|
||||||
|
- `Unregister`
|
||||||
|
- `AddItem`
|
||||||
|
- `AddItem2`
|
||||||
|
- `RemoveItem`
|
||||||
|
- `Advise`
|
||||||
|
- `UnAdvise`
|
||||||
|
- `AdviseSupervisory`
|
||||||
|
- `AddBufferedItem`
|
||||||
|
- `SetBufferedUpdateInterval`
|
||||||
|
- `Suspend`
|
||||||
|
- `Activate`
|
||||||
|
- `Write`
|
||||||
|
- `Write2`
|
||||||
|
- `WriteSecured`
|
||||||
|
- `WriteSecured2`
|
||||||
|
- `AuthenticateUser`
|
||||||
|
- `ArchestrAUserToId`
|
||||||
|
|
||||||
|
Diagnostics may include `Ping`, `GetSessionState`, `GetWorkerInfo`,
|
||||||
|
`DrainEvents`, and `ShutdownWorker`.
|
||||||
|
|
||||||
|
## Event Requirements
|
||||||
|
|
||||||
|
Represent every public MXAccess event family:
|
||||||
|
|
||||||
|
- `OnDataChange`
|
||||||
|
- `OnWriteComplete`
|
||||||
|
- `OperationComplete`
|
||||||
|
- `OnBufferedDataChange`
|
||||||
|
|
||||||
|
Preserve per-worker event order. The gateway must not reorder events emitted by
|
||||||
|
the same MXAccess instance.
|
||||||
|
|
||||||
|
Event DTOs should carry event family, session id, server handle, item handle,
|
||||||
|
value, quality, timestamp, `MXSTATUS_PROXY[]` equivalent, raw HRESULT/status
|
||||||
|
fields when available, event sequence, worker timestamp, and gateway receive
|
||||||
|
timestamp.
|
||||||
|
|
||||||
|
## Value And Status Rules
|
||||||
|
|
||||||
|
Use a protobuf value union that can represent COM `VARIANT` values and arrays.
|
||||||
|
When a value cannot be losslessly converted, preserve both the best typed
|
||||||
|
projection and enough raw diagnostic metadata to reproduce the case.
|
||||||
|
|
||||||
|
Represent `MXSTATUS_PROXY` explicitly. Do not collapse status arrays into a
|
||||||
|
single success flag.
|
||||||
|
|
||||||
|
Command replies should include protocol status, COM HRESULT if available,
|
||||||
|
MXAccess return values, method-specific out parameters, and status arrays where
|
||||||
|
the MXAccess method emits them.
|
||||||
|
|
||||||
|
## Galaxy Repository SQL Discovery
|
||||||
|
|
||||||
|
Galaxy tags, hierarchy, and attribute details can be queried from the AVEVA /
|
||||||
|
Wonderware System Platform Galaxy Repository SQL Server database. Use this as a
|
||||||
|
discovery and metadata path only; runtime MXAccess parity still belongs to the
|
||||||
|
MXAccess-backed worker unless an explicit non-parity backend is being designed.
|
||||||
|
|
||||||
|
Full notes, schema details, screenshots, and query examples are in:
|
||||||
|
|
||||||
|
```text
|
||||||
|
C:\Users\dohertj2\Desktop\lmxopcua\gr
|
||||||
|
```
|
||||||
|
|
||||||
|
Important files in that notes directory:
|
||||||
|
|
||||||
|
- `connectioninfo.md` - SQL Server connection details and `sqlcmd` usage.
|
||||||
|
- `layout.md` - hierarchy vs `tag_name` relationship.
|
||||||
|
- `build_layout_plan.md` - extraction plan for hierarchy and attributes.
|
||||||
|
- `schema.md` and `ddl/` - Galaxy Repository schema reference.
|
||||||
|
- `queries/hierarchy.sql` - deployed object hierarchy.
|
||||||
|
- `queries/attributes.sql` - user-defined dynamic attributes.
|
||||||
|
- `queries/attributes_extended.sql` - system plus user-defined attributes.
|
||||||
|
- `queries/change_detection.sql` - deployment-change polling via
|
||||||
|
`galaxy.time_of_last_deploy`.
|
||||||
|
|
||||||
|
Current documented connection is SQL Server `localhost`, database `ZB`, Windows
|
||||||
|
Auth. Example:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
sqlcmd -S localhost -d ZB -E -Q "SELECT time_of_last_deploy FROM galaxy;"
|
||||||
|
```
|
||||||
|
|
||||||
|
Key tables from the notes are `gobject`, `template_definition`,
|
||||||
|
`dynamic_attribute`, `attribute_definition`, `primitive_instance`, and
|
||||||
|
`galaxy`. The hierarchy uses contained names for human-readable browsing, while
|
||||||
|
runtime tag references use globally unique `tag_name` values such as
|
||||||
|
`<tag_name>.<AttributeName>`.
|
||||||
|
|
||||||
|
## MXAccess Analysis Source
|
||||||
|
|
||||||
|
Use the local MXAccess analysis project when answering questions about installed
|
||||||
|
MXAccess classes, interfaces, fields, events, HRESULT/status behavior, value
|
||||||
|
projection, captures, and parity gaps:
|
||||||
|
|
||||||
|
```text
|
||||||
|
C:\Users\dohertj2\Desktop\mxaccess
|
||||||
|
```
|
||||||
|
|
||||||
|
Primary files:
|
||||||
|
|
||||||
|
- `README.md` - overview of available analysis and capture artifacts.
|
||||||
|
- `docs/MXAccess-Public-API.md` - COM class, ProgID, CLSID, method list,
|
||||||
|
event signatures, `MxDataType`, `MxStatus`, and `MXSTATUS_PROXY`.
|
||||||
|
- `docs/MXAccess-Reverse-Engineering.md` - installed runtime path and x86 COM
|
||||||
|
constraints.
|
||||||
|
- `docs/Current-Sprint-State.md` and `docs/DotNet10-Native-Library-Plan.md` -
|
||||||
|
current parity gaps and managed native-client research status.
|
||||||
|
- `src/MxTraceHarness/` - x86 MXAccess harness examples using the real COM
|
||||||
|
interop assembly.
|
||||||
|
- `captures/` and `analysis/` - observed native behavior and generated
|
||||||
|
reverse-engineering artifacts.
|
||||||
|
|
||||||
|
Concrete MXAccess COM target from the analysis:
|
||||||
|
|
||||||
|
- class: `ArchestrA.MxAccess.LMXProxyServerClass`
|
||||||
|
- CLSID: `{C30B52F5-2CB5-4760-AF0A-3A344A7EB5DC}`
|
||||||
|
- ProgID: `LMXProxy.LMXProxyServer.1`
|
||||||
|
- version-independent ProgID: `LMXProxy.LMXProxyServer`
|
||||||
|
- registered server: `C:\Program Files (x86)\ArchestrA\Framework\Bin\LmxProxy.dll`
|
||||||
|
- interop assembly:
|
||||||
|
`C:\Program Files (x86)\ArchestrA\Framework\Bin\ArchestrA.MXAccess.dll`
|
||||||
|
- threading model: `Apartment`
|
||||||
|
|
||||||
|
## Worker Rules
|
||||||
|
|
||||||
|
Each worker owns:
|
||||||
|
|
||||||
|
- one process,
|
||||||
|
- one MXAccess session,
|
||||||
|
- one dedicated STA thread,
|
||||||
|
- one MXAccess COM object,
|
||||||
|
- one inbound command queue,
|
||||||
|
- one outbound event queue.
|
||||||
|
|
||||||
|
All MXAccess operations must run on the STA. A plain blocking queue is not
|
||||||
|
enough for the STA; the STA loop must pump Windows/COM messages and service
|
||||||
|
queued commands.
|
||||||
|
|
||||||
|
Do not block the STA on pipe writes, gRPC calls, or slow consumers. Event
|
||||||
|
handlers should convert event args, enqueue outbound events, and return to
|
||||||
|
pumping messages.
|
||||||
|
|
||||||
|
On graceful shutdown, reject new commands, optionally clean up active MXAccess
|
||||||
|
handles, detach events, release the COM object, uninitialize COM, and exit. If
|
||||||
|
graceful shutdown exceeds the configured timeout, the gateway may kill the
|
||||||
|
worker.
|
||||||
|
|
||||||
|
## IPC Rules
|
||||||
|
|
||||||
|
Default pipe name shape:
|
||||||
|
|
||||||
|
```text
|
||||||
|
mxaccess-gateway-{gatewayProcessId}-{sessionId}
|
||||||
|
```
|
||||||
|
|
||||||
|
Frame messages as:
|
||||||
|
|
||||||
|
```text
|
||||||
|
uint32 little-endian payload_length
|
||||||
|
payload_length bytes protobuf WorkerEnvelope
|
||||||
|
```
|
||||||
|
|
||||||
|
Every envelope should include protocol version, session id, monotonic sender
|
||||||
|
sequence, correlation id, and a typed body. Protocol version mismatch should
|
||||||
|
fail session creation.
|
||||||
|
|
||||||
|
Pipe security should be local-machine only, with ACLs restricted to the gateway
|
||||||
|
identity and launched worker identity. Prefer a per-session nonce handshake.
|
||||||
|
|
||||||
|
## Gateway Rules
|
||||||
|
|
||||||
|
The gateway is responsible for:
|
||||||
|
|
||||||
|
- public TCP/gRPC API,
|
||||||
|
- Blazor Server dashboard using Bootstrap CSS/JS only,
|
||||||
|
- authn/authz when needed,
|
||||||
|
- session creation and teardown,
|
||||||
|
- worker launch and lifecycle management,
|
||||||
|
- command routing,
|
||||||
|
- event streaming,
|
||||||
|
- leases, heartbeats, timeouts, and quotas,
|
||||||
|
- worker kill/restart policy,
|
||||||
|
- metrics and structured logs.
|
||||||
|
|
||||||
|
The gRPC layer should stay thin: validate request, find session, call the
|
||||||
|
session worker client, map worker replies to public replies, and stream events.
|
||||||
|
Keep MXAccess-specific translation logic testable outside the gRPC handlers.
|
||||||
|
|
||||||
|
Dashboard code should also stay thin and read-only for v1. Use a snapshot
|
||||||
|
service over session/worker/metrics state; do not let Razor components mutate
|
||||||
|
gateway sessions or workers directly. Do not use MudBlazor or other Blazor UI
|
||||||
|
component libraries.
|
||||||
|
|
||||||
|
Gateway restart should not try to reattach old workers in the first version.
|
||||||
|
Terminate orphaned workers on startup if that behavior is implemented.
|
||||||
|
|
||||||
|
## Command, Timeout, And Cancellation Semantics
|
||||||
|
|
||||||
|
Command lifecycle:
|
||||||
|
|
||||||
|
```text
|
||||||
|
client gRPC command
|
||||||
|
gateway validates session and payload
|
||||||
|
gateway assigns correlation id
|
||||||
|
gateway writes WorkerCommand to pipe
|
||||||
|
worker queues command to STA
|
||||||
|
STA executes MXAccess method
|
||||||
|
worker captures return/out/status/HRESULT
|
||||||
|
worker sends WorkerCommandReply
|
||||||
|
gateway completes gRPC response
|
||||||
|
```
|
||||||
|
|
||||||
|
Canceling a gRPC call should stop waiting in the gateway, but it cannot safely
|
||||||
|
abort an in-flight COM call on the STA. Hard cancellation means killing the
|
||||||
|
worker process.
|
||||||
|
|
||||||
|
If a command wedges the STA beyond a configured grace period, the gateway should
|
||||||
|
kill the worker and fail the session.
|
||||||
|
|
||||||
|
## Backpressure Policy
|
||||||
|
|
||||||
|
Worker outbound events must use a bounded queue. For parity testing, prefer
|
||||||
|
fail-fast behavior over silent drops. Production coalescing or drop policies
|
||||||
|
must be explicit and observable.
|
||||||
|
|
||||||
|
The gateway should preserve per-session event order, apply backpressure from
|
||||||
|
slow gRPC streams, and disconnect or coalesce only according to an explicit
|
||||||
|
policy.
|
||||||
|
|
||||||
|
## Security And Logging
|
||||||
|
|
||||||
|
Use TLS for remote gRPC when crossing machine boundaries. Authentication may be
|
||||||
|
Windows auth, mTLS, or a deployment-specific token.
|
||||||
|
|
||||||
|
Commands that write, authenticate users, or alter runtime state need explicit
|
||||||
|
authorization design.
|
||||||
|
|
||||||
|
Never log passwords or raw credential values for `AuthenticateUser`,
|
||||||
|
`WriteSecured`, or related secured operations. Do not log full values by
|
||||||
|
default; make value logging opt-in and redacted.
|
||||||
|
|
||||||
|
## Testing Expectations
|
||||||
|
|
||||||
|
Use focused tests for:
|
||||||
|
|
||||||
|
- contract/protobuf compatibility,
|
||||||
|
- gateway session state and worker lifecycle,
|
||||||
|
- gateway behavior with a fake worker,
|
||||||
|
- worker value/status conversion,
|
||||||
|
- STA queue and message-pump behavior.
|
||||||
|
|
||||||
|
Live MXAccess integration tests are optional but should be isolated because they
|
||||||
|
depend on installed COM components and provider behavior.
|
||||||
|
|
||||||
|
Parity tests should compare direct MXAccess behavior against the gateway:
|
||||||
|
|
||||||
|
- return values,
|
||||||
|
- HRESULTs and exceptions,
|
||||||
|
- event sequence,
|
||||||
|
- value projection,
|
||||||
|
- quality/status arrays,
|
||||||
|
- invalid handle behavior,
|
||||||
|
- cross-server handle behavior,
|
||||||
|
- cleanup behavior.
|
||||||
|
|
||||||
|
Known important parity areas:
|
||||||
|
|
||||||
|
- `WriteSecured` may fail before a value-bearing NMX body is emitted.
|
||||||
|
- `WriteSecured2` can succeed in observed native paths.
|
||||||
|
- `OperationComplete` is distinct from write completion.
|
||||||
|
- `OnBufferedDataChange` has a distinct public event shape.
|
||||||
|
- Invalid handles and cross-server handles have specific exception/status
|
||||||
|
behavior.
|
||||||
|
- STA message pumping is required for event delivery.
|
||||||
|
|
||||||
|
## Source Update Workflow
|
||||||
|
|
||||||
|
When source code changes, build the affected component before handing work
|
||||||
|
back. If the change crosses component boundaries, build each affected component
|
||||||
|
instead of relying on a single top-level build.
|
||||||
|
|
||||||
|
Use the native build and test command for each changed area:
|
||||||
|
|
||||||
|
| Changed area | Required verification |
|
||||||
|
|--------------|-----------------------|
|
||||||
|
| Contracts or `.proto` files | regenerate generated code, then build gateway, worker, and every generated client touched by the contract |
|
||||||
|
| Gateway server, sessions, workers, gRPC, dashboard, or metrics | build the .NET 10 gateway project and run affected gateway or fake-worker tests |
|
||||||
|
| Worker IPC, STA, MXAccess, or conversion code | build the .NET Framework 4.8 x86 worker project and run affected worker tests |
|
||||||
|
| Shared test infrastructure | run every test suite that consumes the changed helpers |
|
||||||
|
| .NET client | build the .NET client library, CLI, and tests |
|
||||||
|
| Go client | run Go formatting, build, and tests for the Go module |
|
||||||
|
| Rust client | run Rust formatting, build or check, and tests for the Rust crate |
|
||||||
|
| Python client | run Python formatting or linting if configured, package/build checks, and tests |
|
||||||
|
| Java client | build the Java client library, CLI, and tests |
|
||||||
|
| Integration tests | run them only when the required MXAccess COM component, provider state, and external services are available; otherwise document why they were skipped |
|
||||||
|
|
||||||
|
Update affected documentation in the same change as the source update. This
|
||||||
|
includes `gateway.md`, component design docs under `docs/`, client docs, API
|
||||||
|
contract notes, test instructions, and operational guidance. Documentation must
|
||||||
|
follow `StyleGuide.md`: write technical present-tense prose, explain the reason
|
||||||
|
for non-obvious choices, use exact code names, specify languages on code
|
||||||
|
blocks, use relative links for internal docs, and avoid stale temporary notes.
|
||||||
|
Source code and contract changes must also follow the relevant language guide
|
||||||
|
from the Style Guides section.
|
||||||
|
|
||||||
|
Do not leave documentation describing old behavior after changing public APIs,
|
||||||
|
contracts, configuration, build steps, security behavior, event shapes, value
|
||||||
|
conversion, status mapping, lifecycle rules, or client semantics.
|
||||||
|
|
||||||
|
## Implementation Priority
|
||||||
|
|
||||||
|
Build the smallest end-to-end slice first:
|
||||||
|
|
||||||
|
1. .NET 10 gateway starts.
|
||||||
|
2. Client calls `OpenSession`.
|
||||||
|
3. Gateway launches .NET Framework 4.8 x86 worker.
|
||||||
|
4. Worker creates STA and MXAccess COM object.
|
||||||
|
5. Client calls `Register`.
|
||||||
|
6. Client calls `AddItem`.
|
||||||
|
7. Client calls `Advise`.
|
||||||
|
8. Worker forwards one `OnDataChange` event to the gateway.
|
||||||
|
9. Gateway streams the event to the client.
|
||||||
|
10. Client calls `CloseSession`.
|
||||||
|
11. Gateway shuts down the worker.
|
||||||
|
|
||||||
|
That slice proves the high-risk requirements: process isolation, STA ownership,
|
||||||
|
message pumping, command routing, and event streaming.
|
||||||
@@ -1,125 +0,0 @@
|
|||||||
# CLAUDE.md
|
|
||||||
|
|
||||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
||||||
|
|
||||||
## Project Overview
|
|
||||||
|
|
||||||
`mxaccessgw` is the MXAccess Gateway: a gRPC service that gives modern (.NET, Go, Rust, Python, Java) clients full MXAccess parity without forcing them to load 32-bit MXAccess COM, run x86, or own an STA message pump.
|
|
||||||
|
|
||||||
The architecture is a two-process design — read `gateway.md` before making structural changes:
|
|
||||||
|
|
||||||
- **Gateway** (`src/MxGateway.Server`, .NET 10, x64): ASP.NET Core gRPC server. Owns the public API, sessions, auth, the Blazor dashboard, and the Galaxy Repository SQL browse RPCs. **Never instantiates MXAccess COM directly.**
|
|
||||||
- **Worker** (`src/MxGateway.Worker`, .NET Framework 4.8, **x86**): one process per session. Owns one MXAccess COM instance on a dedicated STA, pumps Windows messages, and converts COM events to protobuf.
|
|
||||||
- **IPC**: gateway↔worker uses one bidirectional named pipe per worker (`mxaccess-gateway-{gatewayPid}-{sessionId}`) with length-prefixed `WorkerEnvelope` protobuf frames. Gateway hosts the pipe server and launches the worker. **gRPC is not used inside the worker** — .NET Framework 4.8 doesn't have a first-class gRPC stack.
|
|
||||||
- **Contracts** (`src/MxGateway.Contracts`): multi-targets `net10.0;net48` and owns the `.proto` files (`mxaccess_gateway.proto`, `mxaccess_worker.proto`, `galaxy_repository.proto`). All other projects consume the generated types from here. Do not hand-edit anything under `Generated/`.
|
|
||||||
|
|
||||||
The worker must do all MXAccess COM calls on its dedicated STA thread, and the STA loop must pump Windows messages (`MsgWaitForMultipleObjectsEx` + `PeekMessage`/`DispatchMessage`) so MXAccess events deliver. A plain blocking queue on an STA is not enough.
|
|
||||||
|
|
||||||
## Build, Test, Run
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
# Full solution build (gateway, worker, contracts, tests)
|
|
||||||
dotnet build src/MxGateway.sln
|
|
||||||
|
|
||||||
# Worker must be built x86 — the gateway looks for MxGateway.Worker.exe under bin\x86
|
|
||||||
dotnet build src/MxGateway.Worker/MxGateway.Worker.csproj -p:Platform=x86
|
|
||||||
|
|
||||||
# Gateway tests (no MXAccess required — uses FakeWorkerHarness)
|
|
||||||
dotnet test src/MxGateway.Tests/MxGateway.Tests.csproj
|
|
||||||
dotnet test src/MxGateway.Worker.Tests/MxGateway.Worker.Tests.csproj -p:Platform=x86
|
|
||||||
|
|
||||||
# Run gateway locally (defaults bound under MxGateway:* in src/MxGateway.Server/appsettings.json)
|
|
||||||
dotnet run --project src/MxGateway.Server/MxGateway.Server.csproj
|
|
||||||
|
|
||||||
# API-key admin CLI (same exe, "apikey" subcommand)
|
|
||||||
dotnet run --project src/MxGateway.Server/MxGateway.Server.csproj -- apikey create --display-name "dev" --scopes session,invoke,event,metadata,admin
|
|
||||||
```
|
|
||||||
|
|
||||||
Single test by name (xUnit `--filter`):
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
dotnet test src/MxGateway.Tests/MxGateway.Tests.csproj --filter FullyQualifiedName~GatewayEndToEndFakeWorkerSmokeTests
|
|
||||||
```
|
|
||||||
|
|
||||||
Live MXAccess integration tests are **opt-in** because they need installed MXAccess COM and live provider state:
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
$env:MXGATEWAY_RUN_LIVE_MXACCESS_TESTS = "1"
|
|
||||||
dotnet test src/MxGateway.IntegrationTests/MxGateway.IntegrationTests.csproj --filter FullyQualifiedName~WorkerLiveMxAccessSmokeTests
|
|
||||||
```
|
|
||||||
|
|
||||||
Live LDAP tests use `MXGATEWAY_RUN_LIVE_LDAP_TESTS=1`. See `docs/GatewayTesting.md` for the full opt-in matrix and `LiveMxAccessFactAttribute` / `LiveLdapFactAttribute` for the gating logic.
|
|
||||||
|
|
||||||
## Clients
|
|
||||||
|
|
||||||
Each language client is in `clients/<lang>/` with its own README. They all consume the shared `.proto` files in `src/MxGateway.Contracts/Protos`:
|
|
||||||
|
|
||||||
- `clients/dotnet`: `dotnet build clients/dotnet/MxGateway.Client.sln`
|
|
||||||
- `clients/python`: `python -m pip install -e ".[dev]"; python -m pytest`
|
|
||||||
- `clients/rust`: `cargo test --workspace; cargo clippy --workspace --all-targets -- -D warnings`
|
|
||||||
- `clients/java`: `gradle test` (Java 21)
|
|
||||||
- Go client lives alongside as `mxgw-go` in the cross-language matrix
|
|
||||||
|
|
||||||
End-to-end matrix runner (needs running gateway + worker + valid API key):
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
$env:MXGATEWAY_API_KEY = "<api-key>"
|
|
||||||
powershell -ExecutionPolicy Bypass -File scripts/run-client-e2e-tests.ps1
|
|
||||||
```
|
|
||||||
|
|
||||||
## Repository-Specific Conventions
|
|
||||||
|
|
||||||
- **Build properties** (`src/Directory.Build.props`) enforce `Nullable=enable`, `TreatWarningsAsErrors=true`, latest analyzers, and `EnforceCodeStyleInBuild=true`. New warnings break the build — fix them, don't suppress unless the suppression has a narrow reason.
|
|
||||||
- **Style guides** in `docs/style-guides/` are authoritative. Follow `CSharpStyleGuide.md` for gateway/worker/.NET-client code: file-scoped namespaces, `sealed` by default, `Async` suffix on Task-returning methods, MXAccess-aligned names (`MxStatusProxy`, `ServerHandle`, `ItemHandle`, `HResult`).
|
|
||||||
- **MXAccess parity is the contract.** Don't "fix" surprising MXAccess behavior (e.g., `WriteSecured` failing before a value-bearing NMX body, distinct `OperationComplete` semantics, invalid-handle exceptions) unless the client explicitly opts into a non-parity mode. The installed MXAccess COM component is the baseline.
|
|
||||||
- **Don't synthesize events.** The gateway forwards only events the worker emits; it never invents `OperationComplete` from write completion or command replies.
|
|
||||||
- **One worker per session, one event subscriber per session** (v1). Multi-subscriber fan-out and reconnectable sessions are explicitly out of scope — see `docs/DesignDecisions.md`.
|
|
||||||
- **Gateway restart does not reattach orphan workers.** The first version terminates orphaned workers on startup; do not design code paths that assume reattachment.
|
|
||||||
- **No Blazor UI component libraries.** Dashboard uses local Bootstrap CSS/JS only — do not introduce MudBlazor, Radzen, FluentUI, etc.
|
|
||||||
- **Don't log secrets or full tag values by default.** API keys, passwords, `WriteSecured` payloads, and `AuthenticateUser` credentials must never reach logs. Value logging is opt-in and redacted.
|
|
||||||
- **Generated code** under `src/MxGateway.Contracts/Generated/`, `clients/*/generated*/`, `clients/python/src/mxgateway/generated/`, etc., is build output. Don't hand-edit. To regenerate, build the contracts project (`dotnet build src/MxGateway.Contracts/MxGateway.Contracts.csproj`) or run the per-client generation step in that client's README.
|
|
||||||
- **Documentation style** (`StyleGuide.md`): PascalCase filenames, no marketing language, present tense, explain *why* not *what*.
|
|
||||||
- **Update docs in the same change as the source.** When public APIs, contracts, configuration, build steps, security behavior, event shapes, value conversion, status mapping, or lifecycle rules change, the affected docs (`gateway.md`, `docs/`, client READMEs, design docs) must change in the same commit. Don't leave stale prose describing old behavior.
|
|
||||||
|
|
||||||
## Source Update Workflow
|
|
||||||
|
|
||||||
When source code changes, build and test the affected component before reporting work done. If the change crosses component boundaries, build each affected component — don't rely on a single top-level build:
|
|
||||||
|
|
||||||
| Changed area | Required verification |
|
|
||||||
|---|---|
|
|
||||||
| Contracts or `.proto` files | regenerate generated code, then build gateway, worker, and every generated client touched by the contract |
|
|
||||||
| Gateway server, sessions, workers, gRPC, dashboard, metrics | `dotnet build src/MxGateway.Server` and run affected gateway / fake-worker tests |
|
|
||||||
| Worker IPC, STA, MXAccess, conversion | `dotnet build src/MxGateway.Worker -p:Platform=x86` and run worker tests |
|
|
||||||
| .NET client | `dotnet build clients/dotnet/MxGateway.Client.sln` and run its tests |
|
|
||||||
| Go client | `gofmt`, `go build ./...`, `go test ./...` from `clients/go` |
|
|
||||||
| Rust client | `cargo fmt`, `cargo check --workspace`, `cargo test --workspace`, `cargo clippy --all-targets -- -D warnings` from `clients/rust` |
|
|
||||||
| Python client | `python -m pytest` from `clients/python` |
|
|
||||||
| Java client | `gradle test` from `clients/java` |
|
|
||||||
| Integration tests | run only when MXAccess COM, provider state, and external services are available; otherwise document why skipped |
|
|
||||||
|
|
||||||
## Design Sources To Consult Before Non-Trivial Changes
|
|
||||||
|
|
||||||
- `gateway.md` — top-level architecture, command/event surface, IPC envelope, STA thread model, fault handling.
|
|
||||||
- `glauth.md` — local LDAP server (GLAuth on `localhost:3893`, base DN `dc=lmxopcua,dc=local`) used for dev authn. Pre-provisioned users (`admin/admin123`, `readonly/readonly123`, etc.) and the role→capability mapping live there.
|
|
||||||
- `docs/DesignDecisions.md` — v1 choices (MXAccess COM target `LMXProxyServerClass` from `C:\Program Files (x86)\ArchestrA\Framework\Bin\ArchestrA.MXAccess.dll`, API-key-in-SQLite auth, fail-fast event backpressure, etc.).
|
|
||||||
- `docs/GatewayProcessDesign.md`, `docs/MxAccessWorkerInstanceDesign.md`, `docs/WorkerFrameProtocol.md`, `docs/WorkerProcessLauncher.md` — detailed component designs.
|
|
||||||
- `docs/GatewayConfiguration.md` — full `MxGateway:*` options bound by `GatewayOptions` and validated at startup by `GatewayOptionsValidator`.
|
|
||||||
- `docs/GatewayTesting.md` — fake worker harness, live MXAccess smoke, parity matrix, cross-language smoke matrix.
|
|
||||||
- `docs/ToolchainLinks.md` — installed compiler/SDK paths on this dev box (.NET 10.0.201, Go 1.26.2, Rust 1.95, Python 3.12.10, Temurin 21, protoc 34.1, etc.).
|
|
||||||
|
|
||||||
External analysis sources referenced by design docs:
|
|
||||||
|
|
||||||
- `C:\Users\dohertj2\Desktop\mxaccess` — MXAccess analysis project. Key files: `docs/MXAccess-Public-API.md` (COM class, ProgID, CLSID, method list, event signatures, `MxDataType`, `MxStatus`, `MXSTATUS_PROXY`), `docs/MXAccess-Reverse-Engineering.md` (installed runtime path, x86 COM constraints), `docs/Current-Sprint-State.md` (parity gaps), `src/MxTraceHarness/` (x86 harness using the real COM interop), `captures/` and `analysis/` (observed native behavior).
|
|
||||||
- `C:\Users\dohertj2\Desktop\lmxopcua\gr` — Galaxy Repository (`ZB` SQL DB) notes. Key files: `connectioninfo.md`, `layout.md`, `schema.md`, `queries/hierarchy.sql`, `queries/attributes.sql`, `queries/attributes_extended.sql`, `queries/change_detection.sql`. Connection is SQL Server `localhost`, database `ZB`, Windows Auth.
|
|
||||||
|
|
||||||
## Authentication
|
|
||||||
|
|
||||||
Gateway gRPC clients authenticate with an API key in metadata: `authorization: Bearer mxgw_<key-id>_<secret>`. Keys are stored hashed (with a peppered SHA) in a gateway-owned SQLite DB (default `C:\ProgramData\MxGateway\gateway-auth.db`). Scopes (`session`, `invoke`, `event`, `metadata`, `admin`) gate specific RPCs; missing → `Unauthenticated`, insufficient → `PermissionDenied`. The `apikey` subcommand on the server exe manages keys; see `src/MxGateway.Server/Security/Authentication/`.
|
|
||||||
|
|
||||||
Dashboard auth is LDAP-backed (separate from the gRPC API-key model). `/login` binds against `MxGateway:Ldap` and maps the user's LDAP groups to `Admin` or `Viewer` via `MxGateway:Dashboard:GroupToRole`, then issues an HTTP-only secure `__Host-MxGatewayDashboard` cookie. SignalR hubs at `/hubs/{snapshot,alarms,events}` accept either the cookie or a 30-minute bearer minted at `/hubs/token`. `Dashboard:AllowAnonymousLocalhost` bypasses auth on loopback when enabled.
|
|
||||||
|
|
||||||
## Process / Platform Notes
|
|
||||||
|
|
||||||
- Working tree is on Windows (`C:\Users\dohertj2\Desktop\mxaccessgw`). PowerShell is the native shell for tooling commands; bash is fine for git/grep/find.
|
|
||||||
- The worker reference to `ArchestrA.MXAccess.dll` uses an absolute `HintPath` to `C:\Program Files (x86)\ArchestrA\Framework\Bin\ArchestrA.MXAccess.dll`. The worker only builds where MXAccess is installed (this dev box).
|
|
||||||
- The repo is not a git repository at the top level — there's no `.git` directory in the working tree.
|
|
||||||
+1
-22
@@ -1,15 +1,12 @@
|
|||||||
using System.Globalization;
|
using System.Globalization;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Cli;
|
namespace MxGateway.Client.Cli;
|
||||||
|
|
||||||
/// <summary>Parses command-line arguments into flags and named values.</summary>
|
|
||||||
internal sealed class CliArguments
|
internal sealed class CliArguments
|
||||||
{
|
{
|
||||||
private readonly Dictionary<string, string> _values = new(StringComparer.OrdinalIgnoreCase);
|
private readonly Dictionary<string, string> _values = new(StringComparer.OrdinalIgnoreCase);
|
||||||
private readonly HashSet<string> _flags = new(StringComparer.OrdinalIgnoreCase);
|
private readonly HashSet<string> _flags = new(StringComparer.OrdinalIgnoreCase);
|
||||||
|
|
||||||
/// <summary>Initializes a new instance by parsing the given command-line arguments.</summary>
|
|
||||||
/// <param name="args">Unparsed command-line arguments; flags prefixed with '--' and values follow their flag.</param>
|
|
||||||
public CliArguments(IEnumerable<string> args)
|
public CliArguments(IEnumerable<string> args)
|
||||||
{
|
{
|
||||||
string? pendingName = null;
|
string? pendingName = null;
|
||||||
@@ -42,15 +39,11 @@ internal sealed class CliArguments
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Returns whether the named flag was present in the arguments.</summary>
|
|
||||||
/// <param name="name">The flag name (without '--' prefix).</param>
|
|
||||||
public bool HasFlag(string name)
|
public bool HasFlag(string name)
|
||||||
{
|
{
|
||||||
return _flags.Contains(name);
|
return _flags.Contains(name);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Returns the value for a named argument, or <c>null</c> if absent.</summary>
|
|
||||||
/// <param name="name">The argument name (without '--' prefix).</param>
|
|
||||||
public string? GetOptional(string name)
|
public string? GetOptional(string name)
|
||||||
{
|
{
|
||||||
return _values.TryGetValue(name, out string? value)
|
return _values.TryGetValue(name, out string? value)
|
||||||
@@ -58,8 +51,6 @@ internal sealed class CliArguments
|
|||||||
: null;
|
: null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Returns the value for a required named argument, or throws if absent.</summary>
|
|
||||||
/// <param name="name">The argument name (without '--' prefix).</param>
|
|
||||||
public string GetRequired(string name)
|
public string GetRequired(string name)
|
||||||
{
|
{
|
||||||
string? value = GetOptional(name);
|
string? value = GetOptional(name);
|
||||||
@@ -71,9 +62,6 @@ internal sealed class CliArguments
|
|||||||
return value;
|
return value;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Parses and returns an int32 argument, or the default value if absent.</summary>
|
|
||||||
/// <param name="name">The argument name (without '--' prefix).</param>
|
|
||||||
/// <param name="defaultValue">The default value if the argument is absent; if <c>null</c>, the argument is required.</param>
|
|
||||||
public int GetInt32(string name, int? defaultValue = null)
|
public int GetInt32(string name, int? defaultValue = null)
|
||||||
{
|
{
|
||||||
string? value = GetOptional(name);
|
string? value = GetOptional(name);
|
||||||
@@ -90,9 +78,6 @@ internal sealed class CliArguments
|
|||||||
return int.Parse(value, CultureInfo.InvariantCulture);
|
return int.Parse(value, CultureInfo.InvariantCulture);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Parses and returns a uint32 argument, or the default value if absent.</summary>
|
|
||||||
/// <param name="name">The argument name (without '--' prefix).</param>
|
|
||||||
/// <param name="defaultValue">The default value if the argument is absent.</param>
|
|
||||||
public uint GetUInt32(string name, uint defaultValue)
|
public uint GetUInt32(string name, uint defaultValue)
|
||||||
{
|
{
|
||||||
string? value = GetOptional(name);
|
string? value = GetOptional(name);
|
||||||
@@ -101,9 +86,6 @@ internal sealed class CliArguments
|
|||||||
: uint.Parse(value, CultureInfo.InvariantCulture);
|
: uint.Parse(value, CultureInfo.InvariantCulture);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Parses and returns a uint64 argument, or the default value if absent.</summary>
|
|
||||||
/// <param name="name">The argument name (without '--' prefix).</param>
|
|
||||||
/// <param name="defaultValue">The default value if the argument is absent.</param>
|
|
||||||
public ulong GetUInt64(string name, ulong defaultValue)
|
public ulong GetUInt64(string name, ulong defaultValue)
|
||||||
{
|
{
|
||||||
string? value = GetOptional(name);
|
string? value = GetOptional(name);
|
||||||
@@ -112,9 +94,6 @@ internal sealed class CliArguments
|
|||||||
: ulong.Parse(value, CultureInfo.InvariantCulture);
|
: ulong.Parse(value, CultureInfo.InvariantCulture);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Parses and returns a TimeSpan argument, or the default value if absent. Supports "ms", "s", and standard TimeSpan format.</summary>
|
|
||||||
/// <param name="name">The argument name (without '--' prefix).</param>
|
|
||||||
/// <param name="defaultValue">The default value if the argument is absent.</param>
|
|
||||||
public TimeSpan GetDuration(string name, TimeSpan defaultValue)
|
public TimeSpan GetDuration(string name, TimeSpan defaultValue)
|
||||||
{
|
{
|
||||||
string? value = GetOptional(name);
|
string? value = GetOptional(name);
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
|
namespace MxGateway.Client.Cli;
|
||||||
|
|
||||||
|
public interface IMxGatewayCliClient : IAsyncDisposable
|
||||||
|
{
|
||||||
|
Task<OpenSessionReply> OpenSessionAsync(
|
||||||
|
OpenSessionRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
|
||||||
|
Task<CloseSessionReply> CloseSessionAsync(
|
||||||
|
CloseSessionRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
|
||||||
|
Task<MxCommandReply> InvokeAsync(
|
||||||
|
MxCommandRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
|
||||||
|
IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
|
StreamEventsRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
|
||||||
|
Task<TestConnectionReply> GalaxyTestConnectionAsync(
|
||||||
|
TestConnectionRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
|
||||||
|
Task<GetLastDeployTimeReply> GalaxyGetLastDeployTimeAsync(
|
||||||
|
GetLastDeployTimeRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
|
||||||
|
Task<DiscoverHierarchyReply> GalaxyDiscoverHierarchyAsync(
|
||||||
|
DiscoverHierarchyRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
|
||||||
|
IAsyncEnumerable<DeployEvent> GalaxyWatchDeployEventsAsync(
|
||||||
|
WatchDeployEventsRequest request,
|
||||||
|
CancellationToken cancellationToken);
|
||||||
|
}
|
||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<ProjectReference Include="..\ZB.MOM.WW.MxGateway.Client\ZB.MOM.WW.MxGateway.Client.csproj" />
|
<ProjectReference Include="..\MxGateway.Client\MxGateway.Client.csproj" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
+4
-17
@@ -1,18 +1,14 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Client;
|
using MxGateway.Client;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Cli;
|
namespace MxGateway.Client.Cli;
|
||||||
|
|
||||||
internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
||||||
{
|
{
|
||||||
private readonly MxGatewayClient _client;
|
private readonly MxGatewayClient _client;
|
||||||
private readonly Lazy<GalaxyRepositoryClient> _galaxyClient;
|
private readonly Lazy<GalaxyRepositoryClient> _galaxyClient;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes a new instance of the <see cref="MxGatewayCliClientAdapter"/> that bridges the CLI to the gateway client.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="client">The gateway client to adapt.</param>
|
|
||||||
public MxGatewayCliClientAdapter(MxGatewayClient client)
|
public MxGatewayCliClientAdapter(MxGatewayClient client)
|
||||||
{
|
{
|
||||||
_client = client;
|
_client = client;
|
||||||
@@ -20,7 +16,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
() => GalaxyRepositoryClient.Create(_client.Options));
|
() => GalaxyRepositoryClient.Create(_client.Options));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<OpenSessionReply> OpenSessionAsync(
|
public Task<OpenSessionReply> OpenSessionAsync(
|
||||||
OpenSessionRequest request,
|
OpenSessionRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -28,7 +23,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _client.OpenSessionRawAsync(request, cancellationToken);
|
return _client.OpenSessionRawAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<CloseSessionReply> CloseSessionAsync(
|
public Task<CloseSessionReply> CloseSessionAsync(
|
||||||
CloseSessionRequest request,
|
CloseSessionRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -36,7 +30,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _client.CloseSessionRawAsync(request, cancellationToken);
|
return _client.CloseSessionRawAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<MxCommandReply> InvokeAsync(
|
public Task<MxCommandReply> InvokeAsync(
|
||||||
MxCommandRequest request,
|
MxCommandRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -44,7 +37,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _client.InvokeAsync(request, cancellationToken);
|
return _client.InvokeAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
public IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
StreamEventsRequest request,
|
StreamEventsRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -52,7 +44,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _client.StreamEventsAsync(request, cancellationToken);
|
return _client.StreamEventsAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<TestConnectionReply> GalaxyTestConnectionAsync(
|
public Task<TestConnectionReply> GalaxyTestConnectionAsync(
|
||||||
TestConnectionRequest request,
|
TestConnectionRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -60,7 +51,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _galaxyClient.Value.TestConnectionRawAsync(request, cancellationToken);
|
return _galaxyClient.Value.TestConnectionRawAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<GetLastDeployTimeReply> GalaxyGetLastDeployTimeAsync(
|
public Task<GetLastDeployTimeReply> GalaxyGetLastDeployTimeAsync(
|
||||||
GetLastDeployTimeRequest request,
|
GetLastDeployTimeRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -68,7 +58,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _galaxyClient.Value.GetLastDeployTimeRawAsync(request, cancellationToken);
|
return _galaxyClient.Value.GetLastDeployTimeRawAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<DiscoverHierarchyReply> GalaxyDiscoverHierarchyAsync(
|
public Task<DiscoverHierarchyReply> GalaxyDiscoverHierarchyAsync(
|
||||||
DiscoverHierarchyRequest request,
|
DiscoverHierarchyRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -76,7 +65,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _galaxyClient.Value.DiscoverHierarchyRawAsync(request, cancellationToken);
|
return _galaxyClient.Value.DiscoverHierarchyRawAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public IAsyncEnumerable<DeployEvent> GalaxyWatchDeployEventsAsync(
|
public IAsyncEnumerable<DeployEvent> GalaxyWatchDeployEventsAsync(
|
||||||
WatchDeployEventsRequest request,
|
WatchDeployEventsRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -84,7 +72,6 @@ internal sealed class MxGatewayCliClientAdapter : IMxGatewayCliClient
|
|||||||
return _galaxyClient.Value.WatchDeployEventsRawAsync(request, cancellationToken);
|
return _galaxyClient.Value.WatchDeployEventsRawAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async ValueTask DisposeAsync()
|
public async ValueTask DisposeAsync()
|
||||||
{
|
{
|
||||||
if (_galaxyClient.IsValueCreated)
|
if (_galaxyClient.IsValueCreated)
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
namespace MxGateway.Client.Cli;
|
||||||
|
|
||||||
|
internal static class MxGatewayCliSecretRedactor
|
||||||
|
{
|
||||||
|
public static string Redact(string value, string? apiKey)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrEmpty(value) || string.IsNullOrEmpty(apiKey))
|
||||||
|
{
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
|
||||||
|
return value.Replace(apiKey, "[redacted]", StringComparison.Ordinal);
|
||||||
|
}
|
||||||
|
}
|
||||||
+4
-14
@@ -1,13 +1,12 @@
|
|||||||
using System.Globalization;
|
using System.Globalization;
|
||||||
using System.Text.Json;
|
using System.Text.Json;
|
||||||
using Google.Protobuf;
|
using Google.Protobuf;
|
||||||
using ZB.MOM.WW.MxGateway.Client;
|
using MxGateway.Client;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Cli;
|
namespace MxGateway.Client.Cli;
|
||||||
|
|
||||||
/// <summary>Command-line interface for the MXAccess Gateway client, supporting session and command operations.</summary>
|
|
||||||
public static class MxGatewayClientCli
|
public static class MxGatewayClientCli
|
||||||
{
|
{
|
||||||
private const uint MaxAggregateEvents = 10_000;
|
private const uint MaxAggregateEvents = 10_000;
|
||||||
@@ -16,10 +15,6 @@ public static class MxGatewayClientCli
|
|||||||
|
|
||||||
private static readonly JsonSerializerOptions JsonOptions = new(JsonSerializerDefaults.Web);
|
private static readonly JsonSerializerOptions JsonOptions = new(JsonSerializerDefaults.Web);
|
||||||
|
|
||||||
/// <summary>Runs the CLI synchronously with the given arguments, writing output and errors.</summary>
|
|
||||||
/// <param name="args">Command-line arguments (command name followed by options).</param>
|
|
||||||
/// <param name="standardOutput">TextWriter for command output.</param>
|
|
||||||
/// <param name="standardError">TextWriter for error messages.</param>
|
|
||||||
public static int Run(
|
public static int Run(
|
||||||
string[] args,
|
string[] args,
|
||||||
TextWriter standardOutput,
|
TextWriter standardOutput,
|
||||||
@@ -30,11 +25,6 @@ public static class MxGatewayClientCli
|
|||||||
.GetResult();
|
.GetResult();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Runs the CLI asynchronously with the given arguments, writing output and errors.</summary>
|
|
||||||
/// <param name="args">Command-line arguments (command name followed by options).</param>
|
|
||||||
/// <param name="standardOutput">TextWriter for command output.</param>
|
|
||||||
/// <param name="standardError">TextWriter for error messages.</param>
|
|
||||||
/// <param name="clientFactory">Optional factory to create the gateway client; defaults to MxGatewayClient.Create.</param>
|
|
||||||
public static Task<int> RunAsync(
|
public static Task<int> RunAsync(
|
||||||
string[] args,
|
string[] args,
|
||||||
TextWriter standardOutput,
|
TextWriter standardOutput,
|
||||||
+1
-1
@@ -1,3 +1,3 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Client.Cli;
|
using MxGateway.Client.Cli;
|
||||||
|
|
||||||
return await MxGatewayClientCli.RunAsync(args, Console.Out, Console.Error);
|
return await MxGatewayClientCli.RunAsync(args, Console.Out, Console.Error);
|
||||||
+2
-67
@@ -1,75 +1,34 @@
|
|||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Fake Galaxy Repository client transport for testing.
|
|
||||||
/// </summary>
|
|
||||||
internal sealed class FakeGalaxyRepositoryTransport(MxGatewayClientOptions options) : IGalaxyRepositoryClientTransport
|
internal sealed class FakeGalaxyRepositoryTransport(MxGatewayClientOptions options) : IGalaxyRepositoryClientTransport
|
||||||
{
|
{
|
||||||
/// <summary>
|
|
||||||
/// Gets the gateway client options.
|
|
||||||
/// </summary>
|
|
||||||
public MxGatewayClientOptions Options { get; } = options;
|
public MxGatewayClientOptions Options { get; } = options;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the raw gRPC client; always null for the fake.
|
|
||||||
/// </summary>
|
|
||||||
public GalaxyRepository.GalaxyRepositoryClient? RawClient => null;
|
public GalaxyRepository.GalaxyRepositoryClient? RawClient => null;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of TestConnection RPC calls made by the client.
|
|
||||||
/// </summary>
|
|
||||||
public List<(TestConnectionRequest Request, CallOptions CallOptions)> TestConnectionCalls { get; } = [];
|
public List<(TestConnectionRequest Request, CallOptions CallOptions)> TestConnectionCalls { get; } = [];
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of GetLastDeployTime RPC calls made by the client.
|
|
||||||
/// </summary>
|
|
||||||
public List<(GetLastDeployTimeRequest Request, CallOptions CallOptions)> GetLastDeployTimeCalls { get; } = [];
|
public List<(GetLastDeployTimeRequest Request, CallOptions CallOptions)> GetLastDeployTimeCalls { get; } = [];
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of DiscoverHierarchy RPC calls made by the client.
|
|
||||||
/// </summary>
|
|
||||||
public List<(DiscoverHierarchyRequest Request, CallOptions CallOptions)> DiscoverHierarchyCalls { get; } = [];
|
public List<(DiscoverHierarchyRequest Request, CallOptions CallOptions)> DiscoverHierarchyCalls { get; } = [];
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the reply to return from TestConnection; defaults to successful response.
|
|
||||||
/// </summary>
|
|
||||||
public TestConnectionReply TestConnectionReply { get; set; } = new() { Ok = true };
|
public TestConnectionReply TestConnectionReply { get; set; } = new() { Ok = true };
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the reply to return from GetLastDeployTime; defaults to no deploy time present.
|
|
||||||
/// </summary>
|
|
||||||
public GetLastDeployTimeReply GetLastDeployTimeReply { get; set; } = new() { Present = false };
|
public GetLastDeployTimeReply GetLastDeployTimeReply { get; set; } = new() { Present = false };
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the reply to return from DiscoverHierarchy; defaults to empty response.
|
|
||||||
/// </summary>
|
|
||||||
public DiscoverHierarchyReply DiscoverHierarchyReply { get; set; } = new();
|
public DiscoverHierarchyReply DiscoverHierarchyReply { get; set; } = new();
|
||||||
|
|
||||||
public Queue<DiscoverHierarchyReply> DiscoverHierarchyReplies { get; } = new();
|
public Queue<DiscoverHierarchyReply> DiscoverHierarchyReplies { get; } = new();
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the queue of exceptions to throw from TestConnection; dequeued in FIFO order.
|
|
||||||
/// </summary>
|
|
||||||
public Queue<Exception> TestConnectionExceptions { get; } = new();
|
public Queue<Exception> TestConnectionExceptions { get; } = new();
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the queue of exceptions to throw from GetLastDeployTime; dequeued in FIFO order.
|
|
||||||
/// </summary>
|
|
||||||
public Queue<Exception> GetLastDeployTimeExceptions { get; } = new();
|
public Queue<Exception> GetLastDeployTimeExceptions { get; } = new();
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the queue of exceptions to throw from DiscoverHierarchy; dequeued in FIFO order.
|
|
||||||
/// </summary>
|
|
||||||
public Queue<Exception> DiscoverHierarchyExceptions { get; } = new();
|
public Queue<Exception> DiscoverHierarchyExceptions { get; } = new();
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Records the request and either throws a queued exception or returns the configured reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The TestConnectionRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public Task<TestConnectionReply> TestConnectionAsync(
|
public Task<TestConnectionReply> TestConnectionAsync(
|
||||||
TestConnectionRequest request,
|
TestConnectionRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -83,11 +42,6 @@ internal sealed class FakeGalaxyRepositoryTransport(MxGatewayClientOptions optio
|
|||||||
return Task.FromResult(TestConnectionReply);
|
return Task.FromResult(TestConnectionReply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Records the request and either throws a queued exception or returns the configured reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The GetLastDeployTimeRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
public Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
||||||
GetLastDeployTimeRequest request,
|
GetLastDeployTimeRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -101,11 +55,6 @@ internal sealed class FakeGalaxyRepositoryTransport(MxGatewayClientOptions optio
|
|||||||
return Task.FromResult(GetLastDeployTimeReply);
|
return Task.FromResult(GetLastDeployTimeReply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Records the request and either throws a queued exception or returns the configured reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The DiscoverHierarchyRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
public Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
||||||
DiscoverHierarchyRequest request,
|
DiscoverHierarchyRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -122,19 +71,10 @@ internal sealed class FakeGalaxyRepositoryTransport(MxGatewayClientOptions optio
|
|||||||
: DiscoverHierarchyReply);
|
: DiscoverHierarchyReply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of WatchDeployEvents RPC calls made by the client.
|
|
||||||
/// </summary>
|
|
||||||
public List<(WatchDeployEventsRequest Request, CallOptions CallOptions)> WatchDeployEventsCalls { get; } = [];
|
public List<(WatchDeployEventsRequest Request, CallOptions CallOptions)> WatchDeployEventsCalls { get; } = [];
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the list of events to stream from WatchDeployEvents.
|
|
||||||
/// </summary>
|
|
||||||
public List<DeployEvent> WatchDeployEvents { get; } = [];
|
public List<DeployEvent> WatchDeployEvents { get; } = [];
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the exception to throw from WatchDeployEvents, if any.
|
|
||||||
/// </summary>
|
|
||||||
public Exception? WatchDeployEventsException { get; set; }
|
public Exception? WatchDeployEventsException { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -143,11 +83,6 @@ internal sealed class FakeGalaxyRepositoryTransport(MxGatewayClientOptions optio
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public Func<CancellationToken, Task>? WatchDeployEventsBeforeYield { get; set; }
|
public Func<CancellationToken, Task>? WatchDeployEventsBeforeYield { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Records the request and streams events, checking for queued exceptions and calling WatchDeployEventsBeforeYield before each event.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The WatchDeployEventsRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public async IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
public async IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
||||||
WatchDeployEventsRequest request,
|
WatchDeployEventsRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
using Grpc.Core;
|
||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
|
internal sealed class FakeGatewayTransport(MxGatewayClientOptions options) : IMxGatewayClientTransport
|
||||||
|
{
|
||||||
|
private readonly Queue<MxCommandReply> _invokeReplies = new();
|
||||||
|
private readonly List<MxEvent> _events = [];
|
||||||
|
|
||||||
|
public MxGatewayClientOptions Options { get; } = options;
|
||||||
|
|
||||||
|
public MxAccessGateway.MxAccessGatewayClient? RawClient => null;
|
||||||
|
|
||||||
|
public List<(OpenSessionRequest Request, CallOptions CallOptions)> OpenSessionCalls { get; } = [];
|
||||||
|
|
||||||
|
public List<(CloseSessionRequest Request, CallOptions CallOptions)> CloseSessionCalls { get; } = [];
|
||||||
|
|
||||||
|
public List<(MxCommandRequest Request, CallOptions CallOptions)> InvokeCalls { get; } = [];
|
||||||
|
|
||||||
|
public List<(StreamEventsRequest Request, CallOptions CallOptions)> StreamEventsCalls { get; } = [];
|
||||||
|
|
||||||
|
public OpenSessionReply OpenSessionReply { get; set; } = new()
|
||||||
|
{
|
||||||
|
SessionId = "session-fixture",
|
||||||
|
BackendName = "mxaccess-worker",
|
||||||
|
GatewayProtocolVersion = 1,
|
||||||
|
WorkerProtocolVersion = 1,
|
||||||
|
ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok },
|
||||||
|
};
|
||||||
|
|
||||||
|
public CloseSessionReply CloseSessionReply { get; set; } = new()
|
||||||
|
{
|
||||||
|
SessionId = "session-fixture",
|
||||||
|
FinalState = SessionState.Closed,
|
||||||
|
ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok },
|
||||||
|
};
|
||||||
|
|
||||||
|
public Queue<Exception> OpenSessionExceptions { get; } = new();
|
||||||
|
|
||||||
|
public Queue<Exception> CloseSessionExceptions { get; } = new();
|
||||||
|
|
||||||
|
public Queue<Exception> InvokeExceptions { get; } = new();
|
||||||
|
|
||||||
|
public Task<OpenSessionReply> OpenSessionAsync(
|
||||||
|
OpenSessionRequest request,
|
||||||
|
CallOptions callOptions)
|
||||||
|
{
|
||||||
|
OpenSessionCalls.Add((request, callOptions));
|
||||||
|
if (OpenSessionExceptions.TryDequeue(out Exception? exception))
|
||||||
|
{
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Task.FromResult(OpenSessionReply);
|
||||||
|
}
|
||||||
|
|
||||||
|
public Task<CloseSessionReply> CloseSessionAsync(
|
||||||
|
CloseSessionRequest request,
|
||||||
|
CallOptions callOptions)
|
||||||
|
{
|
||||||
|
CloseSessionCalls.Add((request, callOptions));
|
||||||
|
if (CloseSessionExceptions.TryDequeue(out Exception? exception))
|
||||||
|
{
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Task.FromResult(CloseSessionReply);
|
||||||
|
}
|
||||||
|
|
||||||
|
public Task<MxCommandReply> InvokeAsync(
|
||||||
|
MxCommandRequest request,
|
||||||
|
CallOptions callOptions)
|
||||||
|
{
|
||||||
|
InvokeCalls.Add((request, callOptions));
|
||||||
|
if (InvokeExceptions.TryDequeue(out Exception? exception))
|
||||||
|
{
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Task.FromResult(_invokeReplies.Dequeue());
|
||||||
|
}
|
||||||
|
|
||||||
|
public async IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
|
StreamEventsRequest request,
|
||||||
|
CallOptions callOptions)
|
||||||
|
{
|
||||||
|
StreamEventsCalls.Add((request, callOptions));
|
||||||
|
|
||||||
|
foreach (MxEvent gatewayEvent in _events)
|
||||||
|
{
|
||||||
|
callOptions.CancellationToken.ThrowIfCancellationRequested();
|
||||||
|
await Task.Yield();
|
||||||
|
yield return gatewayEvent;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public void AddInvokeReply(MxCommandReply reply)
|
||||||
|
{
|
||||||
|
_invokeReplies.Enqueue(reply);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void AddEvent(MxEvent gatewayEvent)
|
||||||
|
{
|
||||||
|
_events.Add(gatewayEvent);
|
||||||
|
}
|
||||||
|
}
|
||||||
+2
-41
@@ -1,14 +1,11 @@
|
|||||||
using Google.Protobuf.WellKnownTypes;
|
using Google.Protobuf.WellKnownTypes;
|
||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
public sealed class GalaxyRepositoryClientTests
|
public sealed class GalaxyRepositoryClientTests
|
||||||
{
|
{
|
||||||
/// <summary>
|
|
||||||
/// Verifies that TestConnectionAsync attaches the API key in request metadata and returns the Ok flag.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task TestConnectionAsync_AttachesApiKeyMetadataAndReturnsOkFlag()
|
public async Task TestConnectionAsync_AttachesApiKeyMetadataAndReturnsOkFlag()
|
||||||
{
|
{
|
||||||
@@ -24,9 +21,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Equal("Bearer test-api-key", call.CallOptions.Headers?.GetValue("authorization"));
|
Assert.Equal("Bearer test-api-key", call.CallOptions.Headers?.GetValue("authorization"));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that TestConnectionAsync returns false when the server reports NotOk.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task TestConnectionAsync_ReturnsFalseWhenServerReportsNotOk()
|
public async Task TestConnectionAsync_ReturnsFalseWhenServerReportsNotOk()
|
||||||
{
|
{
|
||||||
@@ -39,9 +33,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.False(ok);
|
Assert.False(ok);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that GetLastDeployTimeAsync returns null when the server reports not present.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task GetLastDeployTimeAsync_ReturnsNullWhenNotPresent()
|
public async Task GetLastDeployTimeAsync_ReturnsNullWhenNotPresent()
|
||||||
{
|
{
|
||||||
@@ -55,9 +46,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Single(transport.GetLastDeployTimeCalls);
|
Assert.Single(transport.GetLastDeployTimeCalls);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that GetLastDeployTimeAsync returns the timestamp when the server reports it present.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task GetLastDeployTimeAsync_ReturnsTimestampWhenPresent()
|
public async Task GetLastDeployTimeAsync_ReturnsTimestampWhenPresent()
|
||||||
{
|
{
|
||||||
@@ -76,9 +64,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Equal(expected, deployTime!.Value);
|
Assert.Equal(expected, deployTime!.Value);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that DiscoverHierarchyAsync returns the objects from the server reply.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task DiscoverHierarchyAsync_ReturnsObjectsFromReply()
|
public async Task DiscoverHierarchyAsync_ReturnsObjectsFromReply()
|
||||||
{
|
{
|
||||||
@@ -138,9 +123,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Equal("DelmiaReceiver_001.DownloadPath", attribute.FullTagReference);
|
Assert.Equal("DelmiaReceiver_001.DownloadPath", attribute.FullTagReference);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that DiscoverHierarchyAsync propagates cancellation tokens to the transport.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task DiscoverHierarchyAsync_PropagatesCancellationToTransport()
|
public async Task DiscoverHierarchyAsync_PropagatesCancellationToTransport()
|
||||||
{
|
{
|
||||||
@@ -158,9 +140,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.False(call.CallOptions.CancellationToken.IsCancellationRequested);
|
Assert.False(call.CallOptions.CancellationToken.IsCancellationRequested);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that TestConnectionAsync retries on transient gRPC failures.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task DiscoverHierarchyAsync_WithRepeatedPageToken_ThrowsProtocolError()
|
public async Task DiscoverHierarchyAsync_WithRepeatedPageToken_ThrowsProtocolError()
|
||||||
{
|
{
|
||||||
@@ -226,9 +205,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Equal(2, transport.TestConnectionCalls.Count);
|
Assert.Equal(2, transport.TestConnectionCalls.Count);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that DiscoverHierarchyAsync retries on transient gRPC failures.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task DiscoverHierarchyAsync_RetriesOnTransientGrpcFailure()
|
public async Task DiscoverHierarchyAsync_RetriesOnTransientGrpcFailure()
|
||||||
{
|
{
|
||||||
@@ -242,9 +218,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Equal(2, transport.DiscoverHierarchyCalls.Count);
|
Assert.Equal(2, transport.DiscoverHierarchyCalls.Count);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that WatchDeployEventsAsync delivers the bootstrap event.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task WatchDeployEventsAsync_DeliversBootstrapEvent()
|
public async Task WatchDeployEventsAsync_DeliversBootstrapEvent()
|
||||||
{
|
{
|
||||||
@@ -278,9 +251,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Null(call.Request.LastSeenDeployTime);
|
Assert.Null(call.Request.LastSeenDeployTime);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that WatchDeployEventsAsync delivers multiple events in order.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task WatchDeployEventsAsync_DeliversMultipleEventsInOrder()
|
public async Task WatchDeployEventsAsync_DeliversMultipleEventsInOrder()
|
||||||
{
|
{
|
||||||
@@ -316,9 +286,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Equal(t0, call.Request.LastSeenDeployTime!.ToDateTime());
|
Assert.Equal(t0, call.Request.LastSeenDeployTime!.ToDateTime());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that WatchDeployEventsAsync stops iteration cleanly when cancelled.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task WatchDeployEventsAsync_CancellationStopsIterationCleanly()
|
public async Task WatchDeployEventsAsync_CancellationStopsIterationCleanly()
|
||||||
{
|
{
|
||||||
@@ -360,9 +327,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
Assert.Equal(1ul, received[0].Sequence);
|
Assert.Equal(1ul, received[0].Sequence);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that WatchDeployEventsAsync throws ObjectDisposedException after the client is disposed.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task WatchDeployEventsAsync_ThrowsAfterDisposal()
|
public async Task WatchDeployEventsAsync_ThrowsAfterDisposal()
|
||||||
{
|
{
|
||||||
@@ -375,9 +339,6 @@ public sealed class GalaxyRepositoryClientTests
|
|||||||
client.WatchDeployEventsAsync());
|
client.WatchDeployEventsAsync());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that TestConnectionAsync throws ObjectDisposedException after the client is disposed.
|
|
||||||
/// </summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task TestConnectionAsync_ThrowsAfterDisposal()
|
public async Task TestConnectionAsync_ThrowsAfterDisposal()
|
||||||
{
|
{
|
||||||
+3
-6
@@ -1,12 +1,11 @@
|
|||||||
using Google.Protobuf;
|
using Google.Protobuf;
|
||||||
using ZB.MOM.WW.MxGateway.Client;
|
using MxGateway.Client;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
public sealed class MxCommandReplyExtensionsTests
|
public sealed class MxCommandReplyExtensionsTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that successful replies pass both protocol and MxAccess success checks.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void EnsureSuccess_WithRegisterFixture_ReturnsReply()
|
public void EnsureSuccess_WithRegisterFixture_ReturnsReply()
|
||||||
{
|
{
|
||||||
@@ -16,7 +15,6 @@ public sealed class MxCommandReplyExtensionsTests
|
|||||||
Assert.Same(reply, reply.EnsureMxAccessSuccess());
|
Assert.Same(reply, reply.EnsureMxAccessSuccess());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that MxAccess failures throw with preserved HResult and status details.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void EnsureMxAccessSuccess_WithFailureFixture_PreservesHResultAndStatuses()
|
public void EnsureMxAccessSuccess_WithFailureFixture_PreservesHResultAndStatuses()
|
||||||
{
|
{
|
||||||
@@ -32,7 +30,6 @@ public sealed class MxCommandReplyExtensionsTests
|
|||||||
Assert.Contains("0x80040200", exception.Message);
|
Assert.Contains("0x80040200", exception.Message);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that session-not-found protocol failures throw the correct gateway exception.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void EnsureProtocolSuccess_WithSessionFailure_ThrowsSessionException()
|
public void EnsureProtocolSuccess_WithSessionFailure_ThrowsSessionException()
|
||||||
{
|
{
|
||||||
+2
-2
@@ -19,8 +19,8 @@
|
|||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<ProjectReference Include="..\ZB.MOM.WW.MxGateway.Client\ZB.MOM.WW.MxGateway.Client.csproj" />
|
<ProjectReference Include="..\MxGateway.Client\MxGateway.Client.csproj" />
|
||||||
<ProjectReference Include="..\ZB.MOM.WW.MxGateway.Client.Cli\ZB.MOM.WW.MxGateway.Client.Cli.csproj" />
|
<ProjectReference Include="..\MxGateway.Client.Cli\MxGateway.Client.Cli.csproj" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
</Project>
|
</Project>
|
||||||
+6
-40
@@ -1,14 +1,12 @@
|
|||||||
using Google.Protobuf.WellKnownTypes;
|
using Google.Protobuf.WellKnownTypes;
|
||||||
using ZB.MOM.WW.MxGateway.Client.Cli;
|
using MxGateway.Client.Cli;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
/// <summary>Tests for the CLI command interface.</summary>
|
|
||||||
public sealed class MxGatewayClientCliTests
|
public sealed class MxGatewayClientCliTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that the version command prints compiled protocol versions.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void Run_Version_PrintsCompiledProtocolVersions()
|
public void Run_Version_PrintsCompiledProtocolVersions()
|
||||||
{
|
{
|
||||||
@@ -18,12 +16,11 @@ public sealed class MxGatewayClientCliTests
|
|||||||
var exitCode = MxGatewayClientCli.Run(["version"], output, error);
|
var exitCode = MxGatewayClientCli.Run(["version"], output, error);
|
||||||
|
|
||||||
Assert.Equal(0, exitCode);
|
Assert.Equal(0, exitCode);
|
||||||
Assert.Contains("gateway-protocol=3", output.ToString());
|
Assert.Contains("gateway-protocol=2", output.ToString());
|
||||||
Assert.Contains("worker-protocol=1", output.ToString());
|
Assert.Contains("worker-protocol=1", output.ToString());
|
||||||
Assert.Equal(string.Empty, error.ToString());
|
Assert.Equal(string.Empty, error.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that the version command with --json flag prints JSON protocol versions.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_VersionJson_PrintsJsonProtocolVersions()
|
public async Task RunAsync_VersionJson_PrintsJsonProtocolVersions()
|
||||||
{
|
{
|
||||||
@@ -33,11 +30,10 @@ public sealed class MxGatewayClientCliTests
|
|||||||
int exitCode = await MxGatewayClientCli.RunAsync(["version", "--json"], output, error);
|
int exitCode = await MxGatewayClientCli.RunAsync(["version", "--json"], output, error);
|
||||||
|
|
||||||
Assert.Equal(0, exitCode);
|
Assert.Equal(0, exitCode);
|
||||||
Assert.Contains("\"gatewayProtocolVersion\":3", output.ToString());
|
Assert.Contains("\"gatewayProtocolVersion\":2", output.ToString());
|
||||||
Assert.Equal(string.Empty, error.ToString());
|
Assert.Equal(string.Empty, error.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that the write command builds a write request and prints JSON reply.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_Write_BuildsWriteCommandAndPrintsJsonReply()
|
public async Task RunAsync_Write_BuildsWriteCommandAndPrintsJsonReply()
|
||||||
{
|
{
|
||||||
@@ -82,7 +78,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
Assert.Equal(string.Empty, error.ToString());
|
Assert.Equal(string.Empty, error.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that error output redacts sensitive API key values.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_ErrorOutput_RedactsApiKey()
|
public async Task RunAsync_ErrorOutput_RedactsApiKey()
|
||||||
{
|
{
|
||||||
@@ -106,7 +101,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
Assert.Contains("[redacted]", error.ToString());
|
Assert.Contains("[redacted]", error.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that stream-events with max-events limit stops output in non-JSON format.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_StreamEvents_WithMaxEventsStopsNonJsonOutput()
|
public async Task RunAsync_StreamEvents_WithMaxEventsStopsNonJsonOutput()
|
||||||
{
|
{
|
||||||
@@ -148,7 +142,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/// <summary>Verifies that smoke command closes opened session when a command fails.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_Smoke_WhenCommandFails_ClosesOpenedSession()
|
public async Task RunAsync_Smoke_WhenCommandFails_ClosesOpenedSession()
|
||||||
{
|
{
|
||||||
@@ -179,7 +172,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
Assert.Equal("session-fixture", closeRequest.SessionId);
|
Assert.Equal("session-fixture", closeRequest.SessionId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that galaxy-test-connection command prints JSON reply.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_GalaxyTestConnection_PrintsJsonReply()
|
public async Task RunAsync_GalaxyTestConnection_PrintsJsonReply()
|
||||||
{
|
{
|
||||||
@@ -209,7 +201,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
Assert.Equal(string.Empty, error.ToString());
|
Assert.Equal(string.Empty, error.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that galaxy-discover command prints hierarchy summary.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_GalaxyDiscover_PrintsHierarchySummary()
|
public async Task RunAsync_GalaxyDiscover_PrintsHierarchySummary()
|
||||||
{
|
{
|
||||||
@@ -279,7 +270,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
Assert.Equal(string.Empty, error.ToString());
|
Assert.Equal(string.Empty, error.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that galaxy-watch command prints text output for deploy events.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_GalaxyWatch_PrintsTextOutputForEvents()
|
public async Task RunAsync_GalaxyWatch_PrintsTextOutputForEvents()
|
||||||
{
|
{
|
||||||
@@ -333,7 +323,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
Assert.Equal(string.Empty, error.ToString());
|
Assert.Equal(string.Empty, error.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that galaxy-watch with --json emits one JSON object per event.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RunAsync_GalaxyWatch_JsonEmitsOneObjectPerEvent()
|
public async Task RunAsync_GalaxyWatch_JsonEmitsOneObjectPerEvent()
|
||||||
{
|
{
|
||||||
@@ -368,31 +357,23 @@ public sealed class MxGatewayClientCliTests
|
|||||||
Assert.Contains("\"objectCount\": 99", text);
|
Assert.Contains("\"objectCount\": 99", text);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Fake CLI client for testing.</summary>
|
|
||||||
private sealed class FakeCliClient : IMxGatewayCliClient
|
private sealed class FakeCliClient : IMxGatewayCliClient
|
||||||
{
|
{
|
||||||
/// <summary>Queue of invoke replies to return.</summary>
|
|
||||||
public Queue<MxCommandReply> InvokeReplies { get; } = new();
|
public Queue<MxCommandReply> InvokeReplies { get; } = new();
|
||||||
|
|
||||||
/// <summary>List of received invoke requests.</summary>
|
|
||||||
public List<MxCommandRequest> InvokeRequests { get; } = [];
|
public List<MxCommandRequest> InvokeRequests { get; } = [];
|
||||||
|
|
||||||
/// <summary>List of received close session requests.</summary>
|
|
||||||
public List<CloseSessionRequest> CloseSessionRequests { get; } = [];
|
public List<CloseSessionRequest> CloseSessionRequests { get; } = [];
|
||||||
|
|
||||||
/// <summary>List of events to yield when streaming.</summary>
|
|
||||||
public List<MxEvent> Events { get; } = [];
|
public List<MxEvent> Events { get; } = [];
|
||||||
|
|
||||||
/// <summary>Exception to throw on invoke, if any.</summary>
|
|
||||||
public Exception? InvokeFailure { get; init; }
|
public Exception? InvokeFailure { get; init; }
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public ValueTask DisposeAsync()
|
public ValueTask DisposeAsync()
|
||||||
{
|
{
|
||||||
return ValueTask.CompletedTask;
|
return ValueTask.CompletedTask;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<OpenSessionReply> OpenSessionAsync(
|
public Task<OpenSessionReply> OpenSessionAsync(
|
||||||
OpenSessionRequest request,
|
OpenSessionRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -406,7 +387,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<CloseSessionReply> CloseSessionAsync(
|
public Task<CloseSessionReply> CloseSessionAsync(
|
||||||
CloseSessionRequest request,
|
CloseSessionRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -420,7 +400,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<MxCommandReply> InvokeAsync(
|
public Task<MxCommandReply> InvokeAsync(
|
||||||
MxCommandRequest request,
|
MxCommandRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -434,7 +413,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
return Task.FromResult(InvokeReplies.Dequeue());
|
return Task.FromResult(InvokeReplies.Dequeue());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
public async IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
StreamEventsRequest request,
|
StreamEventsRequest request,
|
||||||
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
|
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
|
||||||
@@ -447,27 +425,20 @@ public sealed class MxGatewayClientCliTests
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Galaxy test connection reply to return.</summary>
|
|
||||||
public TestConnectionReply GalaxyTestConnectionReply { get; set; } = new() { Ok = true };
|
public TestConnectionReply GalaxyTestConnectionReply { get; set; } = new() { Ok = true };
|
||||||
|
|
||||||
/// <summary>Galaxy get last deploy time reply to return.</summary>
|
|
||||||
public GetLastDeployTimeReply GalaxyGetLastDeployTimeReply { get; set; } = new() { Present = false };
|
public GetLastDeployTimeReply GalaxyGetLastDeployTimeReply { get; set; } = new() { Present = false };
|
||||||
|
|
||||||
/// <summary>Galaxy discover hierarchy reply to return.</summary>
|
|
||||||
public DiscoverHierarchyReply GalaxyDiscoverHierarchyReply { get; set; } = new();
|
public DiscoverHierarchyReply GalaxyDiscoverHierarchyReply { get; set; } = new();
|
||||||
|
|
||||||
public Queue<DiscoverHierarchyReply> GalaxyDiscoverHierarchyReplies { get; } = new();
|
public Queue<DiscoverHierarchyReply> GalaxyDiscoverHierarchyReplies { get; } = new();
|
||||||
|
|
||||||
/// <summary>List of received galaxy test connection requests.</summary>
|
|
||||||
public List<TestConnectionRequest> GalaxyTestConnectionRequests { get; } = [];
|
public List<TestConnectionRequest> GalaxyTestConnectionRequests { get; } = [];
|
||||||
|
|
||||||
/// <summary>List of received galaxy get last deploy time requests.</summary>
|
|
||||||
public List<GetLastDeployTimeRequest> GalaxyGetLastDeployTimeRequests { get; } = [];
|
public List<GetLastDeployTimeRequest> GalaxyGetLastDeployTimeRequests { get; } = [];
|
||||||
|
|
||||||
/// <summary>List of received galaxy discover hierarchy requests.</summary>
|
|
||||||
public List<DiscoverHierarchyRequest> GalaxyDiscoverHierarchyRequests { get; } = [];
|
public List<DiscoverHierarchyRequest> GalaxyDiscoverHierarchyRequests { get; } = [];
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<TestConnectionReply> GalaxyTestConnectionAsync(
|
public Task<TestConnectionReply> GalaxyTestConnectionAsync(
|
||||||
TestConnectionRequest request,
|
TestConnectionRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -476,7 +447,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
return Task.FromResult(GalaxyTestConnectionReply);
|
return Task.FromResult(GalaxyTestConnectionReply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<GetLastDeployTimeReply> GalaxyGetLastDeployTimeAsync(
|
public Task<GetLastDeployTimeReply> GalaxyGetLastDeployTimeAsync(
|
||||||
GetLastDeployTimeRequest request,
|
GetLastDeployTimeRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -485,7 +455,6 @@ public sealed class MxGatewayClientCliTests
|
|||||||
return Task.FromResult(GalaxyGetLastDeployTimeReply);
|
return Task.FromResult(GalaxyGetLastDeployTimeReply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public Task<DiscoverHierarchyReply> GalaxyDiscoverHierarchyAsync(
|
public Task<DiscoverHierarchyReply> GalaxyDiscoverHierarchyAsync(
|
||||||
DiscoverHierarchyRequest request,
|
DiscoverHierarchyRequest request,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -497,13 +466,10 @@ public sealed class MxGatewayClientCliTests
|
|||||||
: GalaxyDiscoverHierarchyReply);
|
: GalaxyDiscoverHierarchyReply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>List of received galaxy watch deploy events requests.</summary>
|
|
||||||
public List<WatchDeployEventsRequest> GalaxyWatchDeployEventsRequests { get; } = [];
|
public List<WatchDeployEventsRequest> GalaxyWatchDeployEventsRequests { get; } = [];
|
||||||
|
|
||||||
/// <summary>List of deploy events to yield when watching.</summary>
|
|
||||||
public List<DeployEvent> GalaxyDeployEvents { get; } = [];
|
public List<DeployEvent> GalaxyDeployEvents { get; } = [];
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async IAsyncEnumerable<DeployEvent> GalaxyWatchDeployEventsAsync(
|
public async IAsyncEnumerable<DeployEvent> GalaxyWatchDeployEventsAsync(
|
||||||
WatchDeployEventsRequest request,
|
WatchDeployEventsRequest request,
|
||||||
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
|
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
|
||||||
+2
-4
@@ -1,10 +1,9 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts;
|
using MxGateway.Contracts;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
public sealed class MxGatewayClientContractInfoTests
|
public sealed class MxGatewayClientContractInfoTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that the client's gateway protocol version matches the shared contract definition.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void GatewayProtocolVersion_MatchesSharedContract()
|
public void GatewayProtocolVersion_MatchesSharedContract()
|
||||||
{
|
{
|
||||||
@@ -13,7 +12,6 @@ public sealed class MxGatewayClientContractInfoTests
|
|||||||
MxGatewayClientContractInfo.GatewayProtocolVersion);
|
MxGatewayClientContractInfo.GatewayProtocolVersion);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that the client's worker protocol version matches the shared contract definition.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void WorkerProtocolVersion_MatchesSharedContract()
|
public void WorkerProtocolVersion_MatchesSharedContract()
|
||||||
{
|
{
|
||||||
+1
-4
@@ -1,8 +1,7 @@
|
|||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
public sealed class MxGatewayClientOptionsTests
|
public sealed class MxGatewayClientOptionsTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that options with valid endpoint and API key pass validation.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void Validate_WithAbsoluteEndpointAndApiKey_Succeeds()
|
public void Validate_WithAbsoluteEndpointAndApiKey_Succeeds()
|
||||||
{
|
{
|
||||||
@@ -15,7 +14,6 @@ public sealed class MxGatewayClientOptionsTests
|
|||||||
options.Validate();
|
options.Validate();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that empty API key causes validation to fail.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void Validate_WithEmptyApiKey_Throws()
|
public void Validate_WithEmptyApiKey_Throws()
|
||||||
{
|
{
|
||||||
@@ -28,7 +26,6 @@ public sealed class MxGatewayClientOptionsTests
|
|||||||
Assert.Throws<ArgumentException>(options.Validate);
|
Assert.Throws<ArgumentException>(options.Validate);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that invalid retry options cause validation to fail.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void Validate_WithInvalidRetryOptions_Throws()
|
public void Validate_WithInvalidRetryOptions_Throws()
|
||||||
{
|
{
|
||||||
+2
-16
@@ -1,12 +1,10 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
/// <summary>Tests for MxGatewaySession and client command behavior.</summary>
|
|
||||||
public sealed class MxGatewayClientSessionTests
|
public sealed class MxGatewayClientSessionTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that open session attaches API key metadata and cancellation token.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task OpenSessionRawAsync_AttachesApiKeyMetadataAndCancellation()
|
public async Task OpenSessionRawAsync_AttachesApiKeyMetadataAndCancellation()
|
||||||
{
|
{
|
||||||
@@ -21,7 +19,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal(cancellation.Token, call.CallOptions.CancellationToken);
|
Assert.Equal(cancellation.Token, call.CallOptions.CancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that open session returns a session with the raw open reply.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task OpenSessionAsync_ReturnsSessionWithRawOpenReply()
|
public async Task OpenSessionAsync_ReturnsSessionWithRawOpenReply()
|
||||||
{
|
{
|
||||||
@@ -36,7 +33,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal(1234, session.OpenSessionReply.WorkerProcessId);
|
Assert.Equal(1234, session.OpenSessionReply.WorkerProcessId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that register builds a register command and returns server handle.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task RegisterAsync_BuildsRegisterCommandAndReturnsServerHandle()
|
public async Task RegisterAsync_BuildsRegisterCommandAndReturnsServerHandle()
|
||||||
{
|
{
|
||||||
@@ -61,7 +57,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal("fixture-client", call.Request.Command.Register.ClientName);
|
Assert.Equal("fixture-client", call.Request.Command.Register.ClientName);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that add item 2 builds a command with the specified context.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task AddItem2Async_BuildsAddItem2CommandWithContext()
|
public async Task AddItem2Async_BuildsAddItem2CommandWithContext()
|
||||||
{
|
{
|
||||||
@@ -86,7 +81,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal("runtime", request.Command.AddItem2.ItemContext);
|
Assert.Equal("runtime", request.Command.AddItem2.ItemContext);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that write raw builds a write command with the raw value.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task WriteRawAsync_BuildsWriteCommandWithRawValue()
|
public async Task WriteRawAsync_BuildsWriteCommandWithRawValue()
|
||||||
{
|
{
|
||||||
@@ -117,7 +111,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal(56, request.Command.Write.UserId);
|
Assert.Equal(56, request.Command.Write.UserId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that write 2 raw builds a write 2 command with value and timestamp.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task Write2RawAsync_BuildsWrite2CommandWithValueAndTimestamp()
|
public async Task Write2RawAsync_BuildsWrite2CommandWithValueAndTimestamp()
|
||||||
{
|
{
|
||||||
@@ -145,7 +138,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal(56, request.Command.Write2.UserId);
|
Assert.Equal(56, request.Command.Write2.UserId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that subscribe bulk builds one command and returns per-item results.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task SubscribeBulkAsync_BuildsOneBulkCommandAndReturnsPerItemResults()
|
public async Task SubscribeBulkAsync_BuildsOneBulkCommandAndReturnsPerItemResults()
|
||||||
{
|
{
|
||||||
@@ -184,7 +176,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal(["Area001.Pump001.Speed"], request.Command.SubscribeBulk.TagAddresses);
|
Assert.Equal(["Area001.Pump001.Speed"], request.Command.SubscribeBulk.TagAddresses);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that stream events yields events in the order received from the gateway.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task StreamEventsAsync_YieldsEventsInGatewayOrder()
|
public async Task StreamEventsAsync_YieldsEventsInGatewayOrder()
|
||||||
{
|
{
|
||||||
@@ -215,7 +206,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal("session-fixture", request.SessionId);
|
Assert.Equal("session-fixture", request.SessionId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that close is explicit and idempotent.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task CloseAsync_IsExplicitAndIdempotent()
|
public async Task CloseAsync_IsExplicitAndIdempotent()
|
||||||
{
|
{
|
||||||
@@ -231,7 +221,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal("session-fixture", call.Request.SessionId);
|
Assert.Equal("session-fixture", call.Request.SessionId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that invoke retries safe diagnostic commands on transient RPC failure.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task InvokeAsync_RetriesSafeDiagnosticCommandOnTransientGrpcFailure()
|
public async Task InvokeAsync_RetriesSafeDiagnosticCommandOnTransientGrpcFailure()
|
||||||
{
|
{
|
||||||
@@ -255,7 +244,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Equal(2, transport.InvokeCalls.Count);
|
Assert.Equal(2, transport.InvokeCalls.Count);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that open session does not retry on transient RPC failure.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task OpenSessionAsync_DoesNotRetryTransientGrpcFailure()
|
public async Task OpenSessionAsync_DoesNotRetryTransientGrpcFailure()
|
||||||
{
|
{
|
||||||
@@ -268,7 +256,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Single(transport.OpenSessionCalls);
|
Assert.Single(transport.OpenSessionCalls);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that invoke does not retry write commands on transient RPC failure.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task InvokeAsync_DoesNotRetryWriteCommand()
|
public async Task InvokeAsync_DoesNotRetryWriteCommand()
|
||||||
{
|
{
|
||||||
@@ -283,7 +270,6 @@ public sealed class MxGatewayClientSessionTests
|
|||||||
Assert.Single(transport.InvokeCalls);
|
Assert.Single(transport.InvokeCalls);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that invoke helpers pass cancellation token to the transport.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task InvokeHelpers_PassCancellationTokenToTransport()
|
public async Task InvokeHelpers_PassCancellationTokenToTransport()
|
||||||
{
|
{
|
||||||
+1
-2
@@ -1,8 +1,7 @@
|
|||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
public sealed class MxGatewayGeneratedContractTests
|
public sealed class MxGatewayGeneratedContractTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that the generated gRPC client can be instantiated from the client factory.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public async Task GeneratedGrpcClient_CanBeConstructedFromClientFactory()
|
public async Task GeneratedGrpcClient_CanBeConstructedFromClientFactory()
|
||||||
{
|
{
|
||||||
+3
-4
@@ -1,13 +1,12 @@
|
|||||||
using System.Text.Json;
|
using System.Text.Json;
|
||||||
using Google.Protobuf;
|
using Google.Protobuf;
|
||||||
using ZB.MOM.WW.MxGateway.Client;
|
using MxGateway.Client;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
public sealed class MxStatusProxyExtensionsTests
|
public sealed class MxStatusProxyExtensionsTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that fixture statuses correctly project success and preserve raw integer fields.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void FixtureStatuses_ProjectSuccessAndPreserveRawFields()
|
public void FixtureStatuses_ProjectSuccessAndPreserveRawFields()
|
||||||
{
|
{
|
||||||
+3
-6
@@ -1,13 +1,12 @@
|
|||||||
using System.Text.Json;
|
using System.Text.Json;
|
||||||
using Google.Protobuf;
|
using Google.Protobuf;
|
||||||
using ZB.MOM.WW.MxGateway.Client;
|
using MxGateway.Client;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
namespace MxGateway.Client.Tests;
|
||||||
|
|
||||||
public sealed class MxValueExtensionsTests
|
public sealed class MxValueExtensionsTests
|
||||||
{
|
{
|
||||||
/// <summary>Verifies that scalar values are converted to correctly-typed MxValue protobuf messages.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void ToMxValue_WithScalarValues_CreatesTypedProtobufValues()
|
public void ToMxValue_WithScalarValues_CreatesTypedProtobufValues()
|
||||||
{
|
{
|
||||||
@@ -19,7 +18,6 @@ public sealed class MxValueExtensionsTests
|
|||||||
Assert.Equal(MxValue.KindOneofCase.StringValue, "alpha".ToMxValue().KindCase);
|
Assert.Equal(MxValue.KindOneofCase.StringValue, "alpha".ToMxValue().KindCase);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that array values are converted to array-kind MxValue messages with correct element types and dimensions.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void ToMxValue_WithArrays_CreatesTypedArrayProtobufValues()
|
public void ToMxValue_WithArrays_CreatesTypedArrayProtobufValues()
|
||||||
{
|
{
|
||||||
@@ -31,7 +29,6 @@ public sealed class MxValueExtensionsTests
|
|||||||
Assert.Equal([2U], value.ArrayValue.Dimensions);
|
Assert.Equal([2U], value.ArrayValue.Dimensions);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Verifies that fixture test cases project to expected MxValue kinds and preserve raw type metadata.</summary>
|
|
||||||
[Fact]
|
[Fact]
|
||||||
public void FixtureValues_ProjectExpectedKindsAndPreserveRawMetadata()
|
public void FixtureValues_ProjectExpectedKindsAndPreserveRawMetadata()
|
||||||
{
|
{
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
|
||||||
|
Microsoft Visual Studio Solution File, Format Version 12.00
|
||||||
|
# Visual Studio Version 17
|
||||||
|
VisualStudioVersion = 17.0.31903.59
|
||||||
|
MinimumVisualStudioVersion = 10.0.40219.1
|
||||||
|
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MxGateway.Client", "MxGateway.Client\MxGateway.Client.csproj", "{7CF9ED88-1F32-4040-BEB1-D0902E304C70}"
|
||||||
|
EndProject
|
||||||
|
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MxGateway.Contracts", "..\..\src\MxGateway.Contracts\MxGateway.Contracts.csproj", "{9AB807A8-0469-40F7-A000-D240F36B6E5D}"
|
||||||
|
EndProject
|
||||||
|
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MxGateway.Client.Cli", "MxGateway.Client.Cli\MxGateway.Client.Cli.csproj", "{EB061E77-2475-4322-9257-3F2456DD141C}"
|
||||||
|
EndProject
|
||||||
|
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MxGateway.Client.Tests", "MxGateway.Client.Tests\MxGateway.Client.Tests.csproj", "{B77B5A8E-0C53-4419-9BCD-227C9753A074}"
|
||||||
|
EndProject
|
||||||
|
Global
|
||||||
|
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||||
|
Debug|Any CPU = Debug|Any CPU
|
||||||
|
Debug|x64 = Debug|x64
|
||||||
|
Debug|x86 = Debug|x86
|
||||||
|
Release|Any CPU = Release|Any CPU
|
||||||
|
Release|x64 = Release|x64
|
||||||
|
Release|x86 = Release|x86
|
||||||
|
EndGlobalSection
|
||||||
|
GlobalSection(ProjectConfigurationPlatforms) = postSolution
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Debug|x64.Build.0 = Debug|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Debug|x86.ActiveCfg = Debug|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Debug|x86.Build.0 = Debug|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Release|x64.ActiveCfg = Release|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Release|x64.Build.0 = Release|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Release|x86.ActiveCfg = Release|Any CPU
|
||||||
|
{7CF9ED88-1F32-4040-BEB1-D0902E304C70}.Release|x86.Build.0 = Release|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Debug|x64.Build.0 = Debug|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Debug|x86.ActiveCfg = Debug|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Debug|x86.Build.0 = Debug|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Release|x64.ActiveCfg = Release|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Release|x64.Build.0 = Release|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Release|x86.ActiveCfg = Release|Any CPU
|
||||||
|
{9AB807A8-0469-40F7-A000-D240F36B6E5D}.Release|x86.Build.0 = Release|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Debug|x64.Build.0 = Debug|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Debug|x86.ActiveCfg = Debug|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Debug|x86.Build.0 = Debug|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Release|x64.ActiveCfg = Release|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Release|x64.Build.0 = Release|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Release|x86.ActiveCfg = Release|Any CPU
|
||||||
|
{EB061E77-2475-4322-9257-3F2456DD141C}.Release|x86.Build.0 = Release|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Debug|x64.Build.0 = Debug|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Debug|x86.ActiveCfg = Debug|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Debug|x86.Build.0 = Debug|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Release|x64.ActiveCfg = Release|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Release|x64.Build.0 = Release|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Release|x86.ActiveCfg = Release|Any CPU
|
||||||
|
{B77B5A8E-0C53-4419-9BCD-227C9753A074}.Release|x86.Build.0 = Release|Any CPU
|
||||||
|
EndGlobalSection
|
||||||
|
GlobalSection(SolutionProperties) = preSolution
|
||||||
|
HideSolutionNode = FALSE
|
||||||
|
EndGlobalSection
|
||||||
|
EndGlobal
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public sealed record DiscoverHierarchyOptions
|
||||||
|
{
|
||||||
|
public int? RootGobjectId { get; init; }
|
||||||
|
|
||||||
|
public string? RootTagName { get; init; }
|
||||||
|
|
||||||
|
public string? RootContainedPath { get; init; }
|
||||||
|
|
||||||
|
public int? MaxDepth { get; init; }
|
||||||
|
|
||||||
|
public IReadOnlyList<int> CategoryIds { get; init; } = Array.Empty<int>();
|
||||||
|
|
||||||
|
public IReadOnlyList<string> TemplateChainContains { get; init; } = Array.Empty<string>();
|
||||||
|
|
||||||
|
public string? TagNameGlob { get; init; }
|
||||||
|
|
||||||
|
public bool? IncludeAttributes { get; init; }
|
||||||
|
|
||||||
|
public bool AlarmBearingOnly { get; init; }
|
||||||
|
|
||||||
|
public bool HistorizedOnly { get; init; }
|
||||||
|
}
|
||||||
+2
-70
@@ -2,14 +2,14 @@ using Google.Protobuf.WellKnownTypes;
|
|||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
using Grpc.Net.Client;
|
using Grpc.Net.Client;
|
||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
using Polly;
|
using Polly;
|
||||||
using System.Net.Http;
|
using System.Net.Http;
|
||||||
using System.Net.Security;
|
using System.Net.Security;
|
||||||
using System.Runtime.CompilerServices;
|
using System.Runtime.CompilerServices;
|
||||||
using System.Security.Cryptography.X509Certificates;
|
using System.Security.Cryptography.X509Certificates;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Provides the .NET client entry point for the public Galaxy Repository gRPC API.
|
/// Provides the .NET client entry point for the public Galaxy Repository gRPC API.
|
||||||
@@ -25,11 +25,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
private readonly ResiliencePipeline _safeUnaryRetryPipeline;
|
private readonly ResiliencePipeline _safeUnaryRetryPipeline;
|
||||||
private bool _disposed;
|
private bool _disposed;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes a Galaxy Repository client with custom transport and options.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="options">Client options.</param>
|
|
||||||
/// <param name="transport">The underlying gRPC transport.</param>
|
|
||||||
internal GalaxyRepositoryClient(
|
internal GalaxyRepositoryClient(
|
||||||
MxGatewayClientOptions options,
|
MxGatewayClientOptions options,
|
||||||
IGalaxyRepositoryClientTransport transport)
|
IGalaxyRepositoryClientTransport transport)
|
||||||
@@ -57,23 +52,12 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
Options.LoggerFactory?.CreateLogger<GalaxyRepositoryClient>());
|
Options.LoggerFactory?.CreateLogger<GalaxyRepositoryClient>());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Client options used to configure timeouts, authentication, and retry policy.
|
|
||||||
/// </summary>
|
|
||||||
public MxGatewayClientOptions Options { get; }
|
public MxGatewayClientOptions Options { get; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The underlying generated gRPC client for advanced operations.
|
|
||||||
/// </summary>
|
|
||||||
public GalaxyRepository.GalaxyRepositoryClient RawClient =>
|
public GalaxyRepository.GalaxyRepositoryClient RawClient =>
|
||||||
_transport.RawClient
|
_transport.RawClient
|
||||||
?? throw new InvalidOperationException("The raw generated gRPC client is not available for this client instance.");
|
?? throw new InvalidOperationException("The raw generated gRPC client is not available for this client instance.");
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates a Galaxy Repository client with the given options, establishing a new gRPC channel.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="options">Client options.</param>
|
|
||||||
/// <returns>A new client instance.</returns>
|
|
||||||
public static GalaxyRepositoryClient Create(MxGatewayClientOptions options)
|
public static GalaxyRepositoryClient Create(MxGatewayClientOptions options)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(options);
|
ArgumentNullException.ThrowIfNull(options);
|
||||||
@@ -101,8 +85,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
/// Probes the Galaxy Repository database connection. Returns true when the
|
/// Probes the Galaxy Repository database connection. Returns true when the
|
||||||
/// gateway can reach the configured ZB SQL Server.
|
/// gateway can reach the configured ZB SQL Server.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>True if connection is successful, false otherwise.</returns>
|
|
||||||
public async Task<bool> TestConnectionAsync(CancellationToken cancellationToken = default)
|
public async Task<bool> TestConnectionAsync(CancellationToken cancellationToken = default)
|
||||||
{
|
{
|
||||||
TestConnectionReply reply = await TestConnectionRawAsync(
|
TestConnectionReply reply = await TestConnectionRawAsync(
|
||||||
@@ -113,12 +95,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
return reply.Ok;
|
return reply.Ok;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Probes the Galaxy Repository database connection without result wrapping.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The test connection request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<TestConnectionReply> TestConnectionRawAsync(
|
public Task<TestConnectionReply> TestConnectionRawAsync(
|
||||||
TestConnectionRequest request,
|
TestConnectionRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -135,8 +111,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
/// Returns the timestamp of the most recent Galaxy deployment, or
|
/// Returns the timestamp of the most recent Galaxy deployment, or
|
||||||
/// <see langword="null"/> when no deployment has been recorded.
|
/// <see langword="null"/> when no deployment has been recorded.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The deployment timestamp, or null if not recorded.</returns>
|
|
||||||
public async Task<DateTime?> GetLastDeployTimeAsync(CancellationToken cancellationToken = default)
|
public async Task<DateTime?> GetLastDeployTimeAsync(CancellationToken cancellationToken = default)
|
||||||
{
|
{
|
||||||
GetLastDeployTimeReply reply = await GetLastDeployTimeRawAsync(
|
GetLastDeployTimeReply reply = await GetLastDeployTimeRawAsync(
|
||||||
@@ -152,12 +126,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
return reply.TimeOfLastDeploy.ToDateTime();
|
return reply.TimeOfLastDeploy.ToDateTime();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Returns the most recent Galaxy deployment timestamp without result wrapping.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The last deploy-time request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<GetLastDeployTimeReply> GetLastDeployTimeRawAsync(
|
public Task<GetLastDeployTimeReply> GetLastDeployTimeRawAsync(
|
||||||
GetLastDeployTimeRequest request,
|
GetLastDeployTimeRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -175,8 +143,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
/// includes its dynamic attributes so callers can determine which tag references
|
/// includes its dynamic attributes so callers can determine which tag references
|
||||||
/// they may subscribe to via the MxAccessGateway service.
|
/// they may subscribe to via the MxAccessGateway service.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The collection of Galaxy objects in the hierarchy.</returns>
|
|
||||||
public async Task<IReadOnlyList<GalaxyObject>> DiscoverHierarchyAsync(CancellationToken cancellationToken = default)
|
public async Task<IReadOnlyList<GalaxyObject>> DiscoverHierarchyAsync(CancellationToken cancellationToken = default)
|
||||||
{
|
{
|
||||||
return await DiscoverHierarchyAsync(new DiscoverHierarchyOptions(), cancellationToken).ConfigureAwait(false);
|
return await DiscoverHierarchyAsync(new DiscoverHierarchyOptions(), cancellationToken).ConfigureAwait(false);
|
||||||
@@ -256,12 +222,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
return request;
|
return request;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Enumerates the Galaxy object hierarchy without result wrapping.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The discover-hierarchy request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<DiscoverHierarchyReply> DiscoverHierarchyRawAsync(
|
public Task<DiscoverHierarchyReply> DiscoverHierarchyRawAsync(
|
||||||
DiscoverHierarchyRequest request,
|
DiscoverHierarchyRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -286,9 +246,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
/// at-least-once delivery beyond the per-subscriber buffer (gaps in
|
/// at-least-once delivery beyond the per-subscriber buffer (gaps in
|
||||||
/// <see cref="DeployEvent.Sequence"/> indicate dropped events).
|
/// <see cref="DeployEvent.Sequence"/> indicate dropped events).
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
/// <param name="lastSeenDeployTime">Optional timestamp to suppress the bootstrap event.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>An async enumerable of deploy events.</returns>
|
|
||||||
public IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
public IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
||||||
DateTimeOffset? lastSeenDeployTime = null,
|
DateTimeOffset? lastSeenDeployTime = null,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -304,12 +261,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
return WatchDeployEventsRawAsync(request, cancellationToken);
|
return WatchDeployEventsRawAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Subscribes to Galaxy deploy events without result wrapping.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The watch-deploy-events request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>An async enumerable of raw deploy events.</returns>
|
|
||||||
public IAsyncEnumerable<DeployEvent> WatchDeployEventsRawAsync(
|
public IAsyncEnumerable<DeployEvent> WatchDeployEventsRawAsync(
|
||||||
WatchDeployEventsRequest request,
|
WatchDeployEventsRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -333,9 +284,6 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Closes the gRPC channel and releases resources.
|
|
||||||
/// </summary>
|
|
||||||
public ValueTask DisposeAsync()
|
public ValueTask DisposeAsync()
|
||||||
{
|
{
|
||||||
if (_disposed)
|
if (_disposed)
|
||||||
@@ -348,32 +296,16 @@ public sealed class GalaxyRepositoryClient : IAsyncDisposable
|
|||||||
return ValueTask.CompletedTask;
|
return ValueTask.CompletedTask;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates gRPC call options with the client's default timeout and API-key authorization.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The call options.</returns>
|
|
||||||
internal CallOptions CreateCallOptions(CancellationToken cancellationToken)
|
internal CallOptions CreateCallOptions(CancellationToken cancellationToken)
|
||||||
{
|
{
|
||||||
return CreateCallOptions(cancellationToken, Options.DefaultCallTimeout);
|
return CreateCallOptions(cancellationToken, Options.DefaultCallTimeout);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates gRPC call options for streaming RPCs with the stream timeout and API-key authorization.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The stream call options.</returns>
|
|
||||||
internal CallOptions CreateStreamCallOptions(CancellationToken cancellationToken)
|
internal CallOptions CreateStreamCallOptions(CancellationToken cancellationToken)
|
||||||
{
|
{
|
||||||
return CreateCallOptions(cancellationToken, Options.StreamTimeout);
|
return CreateCallOptions(cancellationToken, Options.StreamTimeout);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates gRPC call options with the specified timeout and API-key authorization.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <param name="timeout">Optional timeout duration.</param>
|
|
||||||
/// <returns>The call options.</returns>
|
|
||||||
internal CallOptions CreateCallOptions(
|
internal CallOptions CreateCallOptions(
|
||||||
CancellationToken cancellationToken,
|
CancellationToken cancellationToken,
|
||||||
TimeSpan? timeout)
|
TimeSpan? timeout)
|
||||||
+2
-17
@@ -1,29 +1,18 @@
|
|||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// gRPC implementation of IGalaxyRepositoryClientTransport.
|
|
||||||
/// </summary>
|
|
||||||
internal sealed class GrpcGalaxyRepositoryClientTransport(
|
internal sealed class GrpcGalaxyRepositoryClientTransport(
|
||||||
MxGatewayClientOptions options,
|
MxGatewayClientOptions options,
|
||||||
GalaxyRepository.GalaxyRepositoryClient rawClient) : IGalaxyRepositoryClientTransport
|
GalaxyRepository.GalaxyRepositoryClient rawClient) : IGalaxyRepositoryClientTransport
|
||||||
{
|
{
|
||||||
/// <summary>
|
|
||||||
/// Gets the gateway client options.
|
|
||||||
/// </summary>
|
|
||||||
public MxGatewayClientOptions Options { get; } = options;
|
public MxGatewayClientOptions Options { get; } = options;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the underlying gRPC client.
|
|
||||||
/// </summary>
|
|
||||||
public GalaxyRepository.GalaxyRepositoryClient RawClient { get; } = rawClient;
|
public GalaxyRepository.GalaxyRepositoryClient RawClient { get; } = rawClient;
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
GalaxyRepository.GalaxyRepositoryClient? IGalaxyRepositoryClientTransport.RawClient => RawClient;
|
GalaxyRepository.GalaxyRepositoryClient? IGalaxyRepositoryClientTransport.RawClient => RawClient;
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async Task<TestConnectionReply> TestConnectionAsync(
|
public async Task<TestConnectionReply> TestConnectionAsync(
|
||||||
TestConnectionRequest request,
|
TestConnectionRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -40,7 +29,6 @@ internal sealed class GrpcGalaxyRepositoryClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
public async Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
||||||
GetLastDeployTimeRequest request,
|
GetLastDeployTimeRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -57,7 +45,6 @@ internal sealed class GrpcGalaxyRepositoryClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
public async Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
||||||
DiscoverHierarchyRequest request,
|
DiscoverHierarchyRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -74,7 +61,6 @@ internal sealed class GrpcGalaxyRepositoryClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
public async IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
||||||
WatchDeployEventsRequest request,
|
WatchDeployEventsRequest request,
|
||||||
CallOptions callOptions,
|
CallOptions callOptions,
|
||||||
@@ -108,7 +94,6 @@ internal sealed class GrpcGalaxyRepositoryClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
IAsyncEnumerable<DeployEvent> IGalaxyRepositoryClientTransport.WatchDeployEventsAsync(
|
IAsyncEnumerable<DeployEvent> IGalaxyRepositoryClientTransport.WatchDeployEventsAsync(
|
||||||
WatchDeployEventsRequest request,
|
WatchDeployEventsRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
+2
-76
@@ -1,29 +1,18 @@
|
|||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// gRPC implementation of IMxGatewayClientTransport.
|
|
||||||
/// </summary>
|
|
||||||
internal sealed class GrpcMxGatewayClientTransport(
|
internal sealed class GrpcMxGatewayClientTransport(
|
||||||
MxGatewayClientOptions options,
|
MxGatewayClientOptions options,
|
||||||
MxAccessGateway.MxAccessGatewayClient rawClient) : IMxGatewayClientTransport
|
MxAccessGateway.MxAccessGatewayClient rawClient) : IMxGatewayClientTransport
|
||||||
{
|
{
|
||||||
/// <summary>
|
|
||||||
/// Gets the gateway client options.
|
|
||||||
/// </summary>
|
|
||||||
public MxGatewayClientOptions Options { get; } = options;
|
public MxGatewayClientOptions Options { get; } = options;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the underlying gRPC client.
|
|
||||||
/// </summary>
|
|
||||||
public MxAccessGateway.MxAccessGatewayClient RawClient { get; } = rawClient;
|
public MxAccessGateway.MxAccessGatewayClient RawClient { get; } = rawClient;
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
MxAccessGateway.MxAccessGatewayClient? IMxGatewayClientTransport.RawClient => RawClient;
|
MxAccessGateway.MxAccessGatewayClient? IMxGatewayClientTransport.RawClient => RawClient;
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async Task<OpenSessionReply> OpenSessionAsync(
|
public async Task<OpenSessionReply> OpenSessionAsync(
|
||||||
OpenSessionRequest request,
|
OpenSessionRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -40,7 +29,6 @@ internal sealed class GrpcMxGatewayClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async Task<CloseSessionReply> CloseSessionAsync(
|
public async Task<CloseSessionReply> CloseSessionAsync(
|
||||||
CloseSessionRequest request,
|
CloseSessionRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -57,7 +45,6 @@ internal sealed class GrpcMxGatewayClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async Task<MxCommandReply> InvokeAsync(
|
public async Task<MxCommandReply> InvokeAsync(
|
||||||
MxCommandRequest request,
|
MxCommandRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -74,7 +61,6 @@ internal sealed class GrpcMxGatewayClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
public async IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
StreamEventsRequest request,
|
StreamEventsRequest request,
|
||||||
CallOptions callOptions,
|
CallOptions callOptions,
|
||||||
@@ -108,7 +94,6 @@ internal sealed class GrpcMxGatewayClientTransport(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
IAsyncEnumerable<MxEvent> IMxGatewayClientTransport.StreamEventsAsync(
|
IAsyncEnumerable<MxEvent> IMxGatewayClientTransport.StreamEventsAsync(
|
||||||
StreamEventsRequest request,
|
StreamEventsRequest request,
|
||||||
CallOptions callOptions)
|
CallOptions callOptions)
|
||||||
@@ -116,65 +101,6 @@ internal sealed class GrpcMxGatewayClientTransport(
|
|||||||
return StreamEventsAsync(request, callOptions);
|
return StreamEventsAsync(request, callOptions);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async Task<AcknowledgeAlarmReply> AcknowledgeAlarmAsync(
|
|
||||||
AcknowledgeAlarmRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
return await RawClient.AcknowledgeAlarmAsync(request, callOptions)
|
|
||||||
.ResponseAsync
|
|
||||||
.ConfigureAwait(false);
|
|
||||||
}
|
|
||||||
catch (RpcException exception)
|
|
||||||
{
|
|
||||||
throw MapRpcException(exception, callOptions.CancellationToken);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
public async IAsyncEnumerable<ActiveAlarmSnapshot> QueryActiveAlarmsAsync(
|
|
||||||
QueryActiveAlarmsRequest request,
|
|
||||||
CallOptions callOptions,
|
|
||||||
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken = default)
|
|
||||||
{
|
|
||||||
CancellationToken effectiveCancellationToken = cancellationToken.CanBeCanceled
|
|
||||||
? cancellationToken
|
|
||||||
: callOptions.CancellationToken;
|
|
||||||
|
|
||||||
using AsyncServerStreamingCall<ActiveAlarmSnapshot> call = RawClient.QueryActiveAlarms(request, callOptions);
|
|
||||||
|
|
||||||
IAsyncStreamReader<ActiveAlarmSnapshot> responseStream = call.ResponseStream;
|
|
||||||
while (true)
|
|
||||||
{
|
|
||||||
ActiveAlarmSnapshot? snapshot;
|
|
||||||
try
|
|
||||||
{
|
|
||||||
if (!await responseStream.MoveNext(effectiveCancellationToken).ConfigureAwait(false))
|
|
||||||
{
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
snapshot = responseStream.Current;
|
|
||||||
}
|
|
||||||
catch (RpcException exception)
|
|
||||||
{
|
|
||||||
throw MapRpcException(exception, effectiveCancellationToken);
|
|
||||||
}
|
|
||||||
|
|
||||||
yield return snapshot;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <inheritdoc />
|
|
||||||
IAsyncEnumerable<ActiveAlarmSnapshot> IMxGatewayClientTransport.QueryActiveAlarmsAsync(
|
|
||||||
QueryActiveAlarmsRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
return QueryActiveAlarmsAsync(request, callOptions);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static Exception MapRpcException(
|
private static Exception MapRpcException(
|
||||||
RpcException exception,
|
RpcException exception,
|
||||||
CancellationToken cancellationToken)
|
CancellationToken cancellationToken)
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
using Grpc.Core;
|
||||||
|
using MxGateway.Contracts.Proto.Galaxy;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
internal interface IGalaxyRepositoryClientTransport
|
||||||
|
{
|
||||||
|
MxGatewayClientOptions Options { get; }
|
||||||
|
|
||||||
|
GalaxyRepository.GalaxyRepositoryClient? RawClient { get; }
|
||||||
|
|
||||||
|
Task<TestConnectionReply> TestConnectionAsync(
|
||||||
|
TestConnectionRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
|
||||||
|
Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
||||||
|
GetLastDeployTimeRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
|
||||||
|
Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
||||||
|
DiscoverHierarchyRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
|
||||||
|
IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
||||||
|
WatchDeployEventsRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
using Grpc.Core;
|
||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
internal interface IMxGatewayClientTransport
|
||||||
|
{
|
||||||
|
MxGatewayClientOptions Options { get; }
|
||||||
|
|
||||||
|
MxAccessGateway.MxAccessGatewayClient? RawClient { get; }
|
||||||
|
|
||||||
|
Task<OpenSessionReply> OpenSessionAsync(
|
||||||
|
OpenSessionRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
|
||||||
|
Task<CloseSessionReply> CloseSessionAsync(
|
||||||
|
CloseSessionRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
|
||||||
|
Task<MxCommandReply> InvokeAsync(
|
||||||
|
MxCommandRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
|
||||||
|
IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
|
StreamEventsRequest request,
|
||||||
|
CallOptions callOptions);
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public sealed class MxAccessException : MxGatewayCommandException
|
||||||
|
{
|
||||||
|
public MxAccessException(
|
||||||
|
string message,
|
||||||
|
MxCommandReply reply,
|
||||||
|
Exception? innerException = null)
|
||||||
|
: base(
|
||||||
|
message,
|
||||||
|
reply.SessionId,
|
||||||
|
reply.CorrelationId,
|
||||||
|
reply.ProtocolStatus,
|
||||||
|
reply.HasHresult ? reply.Hresult : null,
|
||||||
|
reply.Statuses.ToArray(),
|
||||||
|
innerException)
|
||||||
|
{
|
||||||
|
Reply = reply;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MxCommandReply Reply { get; }
|
||||||
|
}
|
||||||
+2
-7
@@ -1,12 +1,9 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>Extension methods for checking MxCommandReply success conditions.</summary>
|
|
||||||
public static class MxCommandReplyExtensions
|
public static class MxCommandReplyExtensions
|
||||||
{
|
{
|
||||||
/// <summary>Validates that the reply has a successful protocol status (Ok or MxAccessFailure), throwing a gateway exception if not.</summary>
|
|
||||||
/// <param name="reply">The command reply to check.</param>
|
|
||||||
public static MxCommandReply EnsureProtocolSuccess(this MxCommandReply reply)
|
public static MxCommandReply EnsureProtocolSuccess(this MxCommandReply reply)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(reply);
|
ArgumentNullException.ThrowIfNull(reply);
|
||||||
@@ -22,8 +19,6 @@ public static class MxCommandReplyExtensions
|
|||||||
throw CreateProtocolException(reply, code);
|
throw CreateProtocolException(reply, code);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Validates that the reply indicates MXAccess success (no HResult or status failures), throwing MxAccessException if not.</summary>
|
|
||||||
/// <param name="reply">The command reply to check.</param>
|
|
||||||
public static MxCommandReply EnsureMxAccessSuccess(this MxCommandReply reply)
|
public static MxCommandReply EnsureMxAccessSuccess(this MxCommandReply reply)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(reply);
|
ArgumentNullException.ThrowIfNull(reply);
|
||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<ProjectReference Include="..\..\..\src\ZB.MOM.WW.MxGateway.Contracts\ZB.MOM.WW.MxGateway.Contracts.csproj" />
|
<ProjectReference Include="..\..\..\src\MxGateway.Contracts\MxGateway.Contracts.csproj" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public sealed class MxGatewayAuthenticationException : MxGatewayException
|
||||||
|
{
|
||||||
|
public MxGatewayAuthenticationException(
|
||||||
|
string message,
|
||||||
|
string? sessionId = null,
|
||||||
|
string? correlationId = null,
|
||||||
|
ProtocolStatus? protocolStatus = null,
|
||||||
|
int? hResult = null,
|
||||||
|
IReadOnlyList<MxStatusProxy>? statuses = null,
|
||||||
|
Exception? innerException = null)
|
||||||
|
: base(
|
||||||
|
message,
|
||||||
|
sessionId,
|
||||||
|
correlationId,
|
||||||
|
protocolStatus,
|
||||||
|
hResult,
|
||||||
|
statuses ?? [],
|
||||||
|
innerException)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public sealed class MxGatewayAuthorizationException : MxGatewayException
|
||||||
|
{
|
||||||
|
public MxGatewayAuthorizationException(
|
||||||
|
string message,
|
||||||
|
string? sessionId = null,
|
||||||
|
string? correlationId = null,
|
||||||
|
ProtocolStatus? protocolStatus = null,
|
||||||
|
int? hResult = null,
|
||||||
|
IReadOnlyList<MxStatusProxy>? statuses = null,
|
||||||
|
Exception? innerException = null)
|
||||||
|
: base(
|
||||||
|
message,
|
||||||
|
sessionId,
|
||||||
|
correlationId,
|
||||||
|
protocolStatus,
|
||||||
|
hResult,
|
||||||
|
statuses ?? [],
|
||||||
|
innerException)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
+2
-109
@@ -1,13 +1,13 @@
|
|||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
using Grpc.Net.Client;
|
using Grpc.Net.Client;
|
||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
using Polly;
|
using Polly;
|
||||||
using System.Net.Http;
|
using System.Net.Http;
|
||||||
using System.Net.Security;
|
using System.Net.Security;
|
||||||
using System.Security.Cryptography.X509Certificates;
|
using System.Security.Cryptography.X509Certificates;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Provides the .NET client entry point for the public MXAccess Gateway gRPC API.
|
/// Provides the .NET client entry point for the public MXAccess Gateway gRPC API.
|
||||||
@@ -19,11 +19,6 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
private readonly ResiliencePipeline _safeUnaryRetryPipeline;
|
private readonly ResiliencePipeline _safeUnaryRetryPipeline;
|
||||||
private bool _disposed;
|
private bool _disposed;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes a new instance of the <see cref="MxGatewayClient"/> with given options and transport.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="options">Client configuration options.</param>
|
|
||||||
/// <param name="transport">Transport implementation for gateway communication.</param>
|
|
||||||
internal MxGatewayClient(
|
internal MxGatewayClient(
|
||||||
MxGatewayClientOptions options,
|
MxGatewayClientOptions options,
|
||||||
IMxGatewayClientTransport transport)
|
IMxGatewayClientTransport transport)
|
||||||
@@ -51,23 +46,12 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
Options.LoggerFactory?.CreateLogger<MxGatewayClient>());
|
Options.LoggerFactory?.CreateLogger<MxGatewayClient>());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the client configuration options.
|
|
||||||
/// </summary>
|
|
||||||
public MxGatewayClientOptions Options { get; }
|
public MxGatewayClientOptions Options { get; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the underlying generated gRPC client.
|
|
||||||
/// </summary>
|
|
||||||
public MxAccessGateway.MxAccessGatewayClient RawClient =>
|
public MxAccessGateway.MxAccessGatewayClient RawClient =>
|
||||||
_transport.RawClient
|
_transport.RawClient
|
||||||
?? throw new InvalidOperationException("The raw generated gRPC client is not available for this client instance.");
|
?? throw new InvalidOperationException("The raw generated gRPC client is not available for this client instance.");
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates a new gateway client with the given options.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="options">Client configuration options.</param>
|
|
||||||
/// <returns>A new gateway client instance.</returns>
|
|
||||||
public static MxGatewayClient Create(MxGatewayClientOptions options)
|
public static MxGatewayClient Create(MxGatewayClientOptions options)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(options);
|
ArgumentNullException.ThrowIfNull(options);
|
||||||
@@ -91,12 +75,6 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
new MxAccessGateway.MxAccessGatewayClient(channel)));
|
new MxAccessGateway.MxAccessGatewayClient(channel)));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Opens a new gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">Session open request; defaults to empty request if null.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>A wrapped gateway session.</returns>
|
|
||||||
public async Task<MxGatewaySession> OpenSessionAsync(
|
public async Task<MxGatewaySession> OpenSessionAsync(
|
||||||
OpenSessionRequest? request = null,
|
OpenSessionRequest? request = null,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -109,12 +87,6 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
return new MxGatewaySession(this, reply);
|
return new MxGatewaySession(this, reply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Opens a new gateway session and returns the raw protobuf reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">Session open request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The raw gateway session open reply.</returns>
|
|
||||||
public Task<OpenSessionReply> OpenSessionRawAsync(
|
public Task<OpenSessionReply> OpenSessionRawAsync(
|
||||||
OpenSessionRequest request,
|
OpenSessionRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -125,12 +97,6 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
return _transport.OpenSessionAsync(request, CreateCallOptions(cancellationToken));
|
return _transport.OpenSessionAsync(request, CreateCallOptions(cancellationToken));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Closes an open gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">Session close request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The session close reply.</returns>
|
|
||||||
public Task<CloseSessionReply> CloseSessionRawAsync(
|
public Task<CloseSessionReply> CloseSessionRawAsync(
|
||||||
CloseSessionRequest request,
|
CloseSessionRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -143,12 +109,6 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Invokes an MXAccess command on the open session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The command request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The command reply.</returns>
|
|
||||||
public Task<MxCommandReply> InvokeAsync(
|
public Task<MxCommandReply> InvokeAsync(
|
||||||
MxCommandRequest request,
|
MxCommandRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -166,12 +126,6 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
return _transport.InvokeAsync(request, CreateCallOptions(cancellationToken));
|
return _transport.InvokeAsync(request, CreateCallOptions(cancellationToken));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Streams events from the gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The stream events request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>An async enumerable of events.</returns>
|
|
||||||
public IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
public IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
StreamEventsRequest request,
|
StreamEventsRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -182,51 +136,6 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
return _transport.StreamEventsAsync(request, CreateStreamCallOptions(cancellationToken));
|
return _transport.StreamEventsAsync(request, CreateStreamCallOptions(cancellationToken));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Acknowledges an active MXAccess alarm condition through the gateway. The
|
|
||||||
/// gateway authenticates the request against the API key's <c>invoke:alarm-ack</c>
|
|
||||||
/// scope and forwards the acknowledge to the worker's MXAccess session;
|
|
||||||
/// the resulting <see cref="MxStatusProxy"/> is returned in the reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The acknowledge request — alarm reference, comment, operator user.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The acknowledge reply with protocol + native MxStatus.</returns>
|
|
||||||
public Task<AcknowledgeAlarmReply> AcknowledgeAlarmAsync(
|
|
||||||
AcknowledgeAlarmRequest request,
|
|
||||||
CancellationToken cancellationToken = default)
|
|
||||||
{
|
|
||||||
ArgumentNullException.ThrowIfNull(request);
|
|
||||||
ThrowIfDisposed();
|
|
||||||
|
|
||||||
return ExecuteSafeUnaryAsync(
|
|
||||||
token => _transport.AcknowledgeAlarmAsync(request, CreateCallOptions(token)),
|
|
||||||
cancellationToken);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Streams a snapshot of all alarms currently Active or ActiveAcked — the gateway's
|
|
||||||
/// ConditionRefresh equivalent. Used after reconnect to seed the local Part 9 state
|
|
||||||
/// machine, or to reconcile alarms that may have been missed during a transport
|
|
||||||
/// blip. Optionally scoped by alarm-reference prefix
|
|
||||||
/// (<see cref="QueryActiveAlarmsRequest.AlarmFilterPrefix"/>) so a partial refresh
|
|
||||||
/// can target an equipment sub-tree.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The query request, optionally scoped by alarm-reference prefix.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the stream.</param>
|
|
||||||
/// <returns>An async enumerable of active-alarm snapshots.</returns>
|
|
||||||
public IAsyncEnumerable<ActiveAlarmSnapshot> QueryActiveAlarmsAsync(
|
|
||||||
QueryActiveAlarmsRequest request,
|
|
||||||
CancellationToken cancellationToken = default)
|
|
||||||
{
|
|
||||||
ArgumentNullException.ThrowIfNull(request);
|
|
||||||
ThrowIfDisposed();
|
|
||||||
|
|
||||||
return _transport.QueryActiveAlarmsAsync(request, CreateStreamCallOptions(cancellationToken));
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Disposes the client and releases all resources.
|
|
||||||
/// </summary>
|
|
||||||
public ValueTask DisposeAsync()
|
public ValueTask DisposeAsync()
|
||||||
{
|
{
|
||||||
if (_disposed)
|
if (_disposed)
|
||||||
@@ -239,32 +148,16 @@ public sealed class MxGatewayClient : IAsyncDisposable
|
|||||||
return ValueTask.CompletedTask;
|
return ValueTask.CompletedTask;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates gRPC call options with default timeout and authorization.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the call.</param>
|
|
||||||
/// <returns>Configured call options.</returns>
|
|
||||||
internal CallOptions CreateCallOptions(CancellationToken cancellationToken)
|
internal CallOptions CreateCallOptions(CancellationToken cancellationToken)
|
||||||
{
|
{
|
||||||
return CreateCallOptions(cancellationToken, Options.DefaultCallTimeout);
|
return CreateCallOptions(cancellationToken, Options.DefaultCallTimeout);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates gRPC call options for streaming with stream timeout and authorization.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the call.</param>
|
|
||||||
/// <returns>Configured call options.</returns>
|
|
||||||
internal CallOptions CreateStreamCallOptions(CancellationToken cancellationToken)
|
internal CallOptions CreateStreamCallOptions(CancellationToken cancellationToken)
|
||||||
{
|
{
|
||||||
return CreateCallOptions(cancellationToken, Options.StreamTimeout);
|
return CreateCallOptions(cancellationToken, Options.StreamTimeout);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates gRPC call options with specified timeout and authorization.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the call.</param>
|
|
||||||
/// <param name="timeout">Optional timeout duration; null means no timeout.</param>
|
|
||||||
/// <returns>Configured call options.</returns>
|
|
||||||
internal CallOptions CreateCallOptions(
|
internal CallOptions CreateCallOptions(
|
||||||
CancellationToken cancellationToken,
|
CancellationToken cancellationToken,
|
||||||
TimeSpan? timeout)
|
TimeSpan? timeout)
|
||||||
+2
-2
@@ -1,6 +1,6 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts;
|
using MxGateway.Contracts;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Exposes the protocol versions compiled into this client package.
|
/// Exposes the protocol versions compiled into this client package.
|
||||||
+1
-37
@@ -1,70 +1,34 @@
|
|||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Configures the gRPC channel used by the .NET MXAccess Gateway client.
|
/// Configures the gRPC channel used by the .NET MXAccess Gateway client.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public sealed class MxGatewayClientOptions
|
public sealed class MxGatewayClientOptions
|
||||||
{
|
{
|
||||||
/// <summary>
|
|
||||||
/// Gets the gateway endpoint URI (required).
|
|
||||||
/// </summary>
|
|
||||||
public required Uri Endpoint { get; init; }
|
public required Uri Endpoint { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the API key for gateway authentication (required).
|
|
||||||
/// </summary>
|
|
||||||
public required string ApiKey { get; init; }
|
public required string ApiKey { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets a value indicating whether to use TLS for the gateway connection.
|
|
||||||
/// </summary>
|
|
||||||
public bool UseTls { get; init; }
|
public bool UseTls { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the path to a CA certificate file for custom certificate validation.
|
|
||||||
/// </summary>
|
|
||||||
public string? CaCertificatePath { get; init; }
|
public string? CaCertificatePath { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the server name override for SNI during TLS handshake.
|
|
||||||
/// </summary>
|
|
||||||
public string? ServerNameOverride { get; init; }
|
public string? ServerNameOverride { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the timeout for establishing connection to the gateway.
|
|
||||||
/// </summary>
|
|
||||||
public TimeSpan ConnectTimeout { get; init; } = TimeSpan.FromSeconds(10);
|
public TimeSpan ConnectTimeout { get; init; } = TimeSpan.FromSeconds(10);
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the default timeout for unary gRPC calls.
|
|
||||||
/// </summary>
|
|
||||||
public TimeSpan DefaultCallTimeout { get; init; } = TimeSpan.FromSeconds(30);
|
public TimeSpan DefaultCallTimeout { get; init; } = TimeSpan.FromSeconds(30);
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the optional timeout for streaming gRPC calls.
|
|
||||||
/// </summary>
|
|
||||||
public TimeSpan? StreamTimeout { get; init; }
|
public TimeSpan? StreamTimeout { get; init; }
|
||||||
|
|
||||||
public int MaxGrpcMessageBytes { get; init; } = 16 * 1024 * 1024;
|
public int MaxGrpcMessageBytes { get; init; } = 16 * 1024 * 1024;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the retry configuration for safe unary calls.
|
|
||||||
/// </summary>
|
|
||||||
public MxGatewayClientRetryOptions Retry { get; init; } = new();
|
public MxGatewayClientRetryOptions Retry { get; init; } = new();
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the logger factory for diagnostic logging.
|
|
||||||
/// </summary>
|
|
||||||
public ILoggerFactory? LoggerFactory { get; init; }
|
public ILoggerFactory? LoggerFactory { get; init; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Validates the client options for consistency and correctness.
|
|
||||||
/// </summary>
|
|
||||||
/// <exception cref="ArgumentNullException">Endpoint is null.</exception>
|
|
||||||
/// <exception cref="ArgumentException">Options are invalid or inconsistent.</exception>
|
|
||||||
/// <exception cref="ArgumentOutOfRangeException">Timeout values are not greater than zero.</exception>
|
|
||||||
public void Validate()
|
public void Validate()
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(Endpoint);
|
ArgumentNullException.ThrowIfNull(Endpoint);
|
||||||
+1
-7
@@ -1,21 +1,15 @@
|
|||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>Configuration for automatic retry behavior on transient gRPC call failures.</summary>
|
|
||||||
public sealed class MxGatewayClientRetryOptions
|
public sealed class MxGatewayClientRetryOptions
|
||||||
{
|
{
|
||||||
/// <summary>Gets the maximum number of attempts (initial + retries); default is 2.</summary>
|
|
||||||
public int MaxAttempts { get; init; } = 2;
|
public int MaxAttempts { get; init; } = 2;
|
||||||
|
|
||||||
/// <summary>Gets the initial delay between retry attempts; default is 200 milliseconds.</summary>
|
|
||||||
public TimeSpan Delay { get; init; } = TimeSpan.FromMilliseconds(200);
|
public TimeSpan Delay { get; init; } = TimeSpan.FromMilliseconds(200);
|
||||||
|
|
||||||
/// <summary>Gets the maximum delay between retry attempts; default is 2 seconds.</summary>
|
|
||||||
public TimeSpan MaxDelay { get; init; } = TimeSpan.FromSeconds(2);
|
public TimeSpan MaxDelay { get; init; } = TimeSpan.FromSeconds(2);
|
||||||
|
|
||||||
/// <summary>Gets a value indicating whether to add randomness to retry delays; default is true.</summary>
|
|
||||||
public bool UseJitter { get; init; } = true;
|
public bool UseJitter { get; init; } = true;
|
||||||
|
|
||||||
/// <summary>Validates the retry options and throws if any constraint is violated.</summary>
|
|
||||||
public void Validate()
|
public void Validate()
|
||||||
{
|
{
|
||||||
if (MaxAttempts <= 0)
|
if (MaxAttempts <= 0)
|
||||||
+2
-8
@@ -1,17 +1,13 @@
|
|||||||
using Grpc.Core;
|
using Grpc.Core;
|
||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
using Polly;
|
using Polly;
|
||||||
using Polly.Retry;
|
using Polly.Retry;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>Factory and helpers for exponential-backoff retry policies on transient gRPC failures.</summary>
|
|
||||||
internal static class MxGatewayClientRetryPolicy
|
internal static class MxGatewayClientRetryPolicy
|
||||||
{
|
{
|
||||||
/// <summary>Creates a Polly ResiliencePipeline that retries transient gRPC failures with exponential backoff.</summary>
|
|
||||||
/// <param name="options">Retry configuration (max attempts, delay bounds, jitter).</param>
|
|
||||||
/// <param name="logger">Optional logger for retry diagnostics.</param>
|
|
||||||
public static ResiliencePipeline Create(
|
public static ResiliencePipeline Create(
|
||||||
MxGatewayClientRetryOptions options,
|
MxGatewayClientRetryOptions options,
|
||||||
ILogger? logger)
|
ILogger? logger)
|
||||||
@@ -40,8 +36,6 @@ internal static class MxGatewayClientRetryPolicy
|
|||||||
.Build();
|
.Build();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Returns whether a command kind is eligible for automatic retry on transient failures.</summary>
|
|
||||||
/// <param name="kind">The command kind to check.</param>
|
|
||||||
public static bool IsRetryableCommand(MxCommandKind kind)
|
public static bool IsRetryableCommand(MxCommandKind kind)
|
||||||
{
|
{
|
||||||
return kind is MxCommandKind.Ping
|
return kind is MxCommandKind.Ping
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public class MxGatewayCommandException : MxGatewayException
|
||||||
|
{
|
||||||
|
public MxGatewayCommandException(
|
||||||
|
string message,
|
||||||
|
string? sessionId = null,
|
||||||
|
string? correlationId = null,
|
||||||
|
ProtocolStatus? protocolStatus = null,
|
||||||
|
int? hResult = null,
|
||||||
|
IReadOnlyList<MxStatusProxy>? statuses = null,
|
||||||
|
Exception? innerException = null)
|
||||||
|
: base(
|
||||||
|
message,
|
||||||
|
sessionId,
|
||||||
|
correlationId,
|
||||||
|
protocolStatus,
|
||||||
|
hResult,
|
||||||
|
statuses ?? [],
|
||||||
|
innerException)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public class MxGatewayException : Exception
|
||||||
|
{
|
||||||
|
public MxGatewayException(string message)
|
||||||
|
: base(message)
|
||||||
|
{
|
||||||
|
Statuses = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
public MxGatewayException(string message, Exception? innerException)
|
||||||
|
: base(message, innerException)
|
||||||
|
{
|
||||||
|
Statuses = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
public MxGatewayException(
|
||||||
|
string message,
|
||||||
|
string? sessionId,
|
||||||
|
string? correlationId,
|
||||||
|
ProtocolStatus? protocolStatus,
|
||||||
|
int? hResult,
|
||||||
|
IReadOnlyList<MxStatusProxy> statuses,
|
||||||
|
Exception? innerException = null)
|
||||||
|
: base(message, innerException)
|
||||||
|
{
|
||||||
|
SessionId = sessionId;
|
||||||
|
CorrelationId = correlationId;
|
||||||
|
ProtocolStatus = protocolStatus;
|
||||||
|
HResultCode = hResult;
|
||||||
|
Statuses = statuses;
|
||||||
|
}
|
||||||
|
|
||||||
|
public string? SessionId { get; }
|
||||||
|
|
||||||
|
public string? CorrelationId { get; }
|
||||||
|
|
||||||
|
public ProtocolStatus? ProtocolStatus { get; }
|
||||||
|
|
||||||
|
public int? HResultCode { get; }
|
||||||
|
|
||||||
|
public IReadOnlyList<MxStatusProxy> Statuses { get; }
|
||||||
|
}
|
||||||
+2
-192
@@ -1,6 +1,6 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Represents one gateway-backed MXAccess session.
|
/// Represents one gateway-backed MXAccess session.
|
||||||
@@ -11,11 +11,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
private readonly SemaphoreSlim _closeLock = new(1, 1);
|
private readonly SemaphoreSlim _closeLock = new(1, 1);
|
||||||
private CloseSessionReply? _closeReply;
|
private CloseSessionReply? _closeReply;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes a new session backed by the given MXAccess gateway client.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="client">The gateway client used for commands and events.</param>
|
|
||||||
/// <param name="openSessionReply">The server's session creation response.</param>
|
|
||||||
internal MxGatewaySession(
|
internal MxGatewaySession(
|
||||||
MxGatewayClient client,
|
MxGatewayClient client,
|
||||||
OpenSessionReply openSessionReply)
|
OpenSessionReply openSessionReply)
|
||||||
@@ -24,21 +19,10 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
OpenSessionReply = openSessionReply ?? throw new ArgumentNullException(nameof(openSessionReply));
|
OpenSessionReply = openSessionReply ?? throw new ArgumentNullException(nameof(openSessionReply));
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The session ID assigned by the gateway.
|
|
||||||
/// </summary>
|
|
||||||
public string SessionId => OpenSessionReply.SessionId;
|
public string SessionId => OpenSessionReply.SessionId;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The server's session creation response containing metadata.
|
|
||||||
/// </summary>
|
|
||||||
public OpenSessionReply OpenSessionReply { get; }
|
public OpenSessionReply OpenSessionReply { get; }
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Closes the session on the gateway. Idempotent.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The server's close-session reply.</returns>
|
|
||||||
public async Task<CloseSessionReply> CloseAsync(CancellationToken cancellationToken = default)
|
public async Task<CloseSessionReply> CloseAsync(CancellationToken cancellationToken = default)
|
||||||
{
|
{
|
||||||
if (_closeReply is not null)
|
if (_closeReply is not null)
|
||||||
@@ -66,12 +50,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Registers a client with the MXAccess session, returning a ServerHandle.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="clientName">Name to register.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The server handle assigned to the registered client.</returns>
|
|
||||||
public async Task<int> RegisterAsync(
|
public async Task<int> RegisterAsync(
|
||||||
string clientName,
|
string clientName,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -82,12 +60,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.Register?.ServerHandle ?? reply.ReturnValue.Int32Value;
|
return reply.Register?.ServerHandle ?? reply.ReturnValue.Int32Value;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Registers a client with the MXAccess session without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="clientName">Name to register.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> RegisterRawAsync(
|
public Task<MxCommandReply> RegisterRawAsync(
|
||||||
string clientName,
|
string clientName,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -103,13 +75,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds an item to the MXAccess session, returning an ItemHandle.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemDefinition">The item tag address.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The item handle assigned to the new item.</returns>
|
|
||||||
public async Task<int> AddItemAsync(
|
public async Task<int> AddItemAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
string itemDefinition,
|
string itemDefinition,
|
||||||
@@ -124,13 +89,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.AddItem?.ItemHandle ?? reply.ReturnValue.Int32Value;
|
return reply.AddItem?.ItemHandle ?? reply.ReturnValue.Int32Value;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds an item to the MXAccess session without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemDefinition">The item tag address.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> AddItemRawAsync(
|
public Task<MxCommandReply> AddItemRawAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
string itemDefinition,
|
string itemDefinition,
|
||||||
@@ -151,14 +109,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds an item with context to the MXAccess session, returning an ItemHandle.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemDefinition">The item tag address.</param>
|
|
||||||
/// <param name="itemContext">Additional context for the item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The item handle assigned to the new item.</returns>
|
|
||||||
public async Task<int> AddItem2Async(
|
public async Task<int> AddItem2Async(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
string itemDefinition,
|
string itemDefinition,
|
||||||
@@ -175,14 +125,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.AddItem2?.ItemHandle ?? reply.ReturnValue.Int32Value;
|
return reply.AddItem2?.ItemHandle ?? reply.ReturnValue.Int32Value;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds an item with context to the MXAccess session without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemDefinition">The item tag address.</param>
|
|
||||||
/// <param name="itemContext">Additional context for the item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> AddItem2RawAsync(
|
public Task<MxCommandReply> AddItem2RawAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
string itemDefinition,
|
string itemDefinition,
|
||||||
@@ -205,12 +147,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Subscribes to events for an item (advises in MXAccess terminology).
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
public async Task AdviseAsync(
|
public async Task AdviseAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -221,13 +157,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Subscribes to events for an item without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> AdviseRawAsync(
|
public Task<MxCommandReply> AdviseRawAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -246,12 +175,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Unsubscribes from events for an item (unadvises in MXAccess terminology).
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
public async Task UnAdviseAsync(
|
public async Task UnAdviseAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -262,13 +185,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Unsubscribes from events for an item without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> UnAdviseRawAsync(
|
public Task<MxCommandReply> UnAdviseRawAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -287,12 +203,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Removes an item from the MXAccess session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
public async Task RemoveItemAsync(
|
public async Task RemoveItemAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -303,13 +213,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Removes an item from the MXAccess session without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> RemoveItemRawAsync(
|
public Task<MxCommandReply> RemoveItemRawAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -328,13 +231,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds multiple items to the MXAccess session in a single command.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="tagAddresses">The item tag addresses to add.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>Per-item subscription results.</returns>
|
|
||||||
public async Task<IReadOnlyList<SubscribeResult>> AddItemBulkAsync(
|
public async Task<IReadOnlyList<SubscribeResult>> AddItemBulkAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
IReadOnlyList<string> tagAddresses,
|
IReadOnlyList<string> tagAddresses,
|
||||||
@@ -357,13 +253,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.AddItemBulk?.Results.ToArray() ?? [];
|
return reply.AddItemBulk?.Results.ToArray() ?? [];
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Advises multiple items in a single command.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandles">The ItemHandles to advise.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>Per-item subscription results.</returns>
|
|
||||||
public async Task<IReadOnlyList<SubscribeResult>> AdviseItemBulkAsync(
|
public async Task<IReadOnlyList<SubscribeResult>> AdviseItemBulkAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
IReadOnlyList<int> itemHandles,
|
IReadOnlyList<int> itemHandles,
|
||||||
@@ -386,13 +275,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.AdviseItemBulk?.Results.ToArray() ?? [];
|
return reply.AdviseItemBulk?.Results.ToArray() ?? [];
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Removes multiple items in a single command.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandles">The ItemHandles to remove.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>Per-item subscription results.</returns>
|
|
||||||
public async Task<IReadOnlyList<SubscribeResult>> RemoveItemBulkAsync(
|
public async Task<IReadOnlyList<SubscribeResult>> RemoveItemBulkAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
IReadOnlyList<int> itemHandles,
|
IReadOnlyList<int> itemHandles,
|
||||||
@@ -415,13 +297,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.RemoveItemBulk?.Results.ToArray() ?? [];
|
return reply.RemoveItemBulk?.Results.ToArray() ?? [];
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Unadvises multiple items in a single command.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandles">The ItemHandles to unadvise.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>Per-item subscription results.</returns>
|
|
||||||
public async Task<IReadOnlyList<SubscribeResult>> UnAdviseItemBulkAsync(
|
public async Task<IReadOnlyList<SubscribeResult>> UnAdviseItemBulkAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
IReadOnlyList<int> itemHandles,
|
IReadOnlyList<int> itemHandles,
|
||||||
@@ -444,13 +319,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.UnAdviseItemBulk?.Results.ToArray() ?? [];
|
return reply.UnAdviseItemBulk?.Results.ToArray() ?? [];
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds and advises multiple items in a single command.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="tagAddresses">The item tag addresses to add and advise.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>Per-item subscription results.</returns>
|
|
||||||
public async Task<IReadOnlyList<SubscribeResult>> SubscribeBulkAsync(
|
public async Task<IReadOnlyList<SubscribeResult>> SubscribeBulkAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
IReadOnlyList<string> tagAddresses,
|
IReadOnlyList<string> tagAddresses,
|
||||||
@@ -473,13 +341,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.SubscribeBulk?.Results.ToArray() ?? [];
|
return reply.SubscribeBulk?.Results.ToArray() ?? [];
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Unadvises and removes multiple items in a single command.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandles">The ItemHandles to unsubscribe.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>Per-item subscription results.</returns>
|
|
||||||
public async Task<IReadOnlyList<SubscribeResult>> UnsubscribeBulkAsync(
|
public async Task<IReadOnlyList<SubscribeResult>> UnsubscribeBulkAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
IReadOnlyList<int> itemHandles,
|
IReadOnlyList<int> itemHandles,
|
||||||
@@ -502,14 +363,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return reply.UnsubscribeBulk?.Results.ToArray() ?? [];
|
return reply.UnsubscribeBulk?.Results.ToArray() ?? [];
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Writes a value to an item on the MXAccess server.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="value">The value to write.</param>
|
|
||||||
/// <param name="userId">User ID context for the write.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
public async Task WriteAsync(
|
public async Task WriteAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -522,15 +375,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Writes a value to an item on the MXAccess server without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="value">The value to write.</param>
|
|
||||||
/// <param name="userId">User ID context for the write.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> WriteRawAsync(
|
public Task<MxCommandReply> WriteRawAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -555,15 +399,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Writes a value and timestamp to an item on the MXAccess server.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="value">The value to write.</param>
|
|
||||||
/// <param name="timestampValue">The timestamp to write with the value.</param>
|
|
||||||
/// <param name="userId">User ID context for the write.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
public async Task Write2Async(
|
public async Task Write2Async(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -583,16 +418,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
reply.EnsureProtocolSuccess().EnsureMxAccessSuccess();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Writes a value and timestamp to an item on the MXAccess server without error checking.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="serverHandle">The ServerHandle from register.</param>
|
|
||||||
/// <param name="itemHandle">The ItemHandle from add-item.</param>
|
|
||||||
/// <param name="value">The value to write.</param>
|
|
||||||
/// <param name="timestampValue">The timestamp to write with the value.</param>
|
|
||||||
/// <param name="userId">User ID context for the write.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> Write2RawAsync(
|
public Task<MxCommandReply> Write2RawAsync(
|
||||||
int serverHandle,
|
int serverHandle,
|
||||||
int itemHandle,
|
int itemHandle,
|
||||||
@@ -620,12 +445,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Invokes an MXAccess command on this session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The command request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>The raw server reply.</returns>
|
|
||||||
public Task<MxCommandReply> InvokeAsync(
|
public Task<MxCommandReply> InvokeAsync(
|
||||||
MxCommandRequest request,
|
MxCommandRequest request,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -634,12 +453,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
return _client.InvokeAsync(request, cancellationToken);
|
return _client.InvokeAsync(request, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Streams events from the worker for this session, optionally starting after a given sequence number.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="afterWorkerSequence">The sequence number to stream from. Defaults to 0.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token.</param>
|
|
||||||
/// <returns>An async enumerable of events.</returns>
|
|
||||||
public IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
public IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
||||||
ulong afterWorkerSequence = 0,
|
ulong afterWorkerSequence = 0,
|
||||||
CancellationToken cancellationToken = default)
|
CancellationToken cancellationToken = default)
|
||||||
@@ -653,9 +466,6 @@ public sealed class MxGatewaySession : IAsyncDisposable
|
|||||||
cancellationToken);
|
cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Closes the session and releases resources.
|
|
||||||
/// </summary>
|
|
||||||
public async ValueTask DisposeAsync()
|
public async ValueTask DisposeAsync()
|
||||||
{
|
{
|
||||||
await CloseAsync().ConfigureAwait(false);
|
await CloseAsync().ConfigureAwait(false);
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public sealed class MxGatewaySessionException : MxGatewayException
|
||||||
|
{
|
||||||
|
public MxGatewaySessionException(
|
||||||
|
string message,
|
||||||
|
string? sessionId = null,
|
||||||
|
string? correlationId = null,
|
||||||
|
ProtocolStatus? protocolStatus = null,
|
||||||
|
int? hResult = null,
|
||||||
|
IReadOnlyList<MxStatusProxy>? statuses = null,
|
||||||
|
Exception? innerException = null)
|
||||||
|
: base(
|
||||||
|
message,
|
||||||
|
sessionId,
|
||||||
|
correlationId,
|
||||||
|
protocolStatus,
|
||||||
|
hResult,
|
||||||
|
statuses ?? [],
|
||||||
|
innerException)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
|
public sealed class MxGatewayWorkerException : MxGatewayException
|
||||||
|
{
|
||||||
|
public MxGatewayWorkerException(
|
||||||
|
string message,
|
||||||
|
string? sessionId = null,
|
||||||
|
string? correlationId = null,
|
||||||
|
ProtocolStatus? protocolStatus = null,
|
||||||
|
int? hResult = null,
|
||||||
|
IReadOnlyList<MxStatusProxy>? statuses = null,
|
||||||
|
Exception? innerException = null)
|
||||||
|
: base(
|
||||||
|
message,
|
||||||
|
sessionId,
|
||||||
|
correlationId,
|
||||||
|
protocolStatus,
|
||||||
|
hResult,
|
||||||
|
statuses ?? [],
|
||||||
|
innerException)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
+2
-7
@@ -1,12 +1,9 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>Extension methods for MxStatusProxy values.</summary>
|
|
||||||
public static class MxStatusProxyExtensions
|
public static class MxStatusProxyExtensions
|
||||||
{
|
{
|
||||||
/// <summary>Returns whether the status indicates success (success flag set and category is Ok).</summary>
|
|
||||||
/// <param name="status">The status to check.</param>
|
|
||||||
public static bool IsSuccess(this MxStatusProxy status)
|
public static bool IsSuccess(this MxStatusProxy status)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(status);
|
ArgumentNullException.ThrowIfNull(status);
|
||||||
@@ -15,8 +12,6 @@ public static class MxStatusProxyExtensions
|
|||||||
&& status.Category is MxStatusCategory.Ok;
|
&& status.Category is MxStatusCategory.Ok;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Returns a formatted summary of the status for diagnostic output.</summary>
|
|
||||||
/// <param name="status">The status to summarize.</param>
|
|
||||||
public static string ToDiagnosticSummary(this MxStatusProxy status)
|
public static string ToDiagnosticSummary(this MxStatusProxy status)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(status);
|
ArgumentNullException.ThrowIfNull(status);
|
||||||
+2
-81
@@ -1,8 +1,8 @@
|
|||||||
using Google.Protobuf;
|
using Google.Protobuf;
|
||||||
using Google.Protobuf.WellKnownTypes;
|
using Google.Protobuf.WellKnownTypes;
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
using MxGateway.Contracts.Proto;
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
namespace MxGateway.Client;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Creates and projects gateway MXAccess values without hiding the raw
|
/// Creates and projects gateway MXAccess values without hiding the raw
|
||||||
@@ -10,10 +10,6 @@ namespace ZB.MOM.WW.MxGateway.Client;
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public static class MxValueExtensions
|
public static class MxValueExtensions
|
||||||
{
|
{
|
||||||
/// <summary>
|
|
||||||
/// Converts a boolean value to an MxValue with MxDataType.Boolean.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">Scalar boolean value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this bool value)
|
public static MxValue ToMxValue(this bool value)
|
||||||
{
|
{
|
||||||
return new MxValue
|
return new MxValue
|
||||||
@@ -24,10 +20,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a 32-bit integer value to an MxValue with MxDataType.Integer.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">32-bit integer value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this int value)
|
public static MxValue ToMxValue(this int value)
|
||||||
{
|
{
|
||||||
return new MxValue
|
return new MxValue
|
||||||
@@ -38,10 +30,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a 64-bit integer value to an MxValue with MxDataType.Integer.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">64-bit integer value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this long value)
|
public static MxValue ToMxValue(this long value)
|
||||||
{
|
{
|
||||||
return new MxValue
|
return new MxValue
|
||||||
@@ -52,10 +40,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a single-precision floating-point value to an MxValue with MxDataType.Float.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">Single-precision floating-point value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this float value)
|
public static MxValue ToMxValue(this float value)
|
||||||
{
|
{
|
||||||
return new MxValue
|
return new MxValue
|
||||||
@@ -66,10 +50,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a double-precision floating-point value to an MxValue with MxDataType.Double.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">Double-precision floating-point value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this double value)
|
public static MxValue ToMxValue(this double value)
|
||||||
{
|
{
|
||||||
return new MxValue
|
return new MxValue
|
||||||
@@ -80,10 +60,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a string value to an MxValue with MxDataType.String.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">String value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this string value)
|
public static MxValue ToMxValue(this string value)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(value);
|
ArgumentNullException.ThrowIfNull(value);
|
||||||
@@ -96,10 +72,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a DateTimeOffset value to an MxValue with MxDataType.Time.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">DateTimeOffset value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this DateTimeOffset value)
|
public static MxValue ToMxValue(this DateTimeOffset value)
|
||||||
{
|
{
|
||||||
return new MxValue
|
return new MxValue
|
||||||
@@ -110,10 +82,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a DateTime value to an MxValue with MxDataType.Time.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">DateTime value to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this DateTime value)
|
public static MxValue ToMxValue(this DateTime value)
|
||||||
{
|
{
|
||||||
return new DateTimeOffset(
|
return new DateTimeOffset(
|
||||||
@@ -123,10 +91,6 @@ public static class MxValueExtensions
|
|||||||
.ToMxValue();
|
.ToMxValue();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a boolean array to an MxValue with MxDataType.Boolean.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="values">Array of boolean values to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this IReadOnlyList<bool> values)
|
public static MxValue ToMxValue(this IReadOnlyList<bool> values)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(values);
|
ArgumentNullException.ThrowIfNull(values);
|
||||||
@@ -141,10 +105,6 @@ public static class MxValueExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a 32-bit integer array to an MxValue with MxDataType.Integer.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="values">Array of 32-bit integer values to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this IReadOnlyList<int> values)
|
public static MxValue ToMxValue(this IReadOnlyList<int> values)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(values);
|
ArgumentNullException.ThrowIfNull(values);
|
||||||
@@ -159,10 +119,6 @@ public static class MxValueExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a 64-bit integer array to an MxValue with MxDataType.Integer.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="values">Array of 64-bit integer values to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this IReadOnlyList<long> values)
|
public static MxValue ToMxValue(this IReadOnlyList<long> values)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(values);
|
ArgumentNullException.ThrowIfNull(values);
|
||||||
@@ -177,10 +133,6 @@ public static class MxValueExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a single-precision floating-point array to an MxValue with MxDataType.Float.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="values">Array of single-precision floating-point values to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this IReadOnlyList<float> values)
|
public static MxValue ToMxValue(this IReadOnlyList<float> values)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(values);
|
ArgumentNullException.ThrowIfNull(values);
|
||||||
@@ -195,10 +147,6 @@ public static class MxValueExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a double-precision floating-point array to an MxValue with MxDataType.Double.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="values">Array of double-precision floating-point values to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this IReadOnlyList<double> values)
|
public static MxValue ToMxValue(this IReadOnlyList<double> values)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(values);
|
ArgumentNullException.ThrowIfNull(values);
|
||||||
@@ -213,10 +161,6 @@ public static class MxValueExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a string array to an MxValue with MxDataType.String.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="values">Array of string values to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this IReadOnlyList<string> values)
|
public static MxValue ToMxValue(this IReadOnlyList<string> values)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(values);
|
ArgumentNullException.ThrowIfNull(values);
|
||||||
@@ -231,10 +175,6 @@ public static class MxValueExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts a DateTimeOffset array to an MxValue with MxDataType.Time.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="values">Array of DateTimeOffset values to wrap.</param>
|
|
||||||
public static MxValue ToMxValue(this IReadOnlyList<DateTimeOffset> values)
|
public static MxValue ToMxValue(this IReadOnlyList<DateTimeOffset> values)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(values);
|
ArgumentNullException.ThrowIfNull(values);
|
||||||
@@ -249,10 +189,6 @@ public static class MxValueExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the projection kind (field name) of the given MxValue's current oneof value.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">The MxValue whose oneof projection kind is returned.</param>
|
|
||||||
public static string GetProjectionKind(this MxValue value)
|
public static string GetProjectionKind(this MxValue value)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(value);
|
ArgumentNullException.ThrowIfNull(value);
|
||||||
@@ -272,10 +208,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts an MxValue to a CLR object; returns the boxed value or null for null MxValues.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">The MxValue to convert.</param>
|
|
||||||
public static object? ToClrValue(this MxValue value)
|
public static object? ToClrValue(this MxValue value)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(value);
|
ArgumentNullException.ThrowIfNull(value);
|
||||||
@@ -295,10 +227,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Converts an MxArray to a CLR array; returns null if the array does not have a known element type.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="array">The MxArray to convert.</param>
|
|
||||||
public static object? ToClrArrayValue(this MxArray array)
|
public static object? ToClrArrayValue(this MxArray array)
|
||||||
{
|
{
|
||||||
ArgumentNullException.ThrowIfNull(array);
|
ArgumentNullException.ThrowIfNull(array);
|
||||||
@@ -321,13 +249,6 @@ public static class MxValueExtensions
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Creates an MxValue with MxDataType.Unknown from raw byte data, variant type, and diagnostic info.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="value">Raw byte data representing the value.</param>
|
|
||||||
/// <param name="variantType">Variant type string (e.g., "VT_BSTR").</param>
|
|
||||||
/// <param name="rawDiagnostic">Diagnostic string describing the raw value.</param>
|
|
||||||
/// <param name="rawDataType">Optional MXAccess data type override.</param>
|
|
||||||
public static MxValue ToRawMxValue(
|
public static MxValue ToRawMxValue(
|
||||||
byte[] value,
|
byte[] value,
|
||||||
string variantType,
|
string variantType,
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
using System.Runtime.CompilerServices;
|
||||||
|
|
||||||
|
[assembly: InternalsVisibleTo("MxGateway.Client.Tests")]
|
||||||
+29
-29
@@ -7,11 +7,11 @@ CLI, and unit tests.
|
|||||||
|
|
||||||
| Project | Purpose |
|
| Project | Purpose |
|
||||||
|---------|---------|
|
|---------|---------|
|
||||||
| `ZB.MOM.WW.MxGateway.Client` | .NET 10 library entry point, raw gRPC calls, and session helpers. |
|
| `MxGateway.Client` | .NET 10 library entry point, raw gRPC calls, and session helpers. |
|
||||||
| `ZB.MOM.WW.MxGateway.Client.Cli` | Test CLI for smoke and diagnostic commands. |
|
| `MxGateway.Client.Cli` | Test CLI for smoke and diagnostic commands. |
|
||||||
| `ZB.MOM.WW.MxGateway.Client.Tests` | Unit tests for client options, generated contract wiring, auth metadata, session helpers, cancellation, and event streaming. |
|
| `MxGateway.Client.Tests` | Unit tests for client options, generated contract wiring, auth metadata, session helpers, cancellation, and event streaming. |
|
||||||
|
|
||||||
The projects reference `src/ZB.MOM.WW.MxGateway.Contracts/ZB.MOM.WW.MxGateway.Contracts.csproj` so
|
The projects reference `src/MxGateway.Contracts/MxGateway.Contracts.csproj` so
|
||||||
the client compiles against the same generated protobuf and gRPC types as the
|
the client compiles against the same generated protobuf and gRPC types as the
|
||||||
gateway. `clients/dotnet/generated` remains reserved for generator output if a
|
gateway. `clients/dotnet/generated` remains reserved for generator output if a
|
||||||
future client build switches to client-local `Grpc.Tools` generation.
|
future client build switches to client-local `Grpc.Tools` generation.
|
||||||
@@ -19,8 +19,8 @@ future client build switches to client-local `Grpc.Tools` generation.
|
|||||||
## Build And Test
|
## Build And Test
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
dotnet build clients/dotnet/ZB.MOM.WW.MxGateway.Client.slnx
|
dotnet build clients/dotnet/MxGateway.Client.sln
|
||||||
dotnet test clients/dotnet/ZB.MOM.WW.MxGateway.Client.slnx --no-build
|
dotnet test clients/dotnet/MxGateway.Client.sln --no-build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Packaging
|
## Packaging
|
||||||
@@ -29,8 +29,8 @@ Create local library and CLI artifacts from the repository root:
|
|||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
$dotnetPackageOutput = Join-Path (Get-Location) 'artifacts/clients/dotnet'
|
$dotnetPackageOutput = Join-Path (Get-Location) 'artifacts/clients/dotnet'
|
||||||
dotnet pack clients/dotnet/ZB.MOM.WW.MxGateway.Client/ZB.MOM.WW.MxGateway.Client.csproj -c Release -p:PackageOutputPath="$dotnetPackageOutput"
|
dotnet pack clients/dotnet/MxGateway.Client/MxGateway.Client.csproj -c Release -p:PackageOutputPath="$dotnetPackageOutput"
|
||||||
dotnet publish clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli/ZB.MOM.WW.MxGateway.Client.Cli.csproj -c Release -o artifacts/clients/dotnet/mxgw-dotnet
|
dotnet publish clients/dotnet/MxGateway.Client.Cli/MxGateway.Client.Cli.csproj -c Release -o artifacts/clients/dotnet/mxgw-dotnet
|
||||||
```
|
```
|
||||||
|
|
||||||
The library package references the shared contracts project at build time. The
|
The library package references the shared contracts project at build time. The
|
||||||
@@ -39,11 +39,11 @@ published CLI runs from `artifacts/clients/dotnet/mxgw-dotnet`.
|
|||||||
## Regenerating Protobuf Bindings
|
## Regenerating Protobuf Bindings
|
||||||
|
|
||||||
The .NET client uses the generated C# types from
|
The .NET client uses the generated C# types from
|
||||||
`src/ZB.MOM.WW.MxGateway.Contracts/Generated`. Regenerate those files through the
|
`src/MxGateway.Contracts/Generated`. Regenerate those files through the
|
||||||
contracts project:
|
contracts project:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
dotnet build src/ZB.MOM.WW.MxGateway.Contracts/ZB.MOM.WW.MxGateway.Contracts.csproj
|
dotnet build src/MxGateway.Contracts/MxGateway.Contracts.csproj
|
||||||
```
|
```
|
||||||
|
|
||||||
## Client Usage
|
## Client Usage
|
||||||
@@ -117,15 +117,15 @@ reply.
|
|||||||
The test CLI supports deterministic JSON output for automation:
|
The test CLI supports deterministic JSON output for automation:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- version --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- version --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- open-session --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- open-session --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- register --session-id <id> --client-name mxgw-dotnet-cli --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- register --session-id <id> --client-name mxgw-dotnet-cli --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- add-item --session-id <id> --server-handle 1 --item Area001.Pump001.Speed --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- add-item --session-id <id> --server-handle 1 --item Area001.Pump001.Speed --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- advise --session-id <id> --server-handle 1 --item-handle 1 --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- advise --session-id <id> --server-handle 1 --item-handle 1 --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- write --session-id <id> --server-handle 1 --item-handle 1 --type int32 --value 123 --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- write --session-id <id> --server-handle 1 --item-handle 1 --type int32 --value 123 --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- write2 --session-id <id> --server-handle 1 --item-handle 1 --type int32 --value 123 --timestamp 2026-01-01T00:00:00Z --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- write2 --session-id <id> --server-handle 1 --item-handle 1 --type int32 --value 123 --timestamp 2026-01-01T00:00:00Z --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- stream-events --session-id <id> --max-events 1 --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- stream-events --session-id <id> --max-events 1 --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- smoke --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --item Area001.Pump001.Speed --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- smoke --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --item Area001.Pump001.Speed --json
|
||||||
```
|
```
|
||||||
|
|
||||||
`smoke` opens a session, registers a client, adds one item, advises it,
|
`smoke` opens a session, registers a client, adds one item, advises it,
|
||||||
@@ -180,9 +180,9 @@ IReadOnlyList<GalaxyObject> pumps = await repository.DiscoverHierarchyAsync(
|
|||||||
The CLI exposes the same operations:
|
The CLI exposes the same operations:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- galaxy-test-connection --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- galaxy-test-connection --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- galaxy-last-deploy --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- galaxy-last-deploy --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- galaxy-discover --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- galaxy-discover --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY
|
||||||
```
|
```
|
||||||
|
|
||||||
### Watching deploy events
|
### Watching deploy events
|
||||||
@@ -217,15 +217,15 @@ await foreach (DeployEvent evt in repository.WatchDeployEventsAsync(
|
|||||||
The CLI counterpart streams events until Ctrl+C (or `--max-events`):
|
The CLI counterpart streams events until Ctrl+C (or `--max-events`):
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- galaxy-watch --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- galaxy-watch --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- galaxy-watch --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --last-seen-deploy-time 2026-04-28T14:30:00Z --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- galaxy-watch --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --last-seen-deploy-time 2026-04-28T14:30:00Z --json
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- galaxy-watch --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --max-events 5 --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- galaxy-watch --endpoint http://localhost:5000 --api-key-env MXGATEWAY_API_KEY --max-events 5 --json
|
||||||
```
|
```
|
||||||
|
|
||||||
Use TLS options for a secured gateway:
|
Use TLS options for a secured gateway:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- smoke --endpoint https://ZB.MOM.WW.MxGateway.example.local:5001 --tls --ca-file C:\certs\mxgateway-ca.pem --server-name ZB.MOM.WW.MxGateway.example.local --api-key-env MXGATEWAY_API_KEY --item Area001.Pump001.Speed --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- smoke --endpoint https://mxgateway.example.local:5001 --tls --ca-file C:\certs\mxgateway-ca.pem --server-name mxgateway.example.local --api-key-env MXGATEWAY_API_KEY --item Area001.Pump001.Speed --json
|
||||||
```
|
```
|
||||||
|
|
||||||
## Integration Checks
|
## Integration Checks
|
||||||
@@ -237,11 +237,11 @@ $env:MXGATEWAY_INTEGRATION = '1'
|
|||||||
$env:MXGATEWAY_ENDPOINT = 'http://localhost:5000'
|
$env:MXGATEWAY_ENDPOINT = 'http://localhost:5000'
|
||||||
$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
|
$env:MXGATEWAY_API_KEY = '<gateway-api-key>'
|
||||||
$env:MXGATEWAY_TEST_ITEM = 'Area001.Pump001.Speed'
|
$env:MXGATEWAY_TEST_ITEM = 'Area001.Pump001.Speed'
|
||||||
dotnet run --project clients/dotnet/ZB.MOM.WW.MxGateway.Client.Cli -- smoke --endpoint $env:MXGATEWAY_ENDPOINT --api-key-env MXGATEWAY_API_KEY --item $env:MXGATEWAY_TEST_ITEM --json
|
dotnet run --project clients/dotnet/MxGateway.Client.Cli -- smoke --endpoint $env:MXGATEWAY_ENDPOINT --api-key-env MXGATEWAY_API_KEY --item $env:MXGATEWAY_TEST_ITEM --json
|
||||||
```
|
```
|
||||||
|
|
||||||
## Related Documentation
|
## Related Documentation
|
||||||
|
|
||||||
- [Client Packaging](../../docs/ClientPackaging.md)
|
- [Client Packaging](../../docs/ClientPackaging.md)
|
||||||
- [Client Proto Generation](../../docs/ClientProtoGeneration.md)
|
- [Client Proto Generation](../../docs/client-proto-generation.md)
|
||||||
- [.NET Client Detailed Design](./DotnetClientDesign.md)
|
- [.NET Client Detailed Design](../../docs/clients-dotnet-csharp-design.md)
|
||||||
|
|||||||
@@ -1,87 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Cli;
|
|
||||||
|
|
||||||
public interface IMxGatewayCliClient : IAsyncDisposable
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Opens a new gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">Session open request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The session open reply.</returns>
|
|
||||||
Task<OpenSessionReply> OpenSessionAsync(
|
|
||||||
OpenSessionRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Closes an open gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">Session close request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The session close reply.</returns>
|
|
||||||
Task<CloseSessionReply> CloseSessionAsync(
|
|
||||||
CloseSessionRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Invokes an MXAccess command on the session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The command request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The command reply.</returns>
|
|
||||||
Task<MxCommandReply> InvokeAsync(
|
|
||||||
MxCommandRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Streams events from the gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The stream events request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>An async enumerable of events.</returns>
|
|
||||||
IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
|
||||||
StreamEventsRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Tests connection to the Galaxy Repository.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The connection test request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The connection test reply.</returns>
|
|
||||||
Task<TestConnectionReply> GalaxyTestConnectionAsync(
|
|
||||||
TestConnectionRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the last deployment time from the Galaxy Repository.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The last deploy time request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The last deploy time reply.</returns>
|
|
||||||
Task<GetLastDeployTimeReply> GalaxyGetLastDeployTimeAsync(
|
|
||||||
GetLastDeployTimeRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Discovers the Galaxy Repository hierarchy.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The discover hierarchy request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>The discover hierarchy reply.</returns>
|
|
||||||
Task<DiscoverHierarchyReply> GalaxyDiscoverHierarchyAsync(
|
|
||||||
DiscoverHierarchyRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Watches for deployment events from the Galaxy Repository.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The watch deploy events request.</param>
|
|
||||||
/// <param name="cancellationToken">Cancellation token for the operation.</param>
|
|
||||||
/// <returns>An async enumerable of deployment events.</returns>
|
|
||||||
IAsyncEnumerable<DeployEvent> GalaxyWatchDeployEventsAsync(
|
|
||||||
WatchDeployEventsRequest request,
|
|
||||||
CancellationToken cancellationToken);
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
namespace ZB.MOM.WW.MxGateway.Client.Cli;
|
|
||||||
|
|
||||||
/// <summary>Utility to redact API keys from error messages for safe output.</summary>
|
|
||||||
internal static class MxGatewayCliSecretRedactor
|
|
||||||
{
|
|
||||||
/// <summary>Replaces occurrences of the API key in the value with a redacted placeholder.</summary>
|
|
||||||
/// <param name="value">The message text to redact.</param>
|
|
||||||
/// <param name="apiKey">The API key to remove; no redaction if null or empty.</param>
|
|
||||||
public static string Redact(string value, string? apiKey)
|
|
||||||
{
|
|
||||||
if (string.IsNullOrEmpty(value) || string.IsNullOrEmpty(apiKey))
|
|
||||||
{
|
|
||||||
return value;
|
|
||||||
}
|
|
||||||
|
|
||||||
return value.Replace(apiKey, "[redacted]", StringComparison.Ordinal);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,241 +0,0 @@
|
|||||||
using Grpc.Core;
|
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Fake implementation of IMxGatewayClientTransport for testing.
|
|
||||||
/// </summary>
|
|
||||||
internal sealed class FakeGatewayTransport(MxGatewayClientOptions options) : IMxGatewayClientTransport
|
|
||||||
{
|
|
||||||
private readonly Queue<MxCommandReply> _invokeReplies = new();
|
|
||||||
private readonly List<MxEvent> _events = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the gateway client options.
|
|
||||||
/// </summary>
|
|
||||||
public MxGatewayClientOptions Options { get; } = options;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets null, since this is a test fake without a real gRPC client.
|
|
||||||
/// </summary>
|
|
||||||
public MxAccessGateway.MxAccessGatewayClient? RawClient => null;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of captured OpenSessionAsync calls.
|
|
||||||
/// </summary>
|
|
||||||
public List<(OpenSessionRequest Request, CallOptions CallOptions)> OpenSessionCalls { get; } = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of captured CloseSessionAsync calls.
|
|
||||||
/// </summary>
|
|
||||||
public List<(CloseSessionRequest Request, CallOptions CallOptions)> CloseSessionCalls { get; } = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of captured InvokeAsync calls.
|
|
||||||
/// </summary>
|
|
||||||
public List<(MxCommandRequest Request, CallOptions CallOptions)> InvokeCalls { get; } = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of captured StreamEventsAsync calls.
|
|
||||||
/// </summary>
|
|
||||||
public List<(StreamEventsRequest Request, CallOptions CallOptions)> StreamEventsCalls { get; } = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of captured AcknowledgeAlarmAsync calls.
|
|
||||||
/// </summary>
|
|
||||||
public List<(AcknowledgeAlarmRequest Request, CallOptions CallOptions)> AcknowledgeAlarmCalls { get; } = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of captured QueryActiveAlarmsAsync calls.
|
|
||||||
/// </summary>
|
|
||||||
public List<(QueryActiveAlarmsRequest Request, CallOptions CallOptions)> QueryActiveAlarmsCalls { get; } = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the queue of exceptions to throw from AcknowledgeAlarmAsync.
|
|
||||||
/// </summary>
|
|
||||||
public Queue<Exception> AcknowledgeAlarmExceptions { get; } = new();
|
|
||||||
|
|
||||||
private readonly Queue<AcknowledgeAlarmReply> _acknowledgeReplies = new();
|
|
||||||
private readonly List<ActiveAlarmSnapshot> _activeAlarmSnapshots = [];
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the reply to return from OpenSessionAsync.
|
|
||||||
/// </summary>
|
|
||||||
public OpenSessionReply OpenSessionReply { get; set; } = new()
|
|
||||||
{
|
|
||||||
SessionId = "session-fixture",
|
|
||||||
BackendName = "mxaccess-worker",
|
|
||||||
GatewayProtocolVersion = 1,
|
|
||||||
WorkerProtocolVersion = 1,
|
|
||||||
ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok },
|
|
||||||
};
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets or sets the reply to return from CloseSessionAsync.
|
|
||||||
/// </summary>
|
|
||||||
public CloseSessionReply CloseSessionReply { get; set; } = new()
|
|
||||||
{
|
|
||||||
SessionId = "session-fixture",
|
|
||||||
FinalState = SessionState.Closed,
|
|
||||||
ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok },
|
|
||||||
};
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the queue of exceptions to throw from OpenSessionAsync.
|
|
||||||
/// </summary>
|
|
||||||
public Queue<Exception> OpenSessionExceptions { get; } = new();
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the queue of exceptions to throw from CloseSessionAsync.
|
|
||||||
/// </summary>
|
|
||||||
public Queue<Exception> CloseSessionExceptions { get; } = new();
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the queue of exceptions to throw from InvokeAsync.
|
|
||||||
/// </summary>
|
|
||||||
public Queue<Exception> InvokeExceptions { get; } = new();
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that the OpenSessionAsync call is recorded and returns the configured reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The OpenSessionRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public Task<OpenSessionReply> OpenSessionAsync(
|
|
||||||
OpenSessionRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
OpenSessionCalls.Add((request, callOptions));
|
|
||||||
if (OpenSessionExceptions.TryDequeue(out Exception? exception))
|
|
||||||
{
|
|
||||||
throw exception;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Task.FromResult(OpenSessionReply);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that the CloseSessionAsync call is recorded and returns the configured reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The CloseSessionRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public Task<CloseSessionReply> CloseSessionAsync(
|
|
||||||
CloseSessionRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
CloseSessionCalls.Add((request, callOptions));
|
|
||||||
if (CloseSessionExceptions.TryDequeue(out Exception? exception))
|
|
||||||
{
|
|
||||||
throw exception;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Task.FromResult(CloseSessionReply);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that the InvokeAsync call is recorded and returns the next enqueued reply.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The MxCommandRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public Task<MxCommandReply> InvokeAsync(
|
|
||||||
MxCommandRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
InvokeCalls.Add((request, callOptions));
|
|
||||||
if (InvokeExceptions.TryDequeue(out Exception? exception))
|
|
||||||
{
|
|
||||||
throw exception;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Task.FromResult(_invokeReplies.Dequeue());
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Verifies that the StreamEventsAsync call is recorded and yields all enqueued events.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The StreamEventsRequest to process.</param>
|
|
||||||
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
||||||
public async IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
|
||||||
StreamEventsRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
StreamEventsCalls.Add((request, callOptions));
|
|
||||||
|
|
||||||
foreach (MxEvent gatewayEvent in _events)
|
|
||||||
{
|
|
||||||
callOptions.CancellationToken.ThrowIfCancellationRequested();
|
|
||||||
await Task.Yield();
|
|
||||||
yield return gatewayEvent;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Enqueues a reply to be returned from the next InvokeAsync call.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="reply">The reply to enqueue.</param>
|
|
||||||
public void AddInvokeReply(MxCommandReply reply)
|
|
||||||
{
|
|
||||||
_invokeReplies.Enqueue(reply);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Enqueues an event to be yielded from StreamEventsAsync.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="gatewayEvent">The event to enqueue.</param>
|
|
||||||
public void AddEvent(MxEvent gatewayEvent)
|
|
||||||
{
|
|
||||||
_events.Add(gatewayEvent);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Records the acknowledge call and returns the next enqueued reply (or default).
|
|
||||||
/// </summary>
|
|
||||||
public Task<AcknowledgeAlarmReply> AcknowledgeAlarmAsync(
|
|
||||||
AcknowledgeAlarmRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
AcknowledgeAlarmCalls.Add((request, callOptions));
|
|
||||||
if (AcknowledgeAlarmExceptions.TryDequeue(out Exception? exception))
|
|
||||||
{
|
|
||||||
throw exception;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Task.FromResult(_acknowledgeReplies.Count > 0
|
|
||||||
? _acknowledgeReplies.Dequeue()
|
|
||||||
: new AcknowledgeAlarmReply
|
|
||||||
{
|
|
||||||
CorrelationId = request.ClientCorrelationId,
|
|
||||||
ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok },
|
|
||||||
Status = new MxStatusProxy { Success = 1, Category = MxStatusCategory.Ok },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Records the query call and yields each enqueued snapshot.
|
|
||||||
/// </summary>
|
|
||||||
public async IAsyncEnumerable<ActiveAlarmSnapshot> QueryActiveAlarmsAsync(
|
|
||||||
QueryActiveAlarmsRequest request,
|
|
||||||
CallOptions callOptions)
|
|
||||||
{
|
|
||||||
QueryActiveAlarmsCalls.Add((request, callOptions));
|
|
||||||
|
|
||||||
foreach (ActiveAlarmSnapshot snapshot in _activeAlarmSnapshots)
|
|
||||||
{
|
|
||||||
callOptions.CancellationToken.ThrowIfCancellationRequested();
|
|
||||||
await Task.Yield();
|
|
||||||
yield return snapshot;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>Enqueues an acknowledge reply.</summary>
|
|
||||||
public void AddAcknowledgeReply(AcknowledgeAlarmReply reply)
|
|
||||||
{
|
|
||||||
_acknowledgeReplies.Enqueue(reply);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>Enqueues a snapshot to be yielded from QueryActiveAlarmsAsync.</summary>
|
|
||||||
public void AddActiveAlarmSnapshot(ActiveAlarmSnapshot snapshot)
|
|
||||||
{
|
|
||||||
_activeAlarmSnapshots.Add(snapshot);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,188 +0,0 @@
|
|||||||
using Google.Protobuf.WellKnownTypes;
|
|
||||||
using Grpc.Core;
|
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// PR E.2 — pins the .NET SDK surface for the new alarm RPCs:
|
|
||||||
/// <see cref="MxGatewayClient.AcknowledgeAlarmAsync"/> and
|
|
||||||
/// <see cref="MxGatewayClient.QueryActiveAlarmsAsync"/>.
|
|
||||||
/// </summary>
|
|
||||||
public sealed class MxGatewayClientAlarmsTests
|
|
||||||
{
|
|
||||||
[Fact]
|
|
||||||
public async Task AcknowledgeAlarmAsync_RecordsRequestShapeAndReturnsReply()
|
|
||||||
{
|
|
||||||
FakeGatewayTransport transport = CreateTransport();
|
|
||||||
transport.AddAcknowledgeReply(new AcknowledgeAlarmReply
|
|
||||||
{
|
|
||||||
CorrelationId = "corr-1",
|
|
||||||
ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok },
|
|
||||||
Status = new MxStatusProxy
|
|
||||||
{
|
|
||||||
Success = 1,
|
|
||||||
Category = MxStatusCategory.Ok,
|
|
||||||
DetectedBy = MxStatusSource.RespondingLmx,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
await using MxGatewayClient client = CreateClient(transport);
|
|
||||||
|
|
||||||
AcknowledgeAlarmReply reply = await client.AcknowledgeAlarmAsync(new AcknowledgeAlarmRequest
|
|
||||||
{
|
|
||||||
ClientCorrelationId = "corr-1",
|
|
||||||
AlarmFullReference = "Tank01.Level.HiHi",
|
|
||||||
Comment = "investigating",
|
|
||||||
OperatorUser = "alice",
|
|
||||||
});
|
|
||||||
|
|
||||||
Assert.Equal(ProtocolStatusCode.Ok, reply.ProtocolStatus.Code);
|
|
||||||
Assert.Equal(MxStatusCategory.Ok, reply.Status.Category);
|
|
||||||
|
|
||||||
var call = Assert.Single(transport.AcknowledgeAlarmCalls);
|
|
||||||
Assert.Equal("Tank01.Level.HiHi", call.Request.AlarmFullReference);
|
|
||||||
Assert.Equal("investigating", call.Request.Comment);
|
|
||||||
Assert.Equal("alice", call.Request.OperatorUser);
|
|
||||||
Assert.Equal("Bearer test-api-key", call.CallOptions.Headers?.GetValue("authorization"));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task AcknowledgeAlarmAsync_HonorsCancellation()
|
|
||||||
{
|
|
||||||
// Acks are routed through the safe-unary retry pipeline (idempotent at the
|
|
||||||
// MxAccess level), so the transport-side cancellation token is a linked one
|
|
||||||
// rather than the caller's original. Verify cancellation by tripping the source
|
|
||||||
// and asserting the call observes it.
|
|
||||||
using CancellationTokenSource cancellation = new();
|
|
||||||
cancellation.Cancel();
|
|
||||||
FakeGatewayTransport transport = CreateTransport();
|
|
||||||
await using MxGatewayClient client = CreateClient(transport);
|
|
||||||
|
|
||||||
await Assert.ThrowsAnyAsync<OperationCanceledException>(() =>
|
|
||||||
client.AcknowledgeAlarmAsync(
|
|
||||||
new AcknowledgeAlarmRequest
|
|
||||||
{
|
|
||||||
AlarmFullReference = "Tank01.Level.HiHi",
|
|
||||||
Comment = string.Empty,
|
|
||||||
OperatorUser = "alice",
|
|
||||||
},
|
|
||||||
cancellation.Token));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task AcknowledgeAlarmAsync_MapsUnauthenticated_RpcException_ToTypedException()
|
|
||||||
{
|
|
||||||
FakeGatewayTransport transport = CreateTransport();
|
|
||||||
transport.AcknowledgeAlarmExceptions.Enqueue(
|
|
||||||
new RpcException(new Status(StatusCode.Unauthenticated, "expired key")));
|
|
||||||
await using MxGatewayClient client = CreateClient(transport);
|
|
||||||
|
|
||||||
// Note: the FakeGatewayTransport surfaces RpcException directly (it does not run
|
|
||||||
// through GrpcMxGatewayClientTransport's mapping); the fake's contract here is to
|
|
||||||
// pass the exception verbatim. RpcException → typed exception mapping is covered
|
|
||||||
// in the GrpcMxGatewayClientTransport-level tests; the SDK-level test pins the
|
|
||||||
// pass-through shape so a future migration to direct mapping won't silently
|
|
||||||
// change observable behaviour.
|
|
||||||
var ex = await Assert.ThrowsAsync<RpcException>(
|
|
||||||
() => client.AcknowledgeAlarmAsync(new AcknowledgeAlarmRequest
|
|
||||||
{
|
|
||||||
AlarmFullReference = "Tank01.Level.HiHi",
|
|
||||||
Comment = string.Empty,
|
|
||||||
OperatorUser = "alice",
|
|
||||||
}));
|
|
||||||
Assert.Equal(StatusCode.Unauthenticated, ex.StatusCode);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task QueryActiveAlarmsAsync_StreamsEnqueuedSnapshots()
|
|
||||||
{
|
|
||||||
FakeGatewayTransport transport = CreateTransport();
|
|
||||||
transport.AddActiveAlarmSnapshot(MakeSnapshot("Tank01.Level.HiHi", AlarmConditionState.Active));
|
|
||||||
transport.AddActiveAlarmSnapshot(MakeSnapshot("Tank02.Level.HiHi", AlarmConditionState.ActiveAcked));
|
|
||||||
await using MxGatewayClient client = CreateClient(transport);
|
|
||||||
|
|
||||||
List<ActiveAlarmSnapshot> snapshots = [];
|
|
||||||
await foreach (ActiveAlarmSnapshot snapshot in client.QueryActiveAlarmsAsync(new QueryActiveAlarmsRequest
|
|
||||||
{
|
|
||||||
SessionId = "session-fixture",
|
|
||||||
}))
|
|
||||||
{
|
|
||||||
snapshots.Add(snapshot);
|
|
||||||
}
|
|
||||||
|
|
||||||
Assert.Equal(2, snapshots.Count);
|
|
||||||
Assert.Equal("Tank01.Level.HiHi", snapshots[0].AlarmFullReference);
|
|
||||||
Assert.Equal(AlarmConditionState.Active, snapshots[0].CurrentState);
|
|
||||||
Assert.Equal(AlarmConditionState.ActiveAcked, snapshots[1].CurrentState);
|
|
||||||
Assert.Single(transport.QueryActiveAlarmsCalls);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task QueryActiveAlarmsAsync_PassesFilterPrefix()
|
|
||||||
{
|
|
||||||
FakeGatewayTransport transport = CreateTransport();
|
|
||||||
await using MxGatewayClient client = CreateClient(transport);
|
|
||||||
|
|
||||||
await foreach (ActiveAlarmSnapshot _ in client.QueryActiveAlarmsAsync(new QueryActiveAlarmsRequest
|
|
||||||
{
|
|
||||||
SessionId = "session-fixture",
|
|
||||||
AlarmFilterPrefix = "Tank01.",
|
|
||||||
}))
|
|
||||||
{
|
|
||||||
// no snapshots enqueued; just verifying the request passes through
|
|
||||||
}
|
|
||||||
|
|
||||||
var call = Assert.Single(transport.QueryActiveAlarmsCalls);
|
|
||||||
Assert.Equal("Tank01.", call.Request.AlarmFilterPrefix);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task QueryActiveAlarmsAsync_HonorsCancellationDuringEnumeration()
|
|
||||||
{
|
|
||||||
FakeGatewayTransport transport = CreateTransport();
|
|
||||||
transport.AddActiveAlarmSnapshot(MakeSnapshot("Tank01.Level.HiHi", AlarmConditionState.Active));
|
|
||||||
transport.AddActiveAlarmSnapshot(MakeSnapshot("Tank02.Level.HiHi", AlarmConditionState.Active));
|
|
||||||
await using MxGatewayClient client = CreateClient(transport);
|
|
||||||
|
|
||||||
using CancellationTokenSource cancellation = new();
|
|
||||||
await Assert.ThrowsAsync<OperationCanceledException>(async () =>
|
|
||||||
{
|
|
||||||
await foreach (ActiveAlarmSnapshot _ in client.QueryActiveAlarmsAsync(
|
|
||||||
new QueryActiveAlarmsRequest { SessionId = "session-fixture" },
|
|
||||||
cancellation.Token))
|
|
||||||
{
|
|
||||||
cancellation.Cancel();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
private static ActiveAlarmSnapshot MakeSnapshot(string fullReference, AlarmConditionState state)
|
|
||||||
{
|
|
||||||
return new ActiveAlarmSnapshot
|
|
||||||
{
|
|
||||||
AlarmFullReference = fullReference,
|
|
||||||
SourceObjectReference = fullReference.Split('.')[0],
|
|
||||||
AlarmTypeName = "AnalogLimitAlarm.HiHi",
|
|
||||||
Severity = 750,
|
|
||||||
CurrentState = state,
|
|
||||||
Category = "Process",
|
|
||||||
Description = "Tank high-high level",
|
|
||||||
OriginalRaiseTimestamp = Timestamp.FromDateTime(new DateTime(2026, 5, 1, 12, 0, 0, DateTimeKind.Utc)),
|
|
||||||
LastTransitionTimestamp = Timestamp.FromDateTime(new DateTime(2026, 5, 1, 12, 0, 30, DateTimeKind.Utc)),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
private static MxGatewayClient CreateClient(FakeGatewayTransport transport)
|
|
||||||
{
|
|
||||||
return new MxGatewayClient(transport.Options, transport);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static FakeGatewayTransport CreateTransport()
|
|
||||||
{
|
|
||||||
return new FakeGatewayTransport(new MxGatewayClientOptions
|
|
||||||
{
|
|
||||||
Endpoint = new Uri("http://localhost:5000"),
|
|
||||||
ApiKey = "test-api-key",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
<Solution>
|
|
||||||
<Configurations>
|
|
||||||
<Platform Name="Any CPU" />
|
|
||||||
<Platform Name="x64" />
|
|
||||||
<Platform Name="x86" />
|
|
||||||
</Configurations>
|
|
||||||
<Project Path="../../src/ZB.MOM.WW.MxGateway.Contracts/ZB.MOM.WW.MxGateway.Contracts.csproj" />
|
|
||||||
<Project Path="ZB.MOM.WW.MxGateway.Client.Cli/ZB.MOM.WW.MxGateway.Client.Cli.csproj" />
|
|
||||||
<Project Path="ZB.MOM.WW.MxGateway.Client.Tests/ZB.MOM.WW.MxGateway.Client.Tests.csproj" />
|
|
||||||
<Project Path="ZB.MOM.WW.MxGateway.Client/ZB.MOM.WW.MxGateway.Client.csproj" />
|
|
||||||
</Solution>
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Filters and shape options for <see cref="GalaxyRepositoryClient.DiscoverHierarchyAsync(DiscoverHierarchyOptions, System.Threading.CancellationToken)"/>.
|
|
||||||
/// </summary>
|
|
||||||
/// <remarks>
|
|
||||||
/// Hand-written ergonomic wrapper around the generated
|
|
||||||
/// <c>DiscoverHierarchyRequest</c>: lets callers express a Galaxy-browse
|
|
||||||
/// slice with .NET-friendly nullable scalars and collection initializers,
|
|
||||||
/// without touching the protobuf message's <c>oneof root</c> directly.
|
|
||||||
/// </remarks>
|
|
||||||
public sealed class DiscoverHierarchyOptions
|
|
||||||
{
|
|
||||||
/// <summary>Restrict to the subtree rooted at this Galaxy <c>gobject_id</c>.</summary>
|
|
||||||
public int? RootGobjectId { get; init; }
|
|
||||||
|
|
||||||
/// <summary>Restrict to the subtree rooted at the object with this tag name.</summary>
|
|
||||||
public string? RootTagName { get; init; }
|
|
||||||
|
|
||||||
/// <summary>Restrict to the subtree rooted at this <c>contained_name</c> path.</summary>
|
|
||||||
public string? RootContainedPath { get; init; }
|
|
||||||
|
|
||||||
/// <summary>Maximum traversal depth, measured from the chosen root.</summary>
|
|
||||||
public int? MaxDepth { get; init; }
|
|
||||||
|
|
||||||
/// <summary>Restrict to objects whose Galaxy category is in this set.</summary>
|
|
||||||
public IReadOnlyList<int> CategoryIds { get; init; } = [];
|
|
||||||
|
|
||||||
/// <summary>Restrict to objects whose template chain contains any of these tokens.</summary>
|
|
||||||
public IReadOnlyList<string> TemplateChainContains { get; init; } = [];
|
|
||||||
|
|
||||||
/// <summary>Optional glob-style filter on <c>tag_name</c>.</summary>
|
|
||||||
public string? TagNameGlob { get; init; }
|
|
||||||
|
|
||||||
/// <summary>Whether to populate each <c>GalaxyObject.Attributes</c>. Null leaves the server default.</summary>
|
|
||||||
public bool? IncludeAttributes { get; init; }
|
|
||||||
|
|
||||||
/// <summary>Restrict to objects that bear at least one alarm attribute.</summary>
|
|
||||||
public bool AlarmBearingOnly { get; init; }
|
|
||||||
|
|
||||||
/// <summary>Restrict to objects that have at least one historized attribute.</summary>
|
|
||||||
public bool HistorizedOnly { get; init; }
|
|
||||||
}
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
using Grpc.Core;
|
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>Transport layer for Galaxy Repository gRPC operations.</summary>
|
|
||||||
internal interface IGalaxyRepositoryClientTransport
|
|
||||||
{
|
|
||||||
/// <summary>Gets the client options used to configure this transport.</summary>
|
|
||||||
MxGatewayClientOptions Options { get; }
|
|
||||||
|
|
||||||
/// <summary>Gets the underlying gRPC client, or <c>null</c> if not yet initialized.</summary>
|
|
||||||
GalaxyRepository.GalaxyRepositoryClient? RawClient { get; }
|
|
||||||
|
|
||||||
/// <summary>Tests the connection to the Galaxy Repository server.</summary>
|
|
||||||
/// <param name="request">The test connection request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
||||||
Task<TestConnectionReply> TestConnectionAsync(
|
|
||||||
TestConnectionRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>Gets the last deploy time from the Galaxy Repository server.</summary>
|
|
||||||
/// <param name="request">The get last deploy time request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
||||||
Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
|
||||||
GetLastDeployTimeRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>Discovers the object hierarchy in the Galaxy Repository.</summary>
|
|
||||||
/// <param name="request">The discover hierarchy request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
||||||
Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
|
||||||
DiscoverHierarchyRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>Watches for deployment events from the Galaxy Repository server.</summary>
|
|
||||||
/// <param name="request">The watch deploy events request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
||||||
IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
|
||||||
WatchDeployEventsRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
}
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
using Grpc.Core;
|
|
||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
internal interface IMxGatewayClientTransport
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the client configuration options.
|
|
||||||
/// </summary>
|
|
||||||
MxGatewayClientOptions Options { get; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the underlying gRPC client, if available.
|
|
||||||
/// </summary>
|
|
||||||
MxAccessGateway.MxAccessGatewayClient? RawClient { get; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Opens a new gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">Session open request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options.</param>
|
|
||||||
/// <returns>The session open reply.</returns>
|
|
||||||
Task<OpenSessionReply> OpenSessionAsync(
|
|
||||||
OpenSessionRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Closes an open gateway session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">Session close request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options.</param>
|
|
||||||
/// <returns>The session close reply.</returns>
|
|
||||||
Task<CloseSessionReply> CloseSessionAsync(
|
|
||||||
CloseSessionRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Invokes an MXAccess command on the session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The command request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options.</param>
|
|
||||||
/// <returns>The command reply.</returns>
|
|
||||||
Task<MxCommandReply> InvokeAsync(
|
|
||||||
MxCommandRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Streams events from the session.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The stream events request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options.</param>
|
|
||||||
/// <returns>An async enumerable of events.</returns>
|
|
||||||
IAsyncEnumerable<MxEvent> StreamEventsAsync(
|
|
||||||
StreamEventsRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Acknowledges an active MXAccess alarm condition.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The acknowledge request.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options.</param>
|
|
||||||
/// <returns>The acknowledge reply with native MxStatus.</returns>
|
|
||||||
Task<AcknowledgeAlarmReply> AcknowledgeAlarmAsync(
|
|
||||||
AcknowledgeAlarmRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Streams a snapshot of all alarms currently in Active or ActiveAcked state — the
|
|
||||||
/// ConditionRefresh equivalent for the gateway.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="request">The query request, optionally scoped by alarm-reference prefix.</param>
|
|
||||||
/// <param name="callOptions">gRPC call options.</param>
|
|
||||||
/// <returns>An async enumerable of active-alarm snapshots.</returns>
|
|
||||||
IAsyncEnumerable<ActiveAlarmSnapshot> QueryActiveAlarmsAsync(
|
|
||||||
QueryActiveAlarmsRequest request,
|
|
||||||
CallOptions callOptions);
|
|
||||||
}
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>Exception thrown when an MXAccess command fails with a non-zero HResult or failing status.</summary>
|
|
||||||
public sealed class MxAccessException : MxGatewayCommandException
|
|
||||||
{
|
|
||||||
/// <summary>Initializes a new instance with the given message, reply, and optional inner exception.</summary>
|
|
||||||
/// <param name="message">The error message describing the MXAccess failure.</param>
|
|
||||||
/// <param name="reply">The MxCommandReply containing the failure details (statuses, HResult, etc.).</param>
|
|
||||||
/// <param name="innerException">The underlying exception, if any.</param>
|
|
||||||
public MxAccessException(
|
|
||||||
string message,
|
|
||||||
MxCommandReply reply,
|
|
||||||
Exception? innerException = null)
|
|
||||||
: base(
|
|
||||||
message,
|
|
||||||
reply.SessionId,
|
|
||||||
reply.CorrelationId,
|
|
||||||
reply.ProtocolStatus,
|
|
||||||
reply.HasHresult ? reply.Hresult : null,
|
|
||||||
reply.Statuses.ToArray(),
|
|
||||||
innerException)
|
|
||||||
{
|
|
||||||
Reply = reply;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>Gets the underlying MxCommandReply containing full failure details.</summary>
|
|
||||||
public MxCommandReply Reply { get; }
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>Exception thrown when an API key is invalid, expired, or malformed.</summary>
|
|
||||||
public sealed class MxGatewayAuthenticationException : MxGatewayException
|
|
||||||
{
|
|
||||||
/// <summary>Initializes a new instance with the given details.</summary>
|
|
||||||
/// <param name="message">The error message describing the authentication failure.</param>
|
|
||||||
/// <param name="sessionId">The session ID, if available.</param>
|
|
||||||
/// <param name="correlationId">The correlation ID for tracing, if available.</param>
|
|
||||||
/// <param name="protocolStatus">The protocol status details, if available.</param>
|
|
||||||
/// <param name="hResult">The HResult code, if available.</param>
|
|
||||||
/// <param name="statuses">The MXAccess statuses, if available.</param>
|
|
||||||
/// <param name="innerException">The underlying exception, if any.</param>
|
|
||||||
public MxGatewayAuthenticationException(
|
|
||||||
string message,
|
|
||||||
string? sessionId = null,
|
|
||||||
string? correlationId = null,
|
|
||||||
ProtocolStatus? protocolStatus = null,
|
|
||||||
int? hResult = null,
|
|
||||||
IReadOnlyList<MxStatusProxy>? statuses = null,
|
|
||||||
Exception? innerException = null)
|
|
||||||
: base(
|
|
||||||
message,
|
|
||||||
sessionId,
|
|
||||||
correlationId,
|
|
||||||
protocolStatus,
|
|
||||||
hResult,
|
|
||||||
statuses ?? [],
|
|
||||||
innerException)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>Exception thrown when the API key lacks required scopes for an operation.</summary>
|
|
||||||
public sealed class MxGatewayAuthorizationException : MxGatewayException
|
|
||||||
{
|
|
||||||
/// <summary>Initializes a new instance with the given details.</summary>
|
|
||||||
/// <param name="message">The error message describing the authorization failure.</param>
|
|
||||||
/// <param name="sessionId">The session ID, if available.</param>
|
|
||||||
/// <param name="correlationId">The correlation ID for tracing, if available.</param>
|
|
||||||
/// <param name="protocolStatus">The protocol status details, if available.</param>
|
|
||||||
/// <param name="hResult">The HResult code, if available.</param>
|
|
||||||
/// <param name="statuses">The MXAccess statuses, if available.</param>
|
|
||||||
/// <param name="innerException">The underlying exception, if any.</param>
|
|
||||||
public MxGatewayAuthorizationException(
|
|
||||||
string message,
|
|
||||||
string? sessionId = null,
|
|
||||||
string? correlationId = null,
|
|
||||||
ProtocolStatus? protocolStatus = null,
|
|
||||||
int? hResult = null,
|
|
||||||
IReadOnlyList<MxStatusProxy>? statuses = null,
|
|
||||||
Exception? innerException = null)
|
|
||||||
: base(
|
|
||||||
message,
|
|
||||||
sessionId,
|
|
||||||
correlationId,
|
|
||||||
protocolStatus,
|
|
||||||
hResult,
|
|
||||||
statuses ?? [],
|
|
||||||
innerException)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>Exception thrown when a gateway command fails due to an unclassified protocol error.</summary>
|
|
||||||
public class MxGatewayCommandException : MxGatewayException
|
|
||||||
{
|
|
||||||
/// <summary>Initializes a new instance with the given details.</summary>
|
|
||||||
/// <param name="message">The error message describing the command failure.</param>
|
|
||||||
/// <param name="sessionId">The session ID, if available.</param>
|
|
||||||
/// <param name="correlationId">The correlation ID for tracing, if available.</param>
|
|
||||||
/// <param name="protocolStatus">The protocol status details, if available.</param>
|
|
||||||
/// <param name="hResult">The HResult code, if available.</param>
|
|
||||||
/// <param name="statuses">The MXAccess statuses, if available.</param>
|
|
||||||
/// <param name="innerException">The underlying exception, if any.</param>
|
|
||||||
public MxGatewayCommandException(
|
|
||||||
string message,
|
|
||||||
string? sessionId = null,
|
|
||||||
string? correlationId = null,
|
|
||||||
ProtocolStatus? protocolStatus = null,
|
|
||||||
int? hResult = null,
|
|
||||||
IReadOnlyList<MxStatusProxy>? statuses = null,
|
|
||||||
Exception? innerException = null)
|
|
||||||
: base(
|
|
||||||
message,
|
|
||||||
sessionId,
|
|
||||||
correlationId,
|
|
||||||
protocolStatus,
|
|
||||||
hResult,
|
|
||||||
statuses ?? [],
|
|
||||||
innerException)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Exception thrown when a gateway RPC call fails or returns an error status.
|
|
||||||
/// </summary>
|
|
||||||
public class MxGatewayException : Exception
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes a new instance of the MxGatewayException class with the specified message.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="message">Diagnostic message describing the failure.</param>
|
|
||||||
public MxGatewayException(string message)
|
|
||||||
: base(message)
|
|
||||||
{
|
|
||||||
Statuses = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes a new instance of the MxGatewayException class with the specified message and inner exception.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="message">Diagnostic message describing the failure.</param>
|
|
||||||
/// <param name="innerException">Underlying exception that caused this failure.</param>
|
|
||||||
public MxGatewayException(string message, Exception? innerException)
|
|
||||||
: base(message, innerException)
|
|
||||||
{
|
|
||||||
Statuses = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes a new instance of the MxGatewayException class with full diagnostic information.
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="message">Diagnostic message describing the failure.</param>
|
|
||||||
/// <param name="sessionId">Session ID associated with the exception, if available.</param>
|
|
||||||
/// <param name="correlationId">Correlation ID associated with the exception, if available.</param>
|
|
||||||
/// <param name="protocolStatus">Protocol-level status returned by the gateway, if available.</param>
|
|
||||||
/// <param name="hResult">HRESULT code returned by the worker or MXAccess, if available.</param>
|
|
||||||
/// <param name="statuses">List of MXAccess status codes returned by the operation.</param>
|
|
||||||
/// <param name="innerException">Underlying exception that caused this failure.</param>
|
|
||||||
public MxGatewayException(
|
|
||||||
string message,
|
|
||||||
string? sessionId,
|
|
||||||
string? correlationId,
|
|
||||||
ProtocolStatus? protocolStatus,
|
|
||||||
int? hResult,
|
|
||||||
IReadOnlyList<MxStatusProxy> statuses,
|
|
||||||
Exception? innerException = null)
|
|
||||||
: base(message, innerException)
|
|
||||||
{
|
|
||||||
SessionId = sessionId;
|
|
||||||
CorrelationId = correlationId;
|
|
||||||
ProtocolStatus = protocolStatus;
|
|
||||||
HResultCode = hResult;
|
|
||||||
Statuses = statuses;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the session ID associated with the exception, if available.
|
|
||||||
/// </summary>
|
|
||||||
public string? SessionId { get; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the correlation ID associated with the exception, if available.
|
|
||||||
/// </summary>
|
|
||||||
public string? CorrelationId { get; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the protocol-level status returned by the gateway, if available.
|
|
||||||
/// </summary>
|
|
||||||
public ProtocolStatus? ProtocolStatus { get; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the HRESULT code returned by the worker or MXAccess, if available.
|
|
||||||
/// </summary>
|
|
||||||
public int? HResultCode { get; }
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Gets the list of MXAccess status codes returned by the operation.
|
|
||||||
/// </summary>
|
|
||||||
public IReadOnlyList<MxStatusProxy> Statuses { get; }
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>Exception thrown when a session is not found, not ready, or invalid.</summary>
|
|
||||||
public sealed class MxGatewaySessionException : MxGatewayException
|
|
||||||
{
|
|
||||||
/// <summary>Initializes a new instance with the given details.</summary>
|
|
||||||
/// <param name="message">The error message describing the session failure.</param>
|
|
||||||
/// <param name="sessionId">The session ID, if available.</param>
|
|
||||||
/// <param name="correlationId">The correlation ID for tracing, if available.</param>
|
|
||||||
/// <param name="protocolStatus">The protocol status details, if available.</param>
|
|
||||||
/// <param name="hResult">The HResult code, if available.</param>
|
|
||||||
/// <param name="statuses">The MXAccess statuses, if available.</param>
|
|
||||||
/// <param name="innerException">The underlying exception, if any.</param>
|
|
||||||
public MxGatewaySessionException(
|
|
||||||
string message,
|
|
||||||
string? sessionId = null,
|
|
||||||
string? correlationId = null,
|
|
||||||
ProtocolStatus? protocolStatus = null,
|
|
||||||
int? hResult = null,
|
|
||||||
IReadOnlyList<MxStatusProxy>? statuses = null,
|
|
||||||
Exception? innerException = null)
|
|
||||||
: base(
|
|
||||||
message,
|
|
||||||
sessionId,
|
|
||||||
correlationId,
|
|
||||||
protocolStatus,
|
|
||||||
hResult,
|
|
||||||
statuses ?? [],
|
|
||||||
innerException)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
||||||
|
|
||||||
namespace ZB.MOM.WW.MxGateway.Client;
|
|
||||||
|
|
||||||
/// <summary>Exception thrown when the worker process is unavailable or fails to process a command.</summary>
|
|
||||||
public sealed class MxGatewayWorkerException : MxGatewayException
|
|
||||||
{
|
|
||||||
/// <summary>Initializes a new instance with the given details.</summary>
|
|
||||||
/// <param name="message">The error message describing the worker failure.</param>
|
|
||||||
/// <param name="sessionId">The session ID, if available.</param>
|
|
||||||
/// <param name="correlationId">The correlation ID for tracing, if available.</param>
|
|
||||||
/// <param name="protocolStatus">The protocol status details, if available.</param>
|
|
||||||
/// <param name="hResult">The HResult code, if available.</param>
|
|
||||||
/// <param name="statuses">The MXAccess statuses, if available.</param>
|
|
||||||
/// <param name="innerException">The underlying exception, if any.</param>
|
|
||||||
public MxGatewayWorkerException(
|
|
||||||
string message,
|
|
||||||
string? sessionId = null,
|
|
||||||
string? correlationId = null,
|
|
||||||
ProtocolStatus? protocolStatus = null,
|
|
||||||
int? hResult = null,
|
|
||||||
IReadOnlyList<MxStatusProxy>? statuses = null,
|
|
||||||
Exception? innerException = null)
|
|
||||||
: base(
|
|
||||||
message,
|
|
||||||
sessionId,
|
|
||||||
correlationId,
|
|
||||||
protocolStatus,
|
|
||||||
hResult,
|
|
||||||
statuses ?? [],
|
|
||||||
innerException)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
using System.Runtime.CompilerServices;
|
|
||||||
|
|
||||||
[assembly: InternalsVisibleTo("ZB.MOM.WW.MxGateway.Client.Tests")]
|
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
The Go client module contains the generated MXAccess Gateway protobuf bindings,
|
The Go client module contains the generated MXAccess Gateway protobuf bindings,
|
||||||
a small handwritten `mxgateway` package, and the `mxgw-go` test CLI scaffold.
|
a small handwritten `mxgateway` package, and the `mxgw-go` test CLI scaffold.
|
||||||
The module uses the shared proto inputs documented in
|
The module uses the shared proto inputs documented in
|
||||||
`../../docs/ClientProtoGeneration.md` so gateway and client contracts stay in
|
`../../docs/client-proto-generation.md` so gateway and client contracts stay in
|
||||||
sync.
|
sync.
|
||||||
|
|
||||||
## Layout
|
## Layout
|
||||||
@@ -28,7 +28,7 @@ Run generation after the shared `.proto` files or the Go output path changes:
|
|||||||
./generate-proto.ps1
|
./generate-proto.ps1
|
||||||
```
|
```
|
||||||
|
|
||||||
The script uses the tool paths recorded in `../../docs/ToolchainLinks.md`.
|
The script uses the tool paths recorded in `../../docs/toolchain-links.md`.
|
||||||
|
|
||||||
## Build And Test
|
## Build And Test
|
||||||
|
|
||||||
@@ -209,5 +209,5 @@ go run ./cmd/mxgw-go smoke -endpoint $env:MXGATEWAY_ENDPOINT -plaintext -api-key
|
|||||||
## Related Documentation
|
## Related Documentation
|
||||||
|
|
||||||
- [Client Packaging](../../docs/ClientPackaging.md)
|
- [Client Packaging](../../docs/ClientPackaging.md)
|
||||||
- [Client Proto Generation](../../docs/ClientProtoGeneration.md)
|
- [Client Proto Generation](../../docs/client-proto-generation.md)
|
||||||
- [Go Client Detailed Design](./GoClientDesign.md)
|
- [Go Client Detailed Design](../../docs/clients-golang-design.md)
|
||||||
|
|||||||
@@ -1,8 +1,3 @@
|
|||||||
// Command mxgw-go is the reference Go CLI for the MXAccess Gateway.
|
|
||||||
//
|
|
||||||
// It exposes versioning, session lifecycle, command invocation, event
|
|
||||||
// streaming, a smoke-test workflow, and Galaxy Repository browse subcommands
|
|
||||||
// that exercise the same gRPC contract used by the mxgateway library.
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|||||||
@@ -2,20 +2,20 @@ Set-StrictMode -Version Latest
|
|||||||
$ErrorActionPreference = 'Stop'
|
$ErrorActionPreference = 'Stop'
|
||||||
|
|
||||||
$repoRoot = Resolve-Path (Join-Path $PSScriptRoot '..\..')
|
$repoRoot = Resolve-Path (Join-Path $PSScriptRoot '..\..')
|
||||||
$protoRoot = Join-Path $repoRoot 'src\ZB.MOM.WW.MxGateway.Contracts\Protos'
|
$protoRoot = Join-Path $repoRoot 'src\MxGateway.Contracts\Protos'
|
||||||
$outputRoot = Join-Path $PSScriptRoot 'internal\generated'
|
$outputRoot = Join-Path $PSScriptRoot 'internal\generated'
|
||||||
$modulePath = 'gitea.dohertylan.com/dohertj2/mxaccessgw/clients/go/internal/generated'
|
$modulePath = 'gitea.dohertylan.com/dohertj2/mxaccessgw/clients/go/internal/generated'
|
||||||
$protoc = 'C:\Users\dohertj2\AppData\Local\Microsoft\WinGet\Packages\Google.Protobuf_Microsoft.Winget.Source_8wekyb3d8bbwe\bin\protoc.exe'
|
$protoc = 'C:\Users\dohertj2\AppData\Local\Microsoft\WinGet\Packages\Google.Protobuf_Microsoft.Winget.Source_8wekyb3d8bbwe\bin\protoc.exe'
|
||||||
$goPluginPath = 'C:\Users\dohertj2\go\bin'
|
$goPluginPath = 'C:\Users\dohertj2\go\bin'
|
||||||
|
|
||||||
if (-not (Test-Path $protoc)) {
|
if (-not (Test-Path $protoc)) {
|
||||||
throw "protoc was not found at $protoc. See docs/ToolchainLinks.md."
|
throw "protoc was not found at $protoc. See docs/toolchain-links.md."
|
||||||
}
|
}
|
||||||
|
|
||||||
foreach ($pluginName in @('protoc-gen-go.exe', 'protoc-gen-go-grpc.exe')) {
|
foreach ($pluginName in @('protoc-gen-go.exe', 'protoc-gen-go-grpc.exe')) {
|
||||||
$pluginPath = Join-Path $goPluginPath $pluginName
|
$pluginPath = Join-Path $goPluginPath $pluginName
|
||||||
if (-not (Test-Path $pluginPath)) {
|
if (-not (Test-Path $pluginPath)) {
|
||||||
throw "$pluginName was not found at $pluginPath. See docs/ToolchainLinks.md."
|
throw "$pluginName was not found at $pluginPath. See docs/toolchain-links.md."
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -687,32 +687,18 @@ func (x *GalaxyObject) GetAttributes() []*GalaxyAttribute {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type GalaxyAttribute struct {
|
type GalaxyAttribute struct {
|
||||||
state protoimpl.MessageState `protogen:"open.v1"`
|
state protoimpl.MessageState `protogen:"open.v1"`
|
||||||
AttributeName string `protobuf:"bytes,1,opt,name=attribute_name,json=attributeName,proto3" json:"attribute_name,omitempty"`
|
AttributeName string `protobuf:"bytes,1,opt,name=attribute_name,json=attributeName,proto3" json:"attribute_name,omitempty"`
|
||||||
FullTagReference string `protobuf:"bytes,2,opt,name=full_tag_reference,json=fullTagReference,proto3" json:"full_tag_reference,omitempty"`
|
FullTagReference string `protobuf:"bytes,2,opt,name=full_tag_reference,json=fullTagReference,proto3" json:"full_tag_reference,omitempty"`
|
||||||
// Raw Galaxy SQL `dbo.data_type` identifier, passed through unchanged.
|
MxDataType int32 `protobuf:"varint,3,opt,name=mx_data_type,json=mxDataType,proto3" json:"mx_data_type,omitempty"`
|
||||||
// This is NOT a member of `mxaccess_gateway.v1.MxDataType` — Galaxy's
|
DataTypeName string `protobuf:"bytes,4,opt,name=data_type_name,json=dataTypeName,proto3" json:"data_type_name,omitempty"`
|
||||||
// type enumeration is distinct from MXAccess's wire data-type enum and
|
IsArray bool `protobuf:"varint,5,opt,name=is_array,json=isArray,proto3" json:"is_array,omitempty"`
|
||||||
// the two must not be cast or compared. The GalaxyRepository service is
|
ArrayDimension int32 `protobuf:"varint,6,opt,name=array_dimension,json=arrayDimension,proto3" json:"array_dimension,omitempty"`
|
||||||
// metadata-only and deliberately does not share types with
|
ArrayDimensionPresent bool `protobuf:"varint,7,opt,name=array_dimension_present,json=arrayDimensionPresent,proto3" json:"array_dimension_present,omitempty"`
|
||||||
// mxaccess_gateway.proto. See docs/GalaxyRepository.md.
|
MxAttributeCategory int32 `protobuf:"varint,8,opt,name=mx_attribute_category,json=mxAttributeCategory,proto3" json:"mx_attribute_category,omitempty"`
|
||||||
MxDataType int32 `protobuf:"varint,3,opt,name=mx_data_type,json=mxDataType,proto3" json:"mx_data_type,omitempty"`
|
SecurityClassification int32 `protobuf:"varint,9,opt,name=security_classification,json=securityClassification,proto3" json:"security_classification,omitempty"`
|
||||||
// Human-readable name from Galaxy's `dbo.data_type` table (e.g. "Float",
|
IsHistorized bool `protobuf:"varint,10,opt,name=is_historized,json=isHistorized,proto3" json:"is_historized,omitempty"`
|
||||||
// "Integer", "Boolean"). Free-form Galaxy text; not a stable enum.
|
IsAlarm bool `protobuf:"varint,11,opt,name=is_alarm,json=isAlarm,proto3" json:"is_alarm,omitempty"`
|
||||||
DataTypeName string `protobuf:"bytes,4,opt,name=data_type_name,json=dataTypeName,proto3" json:"data_type_name,omitempty"`
|
|
||||||
IsArray bool `protobuf:"varint,5,opt,name=is_array,json=isArray,proto3" json:"is_array,omitempty"`
|
|
||||||
ArrayDimension int32 `protobuf:"varint,6,opt,name=array_dimension,json=arrayDimension,proto3" json:"array_dimension,omitempty"`
|
|
||||||
ArrayDimensionPresent bool `protobuf:"varint,7,opt,name=array_dimension_present,json=arrayDimensionPresent,proto3" json:"array_dimension_present,omitempty"`
|
|
||||||
// Raw Galaxy SQL attribute-category identifier, passed through unchanged.
|
|
||||||
// Galaxy-specific; not mapped to any gateway enum. See
|
|
||||||
// docs/GalaxyRepository.md.
|
|
||||||
MxAttributeCategory int32 `protobuf:"varint,8,opt,name=mx_attribute_category,json=mxAttributeCategory,proto3" json:"mx_attribute_category,omitempty"`
|
|
||||||
// Raw Galaxy SQL security-classification identifier, passed through
|
|
||||||
// unchanged. Galaxy-specific; not mapped to any gateway enum. See
|
|
||||||
// docs/GalaxyRepository.md.
|
|
||||||
SecurityClassification int32 `protobuf:"varint,9,opt,name=security_classification,json=securityClassification,proto3" json:"security_classification,omitempty"`
|
|
||||||
IsHistorized bool `protobuf:"varint,10,opt,name=is_historized,json=isHistorized,proto3" json:"is_historized,omitempty"`
|
|
||||||
IsAlarm bool `protobuf:"varint,11,opt,name=is_alarm,json=isAlarm,proto3" json:"is_alarm,omitempty"`
|
|
||||||
unknownFields protoimpl.UnknownFields
|
unknownFields protoimpl.UnknownFields
|
||||||
sizeCache protoimpl.SizeCache
|
sizeCache protoimpl.SizeCache
|
||||||
}
|
}
|
||||||
@@ -902,7 +888,7 @@ const file_galaxy_repository_proto_rawDesc = "" +
|
|||||||
"\x0eTestConnection\x12+.galaxy_repository.v1.TestConnectionRequest\x1a).galaxy_repository.v1.TestConnectionReply\x12q\n" +
|
"\x0eTestConnection\x12+.galaxy_repository.v1.TestConnectionRequest\x1a).galaxy_repository.v1.TestConnectionReply\x12q\n" +
|
||||||
"\x11GetLastDeployTime\x12..galaxy_repository.v1.GetLastDeployTimeRequest\x1a,.galaxy_repository.v1.GetLastDeployTimeReply\x12q\n" +
|
"\x11GetLastDeployTime\x12..galaxy_repository.v1.GetLastDeployTimeRequest\x1a,.galaxy_repository.v1.GetLastDeployTimeReply\x12q\n" +
|
||||||
"\x11DiscoverHierarchy\x12..galaxy_repository.v1.DiscoverHierarchyRequest\x1a,.galaxy_repository.v1.DiscoverHierarchyReply\x12h\n" +
|
"\x11DiscoverHierarchy\x12..galaxy_repository.v1.DiscoverHierarchyRequest\x1a,.galaxy_repository.v1.DiscoverHierarchyReply\x12h\n" +
|
||||||
"\x11WatchDeployEvents\x12..galaxy_repository.v1.WatchDeployEventsRequest\x1a!.galaxy_repository.v1.DeployEvent0\x01B-\xaa\x02*ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxyb\x06proto3"
|
"\x11WatchDeployEvents\x12..galaxy_repository.v1.WatchDeployEventsRequest\x1a!.galaxy_repository.v1.DeployEvent0\x01B#\xaa\x02 MxGateway.Contracts.Proto.Galaxyb\x06proto3"
|
||||||
|
|
||||||
var (
|
var (
|
||||||
file_galaxy_repository_proto_rawDescOnce sync.Once
|
file_galaxy_repository_proto_rawDescOnce sync.Once
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -19,13 +19,10 @@ import (
|
|||||||
const _ = grpc.SupportPackageIsVersion9
|
const _ = grpc.SupportPackageIsVersion9
|
||||||
|
|
||||||
const (
|
const (
|
||||||
MxAccessGateway_OpenSession_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/OpenSession"
|
MxAccessGateway_OpenSession_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/OpenSession"
|
||||||
MxAccessGateway_CloseSession_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/CloseSession"
|
MxAccessGateway_CloseSession_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/CloseSession"
|
||||||
MxAccessGateway_Invoke_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/Invoke"
|
MxAccessGateway_Invoke_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/Invoke"
|
||||||
MxAccessGateway_StreamEvents_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/StreamEvents"
|
MxAccessGateway_StreamEvents_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/StreamEvents"
|
||||||
MxAccessGateway_AcknowledgeAlarm_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/AcknowledgeAlarm"
|
|
||||||
MxAccessGateway_StreamAlarms_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/StreamAlarms"
|
|
||||||
MxAccessGateway_QueryActiveAlarms_FullMethodName = "/mxaccess_gateway.v1.MxAccessGateway/QueryActiveAlarms"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// MxAccessGatewayClient is the client API for MxAccessGateway service.
|
// MxAccessGatewayClient is the client API for MxAccessGateway service.
|
||||||
@@ -38,19 +35,6 @@ type MxAccessGatewayClient interface {
|
|||||||
CloseSession(ctx context.Context, in *CloseSessionRequest, opts ...grpc.CallOption) (*CloseSessionReply, error)
|
CloseSession(ctx context.Context, in *CloseSessionRequest, opts ...grpc.CallOption) (*CloseSessionReply, error)
|
||||||
Invoke(ctx context.Context, in *MxCommandRequest, opts ...grpc.CallOption) (*MxCommandReply, error)
|
Invoke(ctx context.Context, in *MxCommandRequest, opts ...grpc.CallOption) (*MxCommandReply, error)
|
||||||
StreamEvents(ctx context.Context, in *StreamEventsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[MxEvent], error)
|
StreamEvents(ctx context.Context, in *StreamEventsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[MxEvent], error)
|
||||||
AcknowledgeAlarm(ctx context.Context, in *AcknowledgeAlarmRequest, opts ...grpc.CallOption) (*AcknowledgeAlarmReply, error)
|
|
||||||
// Session-less central alarm feed. The stream opens with the current
|
|
||||||
// active-alarm snapshot (one `active_alarm` per alarm), then a single
|
|
||||||
// `snapshot_complete`, then a `transition` for every subsequent change.
|
|
||||||
// Served by the gateway's always-on alarm monitor; any number of clients
|
|
||||||
// fan out from the single monitor without opening a worker session.
|
|
||||||
StreamAlarms(ctx context.Context, in *StreamAlarmsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[AlarmFeedMessage], error)
|
|
||||||
// Point-in-time snapshot of the currently-active alarm set served from the
|
|
||||||
// gateway's always-on alarm monitor cache (session-less). Used after a
|
|
||||||
// reconnect to seed Part 9 client state, or to reconcile alarms that may
|
|
||||||
// have been missed during a transport blip. Streamed so callers can
|
|
||||||
// begin processing without buffering the full set.
|
|
||||||
QueryActiveAlarms(ctx context.Context, in *QueryActiveAlarmsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ActiveAlarmSnapshot], error)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type mxAccessGatewayClient struct {
|
type mxAccessGatewayClient struct {
|
||||||
@@ -110,54 +94,6 @@ func (c *mxAccessGatewayClient) StreamEvents(ctx context.Context, in *StreamEven
|
|||||||
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
||||||
type MxAccessGateway_StreamEventsClient = grpc.ServerStreamingClient[MxEvent]
|
type MxAccessGateway_StreamEventsClient = grpc.ServerStreamingClient[MxEvent]
|
||||||
|
|
||||||
func (c *mxAccessGatewayClient) AcknowledgeAlarm(ctx context.Context, in *AcknowledgeAlarmRequest, opts ...grpc.CallOption) (*AcknowledgeAlarmReply, error) {
|
|
||||||
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
|
|
||||||
out := new(AcknowledgeAlarmReply)
|
|
||||||
err := c.cc.Invoke(ctx, MxAccessGateway_AcknowledgeAlarm_FullMethodName, in, out, cOpts...)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *mxAccessGatewayClient) StreamAlarms(ctx context.Context, in *StreamAlarmsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[AlarmFeedMessage], error) {
|
|
||||||
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
|
|
||||||
stream, err := c.cc.NewStream(ctx, &MxAccessGateway_ServiceDesc.Streams[1], MxAccessGateway_StreamAlarms_FullMethodName, cOpts...)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
x := &grpc.GenericClientStream[StreamAlarmsRequest, AlarmFeedMessage]{ClientStream: stream}
|
|
||||||
if err := x.ClientStream.SendMsg(in); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if err := x.ClientStream.CloseSend(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return x, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
|
||||||
type MxAccessGateway_StreamAlarmsClient = grpc.ServerStreamingClient[AlarmFeedMessage]
|
|
||||||
|
|
||||||
func (c *mxAccessGatewayClient) QueryActiveAlarms(ctx context.Context, in *QueryActiveAlarmsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ActiveAlarmSnapshot], error) {
|
|
||||||
cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
|
|
||||||
stream, err := c.cc.NewStream(ctx, &MxAccessGateway_ServiceDesc.Streams[2], MxAccessGateway_QueryActiveAlarms_FullMethodName, cOpts...)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
x := &grpc.GenericClientStream[QueryActiveAlarmsRequest, ActiveAlarmSnapshot]{ClientStream: stream}
|
|
||||||
if err := x.ClientStream.SendMsg(in); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if err := x.ClientStream.CloseSend(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return x, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
|
||||||
type MxAccessGateway_QueryActiveAlarmsClient = grpc.ServerStreamingClient[ActiveAlarmSnapshot]
|
|
||||||
|
|
||||||
// MxAccessGatewayServer is the server API for MxAccessGateway service.
|
// MxAccessGatewayServer is the server API for MxAccessGateway service.
|
||||||
// All implementations must embed UnimplementedMxAccessGatewayServer
|
// All implementations must embed UnimplementedMxAccessGatewayServer
|
||||||
// for forward compatibility.
|
// for forward compatibility.
|
||||||
@@ -168,19 +104,6 @@ type MxAccessGatewayServer interface {
|
|||||||
CloseSession(context.Context, *CloseSessionRequest) (*CloseSessionReply, error)
|
CloseSession(context.Context, *CloseSessionRequest) (*CloseSessionReply, error)
|
||||||
Invoke(context.Context, *MxCommandRequest) (*MxCommandReply, error)
|
Invoke(context.Context, *MxCommandRequest) (*MxCommandReply, error)
|
||||||
StreamEvents(*StreamEventsRequest, grpc.ServerStreamingServer[MxEvent]) error
|
StreamEvents(*StreamEventsRequest, grpc.ServerStreamingServer[MxEvent]) error
|
||||||
AcknowledgeAlarm(context.Context, *AcknowledgeAlarmRequest) (*AcknowledgeAlarmReply, error)
|
|
||||||
// Session-less central alarm feed. The stream opens with the current
|
|
||||||
// active-alarm snapshot (one `active_alarm` per alarm), then a single
|
|
||||||
// `snapshot_complete`, then a `transition` for every subsequent change.
|
|
||||||
// Served by the gateway's always-on alarm monitor; any number of clients
|
|
||||||
// fan out from the single monitor without opening a worker session.
|
|
||||||
StreamAlarms(*StreamAlarmsRequest, grpc.ServerStreamingServer[AlarmFeedMessage]) error
|
|
||||||
// Point-in-time snapshot of the currently-active alarm set served from the
|
|
||||||
// gateway's always-on alarm monitor cache (session-less). Used after a
|
|
||||||
// reconnect to seed Part 9 client state, or to reconcile alarms that may
|
|
||||||
// have been missed during a transport blip. Streamed so callers can
|
|
||||||
// begin processing without buffering the full set.
|
|
||||||
QueryActiveAlarms(*QueryActiveAlarmsRequest, grpc.ServerStreamingServer[ActiveAlarmSnapshot]) error
|
|
||||||
mustEmbedUnimplementedMxAccessGatewayServer()
|
mustEmbedUnimplementedMxAccessGatewayServer()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -203,15 +126,6 @@ func (UnimplementedMxAccessGatewayServer) Invoke(context.Context, *MxCommandRequ
|
|||||||
func (UnimplementedMxAccessGatewayServer) StreamEvents(*StreamEventsRequest, grpc.ServerStreamingServer[MxEvent]) error {
|
func (UnimplementedMxAccessGatewayServer) StreamEvents(*StreamEventsRequest, grpc.ServerStreamingServer[MxEvent]) error {
|
||||||
return status.Error(codes.Unimplemented, "method StreamEvents not implemented")
|
return status.Error(codes.Unimplemented, "method StreamEvents not implemented")
|
||||||
}
|
}
|
||||||
func (UnimplementedMxAccessGatewayServer) AcknowledgeAlarm(context.Context, *AcknowledgeAlarmRequest) (*AcknowledgeAlarmReply, error) {
|
|
||||||
return nil, status.Error(codes.Unimplemented, "method AcknowledgeAlarm not implemented")
|
|
||||||
}
|
|
||||||
func (UnimplementedMxAccessGatewayServer) StreamAlarms(*StreamAlarmsRequest, grpc.ServerStreamingServer[AlarmFeedMessage]) error {
|
|
||||||
return status.Error(codes.Unimplemented, "method StreamAlarms not implemented")
|
|
||||||
}
|
|
||||||
func (UnimplementedMxAccessGatewayServer) QueryActiveAlarms(*QueryActiveAlarmsRequest, grpc.ServerStreamingServer[ActiveAlarmSnapshot]) error {
|
|
||||||
return status.Error(codes.Unimplemented, "method QueryActiveAlarms not implemented")
|
|
||||||
}
|
|
||||||
func (UnimplementedMxAccessGatewayServer) mustEmbedUnimplementedMxAccessGatewayServer() {}
|
func (UnimplementedMxAccessGatewayServer) mustEmbedUnimplementedMxAccessGatewayServer() {}
|
||||||
func (UnimplementedMxAccessGatewayServer) testEmbeddedByValue() {}
|
func (UnimplementedMxAccessGatewayServer) testEmbeddedByValue() {}
|
||||||
|
|
||||||
@@ -298,46 +212,6 @@ func _MxAccessGateway_StreamEvents_Handler(srv interface{}, stream grpc.ServerSt
|
|||||||
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
||||||
type MxAccessGateway_StreamEventsServer = grpc.ServerStreamingServer[MxEvent]
|
type MxAccessGateway_StreamEventsServer = grpc.ServerStreamingServer[MxEvent]
|
||||||
|
|
||||||
func _MxAccessGateway_AcknowledgeAlarm_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
|
|
||||||
in := new(AcknowledgeAlarmRequest)
|
|
||||||
if err := dec(in); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if interceptor == nil {
|
|
||||||
return srv.(MxAccessGatewayServer).AcknowledgeAlarm(ctx, in)
|
|
||||||
}
|
|
||||||
info := &grpc.UnaryServerInfo{
|
|
||||||
Server: srv,
|
|
||||||
FullMethod: MxAccessGateway_AcknowledgeAlarm_FullMethodName,
|
|
||||||
}
|
|
||||||
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
||||||
return srv.(MxAccessGatewayServer).AcknowledgeAlarm(ctx, req.(*AcknowledgeAlarmRequest))
|
|
||||||
}
|
|
||||||
return interceptor(ctx, in, info, handler)
|
|
||||||
}
|
|
||||||
|
|
||||||
func _MxAccessGateway_StreamAlarms_Handler(srv interface{}, stream grpc.ServerStream) error {
|
|
||||||
m := new(StreamAlarmsRequest)
|
|
||||||
if err := stream.RecvMsg(m); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return srv.(MxAccessGatewayServer).StreamAlarms(m, &grpc.GenericServerStream[StreamAlarmsRequest, AlarmFeedMessage]{ServerStream: stream})
|
|
||||||
}
|
|
||||||
|
|
||||||
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
|
||||||
type MxAccessGateway_StreamAlarmsServer = grpc.ServerStreamingServer[AlarmFeedMessage]
|
|
||||||
|
|
||||||
func _MxAccessGateway_QueryActiveAlarms_Handler(srv interface{}, stream grpc.ServerStream) error {
|
|
||||||
m := new(QueryActiveAlarmsRequest)
|
|
||||||
if err := stream.RecvMsg(m); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return srv.(MxAccessGatewayServer).QueryActiveAlarms(m, &grpc.GenericServerStream[QueryActiveAlarmsRequest, ActiveAlarmSnapshot]{ServerStream: stream})
|
|
||||||
}
|
|
||||||
|
|
||||||
// This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
|
|
||||||
type MxAccessGateway_QueryActiveAlarmsServer = grpc.ServerStreamingServer[ActiveAlarmSnapshot]
|
|
||||||
|
|
||||||
// MxAccessGateway_ServiceDesc is the grpc.ServiceDesc for MxAccessGateway service.
|
// MxAccessGateway_ServiceDesc is the grpc.ServiceDesc for MxAccessGateway service.
|
||||||
// It's only intended for direct use with grpc.RegisterService,
|
// It's only intended for direct use with grpc.RegisterService,
|
||||||
// and not to be introspected or modified (even as a copy)
|
// and not to be introspected or modified (even as a copy)
|
||||||
@@ -357,10 +231,6 @@ var MxAccessGateway_ServiceDesc = grpc.ServiceDesc{
|
|||||||
MethodName: "Invoke",
|
MethodName: "Invoke",
|
||||||
Handler: _MxAccessGateway_Invoke_Handler,
|
Handler: _MxAccessGateway_Invoke_Handler,
|
||||||
},
|
},
|
||||||
{
|
|
||||||
MethodName: "AcknowledgeAlarm",
|
|
||||||
Handler: _MxAccessGateway_AcknowledgeAlarm_Handler,
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
Streams: []grpc.StreamDesc{
|
Streams: []grpc.StreamDesc{
|
||||||
{
|
{
|
||||||
@@ -368,16 +238,6 @@ var MxAccessGateway_ServiceDesc = grpc.ServiceDesc{
|
|||||||
Handler: _MxAccessGateway_StreamEvents_Handler,
|
Handler: _MxAccessGateway_StreamEvents_Handler,
|
||||||
ServerStreams: true,
|
ServerStreams: true,
|
||||||
},
|
},
|
||||||
{
|
|
||||||
StreamName: "StreamAlarms",
|
|
||||||
Handler: _MxAccessGateway_StreamAlarms_Handler,
|
|
||||||
ServerStreams: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
StreamName: "QueryActiveAlarms",
|
|
||||||
Handler: _MxAccessGateway_QueryActiveAlarms_Handler,
|
|
||||||
ServerStreams: true,
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
Metadata: "mxaccess_gateway.proto",
|
Metadata: "mxaccess_gateway.proto",
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1179,7 +1179,7 @@ const file_mxaccess_worker_proto_rawDesc = "" +
|
|||||||
"\x1eWORKER_FAULT_CATEGORY_STA_HUNG\x10\t\x12(\n" +
|
"\x1eWORKER_FAULT_CATEGORY_STA_HUNG\x10\t\x12(\n" +
|
||||||
"$WORKER_FAULT_CATEGORY_QUEUE_OVERFLOW\x10\n" +
|
"$WORKER_FAULT_CATEGORY_QUEUE_OVERFLOW\x10\n" +
|
||||||
"\x12*\n" +
|
"\x12*\n" +
|
||||||
"&WORKER_FAULT_CATEGORY_SHUTDOWN_TIMEOUT\x10\vB&\xaa\x02#ZB.MOM.WW.MxGateway.Contracts.Protob\x06proto3"
|
"&WORKER_FAULT_CATEGORY_SHUTDOWN_TIMEOUT\x10\vB\x1c\xaa\x02\x19MxGateway.Contracts.Protob\x06proto3"
|
||||||
|
|
||||||
var (
|
var (
|
||||||
file_mxaccess_worker_proto_rawDescOnce sync.Once
|
file_mxaccess_worker_proto_rawDescOnce sync.Once
|
||||||
|
|||||||
@@ -1,53 +0,0 @@
|
|||||||
package mxgateway
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
// AcknowledgeAlarm acknowledges an active MXAccess alarm condition through the
|
|
||||||
// gateway. The gateway authenticates the request against the API key's
|
|
||||||
// invoke:alarm-ack scope and forwards the acknowledge to the worker's MXAccess
|
|
||||||
// session; the resulting native MxStatus is returned in the reply.
|
|
||||||
//
|
|
||||||
// Acks are idempotent — re-acking an already-acked condition is a no-op at
|
|
||||||
// the MxAccess layer.
|
|
||||||
func (c *Client) AcknowledgeAlarm(ctx context.Context, req *AcknowledgeAlarmRequest) (*AcknowledgeAlarmReply, error) {
|
|
||||||
if req == nil {
|
|
||||||
return nil, errors.New("mxgateway: acknowledge alarm request is required")
|
|
||||||
}
|
|
||||||
|
|
||||||
callCtx, cancel := c.callContext(ctx)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
reply, err := c.raw.AcknowledgeAlarm(callCtx, req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, &GatewayError{Op: "acknowledge alarm", Err: err}
|
|
||||||
}
|
|
||||||
if err := EnsureProtocolSuccess("acknowledge alarm", reply.GetProtocolStatus(), nil); err != nil {
|
|
||||||
return reply, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return reply, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// QueryActiveAlarms streams a snapshot of all alarms currently Active or
|
|
||||||
// ActiveAcked — the gateway's ConditionRefresh equivalent. Used after reconnect
|
|
||||||
// to seed local Part 9 state, or to reconcile alarms that may have been missed
|
|
||||||
// during a transport blip.
|
|
||||||
//
|
|
||||||
// The returned stream is owned by the caller; cancel ctx to release it.
|
|
||||||
// Optional alarm-reference prefix scoping (req.AlarmFilterPrefix) limits the
|
|
||||||
// stream to a sub-tree.
|
|
||||||
func (c *Client) QueryActiveAlarms(ctx context.Context, req *QueryActiveAlarmsRequest) (QueryActiveAlarmsClient, error) {
|
|
||||||
if req == nil {
|
|
||||||
return nil, errors.New("mxgateway: query active alarms request is required")
|
|
||||||
}
|
|
||||||
|
|
||||||
stream, err := c.raw.QueryActiveAlarms(ctx, req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, &GatewayError{Op: "query active alarms", Err: err}
|
|
||||||
}
|
|
||||||
|
|
||||||
return stream, nil
|
|
||||||
}
|
|
||||||
@@ -1,235 +0,0 @@
|
|||||||
package mxgateway
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
pb "gitea.dohertylan.com/dohertj2/mxaccessgw/clients/go/internal/generated"
|
|
||||||
"google.golang.org/grpc"
|
|
||||||
"google.golang.org/grpc/codes"
|
|
||||||
"google.golang.org/grpc/status"
|
|
||||||
"google.golang.org/grpc/test/bufconn"
|
|
||||||
)
|
|
||||||
|
|
||||||
// PR E.4 — pins the Go SDK surface for the new alarm RPCs:
|
|
||||||
// AcknowledgeAlarm + QueryActiveAlarms.
|
|
||||||
|
|
||||||
func TestAcknowledgeAlarmSendsRequestAndReturnsReply(t *testing.T) {
|
|
||||||
fake := &fakeGatewayWithAlarms{
|
|
||||||
acknowledgeReply: &pb.AcknowledgeAlarmReply{
|
|
||||||
CorrelationId: "corr-1",
|
|
||||||
ProtocolStatus: &pb.ProtocolStatus{
|
|
||||||
Code: pb.ProtocolStatusCode_PROTOCOL_STATUS_CODE_OK,
|
|
||||||
},
|
|
||||||
Status: &pb.MxStatusProxy{
|
|
||||||
Success: 1,
|
|
||||||
Category: pb.MxStatusCategory_MX_STATUS_CATEGORY_OK,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
client, cleanup := newBufconnClientWithAlarms(t, fake)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
reply, err := client.AcknowledgeAlarm(context.Background(), &pb.AcknowledgeAlarmRequest{
|
|
||||||
ClientCorrelationId: "corr-1",
|
|
||||||
AlarmFullReference: "Tank01.Level.HiHi",
|
|
||||||
Comment: "investigating",
|
|
||||||
OperatorUser: "alice",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("AcknowledgeAlarm() error = %v", err)
|
|
||||||
}
|
|
||||||
if reply.GetProtocolStatus().GetCode() != pb.ProtocolStatusCode_PROTOCOL_STATUS_CODE_OK {
|
|
||||||
t.Fatalf("protocol status = %v", reply.GetProtocolStatus().GetCode())
|
|
||||||
}
|
|
||||||
if got := fake.acknowledgeRequest.GetAlarmFullReference(); got != "Tank01.Level.HiHi" {
|
|
||||||
t.Fatalf("captured alarm reference = %q", got)
|
|
||||||
}
|
|
||||||
if got := fake.acknowledgeRequest.GetComment(); got != "investigating" {
|
|
||||||
t.Fatalf("captured comment = %q", got)
|
|
||||||
}
|
|
||||||
if got := fake.acknowledgeAuth; got != "Bearer test-api-key" {
|
|
||||||
t.Fatalf("authorization metadata = %q", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAcknowledgeAlarmRejectsNilRequest(t *testing.T) {
|
|
||||||
fake := &fakeGatewayWithAlarms{}
|
|
||||||
client, cleanup := newBufconnClientWithAlarms(t, fake)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
_, err := client.AcknowledgeAlarm(context.Background(), nil)
|
|
||||||
if err == nil || !errors.Is(err, errors.Unwrap(err)) && err.Error() != "mxgateway: acknowledge alarm request is required" {
|
|
||||||
// Accept either: the helper returned the literal sentinel, or the
|
|
||||||
// generic transport error — both prove nil was rejected.
|
|
||||||
}
|
|
||||||
if err == nil {
|
|
||||||
t.Fatalf("AcknowledgeAlarm(nil) returned no error")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAcknowledgeAlarmMapsUnauthenticated(t *testing.T) {
|
|
||||||
fake := &fakeGatewayWithAlarms{
|
|
||||||
acknowledgeError: status.Error(codes.Unauthenticated, "expired key"),
|
|
||||||
}
|
|
||||||
client, cleanup := newBufconnClientWithAlarms(t, fake)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
_, err := client.AcknowledgeAlarm(context.Background(), &pb.AcknowledgeAlarmRequest{
|
|
||||||
AlarmFullReference: "Tank01.Level.HiHi",
|
|
||||||
OperatorUser: "alice",
|
|
||||||
})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatalf("AcknowledgeAlarm() returned no error on Unauthenticated")
|
|
||||||
}
|
|
||||||
var gwErr *GatewayError
|
|
||||||
if !errors.As(err, &gwErr) {
|
|
||||||
t.Fatalf("error %T does not unwrap to *GatewayError", err)
|
|
||||||
}
|
|
||||||
if got, _ := status.FromError(gwErr.Err); got.Code() != codes.Unauthenticated {
|
|
||||||
t.Fatalf("inner status code = %v", got.Code())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestQueryActiveAlarmsStreamsSnapshots(t *testing.T) {
|
|
||||||
fake := &fakeGatewayWithAlarms{
|
|
||||||
activeSnapshots: []*pb.ActiveAlarmSnapshot{
|
|
||||||
{
|
|
||||||
AlarmFullReference: "Tank01.Level.HiHi",
|
|
||||||
CurrentState: pb.AlarmConditionState_ALARM_CONDITION_STATE_ACTIVE,
|
|
||||||
Severity: 750,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
AlarmFullReference: "Tank02.Level.HiHi",
|
|
||||||
CurrentState: pb.AlarmConditionState_ALARM_CONDITION_STATE_ACTIVE_ACKED,
|
|
||||||
Severity: 750,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
client, cleanup := newBufconnClientWithAlarms(t, fake)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
stream, err := client.QueryActiveAlarms(context.Background(), &pb.QueryActiveAlarmsRequest{
|
|
||||||
SessionId: "session-1",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("QueryActiveAlarms() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var received []*pb.ActiveAlarmSnapshot
|
|
||||||
for {
|
|
||||||
snap, err := stream.Recv()
|
|
||||||
if errors.Is(err, io.EOF) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stream.Recv() error = %v", err)
|
|
||||||
}
|
|
||||||
received = append(received, snap)
|
|
||||||
}
|
|
||||||
if len(received) != 2 {
|
|
||||||
t.Fatalf("snapshot count = %d, want 2", len(received))
|
|
||||||
}
|
|
||||||
if received[0].GetAlarmFullReference() != "Tank01.Level.HiHi" {
|
|
||||||
t.Fatalf("snapshot[0] ref = %q", received[0].GetAlarmFullReference())
|
|
||||||
}
|
|
||||||
if received[1].GetCurrentState() != pb.AlarmConditionState_ALARM_CONDITION_STATE_ACTIVE_ACKED {
|
|
||||||
t.Fatalf("snapshot[1] state = %v", received[1].GetCurrentState())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestQueryActiveAlarmsPassesFilterPrefix(t *testing.T) {
|
|
||||||
fake := &fakeGatewayWithAlarms{}
|
|
||||||
client, cleanup := newBufconnClientWithAlarms(t, fake)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
stream, err := client.QueryActiveAlarms(context.Background(), &pb.QueryActiveAlarmsRequest{
|
|
||||||
SessionId: "session-1",
|
|
||||||
AlarmFilterPrefix: "Tank01.",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("QueryActiveAlarms() error = %v", err)
|
|
||||||
}
|
|
||||||
for {
|
|
||||||
_, err := stream.Recv()
|
|
||||||
if errors.Is(err, io.EOF) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stream.Recv() error = %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := fake.queryRequest.GetAlarmFilterPrefix(); got != "Tank01." {
|
|
||||||
t.Fatalf("captured filter prefix = %q", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type fakeGatewayWithAlarms struct {
|
|
||||||
pb.UnimplementedMxAccessGatewayServer
|
|
||||||
|
|
||||||
acknowledgeRequest *pb.AcknowledgeAlarmRequest
|
|
||||||
acknowledgeReply *pb.AcknowledgeAlarmReply
|
|
||||||
acknowledgeError error
|
|
||||||
acknowledgeAuth string
|
|
||||||
|
|
||||||
queryRequest *pb.QueryActiveAlarmsRequest
|
|
||||||
activeSnapshots []*pb.ActiveAlarmSnapshot
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *fakeGatewayWithAlarms) AcknowledgeAlarm(ctx context.Context, req *pb.AcknowledgeAlarmRequest) (*pb.AcknowledgeAlarmReply, error) {
|
|
||||||
s.acknowledgeRequest = req
|
|
||||||
s.acknowledgeAuth = authorizationFromContext(ctx)
|
|
||||||
if s.acknowledgeError != nil {
|
|
||||||
return nil, s.acknowledgeError
|
|
||||||
}
|
|
||||||
if s.acknowledgeReply != nil {
|
|
||||||
return s.acknowledgeReply, nil
|
|
||||||
}
|
|
||||||
return &pb.AcknowledgeAlarmReply{
|
|
||||||
CorrelationId: req.GetClientCorrelationId(),
|
|
||||||
ProtocolStatus: &pb.ProtocolStatus{
|
|
||||||
Code: pb.ProtocolStatusCode_PROTOCOL_STATUS_CODE_OK,
|
|
||||||
},
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *fakeGatewayWithAlarms) QueryActiveAlarms(req *pb.QueryActiveAlarmsRequest, stream grpc.ServerStreamingServer[pb.ActiveAlarmSnapshot]) error {
|
|
||||||
s.queryRequest = req
|
|
||||||
for _, snap := range s.activeSnapshots {
|
|
||||||
if err := stream.Send(snap); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func newBufconnClientWithAlarms(t *testing.T, fake *fakeGatewayWithAlarms) (*Client, func()) {
|
|
||||||
t.Helper()
|
|
||||||
listener := bufconn.Listen(bufSize)
|
|
||||||
server := grpc.NewServer()
|
|
||||||
pb.RegisterMxAccessGatewayServer(server, fake)
|
|
||||||
go func() {
|
|
||||||
_ = server.Serve(listener)
|
|
||||||
}()
|
|
||||||
dialer := func(ctx context.Context, _ string) (net.Conn, error) {
|
|
||||||
return listener.DialContext(ctx)
|
|
||||||
}
|
|
||||||
client, err := Dial(context.Background(), Options{
|
|
||||||
Endpoint: "bufnet",
|
|
||||||
APIKey: "test-api-key",
|
|
||||||
Plaintext: true,
|
|
||||||
DialOptions: []grpc.DialOption{grpc.WithContextDialer(dialer)},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Dial() error = %v", err)
|
|
||||||
}
|
|
||||||
return client, func() {
|
|
||||||
client.Close()
|
|
||||||
server.Stop()
|
|
||||||
listener.Close()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +1,3 @@
|
|||||||
// Package mxgateway is the Go client for the MXAccess Gateway gRPC service.
|
|
||||||
//
|
|
||||||
// The package wraps the generated gRPC contract with session-oriented helpers
|
|
||||||
// for invoking MXAccess commands, streaming events, and browsing the Galaxy
|
|
||||||
// Repository. Authentication uses an API-key bearer token attached as gRPC
|
|
||||||
// metadata on every call.
|
|
||||||
//
|
|
||||||
// Typical use opens a Client with Dial, opens a Session, invokes commands such
|
|
||||||
// as Register, AddItem, Advise, and Write, and consumes events via
|
|
||||||
// SubscribeEvents. Galaxy Repository browse RPCs are exposed through
|
|
||||||
// GalaxyClient.
|
|
||||||
package mxgateway
|
package mxgateway
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -27,6 +16,7 @@ import (
|
|||||||
const (
|
const (
|
||||||
defaultDialTimeout = 10 * time.Second
|
defaultDialTimeout = 10 * time.Second
|
||||||
defaultCallTimeout = 30 * time.Second
|
defaultCallTimeout = 30 * time.Second
|
||||||
|
defaultMaxGrpcMessageBytes = 16 * 1024 * 1024
|
||||||
)
|
)
|
||||||
|
|
||||||
// Client owns a gateway gRPC connection and exposes session-oriented helpers.
|
// Client owns a gateway gRPC connection and exposes session-oriented helpers.
|
||||||
@@ -61,6 +51,10 @@ func Dial(ctx context.Context, opts Options) (*Client, error) {
|
|||||||
grpc.WithTransportCredentials(transportCredentials),
|
grpc.WithTransportCredentials(transportCredentials),
|
||||||
grpc.WithUnaryInterceptor(unaryAuthInterceptor(opts.APIKey)),
|
grpc.WithUnaryInterceptor(unaryAuthInterceptor(opts.APIKey)),
|
||||||
grpc.WithStreamInterceptor(streamAuthInterceptor(opts.APIKey)),
|
grpc.WithStreamInterceptor(streamAuthInterceptor(opts.APIKey)),
|
||||||
|
grpc.WithDefaultCallOptions(
|
||||||
|
grpc.MaxCallRecvMsgSize(resolveMaxGrpcMessageBytes(opts)),
|
||||||
|
grpc.MaxCallSendMsgSize(resolveMaxGrpcMessageBytes(opts)),
|
||||||
|
),
|
||||||
grpc.WithBlock(),
|
grpc.WithBlock(),
|
||||||
}
|
}
|
||||||
dialOptions = append(dialOptions, opts.DialOptions...)
|
dialOptions = append(dialOptions, opts.DialOptions...)
|
||||||
@@ -73,6 +67,13 @@ func Dial(ctx context.Context, opts Options) (*Client, error) {
|
|||||||
return NewClient(conn, opts), nil
|
return NewClient(conn, opts), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func resolveMaxGrpcMessageBytes(opts Options) int {
|
||||||
|
if opts.MaxGrpcMessageBytes > 0 {
|
||||||
|
return opts.MaxGrpcMessageBytes
|
||||||
|
}
|
||||||
|
return defaultMaxGrpcMessageBytes
|
||||||
|
}
|
||||||
|
|
||||||
// NewClient wraps an existing gRPC connection. The caller owns closing conn
|
// NewClient wraps an existing gRPC connection. The caller owns closing conn
|
||||||
// unless it calls Close on the returned Client.
|
// unless it calls Close on the returned Client.
|
||||||
func NewClient(conn *grpc.ClientConn, opts Options) *Client {
|
func NewClient(conn *grpc.ClientConn, opts Options) *Client {
|
||||||
@@ -230,15 +231,10 @@ func resolveTransportCredentials(opts Options) (credentials.TransportCredentials
|
|||||||
|
|
||||||
// OpenSessionOptions describes fields used to create an OpenSessionRequest.
|
// OpenSessionOptions describes fields used to create an OpenSessionRequest.
|
||||||
type OpenSessionOptions struct {
|
type OpenSessionOptions struct {
|
||||||
// RequestedBackend selects the gateway worker backend (empty for default).
|
RequestedBackend string
|
||||||
RequestedBackend string
|
ClientSessionName string
|
||||||
// ClientSessionName is a human-readable name recorded on the session.
|
|
||||||
ClientSessionName string
|
|
||||||
// ClientCorrelationID echoes through gateway logs and replies for tracing.
|
|
||||||
ClientCorrelationID string
|
ClientCorrelationID string
|
||||||
// CommandTimeout sets the per-command timeout the gateway forwards to the
|
CommandTimeout time.Duration
|
||||||
// worker; zero leaves the gateway default in place.
|
|
||||||
CommandTimeout time.Duration
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Request returns the raw protobuf OpenSessionRequest for these options.
|
// Request returns the raw protobuf OpenSessionRequest for these options.
|
||||||
|
|||||||
@@ -8,13 +8,10 @@ import (
|
|||||||
|
|
||||||
// GatewayError wraps transport-level gRPC failures.
|
// GatewayError wraps transport-level gRPC failures.
|
||||||
type GatewayError struct {
|
type GatewayError struct {
|
||||||
// Op names the operation that failed (for example "dial" or "invoke").
|
Op string
|
||||||
Op string
|
|
||||||
// Err is the underlying gRPC or transport error.
|
|
||||||
Err error
|
Err error
|
||||||
}
|
}
|
||||||
|
|
||||||
// Error returns the formatted gateway error message.
|
|
||||||
func (e *GatewayError) Error() string {
|
func (e *GatewayError) Error() string {
|
||||||
if e == nil {
|
if e == nil {
|
||||||
return ""
|
return ""
|
||||||
@@ -25,7 +22,6 @@ func (e *GatewayError) Error() string {
|
|||||||
return fmt.Sprintf("mxgateway: %s failed: %v", e.Op, e.Err)
|
return fmt.Sprintf("mxgateway: %s failed: %v", e.Op, e.Err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Unwrap returns the wrapped transport error.
|
|
||||||
func (e *GatewayError) Unwrap() error {
|
func (e *GatewayError) Unwrap() error {
|
||||||
if e == nil {
|
if e == nil {
|
||||||
return nil
|
return nil
|
||||||
@@ -36,15 +32,11 @@ func (e *GatewayError) Unwrap() error {
|
|||||||
// CommandError reports a non-OK gateway protocol status and keeps the raw
|
// CommandError reports a non-OK gateway protocol status and keeps the raw
|
||||||
// command reply when one exists.
|
// command reply when one exists.
|
||||||
type CommandError struct {
|
type CommandError struct {
|
||||||
// Op names the gateway operation that produced the non-OK status.
|
Op string
|
||||||
Op string
|
|
||||||
// Status carries the gateway-reported protocol status.
|
|
||||||
Status *ProtocolStatus
|
Status *ProtocolStatus
|
||||||
// Reply is the raw command reply, when one was returned alongside the status.
|
Reply *MxCommandReply
|
||||||
Reply *MxCommandReply
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Error returns the formatted command error message.
|
|
||||||
func (e *CommandError) Error() string {
|
func (e *CommandError) Error() string {
|
||||||
if e == nil {
|
if e == nil {
|
||||||
return ""
|
return ""
|
||||||
@@ -61,13 +53,10 @@ func (e *CommandError) Error() string {
|
|||||||
|
|
||||||
// MxAccessError reports HRESULT or MXSTATUS_PROXY failures returned by MXAccess.
|
// MxAccessError reports HRESULT or MXSTATUS_PROXY failures returned by MXAccess.
|
||||||
type MxAccessError struct {
|
type MxAccessError struct {
|
||||||
// Command is the wrapped CommandError when the protocol status carried one.
|
|
||||||
Command *CommandError
|
Command *CommandError
|
||||||
// Reply is the raw MXAccess command reply that surfaced the failure.
|
Reply *MxCommandReply
|
||||||
Reply *MxCommandReply
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Error returns the formatted MXAccess error message.
|
|
||||||
func (e *MxAccessError) Error() string {
|
func (e *MxAccessError) Error() string {
|
||||||
if e == nil {
|
if e == nil {
|
||||||
return ""
|
return ""
|
||||||
@@ -84,7 +73,6 @@ func (e *MxAccessError) Error() string {
|
|||||||
return "mxgateway: MXAccess command failed"
|
return "mxgateway: MXAccess command failed"
|
||||||
}
|
}
|
||||||
|
|
||||||
// Unwrap returns the wrapped CommandError, when one is present.
|
|
||||||
func (e *MxAccessError) Unwrap() error {
|
func (e *MxAccessError) Unwrap() error {
|
||||||
if e == nil {
|
if e == nil {
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package mxgateway
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -13,6 +14,8 @@ import (
|
|||||||
"google.golang.org/protobuf/types/known/timestamppb"
|
"google.golang.org/protobuf/types/known/timestamppb"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const discoverHierarchyPageSize = 5000
|
||||||
|
|
||||||
// RawGalaxyRepositoryClient is the generated gRPC client interface for the
|
// RawGalaxyRepositoryClient is the generated gRPC client interface for the
|
||||||
// Galaxy Repository service exposed for callers that need direct contract
|
// Galaxy Repository service exposed for callers that need direct contract
|
||||||
// access.
|
// access.
|
||||||
@@ -20,26 +23,16 @@ type RawGalaxyRepositoryClient = pb.GalaxyRepositoryClient
|
|||||||
|
|
||||||
// Generated protobuf aliases for Galaxy Repository messages.
|
// Generated protobuf aliases for Galaxy Repository messages.
|
||||||
type (
|
type (
|
||||||
// TestConnectionRequest is the request for Galaxy Repository TestConnection.
|
TestConnectionRequest = pb.TestConnectionRequest
|
||||||
TestConnectionRequest = pb.TestConnectionRequest
|
TestConnectionReply = pb.TestConnectionReply
|
||||||
// TestConnectionReply is the reply for Galaxy Repository TestConnection.
|
GetLastDeployTimeRequest = pb.GetLastDeployTimeRequest
|
||||||
TestConnectionReply = pb.TestConnectionReply
|
GetLastDeployTimeReply = pb.GetLastDeployTimeReply
|
||||||
// GetLastDeployTimeRequest is the request for GetLastDeployTime.
|
DiscoverHierarchyRequest = pb.DiscoverHierarchyRequest
|
||||||
GetLastDeployTimeRequest = pb.GetLastDeployTimeRequest
|
DiscoverHierarchyReply = pb.DiscoverHierarchyReply
|
||||||
// GetLastDeployTimeReply is the reply for GetLastDeployTime.
|
GalaxyObject = pb.GalaxyObject
|
||||||
GetLastDeployTimeReply = pb.GetLastDeployTimeReply
|
GalaxyAttribute = pb.GalaxyAttribute
|
||||||
// DiscoverHierarchyRequest is the request for DiscoverHierarchy.
|
WatchDeployEventsRequest = pb.WatchDeployEventsRequest
|
||||||
DiscoverHierarchyRequest = pb.DiscoverHierarchyRequest
|
DeployEvent = pb.DeployEvent
|
||||||
// DiscoverHierarchyReply is the reply for DiscoverHierarchy.
|
|
||||||
DiscoverHierarchyReply = pb.DiscoverHierarchyReply
|
|
||||||
// GalaxyObject describes one Galaxy object with its dynamic attributes.
|
|
||||||
GalaxyObject = pb.GalaxyObject
|
|
||||||
// GalaxyAttribute describes one dynamic attribute on a GalaxyObject.
|
|
||||||
GalaxyAttribute = pb.GalaxyAttribute
|
|
||||||
// WatchDeployEventsRequest is the request for WatchDeployEvents.
|
|
||||||
WatchDeployEventsRequest = pb.WatchDeployEventsRequest
|
|
||||||
// DeployEvent is one Galaxy Repository deploy event.
|
|
||||||
DeployEvent = pb.DeployEvent
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// RawDeployEventStream is the generated WatchDeployEvents client stream.
|
// RawDeployEventStream is the generated WatchDeployEvents client stream.
|
||||||
@@ -80,6 +73,10 @@ func DialGalaxy(ctx context.Context, opts Options) (*GalaxyClient, error) {
|
|||||||
grpc.WithTransportCredentials(transportCredentials),
|
grpc.WithTransportCredentials(transportCredentials),
|
||||||
grpc.WithUnaryInterceptor(unaryAuthInterceptor(opts.APIKey)),
|
grpc.WithUnaryInterceptor(unaryAuthInterceptor(opts.APIKey)),
|
||||||
grpc.WithStreamInterceptor(streamAuthInterceptor(opts.APIKey)),
|
grpc.WithStreamInterceptor(streamAuthInterceptor(opts.APIKey)),
|
||||||
|
grpc.WithDefaultCallOptions(
|
||||||
|
grpc.MaxCallRecvMsgSize(resolveMaxGrpcMessageBytes(opts)),
|
||||||
|
grpc.MaxCallSendMsgSize(resolveMaxGrpcMessageBytes(opts)),
|
||||||
|
),
|
||||||
grpc.WithBlock(),
|
grpc.WithBlock(),
|
||||||
}
|
}
|
||||||
dialOptions = append(dialOptions, opts.DialOptions...)
|
dialOptions = append(dialOptions, opts.DialOptions...)
|
||||||
@@ -151,11 +148,28 @@ func (c *GalaxyClient) DiscoverHierarchy(ctx context.Context) ([]*GalaxyObject,
|
|||||||
callCtx, cancel := c.callContext(ctx)
|
callCtx, cancel := c.callContext(ctx)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
reply, err := c.raw.DiscoverHierarchy(callCtx, &pb.DiscoverHierarchyRequest{})
|
var objects []*GalaxyObject
|
||||||
if err != nil {
|
seenPageTokens := make(map[string]struct{})
|
||||||
return nil, &GatewayError{Op: "galaxy discover hierarchy", Err: err}
|
pageToken := ""
|
||||||
|
for {
|
||||||
|
reply, err := c.raw.DiscoverHierarchy(callCtx, &pb.DiscoverHierarchyRequest{
|
||||||
|
PageSize: discoverHierarchyPageSize,
|
||||||
|
PageToken: pageToken,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, &GatewayError{Op: "galaxy discover hierarchy", Err: err}
|
||||||
|
}
|
||||||
|
objects = append(objects, reply.GetObjects()...)
|
||||||
|
pageToken = reply.GetNextPageToken()
|
||||||
|
if pageToken == "" {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if _, seen := seenPageTokens[pageToken]; seen {
|
||||||
|
return nil, fmt.Errorf("mxgateway: galaxy discover hierarchy returned repeated page token %q", pageToken)
|
||||||
|
}
|
||||||
|
seenPageTokens[pageToken] = struct{}{}
|
||||||
}
|
}
|
||||||
return reply.GetObjects(), nil
|
return objects, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// WatchDeployEventsRaw starts the generated WatchDeployEvents stream for callers
|
// WatchDeployEventsRaw starts the generated WatchDeployEvents stream for callers
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"net"
|
"net"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -95,7 +96,9 @@ func TestGalaxyGetLastDeployTimeReturnsAbsentWhenTimestampNil(t *testing.T) {
|
|||||||
|
|
||||||
func TestGalaxyDiscoverHierarchyReturnsObjects(t *testing.T) {
|
func TestGalaxyDiscoverHierarchyReturnsObjects(t *testing.T) {
|
||||||
fake := &fakeGalaxyServer{
|
fake := &fakeGalaxyServer{
|
||||||
discoverReply: &pb.DiscoverHierarchyReply{
|
discoverReplies: []*pb.DiscoverHierarchyReply{{
|
||||||
|
NextPageToken: "page-2",
|
||||||
|
TotalObjectCount: 2,
|
||||||
Objects: []*pb.GalaxyObject{
|
Objects: []*pb.GalaxyObject{
|
||||||
{
|
{
|
||||||
GobjectId: 1,
|
GobjectId: 1,
|
||||||
@@ -114,6 +117,10 @@ func TestGalaxyDiscoverHierarchyReturnsObjects(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
},
|
||||||
|
}, {
|
||||||
|
TotalObjectCount: 2,
|
||||||
|
Objects: []*pb.GalaxyObject{
|
||||||
{
|
{
|
||||||
GobjectId: 2,
|
GobjectId: 2,
|
||||||
TagName: "TestMachine_002",
|
TagName: "TestMachine_002",
|
||||||
@@ -121,7 +128,7 @@ func TestGalaxyDiscoverHierarchyReturnsObjects(t *testing.T) {
|
|||||||
ParentGobjectId: 1,
|
ParentGobjectId: 1,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
}},
|
||||||
}
|
}
|
||||||
client, cleanup := newGalaxyBufconnClient(t, fake)
|
client, cleanup := newGalaxyBufconnClient(t, fake)
|
||||||
defer cleanup()
|
defer cleanup()
|
||||||
@@ -133,6 +140,15 @@ func TestGalaxyDiscoverHierarchyReturnsObjects(t *testing.T) {
|
|||||||
if len(objects) != 2 {
|
if len(objects) != 2 {
|
||||||
t.Fatalf("len(objects) = %d, want 2", len(objects))
|
t.Fatalf("len(objects) = %d, want 2", len(objects))
|
||||||
}
|
}
|
||||||
|
if len(fake.discoverRequests) != 2 {
|
||||||
|
t.Fatalf("len(discoverRequests) = %d, want 2", len(fake.discoverRequests))
|
||||||
|
}
|
||||||
|
if fake.discoverRequests[0].GetPageSize() != 5000 || fake.discoverRequests[0].GetPageToken() != "" {
|
||||||
|
t.Fatalf("first request = %+v", fake.discoverRequests[0])
|
||||||
|
}
|
||||||
|
if fake.discoverRequests[1].GetPageToken() != "page-2" {
|
||||||
|
t.Fatalf("second page_token = %q, want page-2", fake.discoverRequests[1].GetPageToken())
|
||||||
|
}
|
||||||
if objects[0].GetTagName() != "TestMachine_001" {
|
if objects[0].GetTagName() != "TestMachine_001" {
|
||||||
t.Fatalf("objects[0].TagName = %q", objects[0].GetTagName())
|
t.Fatalf("objects[0].TagName = %q", objects[0].GetTagName())
|
||||||
}
|
}
|
||||||
@@ -144,6 +160,25 @@ func TestGalaxyDiscoverHierarchyReturnsObjects(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestGalaxyDiscoverHierarchyRejectsRepeatedPageToken(t *testing.T) {
|
||||||
|
fake := &fakeGalaxyServer{
|
||||||
|
discoverReplies: []*pb.DiscoverHierarchyReply{
|
||||||
|
{NextPageToken: "7:1"},
|
||||||
|
{NextPageToken: "7:1"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
client, cleanup := newGalaxyBufconnClient(t, fake)
|
||||||
|
defer cleanup()
|
||||||
|
|
||||||
|
_, err := client.DiscoverHierarchy(context.Background())
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("DiscoverHierarchy() error = nil, want repeated token error")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "repeated page token") {
|
||||||
|
t.Fatalf("error = %v, want repeated page token", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestGalaxyDialReturnsGatewayErrorOnRpcFailure(t *testing.T) {
|
func TestGalaxyDialReturnsGatewayErrorOnRpcFailure(t *testing.T) {
|
||||||
fake := &fakeGalaxyServer{failTest: true}
|
fake := &fakeGalaxyServer{failTest: true}
|
||||||
client, cleanup := newGalaxyBufconnClient(t, fake)
|
client, cleanup := newGalaxyBufconnClient(t, fake)
|
||||||
@@ -375,6 +410,8 @@ type fakeGalaxyServer struct {
|
|||||||
failTest bool
|
failTest bool
|
||||||
deployReply *pb.GetLastDeployTimeReply
|
deployReply *pb.GetLastDeployTimeReply
|
||||||
discoverReply *pb.DiscoverHierarchyReply
|
discoverReply *pb.DiscoverHierarchyReply
|
||||||
|
discoverReplies []*pb.DiscoverHierarchyReply
|
||||||
|
discoverRequests []*pb.DiscoverHierarchyRequest
|
||||||
watchEvents []*pb.DeployEvent
|
watchEvents []*pb.DeployEvent
|
||||||
watchRequest *pb.WatchDeployEventsRequest
|
watchRequest *pb.WatchDeployEventsRequest
|
||||||
watchSendInterval time.Duration
|
watchSendInterval time.Duration
|
||||||
@@ -400,6 +437,12 @@ func (s *fakeGalaxyServer) GetLastDeployTime(ctx context.Context, req *pb.GetLas
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *fakeGalaxyServer) DiscoverHierarchy(ctx context.Context, req *pb.DiscoverHierarchyRequest) (*pb.DiscoverHierarchyReply, error) {
|
func (s *fakeGalaxyServer) DiscoverHierarchy(ctx context.Context, req *pb.DiscoverHierarchyRequest) (*pb.DiscoverHierarchyReply, error) {
|
||||||
|
s.discoverRequests = append(s.discoverRequests, req)
|
||||||
|
if len(s.discoverReplies) > 0 {
|
||||||
|
reply := s.discoverReplies[0]
|
||||||
|
s.discoverReplies = s.discoverReplies[1:]
|
||||||
|
return reply, nil
|
||||||
|
}
|
||||||
if s.discoverReply != nil {
|
if s.discoverReply != nil {
|
||||||
return s.discoverReply, nil
|
return s.discoverReply, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,29 +11,17 @@ import (
|
|||||||
|
|
||||||
// Options configures gateway connections.
|
// Options configures gateway connections.
|
||||||
type Options struct {
|
type Options struct {
|
||||||
// Endpoint is the gateway host:port address to dial.
|
Endpoint string
|
||||||
Endpoint string
|
APIKey string
|
||||||
// APIKey is the bearer token attached to outgoing gRPC metadata.
|
Plaintext bool
|
||||||
APIKey string
|
CACertFile string
|
||||||
// Plaintext disables TLS and uses insecure credentials when true.
|
ServerNameOverride string
|
||||||
Plaintext bool
|
DialTimeout time.Duration
|
||||||
// CACertFile points to a PEM file used to verify the gateway certificate.
|
CallTimeout time.Duration
|
||||||
CACertFile string
|
MaxGrpcMessageBytes int
|
||||||
// ServerNameOverride overrides the TLS SNI/SAN name presented to the gateway.
|
TLSConfig *tls.Config
|
||||||
ServerNameOverride string
|
|
||||||
// DialTimeout bounds the blocking Dial; zero applies a built-in default.
|
|
||||||
DialTimeout time.Duration
|
|
||||||
// CallTimeout bounds each unary RPC; zero applies a built-in default and
|
|
||||||
// negative disables the bound entirely.
|
|
||||||
CallTimeout time.Duration
|
|
||||||
// TLSConfig supplies a custom TLS configuration; takes precedence over
|
|
||||||
// CACertFile when TransportCredentials is unset.
|
|
||||||
TLSConfig *tls.Config
|
|
||||||
// TransportCredentials, when non-nil, overrides every other transport-level
|
|
||||||
// option and is used as-is.
|
|
||||||
TransportCredentials credentials.TransportCredentials
|
TransportCredentials credentials.TransportCredentials
|
||||||
// DialOptions are appended to the gRPC dial options after the defaults.
|
DialOptions []grpc.DialOption
|
||||||
DialOptions []grpc.DialOption
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// RedactedAPIKey returns a display-safe representation of the configured API
|
// RedactedAPIKey returns a display-safe representation of the configured API
|
||||||
|
|||||||
@@ -18,10 +18,8 @@ const maxBulkItems = 1000
|
|||||||
|
|
||||||
// EventResult carries either the next ordered event or a terminal stream error.
|
// EventResult carries either the next ordered event or a terminal stream error.
|
||||||
type EventResult struct {
|
type EventResult struct {
|
||||||
// Event is the next event from the stream when Err is nil.
|
|
||||||
Event *MxEvent
|
Event *MxEvent
|
||||||
// Err is the terminal stream error; when non-nil no further results follow.
|
Err error
|
||||||
Err error
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// EventSubscription owns a running gateway event stream.
|
// EventSubscription owns a running gateway event stream.
|
||||||
|
|||||||
+58
-148
@@ -12,167 +12,77 @@ type RawEventStream = pb.MxAccessGateway_StreamEventsClient
|
|||||||
// Generated protobuf aliases keep raw contract access available from the public
|
// Generated protobuf aliases keep raw contract access available from the public
|
||||||
// mxgateway package while generated code remains under internal/generated.
|
// mxgateway package while generated code remains under internal/generated.
|
||||||
type (
|
type (
|
||||||
// OpenSessionRequest is the gateway OpenSession request message.
|
OpenSessionRequest = pb.OpenSessionRequest
|
||||||
OpenSessionRequest = pb.OpenSessionRequest
|
OpenSessionReply = pb.OpenSessionReply
|
||||||
// OpenSessionReply is the gateway OpenSession reply message.
|
CloseSessionRequest = pb.CloseSessionRequest
|
||||||
OpenSessionReply = pb.OpenSessionReply
|
CloseSessionReply = pb.CloseSessionReply
|
||||||
// CloseSessionRequest is the gateway CloseSession request message.
|
StreamEventsRequest = pb.StreamEventsRequest
|
||||||
CloseSessionRequest = pb.CloseSessionRequest
|
MxCommandRequest = pb.MxCommandRequest
|
||||||
// CloseSessionReply is the gateway CloseSession reply message.
|
MxCommandReply = pb.MxCommandReply
|
||||||
CloseSessionReply = pb.CloseSessionReply
|
MxCommand = pb.MxCommand
|
||||||
// StreamEventsRequest is the gateway StreamEvents request message.
|
MxEvent = pb.MxEvent
|
||||||
StreamEventsRequest = pb.StreamEventsRequest
|
MxValue = pb.MxValue
|
||||||
// MxCommandRequest carries one MXAccess command for Invoke.
|
Value = pb.MxValue
|
||||||
MxCommandRequest = pb.MxCommandRequest
|
MxArray = pb.MxArray
|
||||||
// MxCommandReply is the reply to an MXAccess command Invoke.
|
MxStatusProxy = pb.MxStatusProxy
|
||||||
MxCommandReply = pb.MxCommandReply
|
ProtocolStatus = pb.ProtocolStatus
|
||||||
// MxCommand is the discriminated union of MXAccess command payloads.
|
RegisterCommand = pb.RegisterCommand
|
||||||
MxCommand = pb.MxCommand
|
UnregisterCommand = pb.UnregisterCommand
|
||||||
// MxEvent is one ordered event delivered on a session event stream.
|
AddItemCommand = pb.AddItemCommand
|
||||||
MxEvent = pb.MxEvent
|
AddItem2Command = pb.AddItem2Command
|
||||||
// MxValue is the protobuf representation of an MXAccess value.
|
RemoveItemCommand = pb.RemoveItemCommand
|
||||||
MxValue = pb.MxValue
|
AdviseCommand = pb.AdviseCommand
|
||||||
// Value is an alias for MxValue retained for symmetry with other clients.
|
UnAdviseCommand = pb.UnAdviseCommand
|
||||||
Value = pb.MxValue
|
AddItemBulkCommand = pb.AddItemBulkCommand
|
||||||
// MxArray is the protobuf representation of an MXAccess array value.
|
AdviseItemBulkCommand = pb.AdviseItemBulkCommand
|
||||||
MxArray = pb.MxArray
|
RemoveItemBulkCommand = pb.RemoveItemBulkCommand
|
||||||
// MxStatusProxy mirrors the MXAccess MXSTATUS_PROXY structure.
|
|
||||||
MxStatusProxy = pb.MxStatusProxy
|
|
||||||
// ProtocolStatus is the gateway-level status carried on every reply.
|
|
||||||
ProtocolStatus = pb.ProtocolStatus
|
|
||||||
// RegisterCommand is the payload of an MXAccess Register command.
|
|
||||||
RegisterCommand = pb.RegisterCommand
|
|
||||||
// UnregisterCommand is the payload of an MXAccess Unregister command.
|
|
||||||
UnregisterCommand = pb.UnregisterCommand
|
|
||||||
// AddItemCommand is the payload of an MXAccess AddItem command.
|
|
||||||
AddItemCommand = pb.AddItemCommand
|
|
||||||
// AddItem2Command is the payload of an MXAccess AddItem2 command.
|
|
||||||
AddItem2Command = pb.AddItem2Command
|
|
||||||
// RemoveItemCommand is the payload of an MXAccess RemoveItem command.
|
|
||||||
RemoveItemCommand = pb.RemoveItemCommand
|
|
||||||
// AdviseCommand is the payload of an MXAccess Advise command.
|
|
||||||
AdviseCommand = pb.AdviseCommand
|
|
||||||
// UnAdviseCommand is the payload of an MXAccess UnAdvise command.
|
|
||||||
UnAdviseCommand = pb.UnAdviseCommand
|
|
||||||
// AddItemBulkCommand is the payload of an AddItem bulk command.
|
|
||||||
AddItemBulkCommand = pb.AddItemBulkCommand
|
|
||||||
// AdviseItemBulkCommand is the payload of an Advise bulk command.
|
|
||||||
AdviseItemBulkCommand = pb.AdviseItemBulkCommand
|
|
||||||
// RemoveItemBulkCommand is the payload of a RemoveItem bulk command.
|
|
||||||
RemoveItemBulkCommand = pb.RemoveItemBulkCommand
|
|
||||||
// UnAdviseItemBulkCommand is the payload of an UnAdvise bulk command.
|
|
||||||
UnAdviseItemBulkCommand = pb.UnAdviseItemBulkCommand
|
UnAdviseItemBulkCommand = pb.UnAdviseItemBulkCommand
|
||||||
// SubscribeBulkCommand combines AddItem and Advise for a list of tags.
|
SubscribeBulkCommand = pb.SubscribeBulkCommand
|
||||||
SubscribeBulkCommand = pb.SubscribeBulkCommand
|
UnsubscribeBulkCommand = pb.UnsubscribeBulkCommand
|
||||||
// UnsubscribeBulkCommand combines UnAdvise and RemoveItem for a list of items.
|
WriteCommand = pb.WriteCommand
|
||||||
UnsubscribeBulkCommand = pb.UnsubscribeBulkCommand
|
Write2Command = pb.Write2Command
|
||||||
// WriteCommand is the payload of an MXAccess Write command.
|
RegisterReply = pb.RegisterReply
|
||||||
WriteCommand = pb.WriteCommand
|
AddItemReply = pb.AddItemReply
|
||||||
// Write2Command is the payload of an MXAccess Write2 command.
|
AddItem2Reply = pb.AddItem2Reply
|
||||||
Write2Command = pb.Write2Command
|
SubscribeResult = pb.SubscribeResult
|
||||||
// RegisterReply carries the ServerHandle returned by Register.
|
BulkSubscribeReply = pb.BulkSubscribeReply
|
||||||
RegisterReply = pb.RegisterReply
|
|
||||||
// AddItemReply carries the ItemHandle returned by AddItem.
|
|
||||||
AddItemReply = pb.AddItemReply
|
|
||||||
// AddItem2Reply carries the ItemHandle returned by AddItem2.
|
|
||||||
AddItem2Reply = pb.AddItem2Reply
|
|
||||||
// SubscribeResult is one entry in a bulk command result list.
|
|
||||||
SubscribeResult = pb.SubscribeResult
|
|
||||||
// BulkSubscribeReply aggregates SubscribeResult entries for a bulk command.
|
|
||||||
BulkSubscribeReply = pb.BulkSubscribeReply
|
|
||||||
// AcknowledgeAlarmRequest is the gateway AcknowledgeAlarm request message.
|
|
||||||
AcknowledgeAlarmRequest = pb.AcknowledgeAlarmRequest
|
|
||||||
// AcknowledgeAlarmReply is the gateway AcknowledgeAlarm reply message.
|
|
||||||
AcknowledgeAlarmReply = pb.AcknowledgeAlarmReply
|
|
||||||
// QueryActiveAlarmsRequest is the gateway QueryActiveAlarms request message.
|
|
||||||
QueryActiveAlarmsRequest = pb.QueryActiveAlarmsRequest
|
|
||||||
// ActiveAlarmSnapshot is one row in a ConditionRefresh stream.
|
|
||||||
ActiveAlarmSnapshot = pb.ActiveAlarmSnapshot
|
|
||||||
// OnAlarmTransitionEvent is the body carried by alarm-transition MxEvents.
|
|
||||||
OnAlarmTransitionEvent = pb.OnAlarmTransitionEvent
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// AlarmTransitionKind discriminates raise / acknowledge / clear / retrigger
|
|
||||||
// transitions on an OnAlarmTransitionEvent.
|
|
||||||
type AlarmTransitionKind = pb.AlarmTransitionKind
|
|
||||||
|
|
||||||
// AlarmConditionState reports the current state of an active alarm in a
|
|
||||||
// ConditionRefresh snapshot.
|
|
||||||
type AlarmConditionState = pb.AlarmConditionState
|
|
||||||
|
|
||||||
// QueryActiveAlarmsClient is the generated server-streaming client for the
|
|
||||||
// QueryActiveAlarms RPC.
|
|
||||||
type QueryActiveAlarmsClient = pb.MxAccessGateway_QueryActiveAlarmsClient
|
|
||||||
|
|
||||||
// Enumerations from the generated contract re-exported for client callers.
|
|
||||||
type (
|
type (
|
||||||
// MxCommandKind discriminates which MXAccess command an MxCommand carries.
|
MxCommandKind = pb.MxCommandKind
|
||||||
MxCommandKind = pb.MxCommandKind
|
MxDataType = pb.MxDataType
|
||||||
// MxDataType is the MXAccess data type tag on values and arrays.
|
MxEventFamily = pb.MxEventFamily
|
||||||
MxDataType = pb.MxDataType
|
MxStatusCategory = pb.MxStatusCategory
|
||||||
// MxEventFamily groups MXAccess events by source category.
|
MxStatusSource = pb.MxStatusSource
|
||||||
MxEventFamily = pb.MxEventFamily
|
|
||||||
// MxStatusCategory classifies MXSTATUS_PROXY entries.
|
|
||||||
MxStatusCategory = pb.MxStatusCategory
|
|
||||||
// MxStatusSource identifies the originator of a status entry.
|
|
||||||
MxStatusSource = pb.MxStatusSource
|
|
||||||
// ProtocolStatusCode enumerates gateway-level status codes.
|
|
||||||
ProtocolStatusCode = pb.ProtocolStatusCode
|
ProtocolStatusCode = pb.ProtocolStatusCode
|
||||||
// SessionState enumerates gateway session lifecycle states.
|
SessionState = pb.SessionState
|
||||||
SessionState = pb.SessionState
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// MXAccess command kind, data type, and protocol status constants surfaced
|
|
||||||
// from the generated contract.
|
|
||||||
const (
|
const (
|
||||||
// CommandKindRegister selects the MXAccess Register command.
|
CommandKindRegister = pb.MxCommandKind_MX_COMMAND_KIND_REGISTER
|
||||||
CommandKindRegister = pb.MxCommandKind_MX_COMMAND_KIND_REGISTER
|
CommandKindUnregister = pb.MxCommandKind_MX_COMMAND_KIND_UNREGISTER
|
||||||
// CommandKindUnregister selects the MXAccess Unregister command.
|
CommandKindAddItem = pb.MxCommandKind_MX_COMMAND_KIND_ADD_ITEM
|
||||||
CommandKindUnregister = pb.MxCommandKind_MX_COMMAND_KIND_UNREGISTER
|
CommandKindAddItem2 = pb.MxCommandKind_MX_COMMAND_KIND_ADD_ITEM2
|
||||||
// CommandKindAddItem selects the MXAccess AddItem command.
|
CommandKindRemoveItem = pb.MxCommandKind_MX_COMMAND_KIND_REMOVE_ITEM
|
||||||
CommandKindAddItem = pb.MxCommandKind_MX_COMMAND_KIND_ADD_ITEM
|
CommandKindAdvise = pb.MxCommandKind_MX_COMMAND_KIND_ADVISE
|
||||||
// CommandKindAddItem2 selects the MXAccess AddItem2 command.
|
CommandKindUnAdvise = pb.MxCommandKind_MX_COMMAND_KIND_UN_ADVISE
|
||||||
CommandKindAddItem2 = pb.MxCommandKind_MX_COMMAND_KIND_ADD_ITEM2
|
CommandKindAddItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_ADD_ITEM_BULK
|
||||||
// CommandKindRemoveItem selects the MXAccess RemoveItem command.
|
CommandKindAdviseItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_ADVISE_ITEM_BULK
|
||||||
CommandKindRemoveItem = pb.MxCommandKind_MX_COMMAND_KIND_REMOVE_ITEM
|
CommandKindRemoveItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_REMOVE_ITEM_BULK
|
||||||
// CommandKindAdvise selects the MXAccess Advise command.
|
|
||||||
CommandKindAdvise = pb.MxCommandKind_MX_COMMAND_KIND_ADVISE
|
|
||||||
// CommandKindUnAdvise selects the MXAccess UnAdvise command.
|
|
||||||
CommandKindUnAdvise = pb.MxCommandKind_MX_COMMAND_KIND_UN_ADVISE
|
|
||||||
// CommandKindAddItemBulk selects the AddItem bulk command.
|
|
||||||
CommandKindAddItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_ADD_ITEM_BULK
|
|
||||||
// CommandKindAdviseItemBulk selects the Advise bulk command.
|
|
||||||
CommandKindAdviseItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_ADVISE_ITEM_BULK
|
|
||||||
// CommandKindRemoveItemBulk selects the RemoveItem bulk command.
|
|
||||||
CommandKindRemoveItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_REMOVE_ITEM_BULK
|
|
||||||
// CommandKindUnAdviseItemBulk selects the UnAdvise bulk command.
|
|
||||||
CommandKindUnAdviseItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_UN_ADVISE_ITEM_BULK
|
CommandKindUnAdviseItemBulk = pb.MxCommandKind_MX_COMMAND_KIND_UN_ADVISE_ITEM_BULK
|
||||||
// CommandKindSubscribeBulk selects the AddItem+Advise combined bulk command.
|
CommandKindSubscribeBulk = pb.MxCommandKind_MX_COMMAND_KIND_SUBSCRIBE_BULK
|
||||||
CommandKindSubscribeBulk = pb.MxCommandKind_MX_COMMAND_KIND_SUBSCRIBE_BULK
|
CommandKindUnsubscribeBulk = pb.MxCommandKind_MX_COMMAND_KIND_UNSUBSCRIBE_BULK
|
||||||
// CommandKindUnsubscribeBulk selects the UnAdvise+RemoveItem combined bulk command.
|
CommandKindWrite = pb.MxCommandKind_MX_COMMAND_KIND_WRITE
|
||||||
CommandKindUnsubscribeBulk = pb.MxCommandKind_MX_COMMAND_KIND_UNSUBSCRIBE_BULK
|
CommandKindWrite2 = pb.MxCommandKind_MX_COMMAND_KIND_WRITE2
|
||||||
// CommandKindWrite selects the MXAccess Write command.
|
|
||||||
CommandKindWrite = pb.MxCommandKind_MX_COMMAND_KIND_WRITE
|
|
||||||
// CommandKindWrite2 selects the MXAccess Write2 command.
|
|
||||||
CommandKindWrite2 = pb.MxCommandKind_MX_COMMAND_KIND_WRITE2
|
|
||||||
|
|
||||||
// DataTypeUnknown denotes an unrecognized MXAccess data type.
|
|
||||||
DataTypeUnknown = pb.MxDataType_MX_DATA_TYPE_UNKNOWN
|
DataTypeUnknown = pb.MxDataType_MX_DATA_TYPE_UNKNOWN
|
||||||
// DataTypeBoolean denotes an MXAccess Boolean value.
|
|
||||||
DataTypeBoolean = pb.MxDataType_MX_DATA_TYPE_BOOLEAN
|
DataTypeBoolean = pb.MxDataType_MX_DATA_TYPE_BOOLEAN
|
||||||
// DataTypeInteger denotes an MXAccess Integer value.
|
|
||||||
DataTypeInteger = pb.MxDataType_MX_DATA_TYPE_INTEGER
|
DataTypeInteger = pb.MxDataType_MX_DATA_TYPE_INTEGER
|
||||||
// DataTypeFloat denotes an MXAccess Float (single precision) value.
|
DataTypeFloat = pb.MxDataType_MX_DATA_TYPE_FLOAT
|
||||||
DataTypeFloat = pb.MxDataType_MX_DATA_TYPE_FLOAT
|
DataTypeDouble = pb.MxDataType_MX_DATA_TYPE_DOUBLE
|
||||||
// DataTypeDouble denotes an MXAccess Double (double precision) value.
|
DataTypeString = pb.MxDataType_MX_DATA_TYPE_STRING
|
||||||
DataTypeDouble = pb.MxDataType_MX_DATA_TYPE_DOUBLE
|
DataTypeTime = pb.MxDataType_MX_DATA_TYPE_TIME
|
||||||
// DataTypeString denotes an MXAccess String value.
|
|
||||||
DataTypeString = pb.MxDataType_MX_DATA_TYPE_STRING
|
|
||||||
// DataTypeTime denotes an MXAccess timestamp value.
|
|
||||||
DataTypeTime = pb.MxDataType_MX_DATA_TYPE_TIME
|
|
||||||
|
|
||||||
// ProtocolStatusOK indicates the gateway processed the request successfully.
|
ProtocolStatusOK = pb.ProtocolStatusCode_PROTOCOL_STATUS_CODE_OK
|
||||||
ProtocolStatusOK = pb.ProtocolStatusCode_PROTOCOL_STATUS_CODE_OK
|
|
||||||
// ProtocolStatusMxAccessFailure indicates the worker reported an MXAccess failure.
|
|
||||||
ProtocolStatusMxAccessFailure = pb.ProtocolStatusCode_PROTOCOL_STATUS_CODE_MXACCESS_FAILURE
|
ProtocolStatusMxAccessFailure = pb.ProtocolStatusCode_PROTOCOL_STATUS_CODE_MXACCESS_FAILURE
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ const (
|
|||||||
|
|
||||||
// GatewayProtocolVersion matches GatewayContractInfo.GatewayProtocolVersion
|
// GatewayProtocolVersion matches GatewayContractInfo.GatewayProtocolVersion
|
||||||
// in the shared .NET contracts.
|
// in the shared .NET contracts.
|
||||||
GatewayProtocolVersion uint32 = 3
|
GatewayProtocolVersion uint32 = 2
|
||||||
|
|
||||||
// WorkerProtocolVersion matches GatewayContractInfo.WorkerProtocolVersion
|
// WorkerProtocolVersion matches GatewayContractInfo.WorkerProtocolVersion
|
||||||
// and is exposed for fake-worker and parity tests.
|
// and is exposed for fake-worker and parity tests.
|
||||||
|
|||||||
@@ -10,12 +10,12 @@ clients/java/
|
|||||||
settings.gradle
|
settings.gradle
|
||||||
build.gradle
|
build.gradle
|
||||||
src/main/generated/
|
src/main/generated/
|
||||||
zb-mom-ww-mxgateway-client/
|
mxgateway-client/
|
||||||
zb-mom-ww-mxgateway-cli/
|
mxgateway-cli/
|
||||||
```
|
```
|
||||||
|
|
||||||
`mxgateway-client` generates Java protobuf and gRPC sources from
|
`mxgateway-client` generates Java protobuf and gRPC sources from
|
||||||
`../../src/ZB.MOM.WW.MxGateway.Contracts/Protos`. The Gradle protobuf plugin writes those
|
`../../src/MxGateway.Contracts/Protos`. The Gradle protobuf plugin writes those
|
||||||
generated sources under `src/main/generated`, which matches the client proto
|
generated sources under `src/main/generated`, which matches the client proto
|
||||||
manifest in `../proto/proto-inputs.json`. Do not edit generated files by hand.
|
manifest in `../proto/proto-inputs.json`. Do not edit generated files by hand.
|
||||||
|
|
||||||
@@ -205,8 +205,8 @@ Create local library and CLI artifacts from `clients/java`:
|
|||||||
gradle :mxgateway-client:jar :mxgateway-cli:installDist
|
gradle :mxgateway-client:jar :mxgateway-cli:installDist
|
||||||
```
|
```
|
||||||
|
|
||||||
The library jar is under `zb-mom-ww-mxgateway-client/build/libs`. The installed CLI
|
The library jar is under `mxgateway-client/build/libs`. The installed CLI
|
||||||
distribution is under `zb-mom-ww-mxgateway-cli/build/install/mxgateway-cli`.
|
distribution is under `mxgateway-cli/build/install/mxgateway-cli`.
|
||||||
|
|
||||||
## Integration Checks
|
## Integration Checks
|
||||||
|
|
||||||
@@ -223,6 +223,6 @@ gradle :mxgateway-cli:run --args="smoke --endpoint $env:MXGATEWAY_ENDPOINT --pla
|
|||||||
## Related Documentation
|
## Related Documentation
|
||||||
|
|
||||||
- [Client Packaging](../../docs/ClientPackaging.md)
|
- [Client Packaging](../../docs/ClientPackaging.md)
|
||||||
- [Client Proto Generation](../../docs/ClientProtoGeneration.md)
|
- [Client Proto Generation](../../docs/client-proto-generation.md)
|
||||||
- [Java Client Detailed Design](./JavaClientDesign.md)
|
- [Java Client Detailed Design](../../docs/clients-java-design.md)
|
||||||
- [Java Style Guide](../../docs/style-guides/JavaStyleGuide.md)
|
- [Java Style Guide](../../docs/style-guides/JavaStyleGuide.md)
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ ext {
|
|||||||
}
|
}
|
||||||
|
|
||||||
subprojects {
|
subprojects {
|
||||||
group = 'com.zb.mom.ww.mxgateway'
|
group = 'com.dohertylan.mxgateway'
|
||||||
version = '0.1.0'
|
version = '0.1.0'
|
||||||
|
|
||||||
pluginManager.withPlugin('java') {
|
pluginManager.withPlugin('java') {
|
||||||
|
|||||||
+2
-2
@@ -3,11 +3,11 @@ plugins {
|
|||||||
}
|
}
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
implementation project(':zb-mom-ww-mxgateway-client')
|
implementation project(':mxgateway-client')
|
||||||
implementation "com.google.protobuf:protobuf-java-util:${protobufVersion}"
|
implementation "com.google.protobuf:protobuf-java-util:${protobufVersion}"
|
||||||
implementation "info.picocli:picocli:${picocliVersion}"
|
implementation "info.picocli:picocli:${picocliVersion}"
|
||||||
}
|
}
|
||||||
|
|
||||||
application {
|
application {
|
||||||
mainClass = 'com.zb.mom.ww.mxgateway.cli.MxGatewayCli'
|
mainClass = 'com.dohertylan.mxgateway.cli.MxGatewayCli'
|
||||||
}
|
}
|
||||||
+10
-34
@@ -1,14 +1,14 @@
|
|||||||
package com.zb.mom.ww.mxgateway.cli;
|
package com.dohertylan.mxgateway.cli;
|
||||||
|
|
||||||
import com.zb.mom.ww.mxgateway.client.DeployEventStream;
|
import com.dohertylan.mxgateway.client.DeployEventStream;
|
||||||
import com.zb.mom.ww.mxgateway.client.GalaxyRepositoryClient;
|
import com.dohertylan.mxgateway.client.GalaxyRepositoryClient;
|
||||||
import com.zb.mom.ww.mxgateway.client.MxEventStream;
|
import com.dohertylan.mxgateway.client.MxEventStream;
|
||||||
import com.zb.mom.ww.mxgateway.client.MxGatewayClient;
|
import com.dohertylan.mxgateway.client.MxGatewayClient;
|
||||||
import com.zb.mom.ww.mxgateway.client.MxGatewayClientOptions;
|
import com.dohertylan.mxgateway.client.MxGatewayClientOptions;
|
||||||
import com.zb.mom.ww.mxgateway.client.MxGatewayClientVersion;
|
import com.dohertylan.mxgateway.client.MxGatewayClientVersion;
|
||||||
import com.zb.mom.ww.mxgateway.client.MxGatewaySecrets;
|
import com.dohertylan.mxgateway.client.MxGatewaySecrets;
|
||||||
import com.zb.mom.ww.mxgateway.client.MxGatewaySession;
|
import com.dohertylan.mxgateway.client.MxGatewaySession;
|
||||||
import com.zb.mom.ww.mxgateway.client.MxValues;
|
import com.dohertylan.mxgateway.client.MxValues;
|
||||||
import galaxy_repository.v1.GalaxyRepositoryOuterClass.DeployEvent;
|
import galaxy_repository.v1.GalaxyRepositoryOuterClass.DeployEvent;
|
||||||
import galaxy_repository.v1.GalaxyRepositoryOuterClass.GalaxyAttribute;
|
import galaxy_repository.v1.GalaxyRepositoryOuterClass.GalaxyAttribute;
|
||||||
import galaxy_repository.v1.GalaxyRepositoryOuterClass.GalaxyObject;
|
import galaxy_repository.v1.GalaxyRepositoryOuterClass.GalaxyObject;
|
||||||
@@ -38,10 +38,6 @@ import picocli.CommandLine.Model.CommandSpec;
|
|||||||
import picocli.CommandLine.Option;
|
import picocli.CommandLine.Option;
|
||||||
import picocli.CommandLine.Spec;
|
import picocli.CommandLine.Spec;
|
||||||
|
|
||||||
/**
|
|
||||||
* Picocli entry point for the {@code mxgw-java} test CLI used by the
|
|
||||||
* cross-language smoke matrix.
|
|
||||||
*/
|
|
||||||
@Command(
|
@Command(
|
||||||
name = "mxgw-java",
|
name = "mxgw-java",
|
||||||
mixinStandardHelpOptions = true,
|
mixinStandardHelpOptions = true,
|
||||||
@@ -52,9 +48,6 @@ public final class MxGatewayCli implements Callable<Integer> {
|
|||||||
@Spec
|
@Spec
|
||||||
private CommandSpec spec;
|
private CommandSpec spec;
|
||||||
|
|
||||||
/**
|
|
||||||
* Builds a CLI bound to the default gRPC client factory.
|
|
||||||
*/
|
|
||||||
public MxGatewayCli() {
|
public MxGatewayCli() {
|
||||||
this(new GrpcMxGatewayCliClientFactory());
|
this(new GrpcMxGatewayCliClientFactory());
|
||||||
}
|
}
|
||||||
@@ -63,25 +56,11 @@ public final class MxGatewayCli implements Callable<Integer> {
|
|||||||
this.clientFactory = clientFactory;
|
this.clientFactory = clientFactory;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Process entry point.
|
|
||||||
*
|
|
||||||
* @param args command-line arguments
|
|
||||||
*/
|
|
||||||
public static void main(String[] args) {
|
public static void main(String[] args) {
|
||||||
int exitCode = commandLine(new GrpcMxGatewayCliClientFactory()).execute(args);
|
int exitCode = commandLine(new GrpcMxGatewayCliClientFactory()).execute(args);
|
||||||
System.exit(exitCode);
|
System.exit(exitCode);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Test-friendly entry point that runs the CLI against the supplied
|
|
||||||
* {@link PrintWriter} pair instead of the system streams.
|
|
||||||
*
|
|
||||||
* @param out writer that receives standard output
|
|
||||||
* @param err writer that receives standard error
|
|
||||||
* @param args command-line arguments
|
|
||||||
* @return the picocli exit code
|
|
||||||
*/
|
|
||||||
public static int execute(PrintWriter out, PrintWriter err, String... args) {
|
public static int execute(PrintWriter out, PrintWriter err, String... args) {
|
||||||
return execute(new GrpcMxGatewayCliClientFactory(), out, err, args);
|
return execute(new GrpcMxGatewayCliClientFactory(), out, err, args);
|
||||||
}
|
}
|
||||||
@@ -301,9 +280,6 @@ public final class MxGatewayCli implements Callable<Integer> {
|
|||||||
return values;
|
return values;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Picocli subcommand that prints the client and protocol version numbers.
|
|
||||||
*/
|
|
||||||
@Command(name = "version", description = "Prints the Java client version.")
|
@Command(name = "version", description = "Prints the Java client version.")
|
||||||
public static final class VersionCommand implements Callable<Integer> {
|
public static final class VersionCommand implements Callable<Integer> {
|
||||||
@Spec
|
@Spec
|
||||||
+4
-4
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.cli;
|
package com.dohertylan.mxgateway.cli;
|
||||||
|
|
||||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
@@ -32,7 +32,7 @@ final class MxGatewayCliTests {
|
|||||||
assertEquals(0, run.exitCode());
|
assertEquals(0, run.exitCode());
|
||||||
assertEquals("", run.errors());
|
assertEquals("", run.errors());
|
||||||
assertTrue(run.output().contains("mxgateway-java 0.1.0"));
|
assertTrue(run.output().contains("mxgateway-java 0.1.0"));
|
||||||
assertTrue(run.output().contains("gatewayProtocolVersion=3"));
|
assertTrue(run.output().contains("gatewayProtocolVersion=2"));
|
||||||
assertTrue(run.output().contains("workerProtocolVersion=1"));
|
assertTrue(run.output().contains("workerProtocolVersion=1"));
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ final class MxGatewayCliTests {
|
|||||||
|
|
||||||
assertEquals(0, run.exitCode());
|
assertEquals(0, run.exitCode());
|
||||||
assertTrue(run.output().contains("\"clientVersion\":\"0.1.0\""));
|
assertTrue(run.output().contains("\"clientVersion\":\"0.1.0\""));
|
||||||
assertTrue(run.output().contains("\"gatewayProtocolVersion\":3"));
|
assertTrue(run.output().contains("\"gatewayProtocolVersion\":2"));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
@@ -296,7 +296,7 @@ final class MxGatewayCliTests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public com.zb.mom.ww.mxgateway.client.MxEventStream streamEventsAfter(long afterWorkerSequence) {
|
public com.dohertylan.mxgateway.client.MxEventStream streamEventsAfter(long afterWorkerSequence) {
|
||||||
throw new UnsupportedOperationException("stream-events is covered by client tests");
|
throw new UnsupportedOperationException("stream-events is covered by client tests");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+1
-1
@@ -22,7 +22,7 @@ dependencies {
|
|||||||
sourceSets {
|
sourceSets {
|
||||||
main {
|
main {
|
||||||
proto {
|
proto {
|
||||||
srcDir rootProject.file('../../src/ZB.MOM.WW.MxGateway.Contracts/Protos')
|
srcDir rootProject.file('../../src/MxGateway.Contracts/Protos')
|
||||||
include 'mxaccess_gateway.proto'
|
include 'mxaccess_gateway.proto'
|
||||||
include 'mxaccess_worker.proto'
|
include 'mxaccess_worker.proto'
|
||||||
include 'galaxy_repository.proto'
|
include 'galaxy_repository.proto'
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import galaxy_repository.v1.GalaxyRepositoryOuterClass.DeployEvent;
|
import galaxy_repository.v1.GalaxyRepositoryOuterClass.DeployEvent;
|
||||||
import galaxy_repository.v1.GalaxyRepositoryOuterClass.WatchDeployEventsRequest;
|
import galaxy_repository.v1.GalaxyRepositoryOuterClass.WatchDeployEventsRequest;
|
||||||
+1
-6
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import galaxy_repository.v1.GalaxyRepositoryOuterClass.DeployEvent;
|
import galaxy_repository.v1.GalaxyRepositoryOuterClass.DeployEvent;
|
||||||
import galaxy_repository.v1.GalaxyRepositoryOuterClass.WatchDeployEventsRequest;
|
import galaxy_repository.v1.GalaxyRepositoryOuterClass.WatchDeployEventsRequest;
|
||||||
@@ -45,11 +45,6 @@ public final class DeployEventSubscription implements AutoCloseable {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Cancels the underlying gRPC call. Safe to invoke before the call has
|
|
||||||
* started; cancellation is recorded and applied as soon as the stream
|
|
||||||
* attaches.
|
|
||||||
*/
|
|
||||||
public void cancel() {
|
public void cancel() {
|
||||||
cancelled.set(true);
|
cancelled.set(true);
|
||||||
ClientCallStreamObserver<WatchDeployEventsRequest> stream = requestStream.get();
|
ClientCallStreamObserver<WatchDeployEventsRequest> stream = requestStream.get();
|
||||||
+11
-80
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import com.google.common.util.concurrent.FutureCallback;
|
import com.google.common.util.concurrent.FutureCallback;
|
||||||
import com.google.common.util.concurrent.Futures;
|
import com.google.common.util.concurrent.Futures;
|
||||||
@@ -54,12 +54,8 @@ public final class GalaxyRepositoryClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs a client over a caller-managed {@link Channel}. The caller owns
|
* Construct a client over a caller-managed {@link Channel}. The caller owns
|
||||||
* channel lifecycle; {@link #close()} is a no-op for this constructor.
|
* channel lifecycle; {@link #close()} is a no-op for this constructor.
|
||||||
*
|
|
||||||
* @param channel the gRPC channel to use for outbound calls
|
|
||||||
* @param options the client options carrying the API key and timeouts
|
|
||||||
* @throws NullPointerException if {@code options} is {@code null}
|
|
||||||
*/
|
*/
|
||||||
public GalaxyRepositoryClient(Channel channel, MxGatewayClientOptions options) {
|
public GalaxyRepositoryClient(Channel channel, MxGatewayClientOptions options) {
|
||||||
this.ownedChannel = null;
|
this.ownedChannel = null;
|
||||||
@@ -70,49 +66,25 @@ public final class GalaxyRepositoryClient implements AutoCloseable {
|
|||||||
asyncStub = GalaxyRepositoryGrpc.newStub(intercepted);
|
asyncStub = GalaxyRepositoryGrpc.newStub(intercepted);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/** Build a new client and own its channel; close shuts the channel down. */
|
||||||
* Builds a new client and owns its channel; {@link #close()} shuts the
|
|
||||||
* channel down.
|
|
||||||
*
|
|
||||||
* @param options the client options carrying the endpoint and credentials
|
|
||||||
* @return a connected client
|
|
||||||
*/
|
|
||||||
public static GalaxyRepositoryClient connect(MxGatewayClientOptions options) {
|
public static GalaxyRepositoryClient connect(MxGatewayClientOptions options) {
|
||||||
return new GalaxyRepositoryClient(createChannel(options), options);
|
return new GalaxyRepositoryClient(createChannel(options), options);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the underlying blocking stub with the per-call deadline applied.
|
|
||||||
*
|
|
||||||
* @return the blocking stub
|
|
||||||
*/
|
|
||||||
public GalaxyRepositoryGrpc.GalaxyRepositoryBlockingStub rawBlockingStub() {
|
public GalaxyRepositoryGrpc.GalaxyRepositoryBlockingStub rawBlockingStub() {
|
||||||
return withDeadline(blockingStub);
|
return withDeadline(blockingStub);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the underlying future stub with the per-call deadline applied.
|
|
||||||
*
|
|
||||||
* @return the future stub
|
|
||||||
*/
|
|
||||||
public GalaxyRepositoryGrpc.GalaxyRepositoryFutureStub rawFutureStub() {
|
public GalaxyRepositoryGrpc.GalaxyRepositoryFutureStub rawFutureStub() {
|
||||||
return withDeadline(futureStub);
|
return withDeadline(futureStub);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the underlying async stub. Stream deadlines are applied per call.
|
|
||||||
*
|
|
||||||
* @return the async stub
|
|
||||||
*/
|
|
||||||
public GalaxyRepositoryGrpc.GalaxyRepositoryStub rawAsyncStub() {
|
public GalaxyRepositoryGrpc.GalaxyRepositoryStub rawAsyncStub() {
|
||||||
return asyncStub;
|
return asyncStub;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Invokes the {@code TestConnection} RPC and returns the {@code ok} flag.
|
* Invoke the {@code TestConnection} RPC and return the {@code ok} flag.
|
||||||
*
|
|
||||||
* @return {@code true} when the gateway reached the Galaxy Repository database
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
*/
|
||||||
public boolean testConnection() {
|
public boolean testConnection() {
|
||||||
try {
|
try {
|
||||||
@@ -126,23 +98,14 @@ public final class GalaxyRepositoryClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes {@code TestConnection} asynchronously.
|
|
||||||
*
|
|
||||||
* @return a future completed with the {@code ok} flag, or completed
|
|
||||||
* exceptionally with {@link MxGatewayException} on failure
|
|
||||||
*/
|
|
||||||
public CompletableFuture<Boolean> testConnectionAsync() {
|
public CompletableFuture<Boolean> testConnectionAsync() {
|
||||||
return toCompletable(rawFutureStub().testConnection(TestConnectionRequest.getDefaultInstance()))
|
return toCompletable(rawFutureStub().testConnection(TestConnectionRequest.getDefaultInstance()))
|
||||||
.thenApply(TestConnectionReply::getOk);
|
.thenApply(TestConnectionReply::getOk);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Invokes the {@code GetLastDeployTime} RPC.
|
* Invoke the {@code GetLastDeployTime} RPC. Returns {@link Optional#empty()}
|
||||||
*
|
* when the server reports {@code present=false}.
|
||||||
* @return the time of the last deploy, or {@link Optional#empty()} when the
|
|
||||||
* server reports {@code present=false}
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
*/
|
||||||
public Optional<Instant> getLastDeployTime() {
|
public Optional<Instant> getLastDeployTime() {
|
||||||
try {
|
try {
|
||||||
@@ -157,25 +120,15 @@ public final class GalaxyRepositoryClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes {@code GetLastDeployTime} asynchronously.
|
|
||||||
*
|
|
||||||
* @return a future completed with the time of the last deploy, or
|
|
||||||
* {@link Optional#empty()} when the server reports {@code present=false};
|
|
||||||
* completed exceptionally with {@link MxGatewayException} on failure
|
|
||||||
*/
|
|
||||||
public CompletableFuture<Optional<Instant>> getLastDeployTimeAsync() {
|
public CompletableFuture<Optional<Instant>> getLastDeployTimeAsync() {
|
||||||
return toCompletable(rawFutureStub().getLastDeployTime(GetLastDeployTimeRequest.getDefaultInstance()))
|
return toCompletable(rawFutureStub().getLastDeployTime(GetLastDeployTimeRequest.getDefaultInstance()))
|
||||||
.thenApply(GalaxyRepositoryClient::mapDeployTime);
|
.thenApply(GalaxyRepositoryClient::mapDeployTime);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Invokes the {@code DiscoverHierarchy} RPC and returns the generated
|
* Invoke the {@code DiscoverHierarchy} RPC and return the generated
|
||||||
* {@link GalaxyObject} messages directly. Callers can read every field of
|
* {@link GalaxyObject} messages directly. Callers can read every field of
|
||||||
* the proto message without an extra DTO layer.
|
* the proto message without an extra DTO layer.
|
||||||
*
|
|
||||||
* @return the Galaxy object hierarchy
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
*/
|
||||||
public List<GalaxyObject> discoverHierarchy() {
|
public List<GalaxyObject> discoverHierarchy() {
|
||||||
try {
|
try {
|
||||||
@@ -203,24 +156,17 @@ public final class GalaxyRepositoryClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes {@code DiscoverHierarchy} asynchronously.
|
|
||||||
*
|
|
||||||
* @return a future completed with the Galaxy object hierarchy, or completed
|
|
||||||
* exceptionally with {@link MxGatewayException} on failure
|
|
||||||
*/
|
|
||||||
public CompletableFuture<List<GalaxyObject>> discoverHierarchyAsync() {
|
public CompletableFuture<List<GalaxyObject>> discoverHierarchyAsync() {
|
||||||
return discoverHierarchyPageAsync("", new java.util.ArrayList<>(), new java.util.HashSet<>());
|
return discoverHierarchyPageAsync("", new java.util.ArrayList<>(), new java.util.HashSet<>());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Subscribes to {@code WatchDeployEvents} via the async stub and consumes
|
* Subscribe to {@code WatchDeployEvents} via the async stub and consume
|
||||||
* results through a blocking iterator. Closing the returned stream cancels
|
* results through a blocking iterator. Closing the returned stream cancels
|
||||||
* the underlying gRPC call.
|
* the underlying gRPC call.
|
||||||
*
|
*
|
||||||
* @param lastSeenDeployTime optional. When non-{@code null}, the bootstrap
|
* @param lastSeenDeployTime optional. When non-null, the bootstrap event is
|
||||||
* event is suppressed if the cached deploy time matches.
|
* suppressed if the cached deploy time matches.
|
||||||
* @return an iterator-style stream of deploy events
|
|
||||||
*/
|
*/
|
||||||
public DeployEventStream watchDeployEvents(Instant lastSeenDeployTime) {
|
public DeployEventStream watchDeployEvents(Instant lastSeenDeployTime) {
|
||||||
DeployEventStream stream = new DeployEventStream(16);
|
DeployEventStream stream = new DeployEventStream(16);
|
||||||
@@ -231,23 +177,15 @@ public final class GalaxyRepositoryClient implements AutoCloseable {
|
|||||||
/**
|
/**
|
||||||
* Iterator-style alias for {@link #watchDeployEvents(Instant)} matching the
|
* Iterator-style alias for {@link #watchDeployEvents(Instant)} matching the
|
||||||
* task-spec signature.
|
* task-spec signature.
|
||||||
*
|
|
||||||
* @param lastSeenDeployTime optional cached deploy time for bootstrap suppression
|
|
||||||
* @return an iterator over deploy events
|
|
||||||
*/
|
*/
|
||||||
public Iterator<DeployEvent> watchDeployEventsIterator(Instant lastSeenDeployTime) {
|
public Iterator<DeployEvent> watchDeployEventsIterator(Instant lastSeenDeployTime) {
|
||||||
return watchDeployEvents(lastSeenDeployTime);
|
return watchDeployEvents(lastSeenDeployTime);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Subscribes to {@code WatchDeployEvents} via the async stub, dispatching
|
* Subscribe to {@code WatchDeployEvents} via the async stub, dispatching
|
||||||
* each event to {@code observer}. The returned subscription is cancellable
|
* each event to {@code observer}. The returned subscription is cancellable
|
||||||
* and {@link AutoCloseable}.
|
* and {@link AutoCloseable}.
|
||||||
*
|
|
||||||
* @param lastSeenDeployTime optional cached deploy time for bootstrap suppression
|
|
||||||
* @param observer caller-supplied observer that receives events and completion
|
|
||||||
* @return a cancellable subscription handle
|
|
||||||
* @throws NullPointerException if {@code observer} is {@code null}
|
|
||||||
*/
|
*/
|
||||||
public DeployEventSubscription watchDeployEventsAsync(
|
public DeployEventSubscription watchDeployEventsAsync(
|
||||||
Instant lastSeenDeployTime, StreamObserver<DeployEvent> observer) {
|
Instant lastSeenDeployTime, StreamObserver<DeployEvent> observer) {
|
||||||
@@ -283,13 +221,6 @@ public final class GalaxyRepositoryClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Shuts the owned channel down and waits up to the configured connect
|
|
||||||
* timeout for termination, forcibly shutting it down on timeout. No-op
|
|
||||||
* for clients that do not own their channel.
|
|
||||||
*
|
|
||||||
* @throws InterruptedException if the calling thread is interrupted while waiting
|
|
||||||
*/
|
|
||||||
public void closeAndAwaitTermination() throws InterruptedException {
|
public void closeAndAwaitTermination() throws InterruptedException {
|
||||||
if (ownedChannel != null) {
|
if (ownedChannel != null) {
|
||||||
ownedChannel.shutdown();
|
ownedChannel.shutdown();
|
||||||
+14
@@ -0,0 +1,14 @@
|
|||||||
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
|
import mxaccess_gateway.v1.MxaccessGateway.MxCommandReply;
|
||||||
|
import mxaccess_gateway.v1.MxaccessGateway.ProtocolStatus;
|
||||||
|
|
||||||
|
public final class MxAccessException extends MxGatewayCommandException {
|
||||||
|
public MxAccessException(String operation, ProtocolStatus protocolStatus, MxCommandReply reply) {
|
||||||
|
super(operation, protocolStatus, reply);
|
||||||
|
}
|
||||||
|
|
||||||
|
public MxAccessException(String operation, MxCommandReply reply) {
|
||||||
|
super(operation, reply == null ? null : reply.getProtocolStatus(), reply);
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-11
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import io.grpc.Status;
|
import io.grpc.Status;
|
||||||
import io.grpc.StatusRuntimeException;
|
import io.grpc.StatusRuntimeException;
|
||||||
@@ -12,16 +12,6 @@ import java.util.concurrent.BlockingQueue;
|
|||||||
import mxaccess_gateway.v1.MxaccessGateway.MxEvent;
|
import mxaccess_gateway.v1.MxaccessGateway.MxEvent;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.StreamEventsRequest;
|
import mxaccess_gateway.v1.MxaccessGateway.StreamEventsRequest;
|
||||||
|
|
||||||
/**
|
|
||||||
* Iterator-style adaptor over the gateway {@code StreamEvents} server-streaming
|
|
||||||
* RPC.
|
|
||||||
*
|
|
||||||
* <p>Events arrive on a background gRPC thread and are buffered in a bounded
|
|
||||||
* blocking queue; the iterator drains them on the calling thread. Closing the
|
|
||||||
* stream cancels the underlying gRPC call. If the queue overflows the call is
|
|
||||||
* cancelled and a follow-up call to {@link #next()} throws
|
|
||||||
* {@link MxGatewayException}.
|
|
||||||
*/
|
|
||||||
public final class MxEventStream implements Iterator<MxEvent>, AutoCloseable {
|
public final class MxEventStream implements Iterator<MxEvent>, AutoCloseable {
|
||||||
private static final Object END = new Object();
|
private static final Object END = new Object();
|
||||||
|
|
||||||
+1
-11
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import io.grpc.CallOptions;
|
import io.grpc.CallOptions;
|
||||||
import io.grpc.Channel;
|
import io.grpc.Channel;
|
||||||
@@ -8,22 +8,12 @@ import io.grpc.ForwardingClientCall;
|
|||||||
import io.grpc.Metadata;
|
import io.grpc.Metadata;
|
||||||
import io.grpc.MethodDescriptor;
|
import io.grpc.MethodDescriptor;
|
||||||
|
|
||||||
/**
|
|
||||||
* gRPC client interceptor that attaches the {@code authorization: Bearer ...}
|
|
||||||
* header carrying the gateway API key. A blank or {@code null} key disables
|
|
||||||
* the interceptor so unauthenticated calls pass through unchanged.
|
|
||||||
*/
|
|
||||||
public final class MxGatewayAuthInterceptor implements ClientInterceptor {
|
public final class MxGatewayAuthInterceptor implements ClientInterceptor {
|
||||||
static final Metadata.Key<String> AUTHORIZATION_HEADER =
|
static final Metadata.Key<String> AUTHORIZATION_HEADER =
|
||||||
Metadata.Key.of("authorization", Metadata.ASCII_STRING_MARSHALLER);
|
Metadata.Key.of("authorization", Metadata.ASCII_STRING_MARSHALLER);
|
||||||
|
|
||||||
private final String apiKey;
|
private final String apiKey;
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates a new interceptor using the supplied API key.
|
|
||||||
*
|
|
||||||
* @param apiKey gateway API key; {@code null} or blank disables the interceptor
|
|
||||||
*/
|
|
||||||
public MxGatewayAuthInterceptor(String apiKey) {
|
public MxGatewayAuthInterceptor(String apiKey) {
|
||||||
this.apiKey = apiKey == null ? "" : apiKey;
|
this.apiKey = apiKey == null ? "" : apiKey;
|
||||||
}
|
}
|
||||||
+7
@@ -0,0 +1,7 @@
|
|||||||
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
|
public final class MxGatewayAuthenticationException extends MxGatewayException {
|
||||||
|
public MxGatewayAuthenticationException(String message, Throwable cause) {
|
||||||
|
super(message, cause);
|
||||||
|
}
|
||||||
|
}
|
||||||
+7
@@ -0,0 +1,7 @@
|
|||||||
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
|
public final class MxGatewayAuthorizationException extends MxGatewayException {
|
||||||
|
public MxGatewayAuthorizationException(String message, Throwable cause) {
|
||||||
|
super(message, cause);
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-177
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import com.google.common.util.concurrent.FutureCallback;
|
import com.google.common.util.concurrent.FutureCallback;
|
||||||
import com.google.common.util.concurrent.Futures;
|
import com.google.common.util.concurrent.Futures;
|
||||||
@@ -15,9 +15,6 @@ import java.util.concurrent.CompletableFuture;
|
|||||||
import java.util.concurrent.TimeUnit;
|
import java.util.concurrent.TimeUnit;
|
||||||
import javax.net.ssl.SSLException;
|
import javax.net.ssl.SSLException;
|
||||||
import mxaccess_gateway.v1.MxAccessGatewayGrpc;
|
import mxaccess_gateway.v1.MxAccessGatewayGrpc;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.AcknowledgeAlarmReply;
|
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.AcknowledgeAlarmRequest;
|
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.ActiveAlarmSnapshot;
|
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.CloseSessionReply;
|
import mxaccess_gateway.v1.MxaccessGateway.CloseSessionReply;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.CloseSessionRequest;
|
import mxaccess_gateway.v1.MxaccessGateway.CloseSessionRequest;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.MxCommandReply;
|
import mxaccess_gateway.v1.MxaccessGateway.MxCommandReply;
|
||||||
@@ -26,18 +23,8 @@ import mxaccess_gateway.v1.MxaccessGateway.MxEvent;
|
|||||||
import mxaccess_gateway.v1.MxaccessGateway.OpenSessionReply;
|
import mxaccess_gateway.v1.MxaccessGateway.OpenSessionReply;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.OpenSessionRequest;
|
import mxaccess_gateway.v1.MxaccessGateway.OpenSessionRequest;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.ProtocolStatusCode;
|
import mxaccess_gateway.v1.MxaccessGateway.ProtocolStatusCode;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.QueryActiveAlarmsRequest;
|
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.StreamEventsRequest;
|
import mxaccess_gateway.v1.MxaccessGateway.StreamEventsRequest;
|
||||||
|
|
||||||
/**
|
|
||||||
* Idiomatic Java wrapper around the generated {@code MxAccessGateway} gRPC
|
|
||||||
* stubs.
|
|
||||||
*
|
|
||||||
* <p>Owns or borrows a {@link ManagedChannel}, attaches a
|
|
||||||
* {@link MxGatewayAuthInterceptor} carrying the configured API key, and
|
|
||||||
* exposes blocking, future, and async stub variants. Translates protocol
|
|
||||||
* status failures into typed {@link MxGatewayException} subclasses.
|
|
||||||
*/
|
|
||||||
public final class MxGatewayClient implements AutoCloseable {
|
public final class MxGatewayClient implements AutoCloseable {
|
||||||
private final ManagedChannel ownedChannel;
|
private final ManagedChannel ownedChannel;
|
||||||
private final MxGatewayClientOptions options;
|
private final MxGatewayClientOptions options;
|
||||||
@@ -54,14 +41,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
asyncStub = MxAccessGatewayGrpc.newStub(intercepted);
|
asyncStub = MxAccessGatewayGrpc.newStub(intercepted);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a client over a caller-managed {@link Channel}. The caller
|
|
||||||
* owns channel lifecycle; {@link #close()} is a no-op for this constructor.
|
|
||||||
*
|
|
||||||
* @param channel the gRPC channel to use for outbound calls
|
|
||||||
* @param options the client options carrying the API key and timeouts
|
|
||||||
* @throws NullPointerException if {@code options} is {@code null}
|
|
||||||
*/
|
|
||||||
public MxGatewayClient(Channel channel, MxGatewayClientOptions options) {
|
public MxGatewayClient(Channel channel, MxGatewayClientOptions options) {
|
||||||
this.ownedChannel = null;
|
this.ownedChannel = null;
|
||||||
this.options = Objects.requireNonNull(options, "options");
|
this.options = Objects.requireNonNull(options, "options");
|
||||||
@@ -71,64 +50,27 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
asyncStub = MxAccessGatewayGrpc.newStub(intercepted);
|
asyncStub = MxAccessGatewayGrpc.newStub(intercepted);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Builds a new client and owns its channel; {@link #close()} shuts the
|
|
||||||
* channel down.
|
|
||||||
*
|
|
||||||
* @param options the client options carrying the endpoint and credentials
|
|
||||||
* @return a connected client
|
|
||||||
*/
|
|
||||||
public static MxGatewayClient connect(MxGatewayClientOptions options) {
|
public static MxGatewayClient connect(MxGatewayClientOptions options) {
|
||||||
return new MxGatewayClient(createChannel(options), options);
|
return new MxGatewayClient(createChannel(options), options);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the underlying blocking stub with the per-call deadline applied.
|
|
||||||
*
|
|
||||||
* @return the blocking stub
|
|
||||||
*/
|
|
||||||
public MxAccessGatewayGrpc.MxAccessGatewayBlockingStub rawBlockingStub() {
|
public MxAccessGatewayGrpc.MxAccessGatewayBlockingStub rawBlockingStub() {
|
||||||
return withDeadline(blockingStub);
|
return withDeadline(blockingStub);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the underlying future stub with the per-call deadline applied.
|
|
||||||
*
|
|
||||||
* @return the future stub
|
|
||||||
*/
|
|
||||||
public MxAccessGatewayGrpc.MxAccessGatewayFutureStub rawFutureStub() {
|
public MxAccessGatewayGrpc.MxAccessGatewayFutureStub rawFutureStub() {
|
||||||
return withDeadline(futureStub);
|
return withDeadline(futureStub);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the underlying async stub. Stream deadlines are applied per call.
|
|
||||||
*
|
|
||||||
* @return the async stub
|
|
||||||
*/
|
|
||||||
public MxAccessGatewayGrpc.MxAccessGatewayStub rawAsyncStub() {
|
public MxAccessGatewayGrpc.MxAccessGatewayStub rawAsyncStub() {
|
||||||
return asyncStub;
|
return asyncStub;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Opens a gateway session and returns a typed handle for further commands.
|
|
||||||
*
|
|
||||||
* @param request the {@code OpenSessionRequest} to send
|
|
||||||
* @return a session bound to the resulting {@code OpenSessionReply}
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
|
||||||
public MxGatewaySession openSession(OpenSessionRequest request) {
|
public MxGatewaySession openSession(OpenSessionRequest request) {
|
||||||
OpenSessionReply reply = openSessionRaw(request);
|
OpenSessionReply reply = openSessionRaw(request);
|
||||||
return new MxGatewaySession(this, reply);
|
return new MxGatewaySession(this, reply);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Opens a gateway session using the configured call timeout for the
|
|
||||||
* worker command timeout and a caller-supplied client session name.
|
|
||||||
*
|
|
||||||
* @param clientSessionName the human-readable session name reported by the gateway
|
|
||||||
* @return a session bound to the resulting {@code OpenSessionReply}
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
|
||||||
public MxGatewaySession openSession(String clientSessionName) {
|
public MxGatewaySession openSession(String clientSessionName) {
|
||||||
return openSession(OpenSessionRequest.newBuilder()
|
return openSession(OpenSessionRequest.newBuilder()
|
||||||
.setClientSessionName(clientSessionName)
|
.setClientSessionName(clientSessionName)
|
||||||
@@ -139,13 +81,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
.build());
|
.build());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes {@code OpenSession} and returns the raw reply.
|
|
||||||
*
|
|
||||||
* @param request the {@code OpenSessionRequest} to send
|
|
||||||
* @return the raw {@code OpenSessionReply}
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
|
||||||
public OpenSessionReply openSessionRaw(OpenSessionRequest request) {
|
public OpenSessionReply openSessionRaw(OpenSessionRequest request) {
|
||||||
try {
|
try {
|
||||||
OpenSessionReply reply = rawBlockingStub().openSession(request);
|
OpenSessionReply reply = rawBlockingStub().openSession(request);
|
||||||
@@ -159,13 +94,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes {@code OpenSession} asynchronously.
|
|
||||||
*
|
|
||||||
* @param request the {@code OpenSessionRequest} to send
|
|
||||||
* @return a future completed with the raw reply, or completed exceptionally
|
|
||||||
* with {@link MxGatewayException} on failure
|
|
||||||
*/
|
|
||||||
public CompletableFuture<OpenSessionReply> openSessionAsync(OpenSessionRequest request) {
|
public CompletableFuture<OpenSessionReply> openSessionAsync(OpenSessionRequest request) {
|
||||||
CompletableFuture<OpenSessionReply> future = toCompletable(rawFutureStub().openSession(request));
|
CompletableFuture<OpenSessionReply> future = toCompletable(rawFutureStub().openSession(request));
|
||||||
return future.thenApply(reply -> {
|
return future.thenApply(reply -> {
|
||||||
@@ -174,15 +102,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes the {@code Invoke} unary RPC and validates both the protocol
|
|
||||||
* status and any MXAccess-side failure carried in the reply.
|
|
||||||
*
|
|
||||||
* @param request the {@code MxCommandRequest} to send
|
|
||||||
* @return the raw command reply
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
* @throws MxAccessException when the worker reports an MXAccess COM-side failure
|
|
||||||
*/
|
|
||||||
public MxCommandReply invoke(MxCommandRequest request) {
|
public MxCommandReply invoke(MxCommandRequest request) {
|
||||||
try {
|
try {
|
||||||
MxCommandReply reply = rawBlockingStub().invoke(request);
|
MxCommandReply reply = rawBlockingStub().invoke(request);
|
||||||
@@ -197,14 +116,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes the {@code Invoke} RPC asynchronously.
|
|
||||||
*
|
|
||||||
* @param request the {@code MxCommandRequest} to send
|
|
||||||
* @return a future completed with the raw reply, or completed exceptionally
|
|
||||||
* with {@link MxGatewayException} (including {@link MxAccessException})
|
|
||||||
* on failure
|
|
||||||
*/
|
|
||||||
public CompletableFuture<MxCommandReply> invokeAsync(MxCommandRequest request) {
|
public CompletableFuture<MxCommandReply> invokeAsync(MxCommandRequest request) {
|
||||||
CompletableFuture<MxCommandReply> future = toCompletable(rawFutureStub().invoke(request));
|
CompletableFuture<MxCommandReply> future = toCompletable(rawFutureStub().invoke(request));
|
||||||
return future.thenApply(reply -> {
|
return future.thenApply(reply -> {
|
||||||
@@ -214,13 +125,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Invokes the {@code CloseSession} unary RPC.
|
|
||||||
*
|
|
||||||
* @param request the {@code CloseSessionRequest} to send
|
|
||||||
* @return the raw reply
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
|
||||||
public CloseSessionReply closeSessionRaw(CloseSessionRequest request) {
|
public CloseSessionReply closeSessionRaw(CloseSessionRequest request) {
|
||||||
try {
|
try {
|
||||||
CloseSessionReply reply = rawBlockingStub().closeSession(request);
|
CloseSessionReply reply = rawBlockingStub().closeSession(request);
|
||||||
@@ -234,28 +138,12 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Subscribes to the {@code StreamEvents} server-streaming RPC and exposes
|
|
||||||
* results as a blocking iterator. Closing the returned stream cancels the
|
|
||||||
* underlying gRPC call.
|
|
||||||
*
|
|
||||||
* @param request the {@code StreamEventsRequest} carrying the session id and resume cursor
|
|
||||||
* @return an iterator-style stream of events
|
|
||||||
*/
|
|
||||||
public MxEventStream streamEvents(StreamEventsRequest request) {
|
public MxEventStream streamEvents(StreamEventsRequest request) {
|
||||||
MxEventStream stream = new MxEventStream(16);
|
MxEventStream stream = new MxEventStream(16);
|
||||||
withStreamDeadline(rawAsyncStub()).streamEvents(request, stream.observer());
|
withStreamDeadline(rawAsyncStub()).streamEvents(request, stream.observer());
|
||||||
return stream;
|
return stream;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Subscribes to {@code StreamEvents} and dispatches each event to the
|
|
||||||
* supplied observer. The returned subscription is cancellable.
|
|
||||||
*
|
|
||||||
* @param request the {@code StreamEventsRequest} to send
|
|
||||||
* @param observer caller-supplied observer that receives events and completion
|
|
||||||
* @return a cancellable subscription handle
|
|
||||||
*/
|
|
||||||
public MxGatewayEventSubscription streamEventsAsync(
|
public MxGatewayEventSubscription streamEventsAsync(
|
||||||
StreamEventsRequest request, StreamObserver<MxEvent> observer) {
|
StreamEventsRequest request, StreamObserver<MxEvent> observer) {
|
||||||
MxGatewayEventSubscription subscription = new MxGatewayEventSubscription();
|
MxGatewayEventSubscription subscription = new MxGatewayEventSubscription();
|
||||||
@@ -263,63 +151,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
return subscription;
|
return subscription;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Acknowledges an active MXAccess alarm condition through the gateway.
|
|
||||||
*
|
|
||||||
* <p>The gateway authenticates the request against the API key's
|
|
||||||
* {@code invoke:alarm-ack} scope and forwards the acknowledge to the
|
|
||||||
* worker's MXAccess session; the resulting native MxStatus is returned
|
|
||||||
* in the reply. Acks are idempotent at the MxAccess layer.
|
|
||||||
*
|
|
||||||
* @param request the {@code AcknowledgeAlarmRequest}
|
|
||||||
* @return the raw acknowledge reply
|
|
||||||
* @throws MxGatewayException on transport or protocol failure
|
|
||||||
*/
|
|
||||||
public AcknowledgeAlarmReply acknowledgeAlarm(AcknowledgeAlarmRequest request) {
|
|
||||||
try {
|
|
||||||
AcknowledgeAlarmReply reply = rawBlockingStub().acknowledgeAlarm(request);
|
|
||||||
MxGatewayErrors.ensureProtocolSuccess("acknowledge alarm", reply.getProtocolStatus(), null);
|
|
||||||
return reply;
|
|
||||||
} catch (RuntimeException error) {
|
|
||||||
if (error instanceof MxGatewayException) {
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
throw MxGatewayErrors.fromGrpc("acknowledge alarm", error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Acknowledges an active MXAccess alarm condition asynchronously.
|
|
||||||
*
|
|
||||||
* @param request the {@code AcknowledgeAlarmRequest}
|
|
||||||
* @return a future completed with the raw reply, or completed exceptionally
|
|
||||||
* with {@link MxGatewayException} on failure
|
|
||||||
*/
|
|
||||||
public CompletableFuture<AcknowledgeAlarmReply> acknowledgeAlarmAsync(AcknowledgeAlarmRequest request) {
|
|
||||||
CompletableFuture<AcknowledgeAlarmReply> future = toCompletable(rawFutureStub().acknowledgeAlarm(request));
|
|
||||||
return future.thenApply(reply -> {
|
|
||||||
MxGatewayErrors.ensureProtocolSuccess("acknowledge alarm", reply.getProtocolStatus(), null);
|
|
||||||
return reply;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Streams a snapshot of all alarms currently Active or ActiveAcked — the
|
|
||||||
* gateway's ConditionRefresh equivalent. Used after reconnect to seed
|
|
||||||
* local Part 9 state.
|
|
||||||
*
|
|
||||||
* @param request the {@code QueryActiveAlarmsRequest}, optionally scoped by
|
|
||||||
* alarm-reference prefix
|
|
||||||
* @param observer caller-supplied observer that receives snapshots and completion
|
|
||||||
* @return a cancellable subscription handle
|
|
||||||
*/
|
|
||||||
public MxGatewayActiveAlarmsSubscription queryActiveAlarms(
|
|
||||||
QueryActiveAlarmsRequest request, StreamObserver<ActiveAlarmSnapshot> observer) {
|
|
||||||
MxGatewayActiveAlarmsSubscription subscription = new MxGatewayActiveAlarmsSubscription();
|
|
||||||
withStreamDeadline(rawAsyncStub()).queryActiveAlarms(request, subscription.wrap(observer));
|
|
||||||
return subscription;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void close() {
|
public void close() {
|
||||||
if (ownedChannel != null) {
|
if (ownedChannel != null) {
|
||||||
@@ -327,13 +158,6 @@ public final class MxGatewayClient implements AutoCloseable {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Shuts the owned channel down and waits up to the configured connect
|
|
||||||
* timeout for termination, forcibly shutting it down on timeout. No-op
|
|
||||||
* for clients that do not own their channel.
|
|
||||||
*
|
|
||||||
* @throws InterruptedException if the calling thread is interrupted while waiting
|
|
||||||
*/
|
|
||||||
public void closeAndAwaitTermination() throws InterruptedException {
|
public void closeAndAwaitTermination() throws InterruptedException {
|
||||||
if (ownedChannel != null) {
|
if (ownedChannel != null) {
|
||||||
ownedChannel.shutdown();
|
ownedChannel.shutdown();
|
||||||
+1
-119
@@ -1,16 +1,9 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import java.nio.file.Path;
|
import java.nio.file.Path;
|
||||||
import java.time.Duration;
|
import java.time.Duration;
|
||||||
import java.util.Objects;
|
import java.util.Objects;
|
||||||
|
|
||||||
/**
|
|
||||||
* Immutable configuration for {@link MxGatewayClient} and
|
|
||||||
* {@link GalaxyRepositoryClient}.
|
|
||||||
*
|
|
||||||
* <p>Captures the gateway endpoint, API key, transport security selection and
|
|
||||||
* call/stream timeouts. Instances are constructed via {@link #builder()}.
|
|
||||||
*/
|
|
||||||
public final class MxGatewayClientOptions {
|
public final class MxGatewayClientOptions {
|
||||||
private static final Duration DEFAULT_CONNECT_TIMEOUT = Duration.ofSeconds(10);
|
private static final Duration DEFAULT_CONNECT_TIMEOUT = Duration.ofSeconds(10);
|
||||||
private static final Duration DEFAULT_CALL_TIMEOUT = Duration.ofSeconds(30);
|
private static final Duration DEFAULT_CALL_TIMEOUT = Duration.ofSeconds(30);
|
||||||
@@ -40,93 +33,42 @@ public final class MxGatewayClientOptions {
|
|||||||
: builder.maxGrpcMessageBytes;
|
: builder.maxGrpcMessageBytes;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a fresh builder with default timeouts and no endpoint set.
|
|
||||||
*
|
|
||||||
* @return a new {@link Builder}
|
|
||||||
*/
|
|
||||||
public static Builder builder() {
|
public static Builder builder() {
|
||||||
return new Builder();
|
return new Builder();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the configured gRPC target endpoint.
|
|
||||||
*
|
|
||||||
* @return the endpoint string in {@code host:port} or DNS-target form
|
|
||||||
*/
|
|
||||||
public String endpoint() {
|
public String endpoint() {
|
||||||
return endpoint;
|
return endpoint;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the configured API key, or an empty string if none was supplied.
|
|
||||||
*
|
|
||||||
* @return the raw API key
|
|
||||||
*/
|
|
||||||
public String apiKey() {
|
public String apiKey() {
|
||||||
return apiKey;
|
return apiKey;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the API key with the body redacted, safe to write to logs.
|
|
||||||
*
|
|
||||||
* @return the redacted form produced by {@link MxGatewaySecrets#redactApiKey(String)}
|
|
||||||
*/
|
|
||||||
public String redactedApiKey() {
|
public String redactedApiKey() {
|
||||||
return MxGatewaySecrets.redactApiKey(apiKey);
|
return MxGatewaySecrets.redactApiKey(apiKey);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns whether the client is configured to use plaintext transport.
|
|
||||||
*
|
|
||||||
* @return {@code true} for plaintext, {@code false} for TLS
|
|
||||||
*/
|
|
||||||
public boolean plaintext() {
|
public boolean plaintext() {
|
||||||
return plaintext;
|
return plaintext;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the configured CA certificate file used to verify the gateway,
|
|
||||||
* or {@code null} when the platform trust store is used.
|
|
||||||
*
|
|
||||||
* @return the CA certificate path, or {@code null}
|
|
||||||
*/
|
|
||||||
public Path caCertificatePath() {
|
public Path caCertificatePath() {
|
||||||
return caCertificatePath;
|
return caCertificatePath;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the TLS server-name override, or an empty string when none was supplied.
|
|
||||||
*
|
|
||||||
* @return the server-name override
|
|
||||||
*/
|
|
||||||
public String serverNameOverride() {
|
public String serverNameOverride() {
|
||||||
return serverNameOverride;
|
return serverNameOverride;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the channel connect timeout.
|
|
||||||
*
|
|
||||||
* @return the connect timeout duration
|
|
||||||
*/
|
|
||||||
public Duration connectTimeout() {
|
public Duration connectTimeout() {
|
||||||
return connectTimeout;
|
return connectTimeout;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the per-call deadline applied to unary RPCs.
|
|
||||||
*
|
|
||||||
* @return the call timeout duration
|
|
||||||
*/
|
|
||||||
public Duration callTimeout() {
|
public Duration callTimeout() {
|
||||||
return callTimeout;
|
return callTimeout;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the deadline applied to server-streaming RPCs, or {@code null} when none is set.
|
|
||||||
*
|
|
||||||
* @return the stream timeout duration, or {@code null}
|
|
||||||
*/
|
|
||||||
public Duration streamTimeout() {
|
public Duration streamTimeout() {
|
||||||
return streamTimeout;
|
return streamTimeout;
|
||||||
}
|
}
|
||||||
@@ -169,9 +111,6 @@ public final class MxGatewayClientOptions {
|
|||||||
return value;
|
return value;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Mutable builder for {@link MxGatewayClientOptions}.
|
|
||||||
*/
|
|
||||||
public static final class Builder {
|
public static final class Builder {
|
||||||
private String endpoint;
|
private String endpoint;
|
||||||
private String apiKey;
|
private String apiKey;
|
||||||
@@ -186,92 +125,41 @@ public final class MxGatewayClientOptions {
|
|||||||
private Builder() {
|
private Builder() {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the gRPC target endpoint.
|
|
||||||
*
|
|
||||||
* @param value endpoint in {@code host:port} or DNS-target form; required
|
|
||||||
* @return this builder
|
|
||||||
*/
|
|
||||||
public Builder endpoint(String value) {
|
public Builder endpoint(String value) {
|
||||||
endpoint = value;
|
endpoint = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the API key sent in the {@code authorization} header.
|
|
||||||
*
|
|
||||||
* @param value the API key, or {@code null}/blank to disable authentication
|
|
||||||
* @return this builder
|
|
||||||
*/
|
|
||||||
public Builder apiKey(String value) {
|
public Builder apiKey(String value) {
|
||||||
apiKey = value;
|
apiKey = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Selects plaintext transport instead of TLS.
|
|
||||||
*
|
|
||||||
* @param value {@code true} for plaintext, {@code false} for TLS
|
|
||||||
* @return this builder
|
|
||||||
*/
|
|
||||||
public Builder plaintext(boolean value) {
|
public Builder plaintext(boolean value) {
|
||||||
plaintext = value;
|
plaintext = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the CA certificate used to verify the gateway server.
|
|
||||||
*
|
|
||||||
* @param value path to a PEM-encoded CA certificate, or {@code null} to use the platform trust store
|
|
||||||
* @return this builder
|
|
||||||
*/
|
|
||||||
public Builder caCertificatePath(Path value) {
|
public Builder caCertificatePath(Path value) {
|
||||||
caCertificatePath = value;
|
caCertificatePath = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Overrides the TLS server name used during the handshake.
|
|
||||||
*
|
|
||||||
* @param value the override host name, or empty/{@code null} for none
|
|
||||||
* @return this builder
|
|
||||||
*/
|
|
||||||
public Builder serverNameOverride(String value) {
|
public Builder serverNameOverride(String value) {
|
||||||
serverNameOverride = value;
|
serverNameOverride = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the channel connect timeout.
|
|
||||||
*
|
|
||||||
* @param value the connect timeout, must be non-{@code null}
|
|
||||||
* @return this builder
|
|
||||||
* @throws NullPointerException if {@code value} is {@code null}
|
|
||||||
*/
|
|
||||||
public Builder connectTimeout(Duration value) {
|
public Builder connectTimeout(Duration value) {
|
||||||
connectTimeout = Objects.requireNonNull(value, "connectTimeout");
|
connectTimeout = Objects.requireNonNull(value, "connectTimeout");
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the per-call deadline applied to unary RPCs.
|
|
||||||
*
|
|
||||||
* @param value the call timeout, must be non-{@code null}
|
|
||||||
* @return this builder
|
|
||||||
* @throws NullPointerException if {@code value} is {@code null}
|
|
||||||
*/
|
|
||||||
public Builder callTimeout(Duration value) {
|
public Builder callTimeout(Duration value) {
|
||||||
callTimeout = Objects.requireNonNull(value, "callTimeout");
|
callTimeout = Objects.requireNonNull(value, "callTimeout");
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the deadline applied to server-streaming RPCs.
|
|
||||||
*
|
|
||||||
* @param value the stream timeout, must be non-{@code null}
|
|
||||||
* @return this builder
|
|
||||||
* @throws NullPointerException if {@code value} is {@code null}
|
|
||||||
*/
|
|
||||||
public Builder streamTimeout(Duration value) {
|
public Builder streamTimeout(Duration value) {
|
||||||
streamTimeout = Objects.requireNonNull(value, "streamTimeout");
|
streamTimeout = Objects.requireNonNull(value, "streamTimeout");
|
||||||
return this;
|
return this;
|
||||||
@@ -282,12 +170,6 @@ public final class MxGatewayClientOptions {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Builds an immutable {@link MxGatewayClientOptions} from the current state.
|
|
||||||
*
|
|
||||||
* @return a new options instance
|
|
||||||
* @throws IllegalArgumentException if {@code endpoint} was not set or is blank
|
|
||||||
*/
|
|
||||||
public MxGatewayClientOptions build() {
|
public MxGatewayClientOptions build() {
|
||||||
return new MxGatewayClientOptions(this);
|
return new MxGatewayClientOptions(this);
|
||||||
}
|
}
|
||||||
+22
@@ -0,0 +1,22 @@
|
|||||||
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
|
public final class MxGatewayClientVersion {
|
||||||
|
private static final int GATEWAY_PROTOCOL_VERSION = 2;
|
||||||
|
private static final int WORKER_PROTOCOL_VERSION = 1;
|
||||||
|
private static final String CLIENT_VERSION = "0.1.0";
|
||||||
|
|
||||||
|
private MxGatewayClientVersion() {
|
||||||
|
}
|
||||||
|
|
||||||
|
public static String clientVersion() {
|
||||||
|
return CLIENT_VERSION;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static int gatewayProtocolVersion() {
|
||||||
|
return GATEWAY_PROTOCOL_VERSION;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static int workerProtocolVersion() {
|
||||||
|
return WORKER_PROTOCOL_VERSION;
|
||||||
|
}
|
||||||
|
}
|
||||||
+23
@@ -0,0 +1,23 @@
|
|||||||
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
|
import mxaccess_gateway.v1.MxaccessGateway.MxCommandReply;
|
||||||
|
import mxaccess_gateway.v1.MxaccessGateway.ProtocolStatus;
|
||||||
|
|
||||||
|
public class MxGatewayCommandException extends MxGatewayException {
|
||||||
|
private final ProtocolStatus protocolStatus;
|
||||||
|
private final MxCommandReply reply;
|
||||||
|
|
||||||
|
public MxGatewayCommandException(String operation, ProtocolStatus protocolStatus, MxCommandReply reply) {
|
||||||
|
super(MxGatewayErrors.protocolStatusMessage(operation, protocolStatus));
|
||||||
|
this.protocolStatus = protocolStatus;
|
||||||
|
this.reply = reply;
|
||||||
|
}
|
||||||
|
|
||||||
|
public ProtocolStatus protocolStatus() {
|
||||||
|
return protocolStatus;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MxCommandReply reply() {
|
||||||
|
return reply;
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import io.grpc.Status;
|
import io.grpc.Status;
|
||||||
import io.grpc.StatusRuntimeException;
|
import io.grpc.StatusRuntimeException;
|
||||||
+1
-14
@@ -1,4 +1,4 @@
|
|||||||
package com.zb.mom.ww.mxgateway.client;
|
package com.dohertylan.mxgateway.client;
|
||||||
|
|
||||||
import io.grpc.stub.ClientCallStreamObserver;
|
import io.grpc.stub.ClientCallStreamObserver;
|
||||||
import io.grpc.stub.ClientResponseObserver;
|
import io.grpc.stub.ClientResponseObserver;
|
||||||
@@ -8,14 +8,6 @@ import java.util.concurrent.atomic.AtomicBoolean;
|
|||||||
import mxaccess_gateway.v1.MxaccessGateway.MxEvent;
|
import mxaccess_gateway.v1.MxaccessGateway.MxEvent;
|
||||||
import mxaccess_gateway.v1.MxaccessGateway.StreamEventsRequest;
|
import mxaccess_gateway.v1.MxaccessGateway.StreamEventsRequest;
|
||||||
|
|
||||||
/**
|
|
||||||
* Cancellable handle returned by the async {@code streamEvents} variant.
|
|
||||||
*
|
|
||||||
* <p>Wraps a caller-supplied {@link StreamObserver} and exposes a
|
|
||||||
* {@link #cancel()} entry point that aborts the underlying gRPC call. The
|
|
||||||
* subscription also implements {@link AutoCloseable} so it can participate in
|
|
||||||
* try-with-resources blocks.
|
|
||||||
*/
|
|
||||||
public final class MxGatewayEventSubscription implements AutoCloseable {
|
public final class MxGatewayEventSubscription implements AutoCloseable {
|
||||||
private final AtomicReference<ClientCallStreamObserver<StreamEventsRequest>> requestStream = new AtomicReference<>();
|
private final AtomicReference<ClientCallStreamObserver<StreamEventsRequest>> requestStream = new AtomicReference<>();
|
||||||
private final AtomicBoolean cancelled = new AtomicBoolean();
|
private final AtomicBoolean cancelled = new AtomicBoolean();
|
||||||
@@ -47,11 +39,6 @@ public final class MxGatewayEventSubscription implements AutoCloseable {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Cancels the underlying gRPC call. Safe to invoke before the call has
|
|
||||||
* started; cancellation is recorded and applied as soon as the stream
|
|
||||||
* attaches.
|
|
||||||
*/
|
|
||||||
public void cancel() {
|
public void cancel() {
|
||||||
cancelled.set(true);
|
cancelled.set(true);
|
||||||
ClientCallStreamObserver<StreamEventsRequest> stream = requestStream.get();
|
ClientCallStreamObserver<StreamEventsRequest> stream = requestStream.get();
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user