RFC30: serde support for error metadata

rust-runtime/aws-smithy-types/src/error/metadata.rs

@@ -39,6 +39,14 @@ pub const EMPTY_ERROR_METADATA: ErrorMetadata = ErrorMetadata {
 /// For many services, Errors are modeled. However, many services only partially model errors or don't
 /// model errors at all. In these cases, the SDK will return this generic error type to expose the
 /// `code`, `message` and `request_id`.
+#[cfg_attr(
+    all(aws_sdk_unstable, feature = "serde-serialize"),
+    derive(serde::Serialize)
+)]
+#[cfg_attr(
+    all(aws_sdk_unstable, feature = "serde-deserialize"),
+    derive(serde::Deserialize)
+)]
 #[derive(Debug, Eq, PartialEq, Default, Clone)]
 pub struct ErrorMetadata {
     code: Option<String>,
@@ -53,8 +61,23 @@ impl ProvideErrorMetadata for ErrorMetadata {
 }
 
 /// Builder for [`ErrorMetadata`].
+#[cfg_attr(
+    all(aws_sdk_unstable, feature = "serde-serialize"),
+    derive(serde::Serialize)
+)]
+#[cfg_attr(
+    all(aws_sdk_unstable, feature = "serde-deserialize"),
+    derive(serde::Deserialize)
+)]
 #[derive(Debug, Default)]
 pub struct Builder {
+    #[cfg_attr(
+        any(
+            all(aws_sdk_unstable, feature = "serde-deserialize"),
+            all(aws_sdk_unstable, feature = "serde-serialize")
+        ),
+        serde(flatten)
+    )]
     inner: ErrorMetadata,
 }
 
@@ -170,3 +193,36 @@ impl fmt::Display for ErrorMetadata {
 }
 
 impl std::error::Error for ErrorMetadata {}
+
+#[cfg(all(
+    test,
+    any(
+        all(aws_sdk_unstable, feature = "serde-deserialize"),
+        all(aws_sdk_unstable, feature = "serde-serialize")
+    )
+))]
+mod test {
+    use super::*;
+
+    #[test]
+    /// tests de/ser on ErrorMetaData.
+    fn test_error_meta_data() {
+        let mut data = Builder::default()
+            .code("code")
+            .message("message")
+            .custom("hello", "world");
+        let ok = serde_json::to_string_pretty(&EMPTY_ERROR_METADATA).unwrap();
+        assert_eq!(
+            &ok,
+            include_str!("../../test-data/error_meta_data_empty.json")
+        );
+        assert_eq!(
+            serde_json::from_str(include_str!("../../test-data/error_meta_data.json")).unwrap(),
+            &data
+        );
+        assert_eq!(
+            serde_json::from_str(include_str!("../../test-data/error_meta_data.json")).unwrap(),
+            data.build()
+        );
+    }
+}

rust-runtime/aws-smithy-types/test_data/error_meta_data.json

@@ -0,0 +1,7 @@
+{
+    "code": "code",
+    "message": "message",
+    "extras": {
+        "hello": "world"
+    }
+}

rust-runtime/aws-smithy-types/test_data/error_meta_data_empty.json

@@ -0,0 +1,5 @@
+{
+    "code": null,
+    "message": null,
+    "extras": null
+}