feat(core): add rpcv2 cbor runtime protocol

Author: kuhe

.changeset/pretty-cows-call.md

@@ -0,0 +1,5 @@
+---
+"@smithy/core": minor
+---
+
+add cbor protocol (alpha)

packages/core/package.json

@@ -72,6 +72,7 @@
     "@smithy/middleware-serde": "workspace:^",
     "@smithy/protocol-http": "workspace:^",
     "@smithy/types": "workspace:^",
+    "@smithy/util-base64": "workspace:^",
     "@smithy/util-body-length-browser": "workspace:^",
     "@smithy/util-middleware": "workspace:^",
     "@smithy/util-stream": "workspace:^",

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

@@ -0,0 +1,173 @@
+import { NormalizedSchema } from "@smithy/core/schema";
+import { copyDocumentWithTransform, parseEpochTimestamp } from "@smithy/core/serde";
+import { Codec, Schema, SchemaRef, SerdeFunctions, ShapeDeserializer, ShapeSerializer } from "@smithy/types";
+
+import { cbor } from "./cbor";
+import { dateToTag } from "./parseCborBody";
+
+/**
+ * @alpha
+ */
+export class CborCodec implements Codec<Uint8Array, Uint8Array> {
+  private serdeContext?: SerdeFunctions;
+
+  public createSerializer(): CborShapeSerializer {
+    const serializer = new CborShapeSerializer();
+    serializer.setSerdeContext(this.serdeContext!);
+    return serializer;
+  }
+
+  public createDeserializer(): CborShapeDeserializer {
+    const deserializer = new CborShapeDeserializer();
+    deserializer.setSerdeContext(this.serdeContext!);
+    return deserializer;
+  }
+
+  public setSerdeContext(serdeContext: SerdeFunctions): void {
+    this.serdeContext = serdeContext;
+  }
+}
+
+/**
+ * @alpha
+ */
+export class CborShapeSerializer implements ShapeSerializer {
+  private serdeContext?: SerdeFunctions;
+  private value: unknown;
+
+  public setSerdeContext(serdeContext: SerdeFunctions) {
+    this.serdeContext = serdeContext;
+  }
+
+  public write(schema: Schema, value: unknown): void {
+    this.value = copyDocumentWithTransform(value, schema, (_: any, schemaRef: SchemaRef) => {
+      if (_ instanceof Date) {
+        return dateToTag(_);
+      }
+      if (_ instanceof Uint8Array) {
+        return _;
+      }
+
+      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 || ns.isStructSchema()) {
+          for (const [k, v] of Object.entries(_)) {
+            if (v == null) {
+              delete _[k];
+            }
+          }
+          return _;
+        }
+      }
+
+      return _;
+    });
+  }
+
+  public flush(): Uint8Array {
+    const buffer = cbor.serialize(this.value);
+    this.value = undefined;
+    return buffer as Uint8Array;
+  }
+}
+
+/**
+ * @alpha
+ */
+export class CborShapeDeserializer implements ShapeDeserializer {
+  private serdeContext?: SerdeFunctions;
+
+  public setSerdeContext(serdeContext: SerdeFunctions) {
+    this.serdeContext = serdeContext;
+  }
+
+  public read(schema: Schema, bytes: Uint8Array): any {
+    const data: any = cbor.deserialize(bytes);
+    return this.readValue(schema, data);
+  }
+
+  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 (ns.isBlobSchema()) {
+        return value;
+      }
+    }
+
+    if (
+      typeof value === "undefined" ||
+      typeof value === "boolean" ||
+      typeof value === "number" ||
+      typeof value === "string" ||
+      typeof value === "bigint" ||
+      typeof value === "symbol"
+    ) {
+      return value;
+    } else if (typeof value === "function" || typeof value === "object") {
+      if (value === null) {
+        return null;
+      }
+      if ("byteLength" in (value as Uint8Array)) {
+        return value;
+      }
+      if (value instanceof Date) {
+        return 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(memberSchema, item));
+          if (!sparse && newArray[newArray.length - 1] == null) {
+            newArray.pop();
+          }
+        }
+        return newArray;
+      }
+
+      const newObject = {} as any;
+
+      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;
+    } else {
+      return value;
+    }
+  }
+}