fix(protocols): fix header serde, handle unset union payloads (smithy-lang#1417)

Author: kuhe

.changeset/proud-bugs-deny.md

@@ -0,0 +1,5 @@
+---
+"@smithy/middleware-compression": patch
+---
+
+comma spacing

.changeset/witty-rings-do.md

@@ -0,0 +1,5 @@
+---
+"@smithy/smithy-client": minor
+---
+
+add quoteHeader function

packages/middleware-compression/src/compressionMiddleware.spec.ts

@@ -160,7 +160,7 @@ describe(compressionMiddleware.name, () => {
             body: mockCompressedBody,
             headers: {
               ...mockArgs.request.headers,
-              "content-encoding": [mockExistingContentEncoding, "gzip"].join(","),
+              "content-encoding": [mockExistingContentEncoding, "gzip"].join(", "),
             },
           },
         });

packages/middleware-compression/src/compressionMiddleware.ts

@@ -82,7 +82,7 @@ export const compressionMiddleware =
           if (headers["content-encoding"]) {
             updatedHeaders = {
               ...headers,
-              "content-encoding": `${headers["content-encoding"]},${algorithm}`,
+              "content-encoding": `${headers["content-encoding"]}, ${algorithm}`,
             };
           } else {
             updatedHeaders = { ...headers, "content-encoding": algorithm };

packages/smithy-client/src/index.ts

@@ -18,7 +18,9 @@ export * from "./lazy-json";
 export * from "./NoOpLogger";
 export * from "./object-mapping";
 export * from "./parse-utils";
+export * from "./quote-header";
 export * from "./resolve-path";
 export * from "./ser-utils";
 export * from "./serde-json";
 export * from "./split-every";
+export * from "./split-header";

packages/smithy-client/src/quote-header.spec.ts

@@ -0,0 +1,19 @@
+import { quoteHeader } from "./quote-header";
+
+describe(quoteHeader.name, () => {
+  it("should not wrap header elements that don't include the delimiter or double quotes", () => {
+    expect(quoteHeader("bc")).toBe("bc");
+  });
+
+  it("should wrap header elements that include the delimiter", () => {
+    expect(quoteHeader("b,c")).toBe('"b,c"');
+  });
+
+  it("should wrap header elements that include double quotes", () => {
+    expect(quoteHeader(`"bc"`)).toBe('"\\"bc\\""');
+  });
+
+  it("should wrap header elements that include the delimiter and double quotes", () => {
+    expect(quoteHeader(`"b,c"`)).toBe('"\\"b,c\\""');
+  });
+});

packages/smithy-client/src/quote-header.ts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ * @param part - header list element
+ * @returns quoted string if part contains delimiter.
+ */
+export function quoteHeader(part: string) {
+  if (part.includes(",") || part.includes('"')) {
+    part = `"${part.replace(/"/g, '\\"')}"`;
+  }
+  return part;
+}

packages/smithy-client/src/split-header.spec.ts

@@ -0,0 +1,22 @@
+import { splitHeader } from "./split-header";
+
+describe(splitHeader.name, () => {
+  it("should split a string by commas and trim only the comma delimited outer values", () => {
+    expect(splitHeader("abc")).toEqual(["abc"]);
+    expect(splitHeader("a,b,c")).toEqual(["a", "b", "c"]);
+    expect(splitHeader("a, b, c")).toEqual(["a", "b", "c"]);
+    expect(splitHeader("a , b , c")).toEqual(["a", "b", "c"]);
+    expect(splitHeader(`a , b , "  c  "`)).toEqual(["a", "b", "  c  "]);
+    expect(splitHeader(`  a  ,     , b`)).toEqual(["a", "", "b"]);
+    expect(splitHeader(`,,`)).toEqual(["", "", ""]);
+    expect(splitHeader(`    ,    ,    `)).toEqual(["", "", ""]);
+  });
+  it("should split a string by commas that are not in quotes, and remove outer quotes", () => {
+    expect(splitHeader('"b,c", "\\"def\\"", a')).toEqual(["b,c", '"def"', "a"]);
+    expect(splitHeader('"a,b,c", ""def"", "a,b ,c"')).toEqual(["a,b,c", '"def"', "a,b ,c"]);
+    expect(splitHeader(`""`)).toEqual([``]);
+    expect(splitHeader(``)).toEqual([``]);
+    expect(splitHeader(`\\"`)).toEqual([`"`]);
+    expect(splitHeader(`"`)).toEqual([`"`]);
+  });
+});

packages/smithy-client/src/split-header.ts

@@ -0,0 +1,45 @@
+/**
+ * @param value - header string value.
+ * @returns value split by commas that aren't in quotes.
+ */
+export const splitHeader = (value: string): string[] => {
+  const z = value.length;
+  const values = [];
+
+  let withinQuotes = false;
+  let prevChar = undefined;
+  let anchor = 0;
+
+  for (let i = 0; i < z; ++i) {
+    const char = value[i];
+    switch (char) {
+      case `"`:
+        if (prevChar !== "\\") {
+          withinQuotes = !withinQuotes;
+        }
+        break;
+      case ",":
+        if (!withinQuotes) {
+          values.push(value.slice(anchor, i));
+          anchor = i + 1;
+        }
+        break;
+      default:
+    }
+    prevChar = char;
+  }
+
+  values.push(value.slice(anchor));
+
+  return values.map((v) => {
+    v = v.trim();
+    const z = v.length;
+    if (z < 2) {
+      return v;
+    }
+    if (v[0] === `"` && v[z - 1] === `"`) {
+      v = v.slice(1, z - 1);
+    }
+    return v.replace(/\\"/g, '"');
+  });
+};

private/smithy-rpcv2-cbor/test/functional/rpcv2cbor.spec.ts

@@ -697,7 +697,7 @@ it("no_input:Request", async () => {
     expect(r.headers["smithy-protocol"]).toBeDefined();
     expect(r.headers["smithy-protocol"]).toBe("rpc-v2-cbor");
 
-    expect(r.body).toBeFalsy();
+    expect(!r.body || r.body === `{}`).toBeTruthy();
   }
 });