Remove `futures_core::stream::Stream` from `aws_smithy_http::byte_stream::ByteStream` #2983

ysaito1001 · 2023-09-12T22:21:52Z

Motivation and Context

Removes futures_core::stream::Stream from aws_smithy_http::byte_stream::ByteStream

Description

This PR is part of our ongoing effort, #2413. We remove the futures_core::stream::Stream trait from aws_smithy_http::byte_stream::ByteStream. To continue support existing places that relied upon ByteStream implementing the Stream trait, we provide explicit .next, .try_next, and .size_hints methods on that type. As part of it, a doc-hidden type FuturesStreamCompatByteStream, which implements Stream, has been added to aws_smithy_http to cater to those who need a type implementing Stream (see discussion why doc-hidden).

Another place we need to update is codegen responsible for rendering stream payload serializer, and this affects the server. The regular server and the python server have slightly different rendering requirements, since the former uses aws_smithy_http::byte_stream::ByteStream (that does not implement the Stream trait) and latter uses its own ByteStream (that does implement Stream). We use ServerHttpBoundProtocolCustomization to handle the difference: StreamPayloadSerializerCustomization and PythonServerStreamPayloadSerializerCustomization.

Testing

No new behavior has been added, relied on the existing tests in CI.

Checklist

I have updated CHANGELOG.next.toml if I made changes to the smithy-rs codegen or runtime crates
I have updated CHANGELOG.next.toml if I made changes to the AWS SDK, generated SDK code, or SDK runtime crates

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

This commit responses to #2978 (comment)

github-actions · 2023-09-12T22:48:01Z

A new generated diff is ready to view.

AWS SDK (ignoring whitespace)
Client Test (ignoring whitespace)
Server Test (ignoring whitespace)
Server Test Python (ignoring whitespace)
No codegen difference in the Server Test Typescript

A new doc preview is ready to view.

github-actions · 2023-09-13T00:44:45Z

A new generated diff is ready to view.

AWS SDK (ignoring whitespace)
Client Test (ignoring whitespace)
Server Test (ignoring whitespace)
Server Test Python (ignoring whitespace)
No codegen difference in the Server Test Typescript

A new doc preview is ready to view.

github-actions · 2023-09-13T16:16:53Z

A new generated diff is ready to view.

AWS SDK (ignoring whitespace)
Client Test (ignoring whitespace)
Server Test (ignoring whitespace)
Server Test Python (ignoring whitespace)
No codegen difference in the Server Test Typescript

A new doc preview is ready to view.

rcoh

seems pretty reasonable. I might consider putting the impl Stream bridge in the types-convert crate instead so customers can easily use it if they want

This commit addresses #2978 (comment)

…aito/remove-futures-stream-from-byte-stream

ysaito1001 · 2023-09-20T20:56:15Z

seems pretty reasonable. I might consider putting the impl Stream bridge in the types-convert crate instead so customers can easily use it if they want

The impl Stream bridge is currently done for FuturesStreamCompatByteStream and it's meant to be used directly by codegen to pass ByteStream (in the case of python-server, it's own aws_smithy_http_server_python::types::ByteStream) to hyper::body::Body::wrap_stream for stream payload serializers.

For external customers' use cases for aws_smithy_http::ByteStream, we may not need the impl Stream bridge, i.e. next, try_next, collect, and into_async_read should do?

github-actions · 2023-09-21T21:33:00Z

A new generated diff is ready to view.

AWS SDK (ignoring whitespace)
No codegen difference in the Client Test
Server Test (ignoring whitespace)
No codegen difference in the Server Test Python
No codegen difference in the Server Test Typescript

A new doc preview is ready to view.

rcoh

Awesome work on this!! I love how narrow this PR ended up being

codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/RuntimeType.kt

...tware/amazon/smithy/rust/codegen/server/smithy/protocols/ServerHttpBoundProtocolGenerator.kt

rust-runtime/aws-smithy-http/src/byte_stream.rs

rust-runtime/aws-smithy-http/src/lib.rs

This commit addresses #2978 (comment)

…aito/remove-futures-stream-from-byte-stream

This commit addresses #2983 (comment)

github-actions · 2023-09-28T18:22:26Z

A new generated diff is ready to view.

AWS SDK (ignoring whitespace)
No codegen difference in the Client Test
Server Test (ignoring whitespace)
Server Test Python (ignoring whitespace)
No codegen difference in the Server Test Typescript

A new doc preview is ready to view.

The method in question is used by the python server's custom `ByteStream` so it needs to be `pub`.

github-actions · 2023-09-28T19:41:40Z

A new generated diff is ready to view.

AWS SDK (ignoring whitespace)
No codegen difference in the Client Test
Server Test (ignoring whitespace)
No codegen difference in the Server Test Python
No codegen difference in the Server Test Typescript

A new doc preview is ready to view.

utkarshgupta137 · 2023-11-02T21:56:46Z

rust-runtime/aws-smithy-http/src/byte_stream.rs

@@ -393,7 +423,9 @@ impl ByteStream {
    /// # }
    /// ```
    pub fn into_async_read(self) -> impl tokio::io::AsyncRead {


Earlier we could do this wrapping ourselves & since tokio_util::io::StreamReader implements AsyncBufRead, we would get a buffered reader for free. Would it be acceptable to change this to:

Suggested change

pub fn into_async_read(self) -> impl tokio::io::AsyncRead {

pub fn into_async_read(self) -> impl tokio::io::AsyncBufRead {

Or perhaps you would want a separate into_async_buf_read?

We don't have any buffering in our implementation. You should be able to wrap the ByteStream with a new-type and implement Stream for it to get the same functionality you used to have. The Stream impl should be a simple call through to the poll_next and size_hint methods.

Yes, I know. What I'm saying is that in this function, you're wrapping bytestream in StreamReader from tokio, which implements AsyncBufRead. So you could also return impl AsyncBufRead from this function.
Otherwise, one has to wrap this in a BufReader for no reason, since it is not possible to wrap ByteStream in StreamReader easily (without wrapping & implementing Stream manually).

Oh, I see what you're saying. Yeah, I don't see why we couldn't have two methods. You're welcome to submit a PR to add that.

I would say it makes more sense to change the signature of the existing function as I suggested above. It won't be a breaking change at all since AsyncBufRead is a super trait of AsyncRead.

Sounds good.

## Motivation and Context The tokio `StreamReader` implements `AsyncBufRead`, but we're returning `AsyncRead` currently. If a user needs an `AsyncBufRead`, then they've to wrap the returned value in tokio `BufReader` for no reason. Since `ByteStream` doesn't implement `Stream` anymore, one has to either wrap the returned value unnecessarily or write a wrapper similar to this function. See #2983 (comment). ## Description Simply changed the return type to say `impl AsyncBufRead`. Since `AsyncBufRead` is a super-set of `AsyncRead`, this is not a breaking change. ## Testing The code example tests it. ## Checklist - [x] I have updated `CHANGELOG.next.toml` if I made changes to the AWS SDK, generated SDK code, or SDK runtime crates ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Russell Cohen <[email protected]>

ysaito1001 added 11 commits September 8, 2023 20:16

Remove futures_core::stream::Stream from aws-smithy-async

f43afc0

Update codegen client to use PaginationStream

cbbaf77

Update canary to use PaginationStream

8005c3d

Stop using tokio_stream::StreamExt in integration-tests

75b96e3

Add comment explaining why the test uses .enter

2b1fcb1

This commit responses to #2978 (comment)

Make FnStream::poll_next module private

73966d4

Update CHANGELOG.next.toml

e25a916

Remove impl Stream trait for ByteStream

cce169c

Make rendering stream payload serializer configurable

0362d9c

Let client configure how to render stream payload serializer

0099bdb

Let server configure how to render stream payload serializer

03e9278

Remove unused tokio_stream::StreamExt from glacier_checksums

b04b3ca

Update CHANGELOG.next.toml

6575943

rcoh reviewed Sep 15, 2023

View reviewed changes

ysaito1001 added 4 commits September 19, 2023 10:17

Remove unnecessary Unpin bound

8147d81

This commit addresses #2978 (comment)

Add convenince method try_collect

43318e7

This commit addresses #2978 (comment)

Merge branch 'main' into ysaito/remove-futures-stream-from-smithy-async

b6811bf

Merge branch 'ysaito/remove-futures-stream-from-smithy-async' into ys…

3ad25c8

…aito/remove-futures-stream-from-byte-stream

ysaito1001 marked this pull request as ready for review September 20, 2023 20:43

ysaito1001 requested review from a team as code owners September 20, 2023 20:43

ysaito1001 requested review from david-perez and removed request for a team September 20, 2023 20:43

ysaito1001 added needs-server-review needs-sdk-review labels Sep 20, 2023

ysaito1001 requested a review from rcoh September 21, 2023 20:43

Revert HttpBoundProtocolPayloadGenerator.kt since no change is needed

5381cfe

rcoh approved these changes Sep 26, 2023

View reviewed changes

ysaito1001 added 4 commits September 26, 2023 21:55

Move fn_stream to its own module

1add37f

This commit addresses #2978 (comment)

Provide docs for PaginationStream for end users

b8f37ea

This commit addresses #2978 (comment)

Merge branch 'main' into ysaito/remove-futures-stream-from-smithy-async

57f2707

Update CHANGELOG.next.toml

7571c8c

This commit addresses #2978 (comment)

Base automatically changed from ysaito/remove-futures-stream-from-smithy-async to main September 27, 2023 21:39

ysaito1001 added 6 commits September 27, 2023 16:54

Merge branch 'ysaito/remove-futures-stream-from-smithy-async' into ys…

e8b1f65

…aito/remove-futures-stream-from-byte-stream

Make ByteStream::poll_next to be pub(crate)

a802799

This commit addresses #2983 (comment)

Doc link ByteStream::next to ByteStream::try_next

5d07b16

This commit addresses #2983 (comment)

Doc link ByteStream::try_next to ByteStream::next

6fc9a96

This commit addresses #2983 (comment)

Explain why futures_stream_adapter is doc(hidden)

b01b1d4

This commit addresses #2983 (comment)

Merge branch 'main' into ysaito/remove-futures-stream-from-byte-stream

f4a60df

ysaito1001 enabled auto-merge September 28, 2023 18:08

ysaito1001 added 2 commits September 28, 2023 14:19

Make ByteStream::poll_next pub again

5bcf5ca

The method in question is used by the python server's custom `ByteStream` so it needs to be `pub`.

Merge branch 'main' into ysaito/remove-futures-stream-from-byte-stream

e942f24

ysaito1001 added this pull request to the merge queue Sep 28, 2023

Merged via the queue into main with commit 33cd698 Sep 28, 2023
40 of 41 checks passed

ysaito1001 deleted the ysaito/remove-futures-stream-from-byte-stream branch September 28, 2023 20:17

Velfi removed the needs-sdk-review label Oct 19, 2023

utkarshgupta137 reviewed Nov 2, 2023

View reviewed changes

jwangnz mentioned this pull request Nov 6, 2023

Update aws-sdk-s3 to 0.35 Hakuyume/s3-mpu-rs#43

Closed

utkarshgupta137 mentioned this pull request Nov 9, 2023

Return impl AsyncBufRead from into_async_read #3164

Merged

1 task

NickDarvey mentioned this pull request Jun 25, 2024

chore: upgrade aws-config for aarch64-pc-windows support lancedb/lance#2510

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove `futures_core::stream::Stream` from `aws_smithy_http::byte_stream::ByteStream` #2983

Remove `futures_core::stream::Stream` from `aws_smithy_http::byte_stream::ByteStream` #2983

ysaito1001 commented Sep 12, 2023 •

edited

Loading

github-actions bot commented Sep 12, 2023

github-actions bot commented Sep 13, 2023

github-actions bot commented Sep 13, 2023

rcoh left a comment

ysaito1001 commented Sep 20, 2023

github-actions bot commented Sep 21, 2023

rcoh left a comment

github-actions bot commented Sep 28, 2023

github-actions bot commented Sep 28, 2023

utkarshgupta137 Nov 2, 2023

utkarshgupta137 Nov 2, 2023

jdisanti Nov 8, 2023

utkarshgupta137 Nov 8, 2023

jdisanti Nov 8, 2023

utkarshgupta137 Nov 9, 2023

jdisanti Nov 9, 2023

	pub fn into_async_read(self) -> impl tokio::io::AsyncRead {
	pub fn into_async_read(self) -> impl tokio::io::AsyncBufRead {

Remove futures_core::stream::Stream from aws_smithy_http::byte_stream::ByteStream #2983

Remove futures_core::stream::Stream from aws_smithy_http::byte_stream::ByteStream #2983

Conversation

ysaito1001 commented Sep 12, 2023 • edited Loading

Motivation and Context

Description

Testing

Checklist

github-actions bot commented Sep 12, 2023

github-actions bot commented Sep 13, 2023

github-actions bot commented Sep 13, 2023

rcoh left a comment

Choose a reason for hiding this comment

ysaito1001 commented Sep 20, 2023

github-actions bot commented Sep 21, 2023

rcoh left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 28, 2023

github-actions bot commented Sep 28, 2023

utkarshgupta137 Nov 2, 2023

Choose a reason for hiding this comment

utkarshgupta137 Nov 2, 2023

Choose a reason for hiding this comment

jdisanti Nov 8, 2023

Choose a reason for hiding this comment

utkarshgupta137 Nov 8, 2023

Choose a reason for hiding this comment

jdisanti Nov 8, 2023

Choose a reason for hiding this comment

utkarshgupta137 Nov 9, 2023

Choose a reason for hiding this comment

jdisanti Nov 9, 2023

Choose a reason for hiding this comment

Remove `futures_core::stream::Stream` from `aws_smithy_http::byte_stream::ByteStream` #2983

Remove `futures_core::stream::Stream` from `aws_smithy_http::byte_stream::ByteStream` #2983

ysaito1001 commented Sep 12, 2023 •

edited

Loading