fix: add keepalive agent timeout (#57)

Author: Jeseeq

package-lock.json

@@ -26,12 +26,14 @@
     "@types/node-fetch": "^2.5.12",
     "@typescript-eslint/eslint-plugin": "^5.4.0",
     "@typescript-eslint/parser": "^5.4.0",
+    "agentkeepalive": "^4.5.0",
     "dotenv": "^16.0.1",
     "eslint": "^8.2.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
     "jest": "^27.5.1",
     "msw": "^0.45.0",
+    "nock": "^13.3.6",
     "prettier": "^2.4.1",
     "standard-version": "^9.3.2",
     "ts-jest": "^27.0.7",

package.json

@@ -1,4 +1,5 @@
-import { Agent } from "https";
+import { HttpsAgent } from "agentkeepalive";
+
 import Abort from "abort-controller";
 import fetch from "node-fetch";
 import { AbortSignal } from "node-fetch/externals";
@@ -37,7 +38,12 @@ export class NodeHttpClient {
   } {
     const { headers = {}, body, retry = true } = options || {};
     const controller = new AbortController();
-    const agent = new Agent({ keepAlive: true, keepAliveMsecs: 1000 });
+    const agent = new HttpsAgent({
+      keepAlive: true,
+      keepAliveMsecs: 1000,
+      timeout: 60000,
+      freeSocketTimeout: 30000
+    });
 
     const abort = () => {
       controller.abort();

src/http/node.ts

@@ -3,7 +3,8 @@ import {
   ExecuteQueryOptions,
   StreamOptions,
   Context,
-  Statistics
+  Statistics,
+  Row
 } from "../types";
 import { Meta } from "../meta";
 import { isDataQuery } from "../common/util";
@@ -161,12 +162,22 @@ export class Statement {
     };
   }
 
-  async fetchResult() {
+  async fetchResult(): Promise<{
+    data: Row[];
+    meta: Meta[];
+    statistics: Statistics | null;
+    query_id?: string;
+  }> {
     const response = await this.request.ready();
     const text = await response.text();
 
     if (this.executeQueryOptions?.settings?.async_execution) {
-      return JSONbig.parse(text);
+      return JSONbig.parse(text) as {
+        data: Row[];
+        meta: Meta[];
+        statistics: Statistics;
+        query_id: string;
+      };
     }
 
     const parsed = this.handleParseResponse(text);

src/statement/index.ts

@@ -58,7 +58,7 @@ describe("integration test", () => {
     });
     const { data } = await statement.fetchResult();
     const row = data[0];
-    expect(row).toMatchObject({ "1": 1 });
+    expect(row).toMatchObject({ "?column?": 1 });
   });
   it("async query", async () => {
     const firebolt = Firebolt({

test/integration/index.test.ts

@@ -1,4 +1,5 @@
 import { Firebolt } from "../../src/index";
+import nock from "nock";
 
 const connectionParams = {
   auth: {
@@ -12,21 +13,41 @@ const connectionParams = {
 jest.setTimeout(500000);
 
 describe("long running request", () => {
-  it.skip("handles long request", async () => {
-    const query = `SELECT sleepEachRow(1) from numbers(360)`;
+  it("handles long request", async () => {
+    const query = `SELECT checksum(*) FROM generate_series(1, 10000000000)`;
 
     const firebolt = Firebolt({
       apiEndpoint: process.env.FIREBOLT_API_ENDPOINT as string
     });
 
     const connection = await firebolt.connect(connectionParams);
 
-    const statement = await connection.execute(query, {
-      settings: { use_standard_sql: 0, advanced_mode: 1 }
-    });
+    const statement = await connection.execute(query);
 
     const { data, meta } = await statement.fetchResult();
-    expect(data.length).toEqual(360);
-    expect(meta.length).toEqual(1);
+    expect(data).toBeTruthy();
+    expect(meta).toBeTruthy();
+  });
+  it("fails with timeout on network disconnect", async () => {
+    const query = `SELECT checksum(*) FROM generate_series(1, 10000000000)`;
+
+    const firebolt = Firebolt({
+      apiEndpoint: process.env.FIREBOLT_API_ENDPOINT as string
+    });
+
+    const connection = await firebolt.connect(connectionParams);
+
+    setTimeout(() => {
+      nock.disableNetConnect();
+    }, 10000);
+    try {
+      const statement = await connection.execute(query);
+      await statement.fetchResult();
+      expect(true).toEqual(false);
+    } catch (error) {
+      expect(true).toEqual(true);
+    } finally {
+      nock.enableNetConnect();
+    }
   });
 });