@hodfords/nestjs-grpc-helper 12.5.0 → 12.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -3
- package/constants/sdk-toolchain.const.d.ts +1 -0
- package/constants/sdk-toolchain.const.js +1 -0
- package/constants/sdk-toolchain.const.js.map +1 -1
- package/package.json +1 -1
- package/services/rust-sdk-generator.service.js +3 -0
- package/services/rust-sdk-generator.service.js.map +1 -1
- package/templates/rust/call.hbs +205 -0
- package/templates/rust/cargo-toml.hbs +1 -0
- package/templates/rust/client.hbs +25 -15
- package/templates/rust/lib.hbs +2 -0
package/README.md
CHANGED
|
@@ -117,6 +117,11 @@ For a nullable result the generated TypeScript method returns `Promise<UserRespo
|
|
|
117
117
|
> The Rust `ClientOptions` struct gained two fields. Code that builds it with a full struct literal
|
|
118
118
|
> (`ClientOptions { timeout: Some(..) }`) stops compiling after the SDK is regenerated; add `..Default::default()`.
|
|
119
119
|
|
|
120
|
+
> **Upgrading to 12.6:** the Rust `ClientOptions` struct gained `retry` and `hook` (see
|
|
121
|
+
> [Retry and call hooks in Rust](#retry-and-call-hooks-in-rust)); a full struct literal needs `..Default::default()`.
|
|
122
|
+
> Rust methods now take `options: impl Into<CallOptions>`, so a call that passes `Default::default()` as the options no
|
|
123
|
+
> longer infers its type; pass `CallOptions::default()`. The crate now depends on `tokio` (feature `time`).
|
|
124
|
+
|
|
120
125
|
### 3. Generate the proto file and start the gRPC server
|
|
121
126
|
|
|
122
127
|
Generate the proto file before the application starts, then connect the gRPC microservice:
|
|
@@ -479,9 +484,58 @@ than tonic's default of 4 MiB are rejected unless the first one is raised; build
|
|
|
479
484
|
do not break your code. In Go the limit belongs to the connection:
|
|
480
485
|
`grpc.NewClient(address, grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(16 * 1024 * 1024)), ...)`.
|
|
481
486
|
|
|
482
|
-
The crate root re-exports `pb`, `SdkError`, `SdkStream`, `ClientOptions`, `CallOptions`
|
|
483
|
-
types live in `sdk_name::enums`. A crate name with hyphens is imported
|
|
484
|
-
`tokio` (with the `macros` and `rt-multi-thread` features) for the
|
|
487
|
+
The crate root re-exports `pb`, `SdkError`, `SdkStream`, `ClientOptions`, `CallOptions`, `RetryPolicy`, `CallHook`,
|
|
488
|
+
`CallGuard`, `Rpc` and every client; the enum types live in `sdk_name::enums`. A crate name with hyphens is imported
|
|
489
|
+
with underscores, and the consuming crate needs `tokio` (with the `macros` and `rt-multi-thread` features) for the
|
|
490
|
+
example above. A `MetadataMap` converts into `CallOptions`, so `client.find_many(request, metadata)` works too.
|
|
491
|
+
|
|
492
|
+
#### Retry and call hooks in Rust
|
|
493
|
+
|
|
494
|
+
`ClientOptions.retry` retries unary calls like the gRPC retry policy: at most `max_attempts` attempts in all, while the
|
|
495
|
+
status is one of `retryable_codes`, waiting a random time up to the current backoff between attempts. The timeout of
|
|
496
|
+
the call (or the client default) bounds all attempts and waits together, and no attempt starts once it has expired.
|
|
497
|
+
Business errors (`SdkError::Service`) and streams are never retried. `RetryPolicy::default()` is 3 attempts on
|
|
498
|
+
`UNAVAILABLE`, backoff 200 ms doubling up to 1 s; only list codes for which sending the request again is safe.
|
|
499
|
+
|
|
500
|
+
`ClientOptions.hook` runs around every call, unary or stream, for tracing, logging or metadata every call needs. `start`
|
|
501
|
+
receives the rpc (`Rpc { service: "sdkName.AppMicroservice", method: "findMany" }`, the wire names) and the metadata
|
|
502
|
+
before the first attempt, and returns a guard whose `finish` receives the outcome once the call ends: after the last
|
|
503
|
+
attempt of a unary call, or when a stream opened or failed to open.
|
|
504
|
+
|
|
505
|
+
```rust
|
|
506
|
+
use std::sync::Arc;
|
|
507
|
+
use sdk_name::{AppMicroserviceClient, CallGuard, CallHook, ClientOptions, RetryPolicy, Rpc, SdkError};
|
|
508
|
+
use tonic::metadata::MetadataMap;
|
|
509
|
+
|
|
510
|
+
#[derive(Debug)]
|
|
511
|
+
struct Logging;
|
|
512
|
+
|
|
513
|
+
struct LoggingGuard(Rpc);
|
|
514
|
+
|
|
515
|
+
impl CallHook for Logging {
|
|
516
|
+
fn start(&self, rpc: Rpc, metadata: &mut MetadataMap) -> Box<dyn CallGuard> {
|
|
517
|
+
metadata.insert("x-caller", "billing".parse().unwrap());
|
|
518
|
+
Box::new(LoggingGuard(rpc))
|
|
519
|
+
}
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
impl CallGuard for LoggingGuard {
|
|
523
|
+
fn finish(self: Box<Self>, outcome: Result<(), &SdkError>) {
|
|
524
|
+
if let Err(error) = outcome {
|
|
525
|
+
println!("{} failed: {error}", self.0);
|
|
526
|
+
}
|
|
527
|
+
}
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
let options = ClientOptions {
|
|
531
|
+
retry: Some(RetryPolicy::default()),
|
|
532
|
+
hook: Some(Arc::new(Logging)),
|
|
533
|
+
..Default::default()
|
|
534
|
+
};
|
|
535
|
+
let client = AppMicroserviceClient::connect("http://localhost:50059", options).await?;
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
In Go, use the retry policy of the gRPC service config and interceptors on the connection instead.
|
|
485
539
|
|
|
486
540
|
```go
|
|
487
541
|
package main
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk-toolchain.const.js","sourceRoot":"","sources":["../../../lib/constants/sdk-toolchain.const.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,WAAW,GAAuB;IAC3C,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,8FAA8F;CAC1G,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAC9B,KAAK,EAAE;QACH,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,+CAA+C,EAAE;QACxG,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,+CAA+C,EAAE;KACnF;IACzB,cAAc,EAAE,MAAM;IACtB,MAAM,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,GAAG;QACd,SAAS,EAAE,GAAG;KACjB;CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,KAAK,EAAE;QACH;YACI,MAAM,EAAE,eAAe;YACvB,OAAO,EAAE,MAAM;YACf,OAAO,EAAE,iEAAiE;SAC7E;QACD;YACI,MAAM,EAAE,oBAAoB;YAC5B,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,iEAAiE;SAC7E;KACoB;IACzB,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE;QACL,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,SAAS;KACtB;CACJ,CAAC"}
|
|
1
|
+
{"version":3,"file":"sdk-toolchain.const.js","sourceRoot":"","sources":["../../../lib/constants/sdk-toolchain.const.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,WAAW,GAAuB;IAC3C,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,8FAA8F;CAC1G,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAC9B,KAAK,EAAE;QACH,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,+CAA+C,EAAE;QACxG,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,+CAA+C,EAAE;KACnF;IACzB,cAAc,EAAE,MAAM;IACtB,MAAM,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,GAAG;QACd,SAAS,EAAE,GAAG;KACjB;CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,KAAK,EAAE;QACH;YACI,MAAM,EAAE,eAAe;YACvB,OAAO,EAAE,MAAM;YACf,OAAO,EAAE,iEAAiE;SAC7E;QACD;YACI,MAAM,EAAE,oBAAoB;YAC5B,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,iEAAiE;SAC7E;KACoB;IACzB,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE;QACL,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,SAAS;KACtB;CACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -67,6 +67,7 @@ export class RustSdkGeneratorService extends HbsGeneratorService {
|
|
|
67
67
|
services: descriptor.services.map((service) => this.buildServiceView(service))
|
|
68
68
|
})
|
|
69
69
|
],
|
|
70
|
+
['src/call.rs', this.compileTemplate('rust/call.hbs', {})],
|
|
70
71
|
['src/error.rs', this.compileTemplate('rust/error.hbs', {})],
|
|
71
72
|
[
|
|
72
73
|
'src/enums.rs',
|
|
@@ -121,6 +122,8 @@ export class RustSdkGeneratorService extends HbsGeneratorService {
|
|
|
121
122
|
}
|
|
122
123
|
return {
|
|
123
124
|
fnName: toRustIdentifier(snakeName),
|
|
125
|
+
rpcService: `${this.config.name}.${service.name}`,
|
|
126
|
+
rpcMethod: method.name,
|
|
124
127
|
docLines,
|
|
125
128
|
requestType: method.requestType ? `pb::${rustTypeName(method.requestType)}` : undefined,
|
|
126
129
|
requestArg: method.requestType ? 'request' : '()',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rust-sdk-generator.service.js","sourceRoot":"","sources":["../../../lib/services/rust-sdk-generator.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAsB,MAAM,qCAAqC,CAAC;AAC1G,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAClH,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAQxG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,eAAe,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACzE,MAAM,YAAY,GAAG,eAAe,CAAC;AACrC,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAIpC,MAAM,mBAAmB,GAAG;IACxB,SAAS;IACT,KAAK;IACL,aAAa;IACb,kBAAkB;IAClB,iBAAiB;IACjB,mBAAmB;IACnB,2BAA2B;IAC3B,2BAA2B;IAC3B,OAAO;CACV,CAAC;AAGF,SAAS,YAAY,CAAC,IAAY;IAC9B,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,OAAO,uBAAwB,SAAQ,mBAAmB;IAOhD;IACA;IAPZ,MAAM,CAAU,aAAa,GAAyB,CAAC,WAAW,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAEzF,MAAM,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAClD,SAAS,CAAS;IAE1B,YACY,MAA0B,EAC1B,gBAA+B,IAAI,aAAa,EAAE;QAE1D,KAAK,EAAE,CAAC;QAHA,WAAM,GAAN,MAAM,CAAoB;QAC1B,kBAAa,GAAb,aAAa,CAAqC;QAG1D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ,CAAC,UAA0B;QAC/B,UAAU,KAAK,IAAI,oBAAoB,EAAE,CAAC,QAAQ,EAAE,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QAC1G,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,UAAyB;QACzC,OAAO,IAAI,GAAG,CAAC;YACX;gBACI,YAAY;gBACZ,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE;oBACxC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS;oBACrC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,mBAAmB;oBACxD,WAAW,EAAE,kBAAkB,CAAC,cAAc;oBAC9C,MAAM,EAAE,kBAAkB,CAAC,MAAM;iBACpC,CAAC;aACL;YACD;gBACI,eAAe;gBACf,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE;oBACpC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;iBACjF,CAAC;aACL;YACD,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YAC5D;gBACI,cAAc;gBACd,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE;oBACnC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;iBAClE,CAAC;aACL;SACJ,CAAC,CAAC;IACP,CAAC;IAEO,eAAe,CAAC,KAA0B;QAC9C,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,CAAC,UAAU,EAAE,EAAE;YAC7D,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;YAClE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,aAAa,CAAC,GAAG,CAClB,CAAC,gBAAgB,EAAE,eAAe,YAAY,EAAE,EAAE,eAAe,YAAY,EAAE,EAAE,oBAAoB,CAAC,EACtG,UAAU,CACb,CAAC;YACF,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACrG,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;gBAClC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5D,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAOO,oBAAoB,CAAC,OAAe;QACxC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACvD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACnF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QAEvE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CACX,iDAAiD,YAAY,YAAY,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,GAAG,CACzG,CAAC;QACN,CAAC;QAED,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;QAC/B,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;QAC/B,MAAM,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;QAElF,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;IACzF,CAAC;IAEO,gBAAgB,CAAC,OAA6B;QAClD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzE,OAAO;YAEH,UAAU,EAAE,GAAG,QAAQ,QAAQ;YAC/B,UAAU,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS;YACjD,QAAQ,EAAE,iBAAiB,OAAO,CAAC,IAAI,YAAY,WAAW,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;YAC5E,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;SAClF,CAAC;IACN,CAAC;IAEO,eAAe,CAAC,OAA6B,EAAE,MAA2B;QAC9E,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,mBAAmB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CACX,kBAAkB,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,uCAAuC,SAAS,oBAAoB,CACpH,CAAC;QACN,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,WAAW,IAAI,aAAa,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrF,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC7B,QAAQ,CAAC,IAAI,CAAC,gCAAgC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrF,CAAC;QAED,OAAO;YAEH,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"rust-sdk-generator.service.js","sourceRoot":"","sources":["../../../lib/services/rust-sdk-generator.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAsB,MAAM,qCAAqC,CAAC;AAC1G,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAClH,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAQxG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,eAAe,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACzE,MAAM,YAAY,GAAG,eAAe,CAAC;AACrC,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAIpC,MAAM,mBAAmB,GAAG;IACxB,SAAS;IACT,KAAK;IACL,aAAa;IACb,kBAAkB;IAClB,iBAAiB;IACjB,mBAAmB;IACnB,2BAA2B;IAC3B,2BAA2B;IAC3B,OAAO;CACV,CAAC;AAGF,SAAS,YAAY,CAAC,IAAY;IAC9B,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,OAAO,uBAAwB,SAAQ,mBAAmB;IAOhD;IACA;IAPZ,MAAM,CAAU,aAAa,GAAyB,CAAC,WAAW,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAEzF,MAAM,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAClD,SAAS,CAAS;IAE1B,YACY,MAA0B,EAC1B,gBAA+B,IAAI,aAAa,EAAE;QAE1D,KAAK,EAAE,CAAC;QAHA,WAAM,GAAN,MAAM,CAAoB;QAC1B,kBAAa,GAAb,aAAa,CAAqC;QAG1D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ,CAAC,UAA0B;QAC/B,UAAU,KAAK,IAAI,oBAAoB,EAAE,CAAC,QAAQ,EAAE,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QAC1G,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,UAAyB;QACzC,OAAO,IAAI,GAAG,CAAC;YACX;gBACI,YAAY;gBACZ,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE;oBACxC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS;oBACrC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,mBAAmB;oBACxD,WAAW,EAAE,kBAAkB,CAAC,cAAc;oBAC9C,MAAM,EAAE,kBAAkB,CAAC,MAAM;iBACpC,CAAC;aACL;YACD;gBACI,eAAe;gBACf,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE;oBACpC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;iBACjF,CAAC;aACL;YACD,CAAC,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YAC1D,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YAC5D;gBACI,cAAc;gBACd,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE;oBACnC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;iBAClE,CAAC;aACL;SACJ,CAAC,CAAC;IACP,CAAC;IAEO,eAAe,CAAC,KAA0B;QAC9C,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,CAAC,UAAU,EAAE,EAAE;YAC7D,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;YAClE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,aAAa,CAAC,GAAG,CAClB,CAAC,gBAAgB,EAAE,eAAe,YAAY,EAAE,EAAE,eAAe,YAAY,EAAE,EAAE,oBAAoB,CAAC,EACtG,UAAU,CACb,CAAC;YACF,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACrG,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;gBAClC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5D,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAOO,oBAAoB,CAAC,OAAe;QACxC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACvD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACnF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QAEvE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CACX,iDAAiD,YAAY,YAAY,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,GAAG,CACzG,CAAC;QACN,CAAC;QAED,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;QAC/B,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;QAC/B,MAAM,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;QAElF,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;IACzF,CAAC;IAEO,gBAAgB,CAAC,OAA6B;QAClD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzE,OAAO;YAEH,UAAU,EAAE,GAAG,QAAQ,QAAQ;YAC/B,UAAU,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS;YACjD,QAAQ,EAAE,iBAAiB,OAAO,CAAC,IAAI,YAAY,WAAW,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;YAC5E,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;SAClF,CAAC;IACN,CAAC;IAEO,eAAe,CAAC,OAA6B,EAAE,MAA2B;QAC9E,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,mBAAmB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CACX,kBAAkB,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,uCAAuC,SAAS,oBAAoB,CACpH,CAAC;QACN,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,WAAW,IAAI,aAAa,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrF,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC7B,QAAQ,CAAC,IAAI,CAAC,gCAAgC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrF,CAAC;QAED,OAAO;YAEH,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC;YAEnC,UAAU,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;YACjD,SAAS,EAAE,MAAM,CAAC,IAAI;YACtB,QAAQ;YACR,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;YACvF,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;YACjD,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YACnC,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;SAC5C,CAAC;IACN,CAAC;IAEO,UAAU,CAAC,MAA2B;QAC1C,QAAQ,MAAM,CAAC,YAAY,EAAE,CAAC;YAC1B,KAAK,OAAO;gBACR,OAAO,IAAI,CAAC;YAChB,KAAK,MAAM;gBACP,OAAO,WAAW,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC3D,KAAK,QAAQ;gBACT,OAAO,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAChD,KAAK,YAAY;gBACb,OAAO,OAAO,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC1D,KAAK,UAAU;gBACX,OAAO,cAAc,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC9D,KAAK,gBAAgB;gBACjB,OAAO,UAAU,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC7D;gBACI,OAAO,OAAO,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QAC1D,CAAC;IACL,CAAC;IAEO,gBAAgB,CAAC,MAA2B;QAChD,QAAQ,MAAM,CAAC,YAAY,EAAE,CAAC;YAC1B,KAAK,MAAM,CAAC;YACZ,KAAK,YAAY;gBACb,OAAO,gBAAgB,CAAC;YAC5B,KAAK,QAAQ,CAAC;YACd,KAAK,UAAU;gBACX,OAAO,gBAAgB,CAAC;YAC5B,KAAK,gBAAgB;gBAEjB,OAAO,2CAA2C,CAAC;YACvD;gBACI,OAAO,UAAU,CAAC;QAC1B,CAAC;IACL,CAAC;IAEO,aAAa,CAAC,IAAuB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC;QAE7C,OAAO;YACH,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACjC,QAAQ;YAER,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAClC,OAAO,EAAE,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpD,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aAChF,CAAC,CAAC;SACN,CAAC;IACN,CAAC;IAEO,MAAM;QACV,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;YACzF,OAAO;QACX,CAAC;QACD,IAAI,CAAC;YACD,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oEAAoE,MAAM,EAAE,CAAC,CAAC;QACnG,CAAC;IACL,CAAC;IAEO,KAAK;QACT,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,EAAE,cAAc,EAAE,GAAG,kBAAkB,CAAC;QAC9C,MAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CACX,2BAA2B,cAAc,oBAAoB,OAAO,+BAA+B,CACtG,CAAC;QACN,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACzC,SAAS,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC"}
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
// Generated by @hodfords/nestjs-grpc-helper. Do not edit.
|
|
2
|
+
|
|
3
|
+
use std::collections::hash_map::RandomState;
|
|
4
|
+
use std::fmt;
|
|
5
|
+
use std::future::Future;
|
|
6
|
+
use std::hash::BuildHasher;
|
|
7
|
+
use std::time::{Duration, Instant};
|
|
8
|
+
|
|
9
|
+
use tonic::metadata::MetadataMap;
|
|
10
|
+
|
|
11
|
+
use crate::client::{CallOptions, ClientOptions};
|
|
12
|
+
use crate::error::SdkError;
|
|
13
|
+
|
|
14
|
+
/// One rpc, named as on the wire: `/{service}/{method}`.
|
|
15
|
+
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
|
|
16
|
+
pub struct Rpc {
|
|
17
|
+
/// Proto package and service, for example `sample.UserMicroservice`.
|
|
18
|
+
pub service: &'static str,
|
|
19
|
+
/// Method name as the proto declares it, for example `findUser`.
|
|
20
|
+
pub method: &'static str,
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
impl fmt::Display for Rpc {
|
|
24
|
+
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
25
|
+
write!(formatter, "{}/{}", self.service, self.method)
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/// Runs around every call of a client, for tracing, logging or metadata every call needs. Set it in
|
|
30
|
+
/// `ClientOptions.hook`.
|
|
31
|
+
///
|
|
32
|
+
/// `start` runs once per call, before the first attempt; metadata it adds is sent by every attempt.
|
|
33
|
+
/// The guard it returns receives the outcome once: after the last attempt of a unary call, or when a
|
|
34
|
+
/// stream opened or failed to open. A call whose future is dropped drops its guard without `finish`.
|
|
35
|
+
pub trait CallHook: Send + Sync + fmt::Debug {
|
|
36
|
+
fn start(&self, rpc: Rpc, metadata: &mut MetadataMap) -> Box<dyn CallGuard>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/// Receives the outcome of the call a `CallHook` started.
|
|
40
|
+
pub trait CallGuard: Send {
|
|
41
|
+
fn finish(self: Box<Self>, outcome: Result<(), &SdkError>);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/// Retry of unary calls, as in the gRPC retry policy: at most `max_attempts` attempts in all, while the
|
|
45
|
+
/// status is one of `retryable_codes`, waiting a random time up to the current backoff between two
|
|
46
|
+
/// attempts. The call timeout bounds all attempts and waits together. Business errors
|
|
47
|
+
/// (`SdkError::Service`) and streams are never retried.
|
|
48
|
+
///
|
|
49
|
+
/// Only list codes for which sending the request again is safe for the rpcs of the client.
|
|
50
|
+
#[derive(Clone, Debug, PartialEq)]
|
|
51
|
+
pub struct RetryPolicy {
|
|
52
|
+
pub max_attempts: u32,
|
|
53
|
+
pub initial_backoff: Duration,
|
|
54
|
+
pub max_backoff: Duration,
|
|
55
|
+
pub backoff_multiplier: f64,
|
|
56
|
+
pub retryable_codes: Vec<tonic::Code>,
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
impl Default for RetryPolicy {
|
|
60
|
+
/// 3 attempts on UNAVAILABLE, with a backoff of 200 ms doubling up to 1 s.
|
|
61
|
+
fn default() -> Self {
|
|
62
|
+
Self {
|
|
63
|
+
max_attempts: 3,
|
|
64
|
+
initial_backoff: Duration::from_millis(200),
|
|
65
|
+
max_backoff: Duration::from_secs(1),
|
|
66
|
+
backoff_multiplier: 2.0,
|
|
67
|
+
retryable_codes: vec![tonic::Code::Unavailable],
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
impl RetryPolicy {
|
|
73
|
+
fn retries(&self, error: &SdkError) -> bool {
|
|
74
|
+
matches!(error, SdkError::Status(status) if self.retryable_codes.contains(&status.code()))
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
fn next_backoff(&self, backoff: Duration) -> Duration {
|
|
78
|
+
Duration::try_from_secs_f64(backoff.as_secs_f64() * self.backoff_multiplier)
|
|
79
|
+
.unwrap_or(self.max_backoff)
|
|
80
|
+
.min(self.max_backoff)
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
pub(crate) fn build_request<T>(message: T, timeout: Option<Duration>, metadata: MetadataMap) -> tonic::Request<T> {
|
|
85
|
+
let mut request = tonic::Request::new(message);
|
|
86
|
+
// Metadata first: set_timeout stores the deadline in the request metadata.
|
|
87
|
+
*request.metadata_mut() = metadata;
|
|
88
|
+
if let Some(timeout) = timeout {
|
|
89
|
+
request.set_timeout(timeout);
|
|
90
|
+
}
|
|
91
|
+
request
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/// A unary call: the hook around it, the client default timeout as the deadline of all attempts, and
|
|
95
|
+
/// the retry policy of the client. `send` performs one attempt.
|
|
96
|
+
#[allow(dead_code, reason = "a crate whose rpcs are all server streams never calls it")]
|
|
97
|
+
pub(crate) async fn unary<Req, Res, F, Fut>(
|
|
98
|
+
rpc: Rpc,
|
|
99
|
+
client: &ClientOptions,
|
|
100
|
+
options: CallOptions,
|
|
101
|
+
message: Req,
|
|
102
|
+
mut send: F,
|
|
103
|
+
) -> Result<Res, SdkError>
|
|
104
|
+
where
|
|
105
|
+
Req: Clone,
|
|
106
|
+
F: FnMut(tonic::Request<Req>) -> Fut,
|
|
107
|
+
Fut: Future<Output = Result<tonic::Response<Res>, tonic::Status>>,
|
|
108
|
+
{
|
|
109
|
+
let CallOptions { mut metadata, timeout } = options;
|
|
110
|
+
let guard = start(client, rpc, &mut metadata);
|
|
111
|
+
let deadline = timeout
|
|
112
|
+
.or(client.timeout)
|
|
113
|
+
.and_then(|timeout| Instant::now().checked_add(timeout));
|
|
114
|
+
let result = attempt(client.retry.as_ref(), deadline, metadata, message, &mut send).await;
|
|
115
|
+
finish(guard, &result);
|
|
116
|
+
result
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/// Opens a server stream: the hook around the opening and the call timeout only, never retried.
|
|
120
|
+
#[allow(dead_code, reason = "a crate without a server-streaming rpc never calls it")]
|
|
121
|
+
pub(crate) async fn open_stream<Req, Res, F, Fut>(
|
|
122
|
+
rpc: Rpc,
|
|
123
|
+
client: &ClientOptions,
|
|
124
|
+
options: CallOptions,
|
|
125
|
+
message: Req,
|
|
126
|
+
send: F,
|
|
127
|
+
) -> Result<tonic::Streaming<Res>, SdkError>
|
|
128
|
+
where
|
|
129
|
+
F: FnOnce(tonic::Request<Req>) -> Fut,
|
|
130
|
+
Fut: Future<Output = Result<tonic::Response<tonic::Streaming<Res>>, tonic::Status>>,
|
|
131
|
+
{
|
|
132
|
+
let CallOptions { mut metadata, timeout } = options;
|
|
133
|
+
let guard = start(client, rpc, &mut metadata);
|
|
134
|
+
let result = send(build_request(message, timeout, metadata))
|
|
135
|
+
.await
|
|
136
|
+
.map(tonic::Response::into_inner)
|
|
137
|
+
.map_err(SdkError::from_status);
|
|
138
|
+
finish(guard, &result);
|
|
139
|
+
result
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
async fn attempt<Req, Res, F, Fut>(
|
|
143
|
+
policy: Option<&RetryPolicy>,
|
|
144
|
+
deadline: Option<Instant>,
|
|
145
|
+
metadata: MetadataMap,
|
|
146
|
+
message: Req,
|
|
147
|
+
send: &mut F,
|
|
148
|
+
) -> Result<Res, SdkError>
|
|
149
|
+
where
|
|
150
|
+
Req: Clone,
|
|
151
|
+
F: FnMut(tonic::Request<Req>) -> Fut,
|
|
152
|
+
Fut: Future<Output = Result<tonic::Response<Res>, tonic::Status>>,
|
|
153
|
+
{
|
|
154
|
+
let max_attempts = policy.map_or(1, |policy| policy.max_attempts.max(1));
|
|
155
|
+
let mut backoff = policy.map_or(Duration::ZERO, |policy| policy.initial_backoff);
|
|
156
|
+
let mut attempt = 1;
|
|
157
|
+
loop {
|
|
158
|
+
let timeout = remaining(deadline)?;
|
|
159
|
+
let Some(policy) = policy.filter(|_| attempt < max_attempts) else {
|
|
160
|
+
// The last attempt sends the message itself instead of a copy.
|
|
161
|
+
return send(build_request(message, timeout, metadata))
|
|
162
|
+
.await
|
|
163
|
+
.map(tonic::Response::into_inner)
|
|
164
|
+
.map_err(SdkError::from_status);
|
|
165
|
+
};
|
|
166
|
+
let error = match send(build_request(message.clone(), timeout, metadata.clone())).await {
|
|
167
|
+
Ok(response) => return Ok(response.into_inner()),
|
|
168
|
+
Err(status) => SdkError::from_status(status),
|
|
169
|
+
};
|
|
170
|
+
let wait = jitter(backoff);
|
|
171
|
+
let out_of_time = deadline.is_some_and(|deadline| Instant::now() + wait >= deadline);
|
|
172
|
+
if out_of_time || !policy.retries(&error) {
|
|
173
|
+
return Err(error);
|
|
174
|
+
}
|
|
175
|
+
tokio::time::sleep(wait).await;
|
|
176
|
+
backoff = policy.next_backoff(backoff);
|
|
177
|
+
attempt += 1;
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
fn remaining(deadline: Option<Instant>) -> Result<Option<Duration>, SdkError> {
|
|
182
|
+
let Some(deadline) = deadline else {
|
|
183
|
+
return Ok(None);
|
|
184
|
+
};
|
|
185
|
+
match deadline.checked_duration_since(Instant::now()) {
|
|
186
|
+
Some(left) if !left.is_zero() => Ok(Some(left)),
|
|
187
|
+
_ => Err(SdkError::Status(tonic::Status::deadline_exceeded("Timeout expired"))),
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
/// A random duration up to `backoff`, without a random number crate: every `RandomState` has new keys.
|
|
192
|
+
fn jitter(backoff: Duration) -> Duration {
|
|
193
|
+
let bits = RandomState::new().hash_one(0u8) >> 11;
|
|
194
|
+
backoff.mul_f64(bits as f64 / (1u64 << 53) as f64)
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
fn start(client: &ClientOptions, rpc: Rpc, metadata: &mut MetadataMap) -> Option<Box<dyn CallGuard>> {
|
|
198
|
+
client.hook.as_ref().map(|hook| hook.start(rpc, metadata))
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
fn finish<T>(guard: Option<Box<dyn CallGuard>>, result: &Result<T, SdkError>) {
|
|
202
|
+
if let Some(guard) = guard {
|
|
203
|
+
guard.finish(result.as_ref().map(|_| ()));
|
|
204
|
+
}
|
|
205
|
+
}
|
|
@@ -8,6 +8,7 @@ rust-version = "{{rustVersion}}"
|
|
|
8
8
|
[dependencies]
|
|
9
9
|
prost = "{{crates.prost}}"
|
|
10
10
|
tonic = "{{crates.tonic}}"
|
|
11
|
+
tokio = { version = "{{crates.tokio}}", features = ["time"] }
|
|
11
12
|
tokio-stream = "{{crates.tokioStream}}"
|
|
12
13
|
serde_json = "{{crates.serdeJson}}"
|
|
13
14
|
thiserror = "{{crates.thiserror}}"
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// Generated by @hodfords/nestjs-grpc-helper. Do not edit.
|
|
2
2
|
|
|
3
3
|
use std::pin::Pin;
|
|
4
|
+
use std::sync::Arc;
|
|
4
5
|
use std::time::Duration;
|
|
5
6
|
|
|
6
7
|
#[allow(unused_imports)]
|
|
@@ -8,6 +9,7 @@ use tokio_stream::{Stream, StreamExt};
|
|
|
8
9
|
use tonic::metadata::MetadataMap;
|
|
9
10
|
use tonic::transport::{Channel, Endpoint};
|
|
10
11
|
|
|
12
|
+
use crate::call::{self, CallHook, RetryPolicy, Rpc};
|
|
11
13
|
use crate::error::SdkError;
|
|
12
14
|
use crate::pb;
|
|
13
15
|
|
|
@@ -21,15 +23,19 @@ pub type SdkStream<T> = Pin<Box<dyn Stream<Item = Result<T, SdkError>> + Send +
|
|
|
21
23
|
/// Options shared by every call of a client.
|
|
22
24
|
#[derive(Clone, Debug, Default)]
|
|
23
25
|
pub struct ClientOptions {
|
|
24
|
-
/// Default timeout of unary calls. Streams never use it.
|
|
26
|
+
/// Default timeout of unary calls, covering every attempt of a retried call. Streams never use it.
|
|
25
27
|
pub timeout: Option<Duration>,
|
|
26
28
|
/// Largest response message, in bytes, the client accepts. `None` keeps tonic's default (4 MiB).
|
|
27
29
|
pub max_decoding_message_size: Option<usize>,
|
|
28
30
|
/// Largest request message, in bytes, the client sends. `None` keeps tonic's default (no limit).
|
|
29
31
|
pub max_encoding_message_size: Option<usize>,
|
|
32
|
+
/// Retry of unary calls. `None` sends each call once.
|
|
33
|
+
pub retry: Option<RetryPolicy>,
|
|
34
|
+
/// Runs around every call, unary or stream.
|
|
35
|
+
pub hook: Option<Arc<dyn CallHook>>,
|
|
30
36
|
}
|
|
31
37
|
|
|
32
|
-
/// Options of a single call.
|
|
38
|
+
/// Options of a single call. A `MetadataMap` converts into options with only that metadata.
|
|
33
39
|
#[derive(Clone, Debug, Default)]
|
|
34
40
|
pub struct CallOptions {
|
|
35
41
|
pub metadata: MetadataMap,
|
|
@@ -39,14 +45,10 @@ pub struct CallOptions {
|
|
|
39
45
|
pub timeout: Option<Duration>,
|
|
40
46
|
}
|
|
41
47
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
*request.metadata_mut() = metadata;
|
|
46
|
-
if let Some(timeout) = timeout {
|
|
47
|
-
request.set_timeout(timeout);
|
|
48
|
+
impl From<MetadataMap> for CallOptions {
|
|
49
|
+
fn from(metadata: MetadataMap) -> Self {
|
|
50
|
+
Self { metadata, timeout: None }
|
|
48
51
|
}
|
|
49
|
-
request
|
|
50
52
|
}
|
|
51
53
|
{{#each services}}
|
|
52
54
|
|
|
@@ -83,15 +85,23 @@ impl {{clientName}} {
|
|
|
83
85
|
/// {{{this}}}
|
|
84
86
|
{{/each}}
|
|
85
87
|
{{#if isStream}}
|
|
86
|
-
pub async fn {{{fnName}}}(&self{{#if requestType}}, request: {{{requestType}}}{{/if}}, options: CallOptions) -> Result<SdkStream<{{{returnType}}}>, SdkError> {
|
|
87
|
-
|
|
88
|
-
let stream = self.
|
|
88
|
+
pub async fn {{{fnName}}}(&self{{#if requestType}}, request: {{{requestType}}}{{/if}}, options: impl Into<CallOptions>) -> Result<SdkStream<{{{returnType}}}>, SdkError> {
|
|
89
|
+
const RPC: Rpc = Rpc { service: "{{{rpcService}}}", method: "{{{rpcMethod}}}" };
|
|
90
|
+
let stream = call::open_stream(RPC, &self.options, options.into(), {{{requestArg}}}, |request| {
|
|
91
|
+
let mut inner = self.inner.clone();
|
|
92
|
+
async move { inner.{{{fnName}}}(request).await }
|
|
93
|
+
})
|
|
94
|
+
.await?;
|
|
89
95
|
Ok(Box::pin(stream.map(|chunk| chunk.map(|response| {{{unwrapExpr}}}).map_err(SdkError::from_status))))
|
|
90
96
|
}
|
|
91
97
|
{{else}}
|
|
92
|
-
pub async fn {{{fnName}}}(&self{{#if requestType}}, request: {{{requestType}}}{{/if}}, options: CallOptions) -> Result<{{{returnType}}}, SdkError> {
|
|
93
|
-
|
|
94
|
-
let response = self.
|
|
98
|
+
pub async fn {{{fnName}}}(&self{{#if requestType}}, request: {{{requestType}}}{{/if}}, options: impl Into<CallOptions>) -> Result<{{{returnType}}}, SdkError> {
|
|
99
|
+
const RPC: Rpc = Rpc { service: "{{{rpcService}}}", method: "{{{rpcMethod}}}" };
|
|
100
|
+
let response = call::unary(RPC, &self.options, options.into(), {{{requestArg}}}, |request| {
|
|
101
|
+
let mut inner = self.inner.clone();
|
|
102
|
+
async move { inner.{{{fnName}}}(request).await }
|
|
103
|
+
})
|
|
104
|
+
.await?;
|
|
95
105
|
Ok({{{unwrapExpr}}})
|
|
96
106
|
}
|
|
97
107
|
{{/if}}
|