HTTP Connectors Refactor pt.1 - Laying the groundwork #1144

Velfi · 2022-02-01T19:56:38Z

Motivation and Context

This is the first PR in a series that will change the way that HTTP connector are created, configured, and shared throughout the SDK. The goal is providing a better experience for users that want to easily configure various aspects of how the SDK makes HTTP requests.

Because this is such a large PR, here's a high-level breakdown of the changes:

The default_providers module has be broken up into multiple files, one per submodule.
The sts module has be broken up into multiple files, one per submodule.
The aws_config::connector module now has it's own file.
The http_provider module has been renamed to http_credential_provider to better reflect the fact that it contains the HttpCredentialProvider and related code.
Imports in several aws_config modules have be separated into separate groups (libstd imports, same-crate imports, aws and smithy runtime crates). This is an unspoken pattern that we've been following elsewhere.
BREAKING CHANGE The aws_smithy_client::timeout::Settings struct has been fully replaced by aws_smithy_types::timeout::TimeoutConfig. I should have done this when I originally added timeout support but better late than never, right? All structs and functions that referenced aws_smithy_client::timeout::Settings have been updated.
BREAKING CHANGE MakeConnectorFn, HttpConnector, and HttpSettings have been moved from aws_config::provider_config to aws_smithy_client::http_connector. This is in preparation for a later PR that will change how connectors are created and configured. Also, I had to update the way that HttpSetting is created because it's a non-exhaustive struct.
BREAKING CHANGE HttpConnector::make_connector has been renamed to HttpConnector::connector in adherence with how we tend to name the methods on providers that return the thing the provider provides. I'm open to workshopping this name or even reverting this change if y'all don't think it's helpful.
As a result of the changes in point 7, aws_types now depends on aws_smithy_client.
aws_types::Config now has a builder + setter method for setting an HttpConnector. Nothing uses this yet, but it will be used when I do the actual "Config owns Connector" refactor in a later PR. I'm OK with removing this change for now if y'all think it would mislead people.

NOTE: This PR breaks our example for setting timeouts, I'll create a PR to the docs repo addressing that once this one is merged. It'll be a one-line change.

The next PR in this series will focus on an RFC for "Config owns Connector" + an implementation.

Testing

I ran the existing tests we had locally and in CI.

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

update: replace timeout::Settings with TimeoutConfig add: HttpConnector to aws_types::Config and Builder refactor: divide default_provider.rs modules into separate files

github-actions · 2022-02-01T20:05:15Z

A new doc preview is ready to view.

github-actions · 2022-02-01T20:06:52Z

A new generated diff is ready to view.

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

github-actions · 2022-02-02T17:13:00Z

A new doc preview is ready to view.

github-actions · 2022-02-02T17:14:01Z

A new generated diff is ready to view.

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

github-actions · 2022-02-02T17:14:18Z

A new doc preview is ready to view.

github-actions · 2022-02-02T17:16:09Z

A new generated diff is ready to view.

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

github-actions · 2022-02-02T18:48:39Z

A new doc preview is ready to view.

github-actions · 2022-02-02T18:48:50Z

A new generated diff is ready to view.

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

…nership

github-actions · 2022-02-02T18:55:30Z

A new doc preview is ready to view.

github-actions · 2022-02-02T18:56:06Z

A new generated diff is ready to view.

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

jdisanti · 2022-02-02T21:32:32Z

I love the splitting out the modules! I think that's going to make it easier to find things.

As a result of the changes in point 6, aws_types now depends on aws_smithy_client.

I understand why this is needed, but at the same time, I'm slightly concerned about tying aws-types to aws-smithy-client since we aim to keep aws-types as stable as possible (from the RFC it was introduced in, "aws-types should be an interface-only crate that is extremely stable").

Should we have an aws-types-like stable interface crate in the Smithy runtime to avoid locking ourselves into certain API decisions? Seems like aws-smithy-types could be this crate, and it does have the TimeoutConfig, so maybe that location makes sense.

Imports in several aws_config modules have be separated into separate groups (libstd imports, same-crate imports, aws and smithy runtime crates). This is an unspoken pattern that we've been following elsewhere.

It's unfortunate that the options to automate this in rustfmt still haven't been stabilized--perhaps we should opt into them anyway. I want to avoid developers changing import style back and forth as my tendency is to lump them all together alphabetically. I don't have a strong preference on the style used; just that its consistency should be enforced/corrected by a computer.

jdisanti

LGTM!

aws/rust-runtime/aws-config/src/lib.rs

remove: impl Default for HttpConnector

github-actions · 2022-02-03T22:16:18Z

A new generated diff is ready to view.

github-actions · 2022-02-03T22:16:33Z

A new doc preview is ready to view.

github-actions · 2022-02-03T22:18:48Z

A new generated diff is ready to view.

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

github-actions · 2022-02-03T22:19:13Z

A new doc preview is ready to view.

github-actions · 2022-02-03T22:40:24Z

A new doc preview is ready to view.

github-actions · 2022-02-03T22:41:23Z

A new generated diff is ready to view.

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

github-actions · 2022-02-04T15:50:51Z

A new generated diff is ready to view.

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

github-actions · 2022-02-04T15:50:57Z

A new doc preview is ready to view.

github-actions · 2022-02-04T16:20:12Z

A new generated diff is ready to view.

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

…nership

github-actions · 2022-02-04T20:01:16Z

A new generated diff is ready to view.

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

github-actions · 2022-02-04T20:01:45Z

A new doc preview is ready to view.

github-actions · 2022-02-04T20:01:59Z

A new doc preview is ready to view.

github-actions · 2022-02-04T20:02:36Z

A new generated diff is ready to view.

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

refactor: HttpSettings, HttpConnection location

1c65876

update: replace timeout::Settings with TimeoutConfig add: HttpConnector to aws_types::Config and Builder refactor: divide default_provider.rs modules into separate files

Velfi added 2 commits February 2, 2022 11:05

add: missing copyright headers

a8c6fb4

Merge branch 'main' into refactor/connector-ownership

8dd2f68

Velfi added 2 commits February 2, 2022 12:40

add: missing http_connector accessor to Config

737d3e4

remove: unused import

c902645

Merge remote-tracking branch 'origin/main' into refactor/connector-ow…

9154ed1

…nership

Velfi changed the title ~~HTTP Connectors Refactor (DRAFT)~~ HTTP Connectors Refactor pt.1 - Laying the groundwork Feb 2, 2022

Velfi marked this pull request as ready for review February 2, 2022 19:53

Velfi requested a review from a team as a code owner February 2, 2022 19:53

jdisanti approved these changes Feb 3, 2022

View reviewed changes

aws/rust-runtime/aws-config/src/lib.rs Outdated Show resolved Hide resolved

Velfi mentioned this pull request Feb 3, 2022

update: timeouts example for TimeoutConfig breaking change awsdocs/aws-doc-sdk-examples#2794

Merged

5 tasks

Velfi added 2 commits February 3, 2022 16:07

update: undo changes to aws_config::connector module

94506d4

remove: impl Default for HttpConnector

Merge branch 'main' into refactor/connector-ownership

7dadafd

Velfi enabled auto-merge (squash) February 3, 2022 22:14

Velfi disabled auto-merge February 3, 2022 22:14

update: CHANGELOG.next.toml

b5d719d

Velfi enabled auto-merge (squash) February 3, 2022 22:33

Merge branch 'main' into refactor/connector-ownership

96b9daf

remove: unused imports

9fee4ba

Velfi added 2 commits February 4, 2022 13:53

fix: incorrectly specified dependencies

d5bc067

Merge remote-tracking branch 'origin/main' into refactor/connector-ow…

45b9775

…nership

Velfi merged commit a1f0652 into main Feb 4, 2022

Velfi deleted the refactor/connector-ownership branch February 4, 2022 20:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HTTP Connectors Refactor pt.1 - Laying the groundwork #1144

HTTP Connectors Refactor pt.1 - Laying the groundwork #1144

Velfi commented Feb 1, 2022 •

edited

Loading

github-actions bot commented Feb 1, 2022

github-actions bot commented Feb 1, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

jdisanti commented Feb 2, 2022

jdisanti left a comment

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

HTTP Connectors Refactor pt.1 - Laying the groundwork #1144

HTTP Connectors Refactor pt.1 - Laying the groundwork #1144

Conversation

Velfi commented Feb 1, 2022 • edited Loading

Motivation and Context

Testing

github-actions bot commented Feb 1, 2022

github-actions bot commented Feb 1, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

github-actions bot commented Feb 2, 2022

jdisanti commented Feb 2, 2022

jdisanti left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 3, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

github-actions bot commented Feb 4, 2022

Velfi commented Feb 1, 2022 •

edited

Loading