Accept AbortSignal in query executor (#103)

* Accept AbortSignal in query executor

* Support AbortSignal exclusively

* Revert package changes

* Use node types @ 20

* engines

Author: jgoz

.changeset/lazy-emus-explain.md

@@ -0,0 +1,6 @@
+---
+'druid-query-toolkit': minor
+---
+
+- Switch to AbortSignal in query executor
+- Use a single object parameter in query executor

package-lock.json

@@ -56,6 +56,9 @@
     "url": "https://github.com/implydata/druid-query-toolkit/issues"
   },
   "homepage": "https://github.com/implydata/druid-query-toolkit",
+  "engines": {
+    "node": ">= 14.17.0"
+  },
   "volta": {
     "node": "20.9.0"
   },
@@ -68,6 +71,7 @@
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.10",
     "@types/jest": "^29.5.0",
+    "@types/node": "^20.0.0",
     "axios": "^1.7.7",
     "eslint": "^9.15.0",
     "eslint-plugin-notice": "^1.0.0",

package.json

@@ -22,7 +22,7 @@ describe('QueryRunner', () => {
 
   const queryRunner = new QueryRunner({
     // eslint-disable-next-line @typescript-eslint/require-await
-    executor: async (payload, isSql) => {
+    executor: async ({ payload, isSql }) => {
       const firstParameterValue: any =
         payload.parameters && payload.parameters.length ? payload.parameters[0].value : undefined;
 

src/query-runner/cancel-token.ts

@@ -16,18 +16,18 @@ import type { QueryParameter, QueryPayload } from '../query-payload/query-payloa
 import { QueryResult } from '../query-result';
 import { SqlQuery } from '../sql';
 
-import type { CancelToken } from './cancel-token';
-
 export interface DataAndHeaders {
   data: unknown;
   headers: Record<string, string>;
 }
 
-export type QueryExecutor = (
-  payload: QueryPayload,
-  isSql: boolean,
-  cancelToken?: CancelToken,
-) => Promise<DataAndHeaders>;
+export interface QueryExecutorArgs {
+  payload: QueryPayload;
+  isSql: boolean;
+  signal: AbortSignal | undefined;
+}
+
+export type QueryExecutor = (args: QueryExecutorArgs) => Promise<DataAndHeaders>;
 
 export interface RunQueryOptions {
   query: string | SqlQuery | QueryPayload;
@@ -38,7 +38,7 @@ export interface RunQueryOptions {
   header?: boolean;
   typesHeader?: boolean;
   sqlTypesHeader?: boolean;
-  cancelToken?: CancelToken;
+  signal?: AbortSignal;
 }
 
 export type InflateDateStrategy = 'fromSqlTypes' | 'guess' | 'none';
@@ -85,7 +85,7 @@ export class QueryRunner {
       header,
       typesHeader,
       sqlTypesHeader,
-      cancelToken,
+      signal,
     } = options;
 
     let isSql: boolean;
@@ -146,10 +146,10 @@ export class QueryRunner {
     }
 
     const startTime = QueryRunner.now();
-    const dataAndHeaders = await this.getExecutor()(queryPayload, isSql, cancelToken);
+    const dataAndHeaders = await this.getExecutor()({ payload: queryPayload, isSql, signal });
     const endTime = QueryRunner.now();
 
-    if (cancelToken) cancelToken.throwIfRequested();
+    if (signal) signal.throwIfAborted();
 
     const result = QueryResult.fromQueryAndRawResult(
       queryPayload,