[smithy-rs] feature: Invocation ID interceptor (#2626)

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here -->
part of #1793

## Description
<!--- Describe your changes in detail -->
This adds an interceptor for AWS SDK requests. The interceptor is run
just before the retry loop and adds a header with name
`amz-sdk-invocation-id` and value that's a UUID. AWS services use this
identifier to more efficiently process requests.

## Testing
<!--- Please describe in detail how you tested your changes -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->
This change includes tests

----

_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: John DiSanti <jdisanti@amazon.com>

Author: 2 people

sdk/aws-runtime/Cargo.toml

@@ -45,6 +45,10 @@ version = "0.55.2"
 path = "../aws-types"
 version = "0.55.2"
 
+[dependencies.uuid]
+version = "1"
+features = ["v4", "fast-rng"]
+
 [dev-dependencies]
 proptest = "1"
 serde_json = "1"

sdk/aws-runtime/src/invocation_id.rs

@@ -0,0 +1,91 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+use aws_smithy_runtime_api::client::interceptors::error::BoxError;
+use aws_smithy_runtime_api::client::interceptors::{Interceptor, InterceptorContext};
+use aws_smithy_runtime_api::client::orchestrator::{HttpRequest, HttpResponse};
+use aws_smithy_runtime_api::config_bag::ConfigBag;
+use http::{HeaderName, HeaderValue};
+use uuid::Uuid;
+
+#[allow(clippy::declare_interior_mutable_const)] // we will never mutate this
+const AMZ_SDK_INVOCATION_ID: HeaderName = HeaderName::from_static("amz-sdk-invocation-id");
+
+/// This interceptor generates a UUID and attaches it to all request attempts made as part of this operation.
+#[non_exhaustive]
+#[derive(Debug)]
+pub struct InvocationIdInterceptor {
+    id: HeaderValue,
+}
+
+impl InvocationIdInterceptor {
+    /// Creates a new `InvocationIdInterceptor`
+    pub fn new() -> Self {
+        Self::default()
+    }
+}
+
+impl Default for InvocationIdInterceptor {
+    fn default() -> Self {
+        let id = Uuid::new_v4();
+        let id = id
+            .to_string()
+            .parse()
+            .expect("UUIDs always produce a valid header value");
+        Self { id }
+    }
+}
+
+impl Interceptor<HttpRequest, HttpResponse> for InvocationIdInterceptor {
+    fn modify_before_retry_loop(
+        &self,
+        context: &mut InterceptorContext<HttpRequest, HttpResponse>,
+        _cfg: &mut ConfigBag,
+    ) -> Result<(), BoxError> {
+        let headers = context.request_mut()?.headers_mut();
+        headers.append(AMZ_SDK_INVOCATION_ID, self.id.clone());
+        Ok(())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::invocation_id::InvocationIdInterceptor;
+    use aws_smithy_http::body::SdkBody;
+    use aws_smithy_runtime_api::client::interceptors::{Interceptor, InterceptorContext};
+    use aws_smithy_runtime_api::client::orchestrator::{HttpRequest, HttpResponse};
+    use aws_smithy_runtime_api::config_bag::ConfigBag;
+    use aws_smithy_runtime_api::type_erasure::TypedBox;
+    use http::HeaderValue;
+
+    fn expect_header<'a>(
+        context: &'a InterceptorContext<HttpRequest, HttpResponse>,
+        header_name: &str,
+    ) -> &'a HeaderValue {
+        context
+            .request()
+            .unwrap()
+            .headers()
+            .get(header_name)
+            .unwrap()
+    }
+
+    #[test]
+    fn test_id_is_generated_and_set() {
+        let mut context = InterceptorContext::new(TypedBox::new("doesntmatter").erase());
+        context.set_request(http::Request::builder().body(SdkBody::empty()).unwrap());
+
+        let mut config = ConfigBag::base();
+        let interceptor = InvocationIdInterceptor::new();
+        interceptor
+            .modify_before_retry_loop(&mut context, &mut config)
+            .unwrap();
+
+        let header = expect_header(&context, "amz-sdk-invocation-id");
+        assert_eq!(&interceptor.id, header);
+        // UUID should include 32 chars and 4 dashes
+        assert_eq!(interceptor.id.len(), 36);
+    }
+}

sdk/aws-runtime/src/lib.rs

@@ -24,3 +24,6 @@ pub mod recursion_detection;
 
 /// Supporting code for user agent headers in the AWS SDK.
 pub mod user_agent;
+
+/// Supporting code for invocation ID headers in the AWS SDK.
+pub mod invocation_id;

versions.toml

@@ -1,4 +1,4 @@
-smithy_rs_revision = '826d89b2c89a6044a9d70576a28304d6c2f366fb'
+smithy_rs_revision = '631ff01637ee9a6aa2a054a78d4c0250ff7f83a5'
 aws_doc_sdk_examples_revision = 'f4fc46139c2ea0784e31cadd19b430fcd2bbc21a'
 
 [manual_interventions]
@@ -31,7 +31,7 @@ source_hash = '5af5b63b3528ac874a7ecb6487f4e6c66d4d90a54116a1b0b5f5e477850bf503'
 [crates.aws-runtime]
 category = 'AwsRuntime'
 version = '0.55.2'
-source_hash = '4fd0645b2def7769d26850f668ca7c0d7908afcfa7e529639b4e60da430a3077'
+source_hash = '2591913d93a1358cff023ca731a93760f154dc35d6b8527c18bcfca044afb175'
 
 [crates.aws-runtime-api]
 category = 'AwsRuntime'