Merge branch 'arrays_support' into js_doc

Author: glasstiger

src/buffer/base.ts

@@ -151,7 +151,8 @@ abstract class SenderBufferBase implements SenderBuffer {
   }
 
   /**
-   * Writes a symbol name and value into the buffer.
+   * Writes a symbol name and value into the buffer. <br>
+   * Use it to insert into SYMBOL columns.
    *
    * @param {string} name - Symbol name.
    * @param {unknown} value - Symbol value, toString() is called to extract the actual symbol value from the parameter.
@@ -178,7 +179,8 @@ abstract class SenderBufferBase implements SenderBuffer {
   }
 
   /**
-   * Writes a string column with its value into the buffer.
+   * Writes a string column with its value into the buffer. <br>
+   * Use it to insert into VARCHAR and STRING columns.
    *
    * @param {string} name - Column name.
    * @param {string} value - Column value, accepts only string values.
@@ -200,7 +202,8 @@ abstract class SenderBufferBase implements SenderBuffer {
   }
 
   /**
-   * Writes a boolean column with its value into the buffer.
+   * Writes a boolean column with its value into the buffer. <br>
+   * Use it to insert into BOOLEAN columns.
    *
    * @param {string} name - Column name.
    * @param {boolean} value - Column value, accepts only boolean values.
@@ -220,7 +223,8 @@ abstract class SenderBufferBase implements SenderBuffer {
   }
 
   /**
-   * Writes a float column with its value into the buffer.
+   * Writes a 64-bit floating point value into the buffer. <br>
+   * Use it to insert into DOUBLE or FLOAT database columns.
    *
    * @param {string} name - Column name.
    * @param {number} value - Column value, accepts only number values.
@@ -238,7 +242,8 @@ abstract class SenderBufferBase implements SenderBuffer {
   abstract arrayColumn(name: string, value: unknown[]): SenderBuffer;
 
   /**
-   * Writes an integer column with its value into the buffer.
+   * Writes a 64-bit signed integer into the buffer. <br>
+   * Use it to insert into LONG, INT, SHORT and BYTE columns.
    *
    * @param {string} name - Column name.
    * @param {number} value - Column value, accepts only number values.
@@ -259,7 +264,8 @@ abstract class SenderBufferBase implements SenderBuffer {
   }
 
   /**
-   * Writes a timestamp column with its value into the buffer.
+   * Writes a timestamp column with its value into the buffer. <br>
+   * Use it to insert into TIMESTAMP columns.
    *
    * @param {string} name - Column name.
    * @param {number | bigint} value - Epoch timestamp, accepts numbers or BigInts.

src/buffer/bufferv1.ts

@@ -17,7 +17,8 @@ class SenderBufferV1 extends SenderBufferBase {
   }
 
   /**
-   * Writes a float column with its value into the buffer using v1 serialization (text format).
+   * Writes a 64-bit floating point value into the buffer using v1 serialization (text format). <br>
+   * Use it to insert into DOUBLE or FLOAT database columns.
    *
    * @param {string} name - Column name.
    * @param {number} value - Column value, accepts only number values.

src/buffer/bufferv2.ts

@@ -29,7 +29,8 @@ class SenderBufferV2 extends SenderBufferBase {
   }
 
   /**
-   * Writes a float column with its value into the buffer using v2 serialization (binary format).
+   * Writes a 64-bit floating point value into the buffer using v2 serialization (binary format). <br>
+   * Use it to insert into DOUBLE or FLOAT database columns.
    *
    * @param {string} name - Column name.
    * @param {number} value - Column value, accepts only number values.
@@ -104,7 +105,7 @@ class SenderBufferV2 extends SenderBufferBase {
         this.writeArrayValues(arr[i] as unknown[], dimensions);
       }
     } else {
-      const type = arr[0] ? typeof arr[0] : null;
+      const type = arr[0] !== undefined ? typeof arr[0] : null;
       switch (type) {
         case "number":
           for (let i = 0; i < arr.length; i++) {

src/utils.ts

@@ -134,7 +134,7 @@ function validateArray(data: unknown[], dimensions: number[]): ArrayPrimitive {
       }
     } else {
       // leaf level, expecting primitives
-      if (expectedType === null && array[0]) {
+      if (expectedType === null && array[0] !== undefined) {
         expectedType = typeof array[0] as ArrayPrimitive;
       }
 
@@ -171,7 +171,7 @@ async function fetchJson<T>(
 ): Promise<T> {
   const controller = new AbortController();
   const { signal } = controller;
-  setTimeout(() => controller.abort(), timeout);
+  const timeoutId = setTimeout(() => controller.abort(), timeout);
 
   let response: globalThis.Response;
   try {
@@ -181,6 +181,8 @@ async function fetchJson<T>(
     });
   } catch (error) {
     throw new Error(`Failed to load ${url} [error=${error}]`);
+  } finally {
+    clearTimeout(timeoutId);
   }
 
   if (!response.ok) {

test/options.test.ts

@@ -15,8 +15,6 @@ const proxyOptions = {
   ca: readFileSync("test/certs/ca/ca.crt"),
 };
 
-process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = "0";
-
 describe("Configuration string parser suite", function () {
   const mockHttp = new MockHttp();
   const mockHttps = new MockHttp();

test/sender.buffer.test.ts

@@ -199,6 +199,22 @@ describe("Sender message builder test suite (anything not covered in client inte
     await sender.close();
   });
 
+  it("supports arrays with zeros", async function () {
+    const sender = new Sender({
+      protocol: "tcp",
+      protocol_version: "2",
+      host: "host",
+      init_buf_size: 1024,
+    });
+    await sender.table("tableName").arrayColumn("arrayCol", [0.0, 0.0]).atNow();
+    expect(bufferContentHex(sender)).toBe(
+      toHex("tableName arrayCol==") +
+        " 0e 0a 01 02 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 " +
+        toHex("\n"),
+    );
+    await sender.close();
+  });
+
   it("supports multidimensional arrays with protocol v2", async function () {
     const sender = new Sender({
       protocol: "tcp",

test/sender.integration.test.ts

@@ -363,6 +363,67 @@ describe("Sender tests with containerized QuestDB instance", () => {
     await sender.close();
   });
 
+  it("can ingest zero vector via HTTP with protocol v2", async () => {
+    const tableName = "test_http_v2_zeros";
+    const schema = [
+      { name: "location", type: "SYMBOL" },
+      { name: "temperatures", type: "ARRAY", elemType: "DOUBLE", dim: 2 },
+      { name: "timestamp", type: "TIMESTAMP" },
+    ];
+
+    const sender = await Sender.fromConfig(
+      `http::addr=${container.getHost()}:${container.getMappedPort(QUESTDB_HTTP_PORT)}`,
+    );
+
+    // ingest via client
+    await sender
+      .table(tableName)
+      .symbol("location", "us")
+      .arrayColumn("temperatures", [
+        [17.1, 17.7, 18.4],
+        [17.1, 17.7, 18.4],
+      ])
+      .at(1658484765000000000n, "ns");
+    await sender
+      .table(tableName)
+      .symbol("location", "gb")
+      .arrayColumn("temperatures", [
+        [0.0, 0.0, 0.0],
+        [0.0, 0.0, 0.0],
+      ])
+      .at(1658484765000666000n, "ns");
+    await sender.flush();
+
+    // wait for the table
+    await waitForTable(container, tableName);
+
+    // query table
+    const select1Result = await runSelect(container, tableName, 2);
+    expect(select1Result.query).toBe(tableName);
+    expect(select1Result.count).toBe(2);
+    expect(select1Result.columns).toStrictEqual(schema);
+    expect(select1Result.dataset).toStrictEqual([
+      [
+        "us",
+        [
+          [17.1, 17.7, 18.4],
+          [17.1, 17.7, 18.4],
+        ],
+        "2022-07-22T10:12:45.000000Z",
+      ],
+      [
+        "gb",
+        [
+          [0.0, 0.0, 0.0],
+          [0.0, 0.0, 0.0],
+        ],
+        "2022-07-22T10:12:45.000666Z",
+      ],
+    ]);
+
+    await sender.close();
+  });
+
   it("can ingest empty array via HTTP with protocol v2", async () => {
     const tableName = "test_http_v2_empty";
     const schema = [