test(core/protocols): document testing

Author: kuhe

packages/core/src/submodules/protocols/json/JsonShapeDeserializer.ts

@@ -1,4 +1,5 @@
-import { NormalizedSchema, SCHEMA } from "@smithy/core/schema";
+import { determineTimestampFormat } from "@smithy/core/protocols";
+import { NormalizedSchema, SCHEMA, TypeRegistry } from "@smithy/core/schema";
 import {
   LazyJsonString,
   NumericValue,
@@ -33,6 +34,22 @@ export class JsonShapeDeserializer extends SerdeContextConfig implements ShapeDe
     return this._read(schema, data);
   }
 
+  /**
+   * Attempts to use the discriminator on the data instead of requiring a
+   * schema as input.
+   */
+  public readDocument(data: DocumentType): any {
+    if (data && typeof data === "object" && typeof (data as any).__type === "string") {
+      const object = structuredClone(data as any);
+      const [namespace, name] = object.__type.split("#");
+      delete object.__type;
+      const schema = TypeRegistry.for(namespace).getSchema(name);
+      const ns = NormalizedSchema.of(schema);
+      return this.readObject(ns, object);
+    }
+    return this.readObject(SCHEMA.DOCUMENT, data);
+  }
+
   private _read(schema: Schema, value: unknown): any {
     const isObject = value !== null && typeof value === "object";
 
@@ -84,13 +101,8 @@ export class JsonShapeDeserializer extends SerdeContextConfig implements ShapeDe
       }
     }
 
-    if (ns.isTimestampSchema()) {
-      const options = this.settings.timestampFormat;
-      const format = options.useTrait
-        ? ns.getSchema() === SCHEMA.TIMESTAMP_DEFAULT
-          ? options.default
-          : ns.getSchema() ?? options.default
-        : options.default;
+    if (ns.isTimestampSchema() && value != null) {
+      const format = determineTimestampFormat(ns, this.settings);
       switch (format) {
         case SCHEMA.TIMESTAMP_DATE_TIME:
           return parseRfc3339DateTimeWithOffset(value);
@@ -126,6 +138,10 @@ export class JsonShapeDeserializer extends SerdeContextConfig implements ShapeDe
       }
     }
 
+    if (ns.isDocumentSchema()) {
+      return structuredClone(value);
+    }
+
     // covers string, numeric, boolean, document, bigDecimal
     return value;
   }

packages/core/src/submodules/protocols/json/JsonShapeSerializer.ts

@@ -1,6 +1,8 @@
+import { determineTimestampFormat } from "@smithy/core/protocols";
 import { NormalizedSchema, SCHEMA } from "@smithy/core/schema";
 import { dateToUtcString, generateIdempotencyToken, LazyJsonString } from "@smithy/core/serde";
 import { Schema, ShapeSerializer } from "@smithy/types";
+import { toBase64 } from "@smithy/util-base64";
 
 import { SerdeContextConfig } from "../ConfigurableSerdeContext";
 import { JsonSettings } from "./JsonCodec";
@@ -22,11 +24,22 @@ export class JsonShapeSerializer extends SerdeContextConfig implements ShapeSeri
     this.buffer = this._write(this.rootSchema, value);
   }
 
+  public writeDiscriminatedDocument(schema: Schema, value: unknown): void {
+    this.write(schema, value);
+    if (typeof this.buffer === "object") {
+      this.buffer.__type = NormalizedSchema.of(schema).getName(true);
+    }
+  }
+
   public flush(): string {
-    if (this.rootSchema?.isStructSchema() || this.rootSchema?.isDocumentSchema()) {
+    const { rootSchema } = this;
+    this.rootSchema = undefined;
+
+    if (rootSchema?.isStructSchema() || rootSchema?.isDocumentSchema()) {
       const replacer = new JsonReplacer();
       return replacer.replaceInJson(JSON.stringify(this.buffer, replacer.createReplacer(), 0));
     }
+    // non-struct root schema indicates a blob (base64 string) or plain string payload.
     return this.buffer;
   }
 
@@ -73,23 +86,21 @@ export class JsonShapeSerializer extends SerdeContextConfig implements ShapeSeri
       return void 0;
     }
 
-    if (ns.isBlobSchema() && (value instanceof Uint8Array || typeof value === "string")) {
+    if (
+      (ns.isBlobSchema() && (value instanceof Uint8Array || typeof value === "string")) ||
+      (ns.isDocumentSchema() && value instanceof Uint8Array)
+    ) {
       if (ns === this.rootSchema) {
         return value;
       }
       if (!this.serdeContext?.base64Encoder) {
-        throw new Error("Missing base64Encoder in serdeContext");
+        return toBase64(value);
       }
       return this.serdeContext?.base64Encoder(value);
     }
 
-    if (ns.isTimestampSchema() && value instanceof Date) {
-      const options = this.settings.timestampFormat;
-      const format = options.useTrait
-        ? ns.getSchema() === SCHEMA.TIMESTAMP_DEFAULT
-          ? options.default
-          : ns.getSchema() ?? options.default
-        : options.default;
+    if ((ns.isTimestampSchema() || ns.isDocumentSchema()) && value instanceof Date) {
+      const format = determineTimestampFormat(ns, this.settings);
       switch (format) {
         case SCHEMA.TIMESTAMP_DATE_TIME:
           return value.toISOString().replace(".000Z", "Z");
@@ -124,6 +135,10 @@ export class JsonShapeSerializer extends SerdeContextConfig implements ShapeSeri
       }
     }
 
+    if (ns.isDocumentSchema() && isObject) {
+      return structuredClone(value);
+    }
+
     return value;
   }
 }