fix(core/cbor): NumericValue typecheck

Author: kuhe

.changeset/curly-fishes-tease.md

@@ -0,0 +1,5 @@
+---
+"@smithy/core": patch
+---
+
+fix NumericValue typecheck

packages/core/src/submodules/cbor/byte-printer.ts

@@ -4,5 +4,42 @@
  * @deprecated for testing only, do not use in runtime.
  */
 export function printBytes(bytes: Uint8Array) {
-  return [...bytes].map((n) => ("0".repeat(8) + n.toString(2)).slice(-8) + ` (${n})`);
+  return [...bytes].map((n) => {
+    const pad = (n) => ("0".repeat(8) + n.toString(2)).slice(-8);
+    const b = pad(n);
+    const [maj, min] = [b.slice(0, 3), b.slice(3)];
+
+    let dmaj;
+
+    switch (maj) {
+      case "000":
+        dmaj = "0 - Uint64";
+        break;
+      case "001":
+        dmaj = "1 - Neg Uint64";
+        break;
+      case "010":
+        dmaj = "2 - unstructured bytestring";
+        break;
+      case "011":
+        dmaj = "3 - utf8 string";
+        break;
+      case "100":
+        dmaj = "4 - list";
+        break;
+      case "101":
+        dmaj = "5 - map";
+        break;
+      case "110":
+        dmaj = "6 - tag";
+        break;
+      case "111":
+        dmaj = "7 - special";
+        break;
+      default:
+        dmaj = parseInt(maj, 2);
+    }
+
+    return `${maj}_${min} (${dmaj}, ${parseInt(min, 2)})`;
+  });
 }

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

@@ -9,6 +9,7 @@ import { cbor } from "./cbor";
 import { bytesToFloat16 } from "./cbor-decode";
 import { tagSymbol } from "./cbor-types";
 import { dateToTag } from "./parseCborBody";
+import { printBytes } from "./byte-printer";
 
 // syntax is ESM but the test target is CJS.
 const here = __dirname;
@@ -286,7 +287,7 @@ describe("cbor", () => {
       expect(deserialized).toEqual(bigInt);
     });
 
-    it.skip("should round-trip NumericValue to major 6 with tag 4", () => {
+    it("should round-trip NumericValue to major 6 with tag 4", () => {
       for (const bigDecimal of [
         "10000000000000000000000054.321",
         "1000000000000000000000000000000000054.134134321",
@@ -310,6 +311,15 @@ describe("cbor", () => {
         expect(deserialized).toEqual(nv);
         expect(deserialized.string).toEqual(nv.string);
       }
+
+      const bigDecimal = nv("0");
+      expect(bigDecimal).toBeInstanceOf(NumericValue);
+      expect(printBytes(cbor.serialize(bigDecimal))).toEqual([
+        "110_00100 (6 - tag, 4)",
+        "100_00010 (4 - list, 2)",
+        "000_00000 (0 - Uint64, 0)",
+        "000_00000 (0 - Uint64, 0)",
+      ]);
     });
 
     it("should round-trip sequences of big numbers", () => {

packages/core/src/submodules/serde/value/NumericValue.spec.ts

@@ -16,4 +16,59 @@ describe(NumericValue.name, () => {
     expect(() => nv("-10.1")).not.toThrow();
     expect(() => nv("-.101")).not.toThrow();
   });
+
+  it("has a custom instanceof check", () => {
+    const isInstance = [
+      nv("0"),
+      nv("-0.00"),
+      new NumericValue("0", "bigDecimal"),
+      new NumericValue("-0.00", "bigDecimal"),
+      {
+        string: "abcd",
+        type: "bigDecimal",
+        constructor: {
+          name: "_NumericValue",
+        },
+      },
+      (() => {
+        const x = {};
+        Object.setPrototypeOf(x, NumericValue.prototype);
+        return x;
+      })(),
+      (() => {
+        function F() {}
+        F.prototype = Object.create(NumericValue.prototype);
+        // @ts-ignore
+        return new F();
+      })(),
+      (() => {
+        return new (class extends NumericValue {})("0", "bigDecimal");
+      })(),
+    ] as unknown[];
+
+    const isNotInstance = [
+      BigInt(0),
+      "-0.00",
+      {
+        string: "abcd",
+        type: "bigDecimal",
+        constructor: {
+          name: "_NumericValue_",
+        },
+      },
+      (() => {
+        const x = {};
+        Object.setPrototypeOf(x, NumericValue);
+        return x;
+      })(),
+    ] as unknown[];
+
+    for (const instance of isInstance) {
+      expect(instance).toBeInstanceOf(NumericValue);
+    }
+
+    for (const instance of isNotInstance) {
+      expect(instance).not.toBeInstanceOf(NumericValue);
+    }
+  });
 });

packages/core/src/submodules/serde/value/NumericValue.ts

@@ -21,10 +21,7 @@ export type NumericType = "bigDecimal";
  * @public
  */
 export class NumericValue {
-  public constructor(
-    public readonly string: string,
-    public readonly type: NumericType
-  ) {
+  public constructor(public readonly string: string, public readonly type: NumericType) {
     let dot = 0;
     for (let i = 0; i < string.length; ++i) {
       const char = string.charCodeAt(i);
@@ -58,11 +55,15 @@ export class NumericValue {
       return false;
     }
     const _nv = object as NumericValue;
-    const prototypeMatch = NumericValue.prototype.isPrototypeOf(object.constructor?.prototype);
+    const prototypeMatch = NumericValue.prototype.isPrototypeOf(object);
     if (prototypeMatch) {
       return prototypeMatch;
     }
-    if (typeof _nv.string === "string" && typeof _nv.type === "string" && _nv.constructor?.name === "NumericValue") {
+    if (
+      typeof _nv.string === "string" &&
+      typeof _nv.type === "string" &&
+      _nv.constructor?.name?.endsWith("NumericValue")
+    ) {
       return true;
     }
     return prototypeMatch;