rework schemas

Author: kuhe

packages/core/src/submodules/cbor/CborCodec.ts

@@ -1,15 +1,6 @@
-import { deref, ListSchema, MapSchema, StructureSchema } from "@smithy/core/schema";
+import { NormalizedSchema } from "@smithy/core/schema";
 import { copyDocumentWithTransform, parseEpochTimestamp } from "@smithy/core/serde";
-import {
-  Codec,
-  MemberSchema,
-  Schema,
-  SchemaRef,
-  SerdeContext,
-  ShapeDeserializer,
-  ShapeSerializer,
-  TraitsSchema,
-} from "@smithy/types";
+import { Codec, Schema, SchemaRef, SerdeContext, ShapeDeserializer, ShapeSerializer } from "@smithy/types";
 
 import { cbor } from "./cbor";
 import { dateToTag } from "./parseCborBody";
@@ -22,6 +13,7 @@ export class CborCodec implements Codec<Uint8Array, Uint8Array> {
     serializer.setSerdeContext(this.serdeContext!);
     return serializer;
   }
+
   public createDeserializer(): CborShapeDeserializer {
     const deserializer = new CborShapeDeserializer();
     deserializer.setSerdeContext(this.serdeContext!);
@@ -46,17 +38,19 @@ export class CborShapeSerializer implements ShapeSerializer<Uint8Array> {
       if (_ instanceof Date) {
         return dateToTag(_);
       }
-      const schema = deref((schemaRef as MemberSchema)?.[0] ?? schemaRef);
       if (_ instanceof Uint8Array) {
         return _;
       }
-      const sparse = (schema as TraitsSchema)?.traits?.sparse;
+
+      const ns = NormalizedSchema.of(schemaRef);
+      const sparse = !!ns.getMergedTraits().sparse;
+
       if (Array.isArray(_)) {
         if (!sparse) {
           return _.filter((item) => item != null);
         }
       } else if (_ && typeof _ === "object") {
-        if (!sparse) {
+        if (!sparse || ns.isStructSchema()) {
           for (const [k, v] of Object.entries(_)) {
             if (v == null) {
               delete _[k];
@@ -65,6 +59,7 @@ export class CborShapeSerializer implements ShapeSerializer<Uint8Array> {
           return _;
         }
       }
+
       return _;
     });
   }
@@ -88,15 +83,20 @@ export class CborShapeDeserializer implements ShapeDeserializer {
     return this.readValue(schema, data);
   }
 
-  private readValue(schema: Schema, value: any): any {
-    if (typeof schema === "string") {
-      if (schema === "time" || schema === "epoch-seconds" || schema === "date-time") {
+  private readValue(_schema: Schema, value: any): any {
+    const ns = NormalizedSchema.of(_schema);
+    const schema = ns.getSchema();
+
+    if (typeof schema === "number") {
+      if (ns.isTimestampSchema()) {
+        // format is ignored.
         return parseEpochTimestamp(value);
       }
-      if (schema === "blob" || schema === "streaming-blob") {
+      if (ns.isBlobSchema()) {
         return value;
       }
     }
+
     switch (typeof value) {
       case "undefined":
       case "boolean":
@@ -116,38 +116,44 @@ export class CborShapeDeserializer implements ShapeDeserializer {
         if (value instanceof Date) {
           return value;
         }
-        const traits =
-          Array.isArray(schema) && schema.length >= 2
-            ? {
-                ...(deref((schema as MemberSchema)[0]) as TraitsSchema)?.traits,
-                ...(schema as MemberSchema)[1],
-              }
-            : (deref(schema) as TraitsSchema)?.traits;
-
-        if (Array.isArray(value)) {
+        if (ns.isDocumentSchema()) {
+          return value;
+        }
+
+        if (ns.isListSchema()) {
           const newArray = [];
+          const memberSchema = ns.getValueSchema();
+          const sparse = ns.isListSchema() && !!ns.getMergedTraits().sparse;
+
           for (const item of value) {
-            newArray.push(this.readValue(schema instanceof ListSchema ? deref(schema.valueSchema) : void 0, item));
-            if (!traits?.sparse) {
-              if (newArray[newArray.length - 1] == null) {
-                newArray.pop();
-              }
+            newArray.push(this.readValue(memberSchema, item));
+            if (!sparse && newArray[newArray.length - 1] == null) {
+              newArray.pop();
             }
           }
           return newArray;
         }
 
         const newObject = {} as any;
-        for (const key of Object.keys(value)) {
-          const targetSchema =
-            schema instanceof StructureSchema
-              ? deref(schema.members[key]?.[0])
-              : schema instanceof MapSchema
-                ? deref(schema.valueSchema)
-                : void 0;
-          newObject[key] = this.readValue(targetSchema, value[key]);
-          if (!traits?.sparse && newObject[key] == null) {
-            delete newObject[key];
+
+        if (ns.isMapSchema()) {
+          const sparse = ns.getMergedTraits().sparse;
+          const targetSchema = ns.getValueSchema();
+
+          for (const key of Object.keys(value)) {
+            newObject[key] = this.readValue(targetSchema, value[key]);
+
+            if (newObject[key] == null && !sparse) {
+              delete newObject[key];
+            }
+          }
+        } else if (ns.isStructSchema()) {
+          for (const key of Object.keys(value)) {
+            const targetSchema = ns.getMemberSchema(key);
+            if (targetSchema === undefined) {
+              continue;
+            }
+            newObject[key] = this.readValue(targetSchema, value[key]);
           }
         }
         return newObject;

packages/core/src/submodules/cbor/SmithyRpcV2CborProtocol.spec.ts

@@ -154,10 +154,10 @@ describe(SmithyRpcV2CborProtocol.name, () => {
         const protocol = new SmithyRpcV2CborProtocol();
         const httpRequest = await protocol.serializeRequest(
           {
+            name: "dummy",
             input: testCase.schema,
             output: void 0,
             traits: {},
-            errors: [],
           },
           testCase.input,
           {
@@ -249,10 +249,10 @@ describe(SmithyRpcV2CborProtocol.name, () => {
         const protocol = new SmithyRpcV2CborProtocol();
         const output = await protocol.deserializeResponse(
           {
+            name: "dummy",
             input: void 0,
             output: testCase.schema,
             traits: {},
-            errors: [],
           },
           {},
           new HttpResponse({

packages/core/src/submodules/cbor/SmithyRpcV2CborProtocol.ts

@@ -1,4 +1,4 @@
-import { HttpInterceptingShapeSerializer,HttpProtocol } from "@smithy/core/protocols";
+import { HttpInterceptingShapeSerializer, RpcProtocol } from "@smithy/core/protocols";
 import { deref, ErrorSchema, OperationSchema, TypeRegistry } from "@smithy/core/schema";
 import type {
   HandlerExecutionContext,
@@ -12,7 +12,7 @@ import { getSmithyContext } from "@smithy/util-middleware";
 import { CborCodec, CborShapeSerializer } from "./CborCodec";
 import { loadSmithyRpcV2CborErrorCode } from "./parseCborBody";
 
-export class SmithyRpcV2CborProtocol extends HttpProtocol {
+export class SmithyRpcV2CborProtocol extends RpcProtocol {
   private codec = new CborCodec();
   protected serializer = new HttpInterceptingShapeSerializer<CborShapeSerializer>(this.codec.createSerializer());
   protected deserializer = this.codec.createDeserializer();
@@ -36,6 +36,10 @@ export class SmithyRpcV2CborProtocol extends HttpProtocol {
       delete request.body;
       delete request.headers["content-type"];
     } else {
+      if (!request.body) {
+        this.serializer.write(15, {});
+        request.body = this.serializer.flush();
+      }
       try {
         request.headers["content-length"] = String((request.body as Uint8Array).byteLength);
       } catch (e) {}
@@ -82,6 +86,7 @@ export class SmithyRpcV2CborProtocol extends HttpProtocol {
       // TODO(schema) throw client base exception using the dataObject.
       throw new Error("schema not found for " + error);
     }
+
     const message = dataObject.message ?? dataObject.Message ?? "Unknown";
     const exception = new errorSchema.ctor(message);
     Object.assign(exception, {