feat: enhance decimal handling in SenderBufferV3 and Sender classes to support null and undefined values

Author: RaphDal

src/buffer/bufferv3.ts

@@ -18,7 +18,7 @@ const EQUALS_SIGN: number = "=".charCodeAt(0);
  */
 class SenderBufferV3 extends SenderBufferV2 {
   /**
-   * Creates a new SenderBufferV2 instance.
+   * Creates a new SenderBufferV3 instance.
    *
    * @param {SenderOptions} options - Sender configuration object.
    *
@@ -37,13 +37,18 @@ class SenderBufferV3 extends SenderBufferV2 {
    * @param {number} value - Column value, accepts only number/string values.
    * @returns {Sender} Returns with a reference to this buffer.
    */
-  decimalColumnText(name: string, value: string | number): SenderBuffer {
+  decimalColumnText(
+    name: string,
+    value: string | number | null | undefined,
+  ): SenderBuffer {
     let str = "";
     if (typeof value === "string") {
       validateDecimalText(value);
       str = value;
     } else if (typeof value === "number") {
       str = value.toString();
+    } else if (value === null || value === undefined) {
+      return this;
     } else {
       throw new TypeError(`Invalid decimal value type: ${typeof value}`);
     }
@@ -69,7 +74,7 @@ class SenderBufferV3 extends SenderBufferV2 {
    */
   decimalColumnUnscaled(
     name: string,
-    unscaled: Int8Array | bigint,
+    unscaled: Int8Array | bigint | null | undefined,
     scale: number,
   ): SenderBuffer {
     if (scale < 0 || scale > 76) {
@@ -80,6 +85,8 @@ class SenderBufferV3 extends SenderBufferV2 {
       arr = bigintToTwosComplementBytes(unscaled);
     } else if (unscaled instanceof Int8Array) {
       arr = Array.from(unscaled);
+    } else if (unscaled === null || unscaled === undefined) {
+      return this;
     } else {
       throw new TypeError(
         `Invalid unscaled value type: ${typeof unscaled}, expected Int8Array or bigint`,

src/sender.ts

@@ -336,7 +336,10 @@ class Sender {
    * - value is not a number/string
    * - or the string contains invalid characters
    */
-  decimalColumnText(name: string, value: string | number): Sender {
+  decimalColumnText(
+    name: string,
+    value: string | number | undefined | null,
+  ): Sender {
     this.buffer.decimalColumnText(name, value);
     return this;
   }
@@ -355,7 +358,7 @@ class Sender {
    */
   decimalColumnUnscaled(
     name: string,
-    unscaled: Int8Array | bigint,
+    unscaled: Int8Array | bigint | undefined | null,
     scale: number,
   ): Sender {
     this.buffer.decimalColumnUnscaled(name, unscaled, scale);

test/sender.buffer.test.ts

@@ -1382,6 +1382,81 @@ describe("Sender message builder test suite (anything not covered in client inte
     sender.reset();
     await sender.close();
   });
+
+  it("doesn't send the decimal text column when undefined is passed as value", async function () {
+    const sender = new Sender({
+      protocol: "tcp",
+      protocol_version: "3",
+      host: "host",
+      init_buf_size: 1024,
+    });
+    try {
+      await sender.table("fx").decimalColumnText("mid", undefined).atNow();
+    } catch (e: Error | any) {
+      expect(e.message).toEqual(
+        "The row must have a symbol or column set before it is closed",
+      );
+    }
+    sender.reset();
+    await sender.close();
+  });
+
+  it("doesn't send the decimal text column when null is passed as value", async function () {
+    const sender = new Sender({
+      protocol: "tcp",
+      protocol_version: "3",
+      host: "host",
+      init_buf_size: 1024,
+    });
+    try {
+      await sender.table("fx").decimalColumnText("mid", null).atNow();
+    } catch (e: Error | any) {
+      expect(e.message).toEqual(
+        "The row must have a symbol or column set before it is closed",
+      );
+    }
+    sender.reset();
+    await sender.close();
+  });
+
+  it("doesn't send the decimal unscaled column when undefined is passed as value", async function () {
+    const sender = new Sender({
+      protocol: "tcp",
+      protocol_version: "3",
+      host: "host",
+      init_buf_size: 1024,
+    });
+    try {
+      await sender
+        .table("fx")
+        .decimalColumnUnscaled("mid", undefined, 0)
+        .atNow();
+    } catch (e: Error | any) {
+      expect(e.message).toEqual(
+        "The row must have a symbol or column set before it is closed",
+      );
+    }
+    sender.reset();
+    await sender.close();
+  });
+
+  it("doesn't send the decimal unscaled column when null is passed as value", async function () {
+    const sender = new Sender({
+      protocol: "tcp",
+      protocol_version: "3",
+      host: "host",
+      init_buf_size: 1024,
+    });
+    try {
+      await sender.table("fx").decimalColumnUnscaled("mid", null, 0).atNow();
+    } catch (e: Error | any) {
+      expect(e.message).toEqual(
+        "The row must have a symbol or column set before it is closed",
+      );
+    }
+    sender.reset();
+    await sender.close();
+  });
 });
 
 function bufferContent(sender: Sender) {