Move result and connection from aws-smithy-http to `aws-smithy-…

…runtime-api` (#3103)

## Motivation and Context
Implements #3092 

## Description
This PR moves the `connection` and `result` modules from
`aws-smithy-http` to `aws_smithy_runtime_api`. `SdkError` is primarily
used within the context of the orchestrator, hence
`aws_smithy_runtime_api` instead of `aws-smithy-types`.

Like the previous sibling PRs, type aliases for affected pub items are
left in `aws_smithy_http` for backwards compatibility. However, due to
lack of trait aliases, a trait `CreateUnhandledError` needs to be
consumed from `aws_smithy_runtime_api`.

This PR also updates existing places that consumed those moved types so
they now depend on `aws-smithy-runtime-api` to do so.

## Testing
Relied on the existing tests, which ensured no deprecated warnings of
using moved types from the old place were issued.

## Checklist
- [x] I have updated `CHANGELOG.next.toml` if I made changes to the
smithy-rs codegen or 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._

CHANGELOG.next.toml

@@ -498,3 +498,11 @@ message = "`ByteStream::poll_next` is now feature-gated. You can turn on a cargo
 references = ["smithy-rs#3033", "smithy-rs#3088"]
 meta = { "breaking" = true, "tada" = false, "bug" = false, "target" = "all" }
 author = "ysaito1001"
+
+[[smithy-rs]]
+message = """
+The [`connection`](https://docs.rs/aws-smithy-http/latest/aws_smithy_http/connection/index.html) and [`result`](https://docs.rs/aws-smithy-http/latest/aws_smithy_http/result/index.html) modules in `aws-smithy-http` have been moved to `aws-smithy-runtime-api`. Type aliases for all affected pub items, except for a trait, are left in `aws-smithy-http` for backwards compatibility but are deprecated. Due to lack of trait aliases, the moved trait `CreateUnhandledError` needs to be used from `aws-smithy-runtime-api`.
+"""
+references = ["smithy-rs#3092", "smithy-rs#3093"]
+meta = { "breaking" = true, "tada" = false, "bug" = false, "target" = "client" }
+author = "ysaito1001"

aws/rust-runtime/aws-config/external-types.toml

@@ -14,7 +14,7 @@ allowed_external_types = [
    "aws_smithy_async::time::TimeSource",
    "aws_smithy_http::endpoint",
    "aws_smithy_http::endpoint::error::InvalidEndpointError",
-   "aws_smithy_http::result::SdkError",
+   "aws_smithy_runtime_api::client::result::SdkError",
    "aws_smithy_runtime::client::identity::cache::IdentityCache",
    "aws_smithy_runtime::client::identity::cache::lazy::LazyCacheBuilder",
    "aws_smithy_runtime_api::client::dns::ResolveDns",

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

@@ -12,7 +12,6 @@ use crate::json_credentials::{parse_json_credentials, JsonCredentials, Refreshab
 use crate::provider_config::ProviderConfig;
 use aws_credential_types::provider::{self, error::CredentialsError};
 use aws_credential_types::Credentials;
-use aws_smithy_http::result::SdkError;
 use aws_smithy_runtime::client::orchestrator::operation::Operation;
 use aws_smithy_runtime::client::retries::classifiers::{
     HttpStatusCodeClassifier, TransientErrorClassifier,
@@ -22,6 +21,7 @@ use aws_smithy_runtime_api::client::interceptors::context::{Error, InterceptorCo
 use aws_smithy_runtime_api::client::orchestrator::{
     HttpResponse, OrchestratorError, SensitiveOutput,
 };
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry;
 use aws_smithy_runtime_api::client::retries::classifiers::RetryAction;
 use aws_smithy_runtime_api::client::runtime_plugin::StaticRuntimePlugin;

aws/rust-runtime/aws-config/src/imds/client.rs

@@ -13,8 +13,6 @@ use crate::provider_config::ProviderConfig;
 use crate::PKG_VERSION;
 use aws_http::user_agent::{ApiMetadata, AwsUserAgent};
 use aws_runtime::user_agent::UserAgentInterceptor;
-use aws_smithy_http::result::ConnectorError;
-use aws_smithy_http::result::SdkError;
 use aws_smithy_runtime::client::orchestrator::operation::Operation;
 use aws_smithy_runtime::client::retries::strategy::StandardRetryStrategy;
 use aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams;
@@ -25,6 +23,8 @@ use aws_smithy_runtime_api::client::interceptors::context::InterceptorContext;
 use aws_smithy_runtime_api::client::orchestrator::{
     HttpRequest, OrchestratorError, SensitiveOutput,
 };
+use aws_smithy_runtime_api::client::result::ConnectorError;
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_runtime_api::client::retries::classifiers::{
     ClassifyRetry, RetryAction, SharedRetryClassifier,
 };
@@ -582,7 +582,6 @@ pub(crate) mod test {
     use crate::provider_config::ProviderConfig;
     use aws_smithy_async::rt::sleep::TokioSleep;
     use aws_smithy_async::test_util::{instant_time_and_sleep, InstantSleep};
-    use aws_smithy_http::result::ConnectorError;
     use aws_smithy_runtime::client::http::test_util::{
         capture_request, ReplayEvent, StaticReplayClient,
     };
@@ -593,6 +592,7 @@ pub(crate) mod test {
     use aws_smithy_runtime_api::client::orchestrator::{
         HttpRequest, HttpResponse, OrchestratorError,
     };
+    use aws_smithy_runtime_api::client::result::ConnectorError;
     use aws_smithy_runtime_api::client::retries::classifiers::{ClassifyRetry, RetryAction};
     use aws_smithy_types::body::SdkBody;
     use aws_smithy_types::error::display::DisplayErrorContext;

aws/rust-runtime/aws-config/src/imds/client/error.rs

@@ -6,8 +6,8 @@
 //! Error types for [`ImdsClient`](crate::imds::client::Client)
 
 use aws_smithy_http::endpoint::error::InvalidEndpointError;
-use aws_smithy_http::result::SdkError;
 use aws_smithy_runtime_api::client::orchestrator::HttpResponse;
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_types::body::SdkBody;
 use std::error::Error;
 use std::fmt;

aws/rust-runtime/aws-config/src/sts/assume_role.rs

@@ -12,8 +12,8 @@ use aws_sdk_sts::operation::assume_role::builders::AssumeRoleFluentBuilder;
 use aws_sdk_sts::operation::assume_role::AssumeRoleError;
 use aws_sdk_sts::types::PolicyDescriptorType;
 use aws_sdk_sts::Client as StsClient;
-use aws_smithy_http::result::SdkError;
 use aws_smithy_runtime::client::identity::IdentityCache;
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_types::error::display::DisplayErrorContext;
 use aws_types::region::Region;
 use aws_types::SdkConfig;

aws/rust-runtime/aws-http/Cargo.toml

@@ -9,6 +9,7 @@ repository = "https://github.com/awslabs/smithy-rs"
 
 [dependencies]
 aws-smithy-http = { path = "../../../rust-runtime/aws-smithy-http" }
+aws-smithy-runtime-api = { path = "../../../rust-runtime/aws-smithy-runtime-api", features = ["client"] }
 aws-smithy-types = { path = "../../../rust-runtime/aws-smithy-types" }
 aws-types = { path = "../aws-types" }
 bytes = "1.1"

aws/rust-runtime/aws-http/src/request_id.rs

@@ -4,7 +4,7 @@
  */
 
 use aws_smithy_http::http::HttpHeaders;
-use aws_smithy_http::result::SdkError;
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_types::error::metadata::{
     Builder as ErrorMetadataBuilder, ErrorMetadata, ProvideErrorMetadata,
 };

aws/rust-runtime/aws-inlineable/src/s3_request_id.rs

@@ -4,7 +4,7 @@
  */
 
 use aws_smithy_http::http::HttpHeaders;
-use aws_smithy_http::result::SdkError;
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_types::error::metadata::{
     Builder as ErrorMetadataBuilder, ErrorMetadata, ProvideErrorMetadata,
 };
@@ -94,7 +94,7 @@ fn extract_extended_request_id(headers: &HeaderMap<HeaderValue>) -> Option<&str>
 #[cfg(test)]
 mod test {
     use super::*;
-    use aws_smithy_http::result::SdkError;
+    use aws_smithy_runtime_api::client::result::SdkError;
     use aws_smithy_types::body::SdkBody;
     use http::Response;
 

aws/rust-runtime/aws-types/Cargo.toml

@@ -17,7 +17,6 @@ aws-smithy-async = { path = "../../../rust-runtime/aws-smithy-async" }
 aws-smithy-types = { path = "../../../rust-runtime/aws-smithy-types" }
 aws-smithy-runtime = { path = "../../../rust-runtime/aws-smithy-runtime", optional = true }
 aws-smithy-runtime-api = { path = "../../../rust-runtime/aws-smithy-runtime-api", features = ["client"] }
-aws-smithy-http = { path = "../../../rust-runtime/aws-smithy-http" }
 tracing = "0.1"
 http = "0.2.6"
 # cargo does not support optional test dependencies, so to completely disable rustls

aws/sdk/integration-tests/kms/tests/integration.rs

@@ -5,8 +5,8 @@
 
 use aws_sdk_kms as kms;
 use aws_sdk_kms::operation::RequestId;
-use aws_smithy_http::result::SdkError;
 use aws_smithy_runtime::client::http::test_util::{ReplayEvent, StaticReplayClient};
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_types::body::SdkBody;
 use http::header::AUTHORIZATION;
 use http::Uri;

aws/sdk/integration-tests/kms/tests/retryable_errors.rs

@@ -6,10 +6,10 @@
 use aws_credential_types::Credentials;
 use aws_runtime::retries::classifiers::AwsErrorCodeClassifier;
 use aws_sdk_kms as kms;
-use aws_smithy_http::result::SdkError;
 use aws_smithy_runtime::client::http::test_util::infallible_client_fn;
 use aws_smithy_runtime_api::client::interceptors::context::{Error, Input, InterceptorContext};
 use aws_smithy_runtime_api::client::orchestrator::{HttpResponse, OrchestratorError};
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_runtime_api::client::retries::classifiers::{ClassifyRetry, RetryAction};
 use bytes::Bytes;
 use kms::operation::create_alias::CreateAliasError;

aws/sdk/integration-tests/s3/tests/alternative-async-runtime.rs

@@ -13,9 +13,9 @@ use aws_sdk_s3::types::{
 use aws_sdk_s3::{Client, Config};
 use aws_smithy_async::assert_elapsed;
 use aws_smithy_async::rt::sleep::{AsyncSleep, SharedAsyncSleep, Sleep};
-use aws_smithy_http::result::SdkError;
 use aws_smithy_runtime::client::http::test_util::NeverClient;
 use aws_smithy_runtime::test_util::capture_test_logs::capture_test_logs;
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_types::error::display::DisplayErrorContext;
 use aws_smithy_types::timeout::TimeoutConfig;
 use std::fmt::Debug;

aws/sdk/integration-tests/s3/tests/query-strings-are-correctly-encoded.rs

@@ -60,7 +60,7 @@ async fn test_s3_signer_query_string_with_all_valid_chars() {
 #[ignore]
 async fn test_query_strings_are_correctly_encoded() {
     use aws_sdk_s3::operation::list_objects_v2::ListObjectsV2Error;
-    use aws_smithy_http::result::SdkError;
+    use aws_smithy_runtime_api::client::result::SdkError;
 
     tracing_subscriber::fmt::init();
     let config = aws_config::load_from_env().await;

aws/sdk/integration-tests/s3/tests/service_timeout_overrides.rs

@@ -6,7 +6,7 @@
 use aws_credential_types::provider::SharedCredentialsProvider;
 use aws_credential_types::Credentials;
 use aws_smithy_async::rt::sleep::{SharedAsyncSleep, TokioSleep};
-use aws_smithy_http::result::SdkError;
+use aws_smithy_runtime_api::client::result::SdkError;
 use aws_smithy_types::timeout::TimeoutConfig;
 use aws_types::region::Region;
 use aws_types::SdkConfig;

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customize/RequiredCustomizations.kt

@@ -92,13 +92,14 @@ class RequiredCustomizations : ClientCodegenDecorator {
             rustTemplate(
                 """
                 /// Error type returned by the client.
-                pub use #{SdkError};
+                pub type SdkError<E, R = #{R}> = #{SdkError}<E, R>;
 
                 pub use #{DisplayErrorContext};
                 pub use #{ProvideErrorMetadata};
                 """,
                 "DisplayErrorContext" to RuntimeType.smithyTypes(rc).resolve("error::display::DisplayErrorContext"),
                 "ProvideErrorMetadata" to RuntimeType.smithyTypes(rc).resolve("error::metadata::ProvideErrorMetadata"),
+                "R" to RuntimeType.smithyRuntimeApi(rc).resolve("client::orchestrator::HttpResponse"),
                 "SdkError" to RuntimeType.sdkError(rc),
             )
         }

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/generators/client/FluentClientGenerator.kt

@@ -264,7 +264,6 @@ class FluentClientGenerator(
                 "OperationError" to errorType,
                 "OperationOutput" to outputType,
                 "SdkError" to RuntimeType.sdkError(runtimeConfig),
-                "SdkSuccess" to RuntimeType.sdkSuccess(runtimeConfig),
             )
         }
 

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/generators/error/OperationErrorGenerator.kt

@@ -54,7 +54,7 @@ class OperationErrorGenerator(
     private val runtimeConfig = symbolProvider.config.runtimeConfig
     private val errorMetadata = errorMetadata(symbolProvider.config.runtimeConfig)
     private val createUnhandledError =
-        RuntimeType.smithyHttp(runtimeConfig).resolve("result::CreateUnhandledError")
+        RuntimeType.smithyRuntimeApi(runtimeConfig).resolve("client::result::CreateUnhandledError")
 
     private fun operationErrors(): List<StructureShape> =
         (operationOrEventStream as OperationShape).operationErrors(model).map { it.asStructureShape().get() }

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

@@ -357,6 +357,9 @@ data class RuntimeType(val path: String, val dependency: RustDependency? = null)
         fun boxError(runtimeConfig: RuntimeConfig): RuntimeType =
             smithyRuntimeApi(runtimeConfig).resolve("box_error::BoxError")
 
+        fun sdkError(runtimeConfig: RuntimeConfig): RuntimeType =
+            smithyRuntimeApi(runtimeConfig).resolve("client::result::SdkError")
+
         fun intercept(runtimeConfig: RuntimeConfig): RuntimeType =
             smithyRuntimeApi(runtimeConfig).resolve("client::interceptors::Intercept")
 
@@ -436,9 +439,6 @@ data class RuntimeType(val path: String, val dependency: RustDependency? = null)
 
         fun queryFormat(runtimeConfig: RuntimeConfig, func: String) = smithyHttp(runtimeConfig).resolve("query::$func")
         fun sdkBody(runtimeConfig: RuntimeConfig): RuntimeType = smithyTypes(runtimeConfig).resolve("body::SdkBody")
-        fun sdkError(runtimeConfig: RuntimeConfig): RuntimeType = smithyHttp(runtimeConfig).resolve("result::SdkError")
-        fun sdkSuccess(runtimeConfig: RuntimeConfig): RuntimeType =
-            smithyHttp(runtimeConfig).resolve("result::SdkSuccess")
 
         fun parseTimestampFormat(
             codegenTarget: CodegenTarget,

rust-runtime/aws-smithy-http/Cargo.toml

@@ -16,6 +16,7 @@ rt-tokio = ["aws-smithy-types/rt-tokio"]
 
 [dependencies]
 aws-smithy-eventstream = { path = "../aws-smithy-eventstream", optional = true }
+aws-smithy-runtime-api = { path = "../aws-smithy-runtime-api", features = ["client"] }
 aws-smithy-types = { path = "../aws-smithy-types", features = ["byte-stream-poll-next", "http-body-0-4-x"] }
 bytes = "1"
 bytes-utils = "0.1"

rust-runtime/aws-smithy-http/external-types.toml

@@ -1,4 +1,5 @@
 allowed_external_types = [
+    "aws_smithy_runtime_api::*",
     "aws_smithy_types::*",
     "bytes::bytes::Bytes",
     "http::error::Error",

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

@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-//TODO(runtimeCratesVersioningCleanup): Re-point those who use the deprecated type aliases to
-// directly depend on `aws_smithy_types` and remove this module.
+//TODO(runtimeCratesVersioningCleanup): Keep the following deprecated type aliases for at least
+// one release since 0.56.1 and then remove this module.
 
 //! Types for representing the body of an HTTP request or response
 

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

@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-//TODO(runtimeCratesVersioningCleanup): Re-point those who use the deprecated type aliases to
-// directly depend on `aws_smithy_types` and remove this module.
+//TODO(runtimeCratesVersioningCleanup): Keep the following deprecated type aliases for at least
+// one release since 0.56.1 and then remove this module.
 
 //! ByteStream Abstractions
 

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

@@ -3,51 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-//! Types related to connection monitoring and management.
+//TODO(runtimeCratesVersioningCleanup): Keep the following deprecated type alias for at least
+// one release since 0.56.1 and then remove this module.
 
-use std::fmt::{Debug, Formatter};
-use std::net::SocketAddr;
-use std::sync::Arc;
+//! Types related to connection monitoring and management.
 
 /// Metadata that tracks the state of an active connection.
-#[derive(Clone)]
-pub struct ConnectionMetadata {
-    is_proxied: bool,
-    remote_addr: Option<SocketAddr>,
-    poison_fn: Arc<dyn Fn() + Send + Sync>,
-}
-
-impl ConnectionMetadata {
-    /// Poison this connection, ensuring that it won't be reused.
-    pub fn poison(&self) {
-        tracing::info!("smithy connection was poisoned");
-        (self.poison_fn)()
-    }
-
-    /// Create a new [`ConnectionMetadata`].
-    pub fn new(
-        is_proxied: bool,
-        remote_addr: Option<SocketAddr>,
-        poison: impl Fn() + Send + Sync + 'static,
-    ) -> Self {
-        Self {
-            is_proxied,
-            remote_addr,
-            poison_fn: Arc::new(poison),
-        }
-    }
-
-    /// Get the remote address for this connection, if one is set.
-    pub fn remote_addr(&self) -> Option<SocketAddr> {
-        self.remote_addr
-    }
-}
-
-impl Debug for ConnectionMetadata {
-    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
-        f.debug_struct("SmithyConnection")
-            .field("is_proxied", &self.is_proxied)
-            .field("remote_addr", &self.remote_addr)
-            .finish()
-    }
-}
+#[deprecated(note = "Moved to `aws_smithy_runtime_api::client::connection::ConnectionMetadata`.")]
+pub type ConnectionMetadata = aws_smithy_runtime_api::client::connection::ConnectionMetadata;

rust-runtime/aws-smithy-http/src/event_stream/receiver.rs

@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-use crate::result::{ConnectorError, SdkError};
 use aws_smithy_eventstream::frame::{
     DecodedFrame, Message, MessageFrameDecoder, UnmarshallMessage, UnmarshalledMessage,
 };
+use aws_smithy_runtime_api::client::result::{ConnectorError, SdkError};
 use aws_smithy_types::body::SdkBody;
 use bytes::Buf;
 use bytes::Bytes;
@@ -276,9 +276,9 @@ impl<T, E> Receiver<T, E> {
 #[cfg(test)]
 mod tests {
     use super::{Receiver, UnmarshallMessage};
-    use crate::result::SdkError;
     use aws_smithy_eventstream::error::Error as EventStreamError;
     use aws_smithy_eventstream::frame::{Header, HeaderValue, Message, UnmarshalledMessage};
+    use aws_smithy_runtime_api::client::result::SdkError;
     use aws_smithy_types::body::SdkBody;
     use bytes::Bytes;
     use hyper::body::Body;

rust-runtime/aws-smithy-http/src/event_stream/sender.rs

@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-use crate::result::SdkError;
 use aws_smithy_eventstream::frame::{MarshallMessage, SignMessage};
+use aws_smithy_runtime_api::client::result::SdkError;
 use bytes::Bytes;
 use futures_core::Stream;
 use std::error::Error as StdError;
@@ -140,7 +140,8 @@ impl<T, E: StdError + Send + Sync + 'static> MessageStreamAdapter<T, E> {
 }
 
 impl<T, E: StdError + Send + Sync + 'static> Stream for MessageStreamAdapter<T, E> {
-    type Item = Result<Bytes, SdkError<E>>;
+    type Item =
+        Result<Bytes, SdkError<E, aws_smithy_runtime_api::client::orchestrator::HttpResponse>>;
 
     fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
         match self.stream.as_mut().poll_next(cx) {
@@ -195,12 +196,12 @@ impl<T, E: StdError + Send + Sync + 'static> Stream for MessageStreamAdapter<T,
 mod tests {
     use super::MarshallMessage;
     use crate::event_stream::{EventStreamSender, MessageStreamAdapter};
-    use crate::result::SdkError;
     use async_stream::stream;
     use aws_smithy_eventstream::error::Error as EventStreamError;
     use aws_smithy_eventstream::frame::{
         Header, HeaderValue, Message, NoOpSigner, SignMessage, SignMessageError,
     };
+    use aws_smithy_runtime_api::client::result::SdkError;
     use bytes::Bytes;
     use futures_core::Stream;
     use futures_util::stream::StreamExt;