Streaming support. by wllenyj · Pull Request #146 · containerd/ttrpc-rust

wllenyj · 2022-06-06T16:09:29Z

Introduce support for streaming(https://github.com/containerd/ttrpc/blob/main/PROTOCOL.md#streaming). This is already supported by Golang's TTRPC in containerd/ttrpc#107. But currently only async is implemented. Related issues #144.

This pull request changes include:

Improved message encoding and decoding.
Added shutdown module to handle graceful shutdown.
Refactored connection handling.
Added streaming support, and added an example about streaming.

Usually, streaming supports 3 types:

Server streaming
Client streaming
Bidirectional streaming ( or duplex streaming )

These 3 types are the same as GRPC, see https://grpc.io/docs/what-is-grpc/core-concepts/#server-streaming-rpc for details.

A general Bidirectional streaming process is as follows:

The Connection is an abstraction of a connection. One connection is handled as one Write async-task and one Read async-task.

The Write task receives the message from the channel and writes it to the connection.
The Read task receives the message from the connection and writes it to the channel.

Tim-Zhang · 2022-06-07T03:12:59Z

@wllenyj Awesome! Thanks a ton for introducing this so important feature. @jodh-intel @mxpv @lifupan @liubin Please take a look at this.

wllenyj · 2022-06-07T09:51:21Z

@dmcgowan Any time to help with this? Thanks a lot.

dmcgowan · 2022-06-07T16:25:24Z

@wllenyj thanks! I'll take a look

quanweiZhou

Thanks, @wllenyj - a few comments

quanweiZhou · 2022-06-12T02:13:11Z

+        &self,
+        req: Request,
+        streaming_client: bool,
+        streaming_server: bool,


I think streaming_client: bool and streaming_server: bool are a bit confusing, it's more clear to define them as sendable: bool and receivable: bool, while in this case only 3 conditions sender stream, receiver stream, and duplex stream, maybe an enum is better.

Try to keep this commit consistent with the golang version. Optimization will be done later.

wllenyj

@quanweiZhou Thanks for your comments.

codecov · 2022-06-24T09:12:19Z

Codecov Report

Merging #146 (98d128d) into master (8f2bd91) will increase coverage by 14.34%.
The diff coverage is 37.58%.

@@             Coverage Diff             @@
##           master     #146       +/-   ##
===========================================
+ Coverage   11.68%   26.02%   +14.34%     
===========================================
  Files          13       16        +3     
  Lines        1549     2413      +864     
===========================================
+ Hits          181      628      +447     
- Misses       1368     1785      +417

Impacted Files	Coverage Δ
src/asynchronous/client.rs	`0.00% <0.00%> (ø)`
src/asynchronous/connection.rs	`0.00% <0.00%> (ø)`
src/asynchronous/server.rs	`0.00% <0.00%> (ø)`
src/asynchronous/stream.rs	`0.00% <0.00%> (ø)`
src/asynchronous/utils.rs	`0.00% <ø> (ø)`
src/common.rs	`34.57% <ø> (-14.76%)`	⬇️
src/error.rs	`55.55% <ø> (+55.55%)`	⬆️
src/lib.rs	`100.00% <ø> (ø)`
src/sync/channel.rs	`0.00% <ø> (ø)`
src/sync/client.rs	`0.00% <0.00%> (ø)`
... and 8 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Move the MessageHeader from `common.rs` to the `proto.rs` file. Move the `compiled::ttrpc` from `common.rs` to `proto.rs` file and re-export. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Introduce Codec trait for protobuf message encoding/decoding. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Added more unit test for proto.rs. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

It is used for server-side graceful shutdown. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

The first block uses the standard library. The second block uses the third party crates, and the third block uses this crate. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Using shutdown can be used instead of channel composition. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Make message encoding/decoding uniform. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

For abstract connections, our connections are handled as one sending task and one receiving task. We can use the same logic to handle it. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

The client and server handle connections almost identically. Both use a sender side and a receiver side to handle the connection. Their respective differences are implemented using the delegate. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Added protocol support for streaming. Added `StreamInner` struct for streaming operations and Streaming related errors. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Added streaming support for client-side. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

Added streaming support for server-side. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

Added streaming support for generator. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

This example is the same as the golang version. See `https://github.com/containerd/ttrpc/tree/main/integration/streaming` for details. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

This is required by unicode-ident crate. For details: ``` error[L001]: failed to satisfy license requirements ┌─ unicode-ident 1.0.3 (registry+https://github.com/rust-lang/crates.io-index):4:13 │ 4 │ license = "(MIT OR Apache-2.0) AND Unicode-DFS-2016" │ -^^^----^^^^^^^^^^------^^^^^^^^^^^^^^^^ │ ││ │ │ │ ││ │ rejected: not explicitly allowed │ ││ accepted: license is explicitly allowed │ │accepted: license is explicitly allowed │ license expression retrieved via Cargo.toml `license` │ = unicode-ident v1.0.3 ├── proc-macro2 v1.0.43 │ ├── async-trait v0.1.57 │ │ └── ttrpc v0.6.1 │ ├── futures-macro v0.3.21 │ │ └── futures-util v0.3.21 │ │ ├── futures v0.3.21 │ │ │ ├── tokio-vsock v0.3.2 │ │ │ │ └── ttrpc v0.6.1 (*) │ │ │ └── ttrpc v0.6.1 (*) │ │ └── futures-executor v0.3.21 │ │ └── futures v0.3.21 (*) │ ├── quote v1.0.21 │ │ ├── async-trait v0.1.57 (*) │ │ ├── futures-macro v0.3.21 (*) │ │ ├── syn v1.0.99 │ │ │ ├── async-trait v0.1.57 (*) │ │ │ ├── futures-macro v0.3.21 (*) │ │ │ ├── thiserror-impl v1.0.32 │ │ │ │ └── thiserror v1.0.32 │ │ │ │ └── ttrpc v0.6.1 (*) │ │ │ └── tokio-macros v1.8.0 │ │ │ └── tokio v1.20.1 │ │ │ ├── tokio-vsock v0.3.2 (*) │ │ │ └── ttrpc v0.6.1 (*) │ │ ├── thiserror-impl v1.0.32 (*) │ │ └── tokio-macros v1.8.0 (*) │ ├── syn v1.0.99 (*) │ ├── thiserror-impl v1.0.32 (*) │ └── tokio-macros v1.8.0 (*) └── syn v1.0.99 (*) ``` Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

quanweiZhou

Thanks @wllenyj, LGTM.

Bump the major version due to pr containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Bump the major version of compiler to 0.6.0 due to containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Bump the major version of ttrpc-compiler to 0.6.0 due to containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Streaming support.

Bump the major version due to pr containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Bump the major version of ttrpc-compiler to 0.6.0 due to containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

wllenyj force-pushed the stream-1 branch 4 times, most recently from a728401 to bda9829 Compare June 6, 2022 17:17

Tim-Zhang requested review from lifupan and liubin June 7, 2022 02:46

Tim-Zhang requested review from jodh-intel and mxpv June 7, 2022 03:13

wllenyj force-pushed the stream-1 branch from bda9829 to d036b30 Compare June 7, 2022 10:16

Tim-Zhang reviewed Jun 9, 2022

View reviewed changes

Comment thread src/error.rs Outdated

Tim-Zhang reviewed Jun 9, 2022

View reviewed changes

Comment thread src/asynchronous/stream.rs

Tim-Zhang reviewed Jun 9, 2022

View reviewed changes

Comment thread src/asynchronous/stream.rs

wllenyj force-pushed the stream-1 branch 2 times, most recently from 84081f0 to d216133 Compare June 10, 2022 08:22

quanweiZhou reviewed Jun 12, 2022

View reviewed changes

wllenyj commented Jun 13, 2022

View reviewed changes

wllenyj force-pushed the stream-1 branch from d216133 to 238c25c Compare June 13, 2022 07:02

wllenyj force-pushed the stream-1 branch from 238c25c to 9dfabbf Compare June 24, 2022 09:09

Tim-Zhang reviewed Jul 12, 2022

View reviewed changes

Comment thread src/asynchronous/server.rs Outdated

Comment thread src/asynchronous/server.rs Outdated

Tim-Zhang reviewed Aug 8, 2022

View reviewed changes

Comment thread src/proto.rs Outdated

Comment thread src/asynchronous/shutdown.rs Outdated

Tim-Zhang reviewed Aug 9, 2022

View reviewed changes

wllenyj added 3 commits August 10, 2022 16:15

Add proto.rs to include protocol related.

5da5061

Move the MessageHeader from `common.rs` to the `proto.rs` file. Move the `compiled::ttrpc` from `common.rs` to `proto.rs` file and re-export. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Improve Message codec.

9126674

Introduce Codec trait for protobuf message encoding/decoding. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

Add more unit test for proto.rs

f4b3d90

Added more unit test for proto.rs. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

wllenyj force-pushed the stream-1 branch from 9dfabbf to c21bc3f Compare August 10, 2022 08:16

async: add shutdown module.

041bf30

It is used for server-side graceful shutdown. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

wllenyj added 7 commits August 10, 2022 16:20

async: Relayout use crate.

21b8e1a

The first block uses the standard library. The second block uses the third party crates, and the third block uses this crate. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

async: use shutdown to implement server graceful shutdown.

54ab070

Using shutdown can be used instead of channel composition. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

async: Refactor message encoding/deocding.

69bd03d

Make message encoding/decoding uniform. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

async: add connection module.

9f97207

For abstract connections, our connections are handled as one sending task and one receiving task. We can use the same logic to handle it. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

async: Refactor connection handling.

4cafce1

The client and server handle connections almost identically. Both use a sender side and a receiver side to handle the connection. Their respective differences are implemented using the delegate. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

async: add streaming support for the base component

314ec95

Added protocol support for streaming. Added `StreamInner` struct for streaming operations and Streaming related errors. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

async: add streaming support for client.

1126e43

Added streaming support for client-side. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

wllenyj force-pushed the stream-1 branch from c21bc3f to 9d313f6 Compare August 10, 2022 08:20

wllenyj added 3 commits August 10, 2022 16:23

async: add streaming support for server

78ffcb8

Added streaming support for server-side. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

async: add generator supprot for streaming

1cc2e59

Added streaming support for generator. Signed-off-by: wanglei01 <wllenyj@linux.alibaba.com>

example: add streaming example

6877207

This example is the same as the golang version. See `https://github.com/containerd/ttrpc/tree/main/integration/streaming` for details. Signed-off-by: wllenyj <wllenyj@linux.alibaba.com>

wllenyj force-pushed the stream-1 branch from 9d313f6 to 6877207 Compare August 10, 2022 08:23

quanweiZhou approved these changes Aug 10, 2022

View reviewed changes

Tim-Zhang approved these changes Aug 10, 2022

View reviewed changes

Tim-Zhang merged commit f63abbe into containerd:master Aug 10, 2022

Tim-Zhang added a commit to Tim-Zhang/ttrpc-rust that referenced this pull request Aug 10, 2022

release: v0.7.0

005d131

Bump the major version due to pr containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Tim-Zhang mentioned this pull request Aug 10, 2022

release: v0.7.0 #153

Merged

Tim-Zhang added a commit to Tim-Zhang/ttrpc-rust that referenced this pull request Aug 12, 2022

release compiler: v0.6.0

b2bad6f

Bump the major version of compiler to 0.6.0 due to containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Tim-Zhang added a commit to Tim-Zhang/ttrpc-rust that referenced this pull request Aug 12, 2022

release ttrpc-compiler: v0.6.0

5c08b4a

Bump the major version of ttrpc-compiler to 0.6.0 due to containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Tim-Zhang mentioned this pull request Aug 12, 2022

Release ttrpc-compiler v0.6.0 and ttrpc-codegen v0.4.0 #154

Merged

Tim-Zhang added a commit to Tim-Zhang/ttrpc-rust that referenced this pull request Aug 12, 2022

release ttrpc-compiler: v0.6.0

6d5ecaf

Bump the major version of ttrpc-compiler to 0.6.0 due to containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Tim-Zhang mentioned this pull request Apr 12, 2023

ttrpc: Bump to the newest version 0.7.1 kata-containers/kata-containers#6646

Closed

KarstenB pushed a commit to KarstenB/ttrpc-rust that referenced this pull request May 1, 2025

Merge pull request containerd#146 from wllenyj/stream-1

02a418d

Streaming support.

KarstenB pushed a commit to KarstenB/ttrpc-rust that referenced this pull request May 1, 2025

release: v0.7.0

8bd41f5

Bump the major version due to pr containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

KarstenB pushed a commit to KarstenB/ttrpc-rust that referenced this pull request May 1, 2025

release ttrpc-compiler: v0.6.0

185e5bd

Bump the major version of ttrpc-compiler to 0.6.0 due to containerd#146. Signed-off-by: Tim Zhang <tim@hyper.sh>

Conversation

wllenyj commented Jun 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Tim-Zhang commented Jun 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wllenyj commented Jun 7, 2022

Uh oh!

dmcgowan commented Jun 7, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

quanweiZhou left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

quanweiZhou Jun 12, 2022

Choose a reason for hiding this comment

Uh oh!

wllenyj Aug 10, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wllenyj left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

quanweiZhou left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

wllenyj commented Jun 6, 2022 •

edited

Loading

Tim-Zhang commented Jun 7, 2022 •

edited

Loading

quanweiZhou left a comment •

edited

Loading

wllenyj left a comment •

edited

Loading

codecov Bot commented Jun 24, 2022 •

edited

Loading