Add new method to parse errortype from document, move error sanitizer to documentutils and add sanitizer for cbor

joewyz · joewyz · commit f3e898997da4 · 2025-12-03T14:18:09.000-08:00
diff --git a/aws/client/aws-client-awsjson/src/main/java/software/amazon/smithy/java/aws/client/awsjson/AwsJson11Protocol.java b/aws/client/aws-client-awsjson/src/main/java/software/amazon/smithy/java/aws/client/awsjson/AwsJson11Protocol.java
@@ -10,7 +10,7 @@
 import software.amazon.smithy.java.client.core.ClientProtocol;
 import software.amazon.smithy.java.client.core.ClientProtocolFactory;
 import software.amazon.smithy.java.client.core.ProtocolSettings;
-import software.amazon.smithy.java.json.ErrorTypeSanitizer;
+import software.amazon.smithy.java.core.serde.document.DocumentUtils;
 import software.amazon.smithy.model.shapes.ShapeId;
 
 /**
@@ -25,7 +25,7 @@ public final class AwsJson11Protocol extends AwsJsonProtocol {
      *                discriminator of documents that use relative shape IDs.
      */
     public AwsJson11Protocol(ShapeId service) {
-        super(TRAIT_ID, service, ErrorTypeSanitizer::removeNamespaceAndUri);
+        super(TRAIT_ID, service, DocumentUtils::removeNamespaceAndUri);
     }
 
     @Override
diff --git a/aws/client/aws-client-awsjson/src/main/java/software/amazon/smithy/java/aws/client/awsjson/AwsJson1Protocol.java b/aws/client/aws-client-awsjson/src/main/java/software/amazon/smithy/java/aws/client/awsjson/AwsJson1Protocol.java
@@ -10,7 +10,7 @@
 import software.amazon.smithy.java.client.core.ClientProtocol;
 import software.amazon.smithy.java.client.core.ClientProtocolFactory;
 import software.amazon.smithy.java.client.core.ProtocolSettings;
-import software.amazon.smithy.java.json.ErrorTypeSanitizer;
+import software.amazon.smithy.java.core.serde.document.DocumentUtils;
 import software.amazon.smithy.model.shapes.ShapeId;
 
 /**
@@ -25,7 +25,7 @@ public final class AwsJson1Protocol extends AwsJsonProtocol {
      *                discriminator of documents that use relative shape IDs.
      */
     public AwsJson1Protocol(ShapeId service) {
-        super(TRAIT_ID, service, ErrorTypeSanitizer::removeUri);
+        super(TRAIT_ID, service, DocumentUtils::removeUri);
     }
 
     @Override
diff --git a/aws/client/aws-client-restjson/src/main/java/software/amazon/smithy/java/aws/client/restjson/RestJsonClientProtocol.java b/aws/client/aws-client-restjson/src/main/java/software/amazon/smithy/java/aws/client/restjson/RestJsonClientProtocol.java
@@ -24,12 +24,12 @@
 import software.amazon.smithy.java.core.schema.SerializableStruct;
 import software.amazon.smithy.java.core.schema.TraitKey;
 import software.amazon.smithy.java.core.serde.Codec;
+import software.amazon.smithy.java.core.serde.document.DocumentUtils;
 import software.amazon.smithy.java.core.serde.event.EventDecoderFactory;
 import software.amazon.smithy.java.core.serde.event.EventEncoderFactory;
 import software.amazon.smithy.java.core.serde.event.EventStreamingException;
 import software.amazon.smithy.java.http.api.HttpRequest;
 import software.amazon.smithy.java.http.binding.RequestSerializer;
-import software.amazon.smithy.java.json.ErrorTypeSanitizer;
 import software.amazon.smithy.java.json.JsonCodec;
 import software.amazon.smithy.model.shapes.ShapeId;
 import software.amazon.smithy.model.shapes.ShapeType;
@@ -53,7 +53,7 @@ public RestJsonClientProtocol(ShapeId service) {
                 .useJsonName(true)
                 .useTimestampFormat(true)
                 .defaultNamespace(service.getNamespace())
-                .errorTypeSanitizer(ErrorTypeSanitizer::removeNamespaceAndUri)
+                .errorTypeSanitizer(DocumentUtils::removeNamespaceAndUri)
                 .build();
 
         this.errorDeserializer = HttpErrorDeserializer.builder()
diff --git a/client/client-http/src/main/java/software/amazon/smithy/java/client/http/HttpErrorDeserializer.java b/client/client-http/src/main/java/software/amazon/smithy/java/client/http/HttpErrorDeserializer.java
@@ -252,7 +252,7 @@ private static CallException makeErrorFromPayload(
 
             if (buffer.remaining() > 0) {
                 var document = codec.createDeserializer(buffer).readDocument();
-                var id = document.discriminator();
+                var id = document.parseErrorType();
                 var builder = typeRegistry.createBuilder(id, ModeledException.class);
                 if (builder != null) {
                     return knownErrorFactory.createErrorFromDocument(
diff --git a/codecs/cbor-codec/src/main/java/software/amazon/smithy/java/cbor/CborDocuments.java b/codecs/cbor-codec/src/main/java/software/amazon/smithy/java/cbor/CborDocuments.java
@@ -13,6 +13,7 @@
 import software.amazon.smithy.java.core.serde.ShapeSerializer;
 import software.amazon.smithy.java.core.serde.document.Document;
 import software.amazon.smithy.java.core.serde.document.DocumentDeserializer;
+import software.amazon.smithy.java.core.serde.document.DocumentUtils;
 import software.amazon.smithy.model.shapes.ShapeId;
 import software.amazon.smithy.model.shapes.ShapeType;
 import software.amazon.smithy.utils.SmithyInternalApi;
@@ -51,11 +52,13 @@ public ShapeType type() {
 
         @Override
         public ShapeId discriminator() {
-            String discriminator = null;
-            var member = values.get("__type");
-            if (member != null && member.type() == ShapeType.STRING) {
-                discriminator = member.asString();
-            }
+            var discriminator = extractType();
+            return DocumentDeserializer.parseDiscriminator(discriminator, settings.defaultNamespace());
+        }
+
+        @Override
+        public ShapeId parseErrorType() {
+            var discriminator = DocumentUtils.removeUri(extractType());
             return DocumentDeserializer.parseDiscriminator(discriminator, settings.defaultNamespace());
         }
 
@@ -102,6 +105,14 @@ public boolean equals(Object obj) {
         public int hashCode() {
             return values.hashCode();
         }
+
+        private String extractType() {
+            var member = values.get("__type");
+            if (member != null && member.type() == ShapeType.STRING) {
+                return member.asString();
+            }
+            return null;
+        }
     }
 
     /**
diff --git a/codecs/json-codec/src/main/java/software/amazon/smithy/java/json/ErrorTypeSanitizer.java b/codecs/json-codec/src/main/java/software/amazon/smithy/java/json/ErrorTypeSanitizer.java
diff --git a/codecs/json-codec/src/main/java/software/amazon/smithy/java/json/JsonDocuments.java b/codecs/json-codec/src/main/java/software/amazon/smithy/java/json/JsonDocuments.java
@@ -246,19 +246,29 @@ public ShapeType type() {
         @Override
         public ShapeId discriminator() {
             String discriminator = null;
+            var member = values.get("__type");
+            if (member != null && member.type() == ShapeType.STRING) {
+                discriminator = member.asString();
+            }
+            return DocumentDeserializer.parseDiscriminator(discriminator, settings.defaultNamespace());
+        }
+
+        @Override
+        public ShapeId parseErrorType() {
+            String errorType = null;
             var typeMember = values.get("__type");
             if (typeMember != null && typeMember.type() == ShapeType.STRING) {
-                discriminator = typeMember.asString();
+                errorType = typeMember.asString();
             } else {
                 var codeMember = values.get("code");
                 if (codeMember != null && codeMember.type() == ShapeType.STRING) {
-                    discriminator = codeMember.asString();
+                    errorType = codeMember.asString();
                 }
             }
             if (settings.errorTypeSanitizer() != null) {
-                discriminator = settings.errorTypeSanitizer().apply(discriminator);
+                errorType = settings.errorTypeSanitizer().apply(errorType);
             }
-            return DocumentDeserializer.parseDiscriminator(discriminator, settings.defaultNamespace());
+            return DocumentDeserializer.parseDiscriminator(errorType, settings.defaultNamespace());
         }
 
         @Override
diff --git a/codecs/json-codec/src/main/java/software/amazon/smithy/java/json/JsonSettings.java b/codecs/json-codec/src/main/java/software/amazon/smithy/java/json/JsonSettings.java
@@ -119,7 +119,8 @@ public boolean serializeTypeInDocuments() {
     }
 
     /**
-     * The error type sanitizer to use for {@code __type}. Default is null
+     * The error type sanitizer to use for {@code __type} or {@code code} when parsing the error discriminator.
+     * Default is null
      *
      * @return the sanitizer used or null
      */
diff --git a/core/src/main/java/software/amazon/smithy/java/core/serde/document/Document.java b/core/src/main/java/software/amazon/smithy/java/core/serde/document/Document.java
@@ -125,6 +125,18 @@ default ShapeId discriminator() {
         return null;
     }
 
+    /**
+     * Attempts to find and parse a sanitized shape ID from the document in the document's discriminator field.
+     *
+     * <p> The discriminator of an error can be represented by either the __type field or the code field
+     * based on the protocol.
+     *
+     * @return the parsed shape ID, or null if not found.
+     */
+    default ShapeId parseErrorType() {
+        return null;
+    }
+
     /**
      * Serializes the Document as a document value in the Smithy data model.
      *
diff --git a/core/src/main/java/software/amazon/smithy/java/core/serde/document/DocumentUtils.java b/core/src/main/java/software/amazon/smithy/java/core/serde/document/DocumentUtils.java
@@ -175,4 +175,44 @@ public static <T> T getMemberValue(Document container, Schema containerSchema, S
                             .id() + "`: " + e.getMessage());
         }
     }
+
+    /**
+     * Removes the trailing URI in {@code __type} field or {@code code} field of the document
+     *
+     * <p>For example, given {@code __type = "aws.protocoltests.restjson#FooError:http://abc.com"},
+     * protocols like restJSON should ignore the trailing URI and keep the namespace of the error type.
+     *
+     * @param text The error type string.
+     * @return The error type string without the trailing URI.
+     */
+    public static String removeUri(String text) {
+        if (text == null) {
+            return null;
+        }
+        var colon = text.indexOf(':');
+        if (colon > 0) {
+            text = text.substring(0, colon);
+        }
+        return text;
+    }
+
+    /**
+     * Removes the namespace and trailing URI in {@code __type} field or {@code code} field of the document
+     *
+     * <p>For example, given {@code __type = "aws.protocoltests.restjson#FooError:http://abc.com"},
+     * protocols like awsJSON 1.1 should ignore the namespace and the trailing URI of the error type.
+     *
+     * @param text The error type string.
+     * @return The error type string without the trailing URI.
+     */
+    public static String removeNamespaceAndUri(String text) {
+        if (text == null) {
+            return null;
+        }
+        var hash = text.indexOf('#');
+        if (hash > 0) {
+            text = text.substring(hash + 1);
+        }
+        return removeUri(text);
+    }
 }
diff --git a/core/src/test/java/software/amazon/smithy/java/core/serde/document/DocumentUtilsTest.java b/core/src/test/java/software/amazon/smithy/java/core/serde/document/DocumentUtilsTest.java
@@ -3,34 +3,35 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package software.amazon.smithy.java.json;
+package software.amazon.smithy.java.core.serde.document;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import org.junit.jupiter.api.Test;
 
-public class ErrorTypeSanitizerTest {
+public class DocumentUtilsTest {
     private static final String SIMPLE_TYPE = "FooError";
     private static final String TYPE_WITH_URI = "FooError:http://amazon.com/smithy/com.amazon.smithy.validate/";
     private static final String TYPE_WITH_NAMESPACE = "aws.protocoltests.restjson#FooError";
     private static final String TYPE_WITH_NAMESPACE_AND_URI =
             "aws.protocoltests.restjson#FooError:http://amazon.com/smithy/com.amazon.smithy.validate/";
+
     @Test
     public void testRemoveUri() {
         String expected = "FooError";
         String expectedWithNamespace = "aws.protocoltests.restjson#FooError";
-        assertEquals(expected, ErrorTypeSanitizer.removeUri(SIMPLE_TYPE));
-        assertEquals(expected, ErrorTypeSanitizer.removeUri(TYPE_WITH_URI));
-        assertEquals(expectedWithNamespace, ErrorTypeSanitizer.removeUri(TYPE_WITH_NAMESPACE));
-        assertEquals(expectedWithNamespace, ErrorTypeSanitizer.removeUri(TYPE_WITH_NAMESPACE_AND_URI));
+        assertEquals(expected, DocumentUtils.removeUri(SIMPLE_TYPE));
+        assertEquals(expected, DocumentUtils.removeUri(TYPE_WITH_URI));
+        assertEquals(expectedWithNamespace, DocumentUtils.removeUri(TYPE_WITH_NAMESPACE));
+        assertEquals(expectedWithNamespace, DocumentUtils.removeUri(TYPE_WITH_NAMESPACE_AND_URI));
     }
 
     @Test
     public void testRemoveNameSpaceAndUri() {
         String expected = "FooError";
-        assertEquals(expected, ErrorTypeSanitizer.removeNamespaceAndUri(SIMPLE_TYPE));
-        assertEquals(expected, ErrorTypeSanitizer.removeNamespaceAndUri(TYPE_WITH_URI));
-        assertEquals(expected, ErrorTypeSanitizer.removeNamespaceAndUri(TYPE_WITH_NAMESPACE));
-        assertEquals(expected, ErrorTypeSanitizer.removeNamespaceAndUri(TYPE_WITH_NAMESPACE_AND_URI));
+        assertEquals(expected, DocumentUtils.removeNamespaceAndUri(SIMPLE_TYPE));
+        assertEquals(expected, DocumentUtils.removeNamespaceAndUri(TYPE_WITH_URI));
+        assertEquals(expected, DocumentUtils.removeNamespaceAndUri(TYPE_WITH_NAMESPACE));
+        assertEquals(expected, DocumentUtils.removeNamespaceAndUri(TYPE_WITH_NAMESPACE_AND_URI));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,8 @@ public boolean serializeTypeInDocuments() {`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`/**`
`122`		`- * The error type sanitizer to use for {@code __type}. Default is null`
	`122`	`+ * The error type sanitizer to use for {@code __type} or {@code code} when parsing the error discriminator.`
	`123`	`+ * Default is null`
`123`	`124`	`*`
`124`	`125`	`* @return the sanitizer used or null`
`125`	`126`	`*/`