@dremio/js-sdk 0.16.2 → 0.18.0

package/dist/common/Config.d.ts

@@ -23,6 +23,12 @@ export type Config = {
      * Required unless using a custom `fetch` provider with its own credentials provision
      */
     credentials?: CredentialProvider;
+    /**
+     * Configure the maximum number of times to retry requests that failed due to a
+     * temporary condition such as 429 or 503. Default is 10. Set to 0 to disable
+     * automatic retry.
+     */
+    maxRetryCount?: number;
 };
 /**
  * @hidden

package/dist/common/Config.js.map

@@ -1 +1 @@
-{"version":3,"file":"Config.js","sourceRoot":"","sources":["../../src/common/Config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { AsyncResult } from \"ts-results-es\";\nimport type { CredentialProvider } from \"./CredentialProvider.ts\";\nimport type { HttpError } from \"./HttpError.ts\";\n\nexport type RequestFn = (input: string, init?: RequestInit) => AsyncResult<Response, HttpError>;\n\nexport type Config = {\n  /**\n   * Custom `fetch` provider\n   * @default globalThis.fetch\n   */\n  fetch?: (input: string, init?: RequestInit) => Promise<Response>;\n\n  /**\n   * Dremio API base origin\n   */\n  origin: string;\n\n  logger?: {\n    debug: typeof console.debug;\n    error: typeof console.error;\n    info: typeof console.info;\n    warn: typeof console.warn;\n  };\n\n  /**\n   * Provides credentials to Dremio for all authenticated API requests.\n   * Required unless using a custom `fetch` provider with its own credentials provision\n   */\n  credentials?: CredentialProvider;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type ResourceConfig = {\n  logger?: Config[\"logger\"];\n  origin: Config[\"origin\"];\n  request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type SonarV2Config = {\n  sonarV2Request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type SonarV3Config = {\n  sonarV3Request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type SonarV4Config = {\n  sonarV4Request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type V3Config = {\n  v3Request: RequestFn;\n};\n"]}
+{"version":3,"file":"Config.js","sourceRoot":"","sources":["../../src/common/Config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { AsyncResult } from \"ts-results-es\";\nimport type { CredentialProvider } from \"./CredentialProvider.ts\";\nimport type { HttpError } from \"./HttpError.ts\";\n\nexport type RequestFn = (input: string, init?: RequestInit) => AsyncResult<Response, HttpError>;\n\nexport type Config = {\n  /**\n   * Custom `fetch` provider\n   * @default globalThis.fetch\n   */\n  fetch?: (input: string, init?: RequestInit) => Promise<Response>;\n\n  /**\n   * Dremio API base origin\n   */\n  origin: string;\n\n  logger?: {\n    debug: typeof console.debug;\n    error: typeof console.error;\n    info: typeof console.info;\n    warn: typeof console.warn;\n  };\n\n  /**\n   * Provides credentials to Dremio for all authenticated API requests.\n   * Required unless using a custom `fetch` provider with its own credentials provision\n   */\n  credentials?: CredentialProvider;\n\n  /**\n   * Configure the maximum number of times to retry requests that failed due to a\n   * temporary condition such as 429 or 503. Default is 10. Set to 0 to disable\n   * automatic retry.\n   */\n  maxRetryCount?: number;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type ResourceConfig = {\n  logger?: Config[\"logger\"];\n  origin: Config[\"origin\"];\n  request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type SonarV2Config = {\n  sonarV2Request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type SonarV3Config = {\n  sonarV3Request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type SonarV4Config = {\n  sonarV4Request: RequestFn;\n};\n\n/**\n * @hidden\n * @internal\n */\nexport type V3Config = {\n  v3Request: RequestFn;\n};\n"]}

package/dist/common/createRequest.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AsyncResult, Err, Ok } from "ts-results-es";
+import { AsyncResult, Err, Ok, Result } from "ts-results-es";
 import { HttpError } from "./HttpError.js";
 const getHeadersFromConfig = async (config) => {
     if (config.credentials) {
@@ -29,18 +29,63 @@ const getHeadersFromConfig = async (config) => {
  */
 export const createRequest = (config) => {
     const fetch = config.fetch || globalThis.fetch;
+    const MAX_RETRIES = config.maxRetryCount ?? 10;
     return function request(input, init) {
-        const start = performance.now();
-        return new AsyncResult((async () => fetch(new URL(input, config.origin), {
-            ...init,
-            headers: { ...(await getHeadersFromConfig(config)), ...init?.headers },
-        }).then(async (res) => {
-            config.logger?.debug(`${init?.method?.toUpperCase() || "GET"} ${input} (${res.status}) [${Math.round(performance.now() - start)}ms]`);
-            if (!res.ok) {
-                return Err(await HttpError.fromResponse(res));
-            }
-            return Ok(res);
-        }))());
+        const startFetch = async (triesRemaining) => {
+            const start = performance.now();
+            return fetch(new URL(input, config.origin), {
+                ...init,
+                headers: { ...(await getHeadersFromConfig(config)), ...init?.headers },
+            }).then(async (res) => {
+                config.logger?.debug(`${init?.method?.toUpperCase() || "GET"} ${input} (${res.status}) [${Math.round(performance.now() - start)}ms]`);
+                if (!res.ok) {
+                    if (isRetryableResponse(res) && triesRemaining > 0) {
+                        const retryWait = getRetryWait(res, triesRemaining, MAX_RETRIES);
+                        config.logger?.warn(`${init?.method?.toUpperCase() || "GET"} ${input} (${res.status}) [Retrying in ${retryWait}ms]`);
+                        await new Promise((resolve) => setTimeout(resolve, retryWait));
+                        return startFetch(triesRemaining - 1);
+                    }
+                    return Err(await HttpError.fromResponse(res));
+                }
+                return Ok(res);
+            });
+        };
+        return new AsyncResult(startFetch(MAX_RETRIES));
     };
 };
+const getRetryWait = (res, triesRemaining, maxRetries) => {
+    const retryAfter = res.headers.get("retry-after");
+    if (retryAfter) {
+        return parseRetryAfter(retryAfter);
+    }
+    return Math.min(MAX_RETRY_INTERVAL, 2 ** (maxRetries - triesRemaining) * 1000 + 6000);
+};
+const isRetryableResponse = (res) => {
+    return res.status === 429 || res.status === 502 || res.status === 503;
+};
+const parseRetryAfter = (retryAfter) => {
+    // Try parsing as the <delay-seconds> format
+    const nval = Number(retryAfter);
+    if (Number.isFinite(nval)) {
+        return Math.min(MAX_RETRY_WAIT, Math.max(0, nval * 1000));
+    }
+    // Try parsing as the <http-date> format
+    const retryDateMs = Date.parse(retryAfter);
+    // This case is hit when value couldn't be parsed as a number or date
+    if (Number.isNaN(retryDateMs)) {
+        return 0;
+    }
+    // Return the number of millseconds between target date and now
+    return Math.min(MAX_RETRY_WAIT, Math.max(0, retryDateMs - Date.now()));
+};
+/**
+ * There really shouldn't be a case where the client needs to wait longer than
+ * five minutes before retrying a request, so if the API requests a longer retry
+ * interval, ignore it.
+ */
+const MAX_RETRY_WAIT = 300_000;
+/**
+ * When no retry-after is provided, cap the retry interval to 30 seconds.
+ */
+const MAX_RETRY_INTERVAL = 30_000;
 //# sourceMappingURL=createRequest.js.map

package/dist/common/createRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"createRequest.js","sourceRoot":"","sources":["../../src/common/createRequest.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,eAAe,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,oBAAoB,GAAG,KAAK,EAAE,MAAc,EAAmC,EAAE;IACrF,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,OAAO;YACL,aAAa,EAAE,UAAU,MAAM,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;SAChE,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAa,EAAE;IACzD,MAAM,KAAK,GAAI,MAAM,CAAC,KAAiC,IAAI,UAAU,CAAC,KAAK,CAAC;IAE5E,OAAO,SAAS,OAAO,CAAC,KAAa,EAAE,IAAkB;QACvD,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAEhC,OAAO,IAAI,WAAW,CACpB,CAAC,KAAK,IAAI,EAAE,CACV,KAAK,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE;YACnC,GAAG,IAAI;YACP,OAAO,EAAE,EAAE,GAAG,CAAC,MAAM,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;SACvE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACpB,MAAM,CAAC,MAAM,EAAE,KAAK,CAClB,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,KAAK,IAAI,KAAK,KAAK,GAAG,CAAC,MAAM,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,CAChH,CAAC;YACF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,OAAO,GAAG,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;YAChD,CAAC;YACD,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC,EAAE,CACR,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { AsyncResult, Err, Ok } from \"ts-results-es\";\nimport type { Config, RequestFn } from \"./Config.ts\";\nimport { HttpError } from \"./HttpError.ts\";\n\nconst getHeadersFromConfig = async (config: Config): Promise<RequestInit[\"headers\"]> => {\n  if (config.credentials) {\n    return {\n      Authorization: `Bearer ${await config.credentials.get(config)}`,\n    };\n  }\n  return {};\n};\n\n/**\n * @internal\n * @hidden\n */\nexport const createRequest = (config: Config): RequestFn => {\n  const fetch = (config.fetch as typeof globalThis.fetch) || globalThis.fetch;\n\n  return function request(input: string, init?: RequestInit) {\n    const start = performance.now();\n\n    return new AsyncResult(\n      (async () =>\n        fetch(new URL(input, config.origin), {\n          ...init,\n          headers: { ...(await getHeadersFromConfig(config)), ...init?.headers },\n        }).then(async (res) => {\n          config.logger?.debug(\n            `${init?.method?.toUpperCase() || \"GET\"} ${input} (${res.status}) [${Math.round(performance.now() - start)}ms]`,\n          );\n          if (!res.ok) {\n            return Err(await HttpError.fromResponse(res));\n          }\n          return Ok(res);\n        }))(),\n    );\n  };\n};\n"]}
+{"version":3,"file":"createRequest.js","sourceRoot":"","sources":["../../src/common/createRequest.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,oBAAoB,GAAG,KAAK,EAAE,MAAc,EAAmC,EAAE;IACrF,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,OAAO;YACL,aAAa,EAAE,UAAU,MAAM,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;SAChE,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAa,EAAE;IACzD,MAAM,KAAK,GAAI,MAAM,CAAC,KAAiC,IAAI,UAAU,CAAC,KAAK,CAAC;IAC5E,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,IAAI,EAAE,CAAC;IAE/C,OAAO,SAAS,OAAO,CAAC,KAAa,EAAE,IAAkB;QACvD,MAAM,UAAU,GAAG,KAAK,EAAE,cAAsB,EAAwC,EAAE;YACxF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAEhC,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE;gBAC1C,GAAG,IAAI;gBACP,OAAO,EAAE,EAAE,GAAG,CAAC,MAAM,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE;aACvE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,EAAE,KAAK,CAClB,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,KAAK,IAAI,KAAK,KAAK,GAAG,CAAC,MAAM,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,CAChH,CAAC;gBAEF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;oBACZ,IAAI,mBAAmB,CAAC,GAAG,CAAC,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;wBACnD,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;wBACjE,MAAM,CAAC,MAAM,EAAE,IAAI,CACjB,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,KAAK,IAAI,KAAK,KAAK,GAAG,CAAC,MAAM,kBAAkB,SAAS,KAAK,CAChG,CAAC;wBACF,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;wBAC/D,OAAO,UAAU,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;oBACxC,CAAC;oBACD,OAAO,GAAG,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;gBAChD,CAAC;gBAED,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;YACjB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,OAAO,IAAI,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,GAAa,EAAE,cAAsB,EAAE,UAAkB,EAAE,EAAE;IACjF,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAElD,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,eAAe,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,UAAU,GAAG,cAAc,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,GAAa,EAAE,EAAE;IAC5C,OAAO,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC;AACxE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,UAAkB,EAAU,EAAE;IACrD,4CAA4C;IAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IAEhC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,wCAAwC;IACxC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE3C,qEAAqE;IACrE,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;QAC9B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,+DAA+D;IAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;AACzE,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc,GAAG,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,kBAAkB,GAAG,MAAM,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { AsyncResult, Err, Ok, Result } from \"ts-results-es\";\nimport type { Config, RequestFn } from \"./Config.ts\";\nimport { HttpError } from \"./HttpError.ts\";\n\nconst getHeadersFromConfig = async (config: Config): Promise<RequestInit[\"headers\"]> => {\n  if (config.credentials) {\n    return {\n      Authorization: `Bearer ${await config.credentials.get(config)}`,\n    };\n  }\n  return {};\n};\n\n/**\n * @internal\n * @hidden\n */\nexport const createRequest = (config: Config): RequestFn => {\n  const fetch = (config.fetch as typeof globalThis.fetch) || globalThis.fetch;\n  const MAX_RETRIES = config.maxRetryCount ?? 10;\n\n  return function request(input: string, init?: RequestInit) {\n    const startFetch = async (triesRemaining: number): Promise<Result<Response, HttpError>> => {\n      const start = performance.now();\n\n      return fetch(new URL(input, config.origin), {\n        ...init,\n        headers: { ...(await getHeadersFromConfig(config)), ...init?.headers },\n      }).then(async (res) => {\n        config.logger?.debug(\n          `${init?.method?.toUpperCase() || \"GET\"} ${input} (${res.status}) [${Math.round(performance.now() - start)}ms]`,\n        );\n\n        if (!res.ok) {\n          if (isRetryableResponse(res) && triesRemaining > 0) {\n            const retryWait = getRetryWait(res, triesRemaining, MAX_RETRIES);\n            config.logger?.warn(\n              `${init?.method?.toUpperCase() || \"GET\"} ${input} (${res.status}) [Retrying in ${retryWait}ms]`,\n            );\n            await new Promise((resolve) => setTimeout(resolve, retryWait));\n            return startFetch(triesRemaining - 1);\n          }\n          return Err(await HttpError.fromResponse(res));\n        }\n\n        return Ok(res);\n      });\n    };\n\n    return new AsyncResult(startFetch(MAX_RETRIES));\n  };\n};\n\nconst getRetryWait = (res: Response, triesRemaining: number, maxRetries: number) => {\n  const retryAfter = res.headers.get(\"retry-after\");\n\n  if (retryAfter) {\n    return parseRetryAfter(retryAfter);\n  }\n\n  return Math.min(MAX_RETRY_INTERVAL, 2 ** (maxRetries - triesRemaining) * 1000 + 6000);\n};\n\nconst isRetryableResponse = (res: Response) => {\n  return res.status === 429 || res.status === 502 || res.status === 503;\n};\n\nconst parseRetryAfter = (retryAfter: string): number => {\n  // Try parsing as the <delay-seconds> format\n  const nval = Number(retryAfter);\n\n  if (Number.isFinite(nval)) {\n    return Math.min(MAX_RETRY_WAIT, Math.max(0, nval * 1000));\n  }\n\n  // Try parsing as the <http-date> format\n  const retryDateMs = Date.parse(retryAfter);\n\n  // This case is hit when value couldn't be parsed as a number or date\n  if (Number.isNaN(retryDateMs)) {\n    return 0;\n  }\n\n  // Return the number of millseconds between target date and now\n  return Math.min(MAX_RETRY_WAIT, Math.max(0, retryDateMs - Date.now()));\n};\n\n/**\n * There really shouldn't be a case where the client needs to wait longer than\n * five minutes before retrying a request, so if the API requests a longer retry\n * interval, ignore it.\n */\nconst MAX_RETRY_WAIT = 300_000;\n\n/**\n * When no retry-after is provided, cap the retry interval to 30 seconds.\n */\nconst MAX_RETRY_INTERVAL = 30_000;\n"]}

package/dist/oss/jobs/Job.d.ts

@@ -43,5 +43,5 @@ export declare class Job {
      * @returns A `Job` instance once it's reached a settled state
      */
     retrieveSettled(): Promise<Job>;
-    cancel(): Promise<Result<undefined, HttpError>>;
+    cancel(): Promise<Result<void, HttpError>>;
 }

package/dist/oss/jobs/Job.js.map

@@ -1 +1 @@
-{"version":3,"file":"Job.js","sourceRoot":"","sources":["../../../src/oss/jobs/Job.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAmB,MAAM,MAAM,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAKnD,MAAM,OAAO,GAAG;IACL,YAAY,CAAgC;IAC5C,kBAAkB,CAAsC;IACxD,YAAY,CAAU;IACtB,OAAO,CAA2B;IAClC,EAAE,CAAsB;IACxB,OAAO,CAA2B;IAClC,SAAS,CAA6B;IACtC,yBAAyB,CAA6C;IACtE,2BAA2B,CAA+C;IAC1E,QAAQ,CAA4B;IACpC,SAAS,CAA6B;IACtC,KAAK,CAAyB;IAEvB,QAAQ,CAAkB;IAC1C,OAAO,CAAgB;IAEvB,YACE,UAAyB,EACzB,MAAqB,EACrB,OAA2D;QAE3D,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC,yBAAyB,CAAC;QACtE,IAAI,CAAC,2BAA2B,GAAG,UAAU,CAAC,2BAA2B,CAAC;QAC1E,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAC3B,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;YAChB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;gBACjB,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAC1B,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;oBACb,IAAI,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;wBACnB,MAAM,MAAM,CAAC,KAAK,CAAC;oBACrB,CAAC;oBACD,OAAO,MAAM,CAAC,KAAK,CAAC;gBACtB,CAAC,CAAC,CACH,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;YAC5B,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,IAAI,OAAO;QACT,OAAO,CACL,IAAI,CAAC,KAAK,KAAK,WAAW;YAC1B,IAAI,CAAC,KAAK,KAAK,QAAQ;YACvB,IAAI,CAAC,KAAK,KAAK,eAAe;YAC9B,IAAI,CAAC,KAAK,KAAK,UAAU,CAC1B,CAAC;IACJ,CAAC;IAED,IAAI,OAAO;QACT,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACzC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACnC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,CAAC,YAAY,CACjB,OAA4C,EAAE,EAC9C,EAAE,MAAM,KAAkB,EAAE;QAE5B,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,2EAA2E;QAC3E,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC/B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QAEnC,6EAA6E;QAC7E,IAAI,OAAO,GAAG,IAAI,CAAC;QAEnB,uGAAuG;QACvG,IAAI,MAAM,GAAG,SAAS,CAAC;QAEvB,iEAAiE;QACjE,MAAM,eAAe,GAAG,QAAQ,GAAG,SAAS,CAAC;QAE7C,OAAO,OAAO,IAAI,MAAM,GAAG,eAAe,EAAE,CAAC;YAC3C,uEAAuE;YACvE,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,eAAe,GAAG,MAAM,CAAC,CAAC;YAEtE,MAAM,KAAK,GAAG,CACZ,MAAM,IAAI,CAAC,OAAO;iBACf,cAAc,CAAC,OAAO,IAAI,CAAC,EAAE,mBAAmB,MAAM,UAAU,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;iBACzF,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAoC,CAAC,CAAC,OAAO,CACtE,CAAC,MAAM,EAAE,CAAC;YAEX,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;YAC5B,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC;YAE3C,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;gBACxC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBACrC,MAAM;oBACJ,IAAI,OAAO;wBACT,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC;oBACjC,CAAC;oBACD,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,MAAM;oBACN,SAAS,EAAE,KAAK,CAAC,QAAQ;iBACjB,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,KAAkB,EAAE;QAC1C,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,OAAO,IAAI,CAAC,EAAE,2BAA2B,EAAE,EAAE,MAAM,EAAE,CAAC;aACrE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAiC,CAAC;aACvD,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAClB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,SAAS,EAAE,QAAQ,CAAC,QAAQ;SAC7B,CAAC,CAAC,CAAC,OAAO,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,QAAgB,CAAC,EACjB,MAAc,QAAQ,EACtB,EAAE,MAAM,KAAkB,EAAE;QAE5B,IAAI,CAAC;YACH,MAAM,IAAI,GAAQ,EAAE,CAAC;YACrB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,CACzC,EAAE,KAAK,EAAE,GAAG,GAAG,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EACrC,EAAE,MAAM,EAAE,CACX,EAAE,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,OAAO,IAAI,CAAC,EAAE,SAAS,EAAE;YACvC,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,MAAM;SACf,CAAC;aACD,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;IAClC,CAAC;CACF;AAED,MAAM,cAAc,GAAG,GAAG,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { SonarV3Config } from \"../../common/Config.ts\";\nimport { Err, Ok, Result } from \"ts-results-es\";\nimport { lastValueFrom, map, of, switchMap, type Observable } from \"rxjs\";\nimport type { JobResultsResponse } from \"./utils/JobResultsResponse.ts\";\nimport { mapRowsToColumns } from \"./utils/mapRowsToColumns.ts\";\nimport { mapRowData } from \"./utils/mapRowData.ts\";\nimport type { SignalParam } from \"../../common/Params.ts\";\nimport type { JobProperties } from \"./utils/jobEntityToProperties.ts\";\nimport type { HttpError } from \"../../common/HttpError.ts\";\n\nexport class Job {\n  readonly acceleration: JobProperties[\"acceleration\"];\n  readonly cancellationReason: JobProperties[\"cancellationReason\"];\n  readonly errorMessage?: string;\n  readonly endedAt: JobProperties[\"endedAt\"];\n  readonly id: JobProperties[\"id\"];\n  readonly problem: JobProperties[\"problem\"];\n  readonly queryType: JobProperties[\"queryType\"];\n  readonly resourceSchedulingEndedAt: JobProperties[\"resourceSchedulingEndedAt\"];\n  readonly resourceSchedulingStartedAt: JobProperties[\"resourceSchedulingStartedAt\"];\n  readonly rowCount: JobProperties[\"rowCount\"];\n  readonly startedAt: JobProperties[\"startedAt\"];\n  readonly state: JobProperties[\"state\"];\n\n  public readonly observer: Observable<Job>;\n  #config: SonarV3Config;\n\n  constructor(\n    properties: JobProperties,\n    config: SonarV3Config,\n    observe: (id: string) => Observable<Result<Job, HttpError>>,\n  ) {\n    this.acceleration = properties.acceleration;\n    this.cancellationReason = properties.cancellationReason;\n    this.endedAt = properties.endedAt;\n    this.id = properties.id;\n    this.problem = properties.problem;\n    this.queryType = properties.queryType;\n    this.resourceSchedulingEndedAt = properties.resourceSchedulingEndedAt;\n    this.resourceSchedulingStartedAt = properties.resourceSchedulingStartedAt;\n    this.rowCount = properties.rowCount;\n    this.startedAt = properties.startedAt;\n    this.state = properties.state;\n    this.#config = config;\n    this.observer = of(this).pipe(\n      switchMap((job) => {\n        if (!job.settled) {\n          return observe(this.id).pipe(\n            map((result) => {\n              if (result.isErr()) {\n                throw result.error;\n              }\n              return result.value;\n            }),\n          );\n        } else {\n          return of(job);\n        }\n      }),\n    );\n\n    if (properties.errorMessage) {\n      this.errorMessage = properties.errorMessage;\n    }\n  }\n\n  get settled() {\n    return (\n      this.state === \"COMPLETED\" ||\n      this.state === \"FAILED\" ||\n      this.state === \"INVALID_STATE\" ||\n      this.state === \"CANCELED\"\n    );\n  }\n\n  get results() {\n    return {\n      jsonBatches: this.#jsonBatches.bind(this),\n      metadata: this.#metadata.bind(this),\n      slice: this.#slice.bind(this),\n    };\n  }\n\n  /**\n   * @returns A `Job` instance once it's reached a settled state\n   */\n  retrieveSettled() {\n    return lastValueFrom(this.observer);\n  }\n\n  async *#jsonBatches<T extends Record<string, unknown> = Record<string, unknown>>(\n    args: { limit?: number; offset?: number } = {},\n    { signal }: SignalParam = {},\n  ) {\n    if (typeof args.limit === \"number\" && args.limit < 0) {\n      throw new Error(\"Limit cannot be negative\");\n    }\n\n    if (typeof args.offset === \"number\" && args.offset < 0) {\n      throw new Error(\"Offset cannot be negative\");\n    }\n\n    // Wait for job to enter a settled state before attempting to fetch batches\n    if (!this.settled) {\n      await this.retrieveSettled();\n    }\n\n    const limitArg = args.limit ?? Infinity;\n    const offsetArg = args.offset || 0;\n\n    // Tracks whether there are more rows available from the job results endpoint\n    let hasMore = true;\n\n    // Tracks the currently requested offset. If the offset arg is provided, start from there instead of 0.\n    let offset = offsetArg;\n\n    // Keeps track of the total number of rows that need to be loaded\n    const stopAfterOffset = limitArg + offsetArg;\n\n    while (hasMore && offset < stopAfterOffset) {\n      // Make batch_size dynamic to allow for requesting a smaller final page\n      const batch_size = Math.min(MAX_BATCH_SIZE, stopAfterOffset - offset);\n\n      const batch = (\n        await this.#config\n          .sonarV3Request(`job/${this.id}/results?offset=${offset}&limit=${batch_size}`, { signal })\n          .map((res) => res.json() as Promise<JobResultsResponse<T>>).promise\n      ).unwrap();\n\n      offset += batch.rows.length;\n      hasMore = batch.rows.length === batch_size;\n\n      if (batch.rows.length) {\n        const schema = { fields: batch.schema };\n        mapRowData(batch.rows, batch.schema);\n        yield {\n          get columns() {\n            return mapRowsToColumns(batch);\n          },\n          rows: batch.rows,\n          schema,\n          totalRows: batch.rowCount,\n        } as const;\n      }\n    }\n  }\n\n  async #metadata({ signal }: SignalParam = {}) {\n    return this.#config\n      .sonarV3Request(`job/${this.id}/results?offset=0&limit=0`, { signal })\n      .map((res) => res.json() as Promise<JobResultsResponse>)\n      .map((response) => ({\n        schema: response.schema,\n        totalRows: response.rowCount,\n      })).promise;\n  }\n\n  async #slice<T extends Record<string, unknown> = Record<string, unknown>>(\n    start: number = 0,\n    end: number = Infinity,\n    { signal }: SignalParam = {},\n  ) {\n    try {\n      const rows: T[] = [];\n      for await (const batch of this.#jsonBatches<T>(\n        { limit: end - start, offset: start },\n        { signal },\n      )) {\n        rows.push(...batch.rows);\n      }\n      return Ok(rows);\n    } catch (e: unknown) {\n      return Err(e);\n    }\n  }\n\n  cancel() {\n    return this.#config\n      .sonarV3Request(`job/${this.id}/cancel`, {\n        keepalive: true,\n        method: \"POST\",\n      })\n      .map(() => undefined).promise;\n  }\n}\n\nconst MAX_BATCH_SIZE = 500;\n"]}
+{"version":3,"file":"Job.js","sourceRoot":"","sources":["../../../src/oss/jobs/Job.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAmB,MAAM,MAAM,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAKnD,MAAM,OAAO,GAAG;IACL,YAAY,CAAgC;IAC5C,kBAAkB,CAAsC;IACxD,YAAY,CAAU;IACtB,OAAO,CAA2B;IAClC,EAAE,CAAsB;IACxB,OAAO,CAA2B;IAClC,SAAS,CAA6B;IACtC,yBAAyB,CAA6C;IACtE,2BAA2B,CAA+C;IAC1E,QAAQ,CAA4B;IACpC,SAAS,CAA6B;IACtC,KAAK,CAAyB;IAEvB,QAAQ,CAAkB;IAC1C,OAAO,CAAgB;IAEvB,YACE,UAAyB,EACzB,MAAqB,EACrB,OAA2D;QAE3D,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC,yBAAyB,CAAC;QACtE,IAAI,CAAC,2BAA2B,GAAG,UAAU,CAAC,2BAA2B,CAAC;QAC1E,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAC3B,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;YAChB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;gBACjB,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAC1B,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;oBACb,IAAI,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;wBACnB,MAAM,MAAM,CAAC,KAAK,CAAC;oBACrB,CAAC;oBACD,OAAO,MAAM,CAAC,KAAK,CAAC;gBACtB,CAAC,CAAC,CACH,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;YAC5B,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,IAAI,OAAO;QACT,OAAO,CACL,IAAI,CAAC,KAAK,KAAK,WAAW;YAC1B,IAAI,CAAC,KAAK,KAAK,QAAQ;YACvB,IAAI,CAAC,KAAK,KAAK,eAAe;YAC9B,IAAI,CAAC,KAAK,KAAK,UAAU,CAC1B,CAAC;IACJ,CAAC;IAED,IAAI,OAAO;QACT,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACzC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACnC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,CAAC,YAAY,CACjB,OAA4C,EAAE,EAC9C,EAAE,MAAM,KAAkB,EAAE;QAE5B,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,2EAA2E;QAC3E,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC/B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QAEnC,6EAA6E;QAC7E,IAAI,OAAO,GAAG,IAAI,CAAC;QAEnB,uGAAuG;QACvG,IAAI,MAAM,GAAG,SAAS,CAAC;QAEvB,iEAAiE;QACjE,MAAM,eAAe,GAAG,QAAQ,GAAG,SAAS,CAAC;QAE7C,OAAO,OAAO,IAAI,MAAM,GAAG,eAAe,EAAE,CAAC;YAC3C,uEAAuE;YACvE,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,eAAe,GAAG,MAAM,CAAC,CAAC;YAEtE,MAAM,KAAK,GAAG,CACZ,MAAM,IAAI,CAAC,OAAO;iBACf,cAAc,CAAC,OAAO,IAAI,CAAC,EAAE,mBAAmB,MAAM,UAAU,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;iBACzF,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAoC,CAAC,CAAC,OAAO,CACtE,CAAC,MAAM,EAAE,CAAC;YAEX,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;YAC5B,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC;YAE3C,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;gBACxC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBACrC,MAAM;oBACJ,IAAI,OAAO;wBACT,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC;oBACjC,CAAC;oBACD,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,MAAM;oBACN,SAAS,EAAE,KAAK,CAAC,QAAQ;iBACjB,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,KAAkB,EAAE;QAC1C,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,OAAO,IAAI,CAAC,EAAE,2BAA2B,EAAE,EAAE,MAAM,EAAE,CAAC;aACrE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAiC,CAAC;aACvD,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAClB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,SAAS,EAAE,QAAQ,CAAC,QAAQ;SAC7B,CAAC,CAAC,CAAC,OAAO,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,QAAgB,CAAC,EACjB,MAAc,QAAQ,EACtB,EAAE,MAAM,KAAkB,EAAE;QAE5B,IAAI,CAAC;YACH,MAAM,IAAI,GAAQ,EAAE,CAAC;YACrB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,CACzC,EAAE,KAAK,EAAE,GAAG,GAAG,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EACrC,EAAE,MAAM,EAAE,CACX,EAAE,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,OAAO,IAAI,CAAC,EAAE,SAAS,EAAE;YACvC,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,MAAM;SACf,CAAC;aACD,GAAG,CAAC,GAAG,EAAE,CAAC,SAAiB,CAAC,CAAC,OAAO,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,cAAc,GAAG,GAAG,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { SonarV3Config } from \"../../common/Config.ts\";\nimport { Err, Ok, Result } from \"ts-results-es\";\nimport { lastValueFrom, map, of, switchMap, type Observable } from \"rxjs\";\nimport type { JobResultsResponse } from \"./utils/JobResultsResponse.ts\";\nimport { mapRowsToColumns } from \"./utils/mapRowsToColumns.ts\";\nimport { mapRowData } from \"./utils/mapRowData.ts\";\nimport type { SignalParam } from \"../../common/Params.ts\";\nimport type { JobProperties } from \"./utils/jobEntityToProperties.ts\";\nimport type { HttpError } from \"../../common/HttpError.ts\";\n\nexport class Job {\n  readonly acceleration: JobProperties[\"acceleration\"];\n  readonly cancellationReason: JobProperties[\"cancellationReason\"];\n  readonly errorMessage?: string;\n  readonly endedAt: JobProperties[\"endedAt\"];\n  readonly id: JobProperties[\"id\"];\n  readonly problem: JobProperties[\"problem\"];\n  readonly queryType: JobProperties[\"queryType\"];\n  readonly resourceSchedulingEndedAt: JobProperties[\"resourceSchedulingEndedAt\"];\n  readonly resourceSchedulingStartedAt: JobProperties[\"resourceSchedulingStartedAt\"];\n  readonly rowCount: JobProperties[\"rowCount\"];\n  readonly startedAt: JobProperties[\"startedAt\"];\n  readonly state: JobProperties[\"state\"];\n\n  public readonly observer: Observable<Job>;\n  #config: SonarV3Config;\n\n  constructor(\n    properties: JobProperties,\n    config: SonarV3Config,\n    observe: (id: string) => Observable<Result<Job, HttpError>>,\n  ) {\n    this.acceleration = properties.acceleration;\n    this.cancellationReason = properties.cancellationReason;\n    this.endedAt = properties.endedAt;\n    this.id = properties.id;\n    this.problem = properties.problem;\n    this.queryType = properties.queryType;\n    this.resourceSchedulingEndedAt = properties.resourceSchedulingEndedAt;\n    this.resourceSchedulingStartedAt = properties.resourceSchedulingStartedAt;\n    this.rowCount = properties.rowCount;\n    this.startedAt = properties.startedAt;\n    this.state = properties.state;\n    this.#config = config;\n    this.observer = of(this).pipe(\n      switchMap((job) => {\n        if (!job.settled) {\n          return observe(this.id).pipe(\n            map((result) => {\n              if (result.isErr()) {\n                throw result.error;\n              }\n              return result.value;\n            }),\n          );\n        } else {\n          return of(job);\n        }\n      }),\n    );\n\n    if (properties.errorMessage) {\n      this.errorMessage = properties.errorMessage;\n    }\n  }\n\n  get settled() {\n    return (\n      this.state === \"COMPLETED\" ||\n      this.state === \"FAILED\" ||\n      this.state === \"INVALID_STATE\" ||\n      this.state === \"CANCELED\"\n    );\n  }\n\n  get results() {\n    return {\n      jsonBatches: this.#jsonBatches.bind(this),\n      metadata: this.#metadata.bind(this),\n      slice: this.#slice.bind(this),\n    };\n  }\n\n  /**\n   * @returns A `Job` instance once it's reached a settled state\n   */\n  retrieveSettled() {\n    return lastValueFrom(this.observer);\n  }\n\n  async *#jsonBatches<T extends Record<string, unknown> = Record<string, unknown>>(\n    args: { limit?: number; offset?: number } = {},\n    { signal }: SignalParam = {},\n  ) {\n    if (typeof args.limit === \"number\" && args.limit < 0) {\n      throw new Error(\"Limit cannot be negative\");\n    }\n\n    if (typeof args.offset === \"number\" && args.offset < 0) {\n      throw new Error(\"Offset cannot be negative\");\n    }\n\n    // Wait for job to enter a settled state before attempting to fetch batches\n    if (!this.settled) {\n      await this.retrieveSettled();\n    }\n\n    const limitArg = args.limit ?? Infinity;\n    const offsetArg = args.offset || 0;\n\n    // Tracks whether there are more rows available from the job results endpoint\n    let hasMore = true;\n\n    // Tracks the currently requested offset. If the offset arg is provided, start from there instead of 0.\n    let offset = offsetArg;\n\n    // Keeps track of the total number of rows that need to be loaded\n    const stopAfterOffset = limitArg + offsetArg;\n\n    while (hasMore && offset < stopAfterOffset) {\n      // Make batch_size dynamic to allow for requesting a smaller final page\n      const batch_size = Math.min(MAX_BATCH_SIZE, stopAfterOffset - offset);\n\n      const batch = (\n        await this.#config\n          .sonarV3Request(`job/${this.id}/results?offset=${offset}&limit=${batch_size}`, { signal })\n          .map((res) => res.json() as Promise<JobResultsResponse<T>>).promise\n      ).unwrap();\n\n      offset += batch.rows.length;\n      hasMore = batch.rows.length === batch_size;\n\n      if (batch.rows.length) {\n        const schema = { fields: batch.schema };\n        mapRowData(batch.rows, batch.schema);\n        yield {\n          get columns() {\n            return mapRowsToColumns(batch);\n          },\n          rows: batch.rows,\n          schema,\n          totalRows: batch.rowCount,\n        } as const;\n      }\n    }\n  }\n\n  async #metadata({ signal }: SignalParam = {}) {\n    return this.#config\n      .sonarV3Request(`job/${this.id}/results?offset=0&limit=0`, { signal })\n      .map((res) => res.json() as Promise<JobResultsResponse>)\n      .map((response) => ({\n        schema: response.schema,\n        totalRows: response.rowCount,\n      })).promise;\n  }\n\n  async #slice<T extends Record<string, unknown> = Record<string, unknown>>(\n    start: number = 0,\n    end: number = Infinity,\n    { signal }: SignalParam = {},\n  ) {\n    try {\n      const rows: T[] = [];\n      for await (const batch of this.#jsonBatches<T>(\n        { limit: end - start, offset: start },\n        { signal },\n      )) {\n        rows.push(...batch.rows);\n      }\n      return Ok(rows);\n    } catch (e: unknown) {\n      return Err(e);\n    }\n  }\n\n  cancel() {\n    return this.#config\n      .sonarV3Request(`job/${this.id}/cancel`, {\n        keepalive: true,\n        method: \"POST\",\n      })\n      .map(() => undefined as void).promise;\n  }\n}\n\nconst MAX_BATCH_SIZE = 500;\n"]}

package/dist/oss/jobs/JobsResource.d.ts

@@ -8,6 +8,12 @@ export declare class JobsResource {
     constructor(config: SonarV3Config);
     _jobFromEntity(id: string, entity: JobEntity): Job;
     create(query: Query): Promise<import("ts-results-es").Result<string, import("../index.ts").HttpError>>;
+    /**
+     * Runs multiple queries sequentially, waiting for each one to finish successfully
+     * before starting the next. If a query fails, any subsequent queries will not be
+     * run.
+     */
+    createSequential(queries: Query[]): AsyncGenerator<import("ts-results-es").Result<Job, import("../index.ts").HttpError>, void, unknown>;
     /**
      * A convenience method to combine job creation and retrieval
      */

package/dist/oss/jobs/JobsResource.js

@@ -71,6 +71,26 @@ export class JobsResource {
             .map((response) => response.json())
             .map((response) => response.id).promise;
     }
+    /**
+     * Runs multiple queries sequentially, waiting for each one to finish successfully
+     * before starting the next. If a query fails, any subsequent queries will not be
+     * run.
+     */
+    async *createSequential(queries) {
+        for (let i = 0; i < queries.length; i++) {
+            const result = await this.createAndRetrieve(queries.at(i));
+            yield result;
+            /**
+             * Stop processing additional queries if the job prior to it failed
+             */
+            if (
+            // If it's the last query, return immediately rather than waiting for it to finish
+            i !== queries.length - 1 &&
+                (result.isErr() || (await result.value.retrieveSettled()).state !== "COMPLETED")) {
+                break;
+            }
+        }
+    }
     /**
      * A convenience method to combine job creation and retrieval
      */

package/dist/oss/jobs/JobsResource.js.map

@@ -1 +1 @@
-{"version":3,"file":"JobsResource.js","sourceRoot":"","sources":["../../../src/oss/jobs/JobsResource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAkB,MAAM,kCAAkC,CAAC;AACzF,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,OAAO,YAAY;IACvB,OAAO,CAAgB;IAEvB,oBAAoB,GAAG,CAAC,EAAU,EAAE,EAAE,CACpC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAC/D,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EACjE,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAC7E,CAAC;IAEJ;;OAEG;IACH,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAC/B,CAAC,EAAU,EAAE,EAAE,CACb,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,IAAI,CAChC,GAAG,CAAC;QACF,QAAQ,EAAE,GAAG,EAAE;YACb,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC;KACF,CAAC;IACF;;;OAGG;IACH,WAAW,CAAC;QACV,UAAU,EAAE,CAAC;QACb,QAAQ,EAAE,IAAI;KACf,CAAC,CACH,EACH;QACE;;;;;WAKG;QACH,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,QAAQ;KAClB,CACF,CAAC;IAEF,YAAY,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,cAAc,CAAC,EAAU,EAAE,MAAiB;QAC1C,OAAO,IAAI,GAAG,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,CAAC,KAAY;QACjB,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,KAAK,EAAE;YACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,GAAG,EAAE,KAAK,CAAC,GAAG;aACf,CAAC;YACF,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACnC;YACD,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,MAAM;SACf,CAAC;aACD,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAA6B,CAAC;aAC7D,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,KAAY;QAC5B,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9F,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,QAAQ,CAAC,EAAU,EAAE,EAAE,MAAM,KAAkB,EAAE;QAC/C,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;aACvC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAwB,CAAC;aAC9C,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE,CAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { SonarV3Config } from \"../../common/Config.ts\";\nimport { Job } from \"./Job.ts\";\nimport { Query } from \"../../common/Query.ts\";\nimport { AsyncResult } from \"ts-results-es\";\nimport type { SignalParam } from \"../../common/Params.ts\";\nimport { repeat, shareReplay, takeWhile, tap, timer } from \"rxjs\";\nimport { fromAbortable } from \"../../common/fromAbortable.ts\";\nimport { jobEntityToProperties, type JobEntity } from \"./utils/jobEntityToProperties.ts\";\nimport moize from \"moize\";\n\nexport class JobsResource {\n  #config: SonarV3Config;\n\n  #createJobObservable = (id: string) =>\n    fromAbortable(({ signal }) => this.retrieve(id, { signal })).pipe(\n      repeat({ delay: (count) => timer(jobPollingBackoff(count - 1)) }),\n      takeWhile((jobResult) => jobResult.isOk() && !jobResult.value.settled, true),\n    );\n\n  /**\n   * Reuse the same observable every time the `observe` method is called.\n   */\n  #jobObserverCache = moize.default(\n    (id: string) =>\n      this.#createJobObservable(id).pipe(\n        tap({\n          finalize: () => {\n            this.#jobObserverCache.remove([id]);\n          },\n        }),\n        /**\n         * Reuse the same polling for multiple subscribers, buffering only the latest result.\n         * Make sure to unsubscribe from the source to stop polling when there are no subscribers (refCount: true)\n         */\n        shareReplay({\n          bufferSize: 1,\n          refCount: true,\n        }),\n      ),\n    {\n      /**\n       * Evict cached observables after 60s. We need some way to prevent a memory\n       * leak for long-running SDK processes, and a maxAge of 60 seconds should be\n       * enough to handle multiple subscribers attached programmatically to a job.\n       * If it's not, then the worst case is that we'd make additional API calls.\n       */\n      maxAge: 60_000,\n      maxSize: Infinity,\n    },\n  );\n\n  constructor(config: SonarV3Config) {\n    this.#config = config;\n  }\n\n  _jobFromEntity(id: string, entity: JobEntity): Job {\n    return new Job(jobEntityToProperties(id, entity), this.#config, this.observe.bind(this));\n  }\n\n  create(query: Query) {\n    return this.#config\n      .sonarV3Request(`sql`, {\n        body: JSON.stringify({\n          context: query.context,\n          sql: query.sql,\n        }),\n        headers: {\n          Accept: \"application/json\",\n          \"Content-Type\": \"application/json\",\n        },\n        keepalive: true,\n        method: \"POST\",\n      })\n      .map((response) => response.json() as Promise<{ id: string }>)\n      .map((response) => response.id).promise;\n  }\n\n  /**\n   * A convenience method to combine job creation and retrieval\n   */\n  createAndRetrieve(query: Query) {\n    return new AsyncResult(this.create(query)).andThen((jobId) => this.retrieve(jobId)).promise;\n  }\n\n  observe(id: string) {\n    return this.#jobObserverCache(id);\n  }\n\n  retrieve(id: string, { signal }: SignalParam = {}) {\n    return this.#config\n      .sonarV3Request(`job/${id}`, { signal })\n      .map((res) => res.json() as Promise<JobEntity>)\n      .map((entity) => this._jobFromEntity(id, entity)).promise;\n  }\n}\n\nconst jobPollingBackoff = (count: number) =>\n  Math.min(Math.ceil((Math.max(count, 0) ** 2 / 40 + 1) * 1000), 3_000);\n"]}
+{"version":3,"file":"JobsResource.js","sourceRoot":"","sources":["../../../src/oss/jobs/JobsResource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAkB,MAAM,kCAAkC,CAAC;AACzF,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,OAAO,YAAY;IACvB,OAAO,CAAgB;IAEvB,oBAAoB,GAAG,CAAC,EAAU,EAAE,EAAE,CACpC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAC/D,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EACjE,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAC7E,CAAC;IAEJ;;OAEG;IACH,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAC/B,CAAC,EAAU,EAAE,EAAE,CACb,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,IAAI,CAChC,GAAG,CAAC;QACF,QAAQ,EAAE,GAAG,EAAE;YACb,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC;KACF,CAAC;IACF;;;OAGG;IACH,WAAW,CAAC;QACV,UAAU,EAAE,CAAC;QACb,QAAQ,EAAE,IAAI;KACf,CAAC,CACH,EACH;QACE;;;;;WAKG;QACH,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,QAAQ;KAClB,CACF,CAAC;IAEF,YAAY,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,cAAc,CAAC,EAAU,EAAE,MAAiB;QAC1C,OAAO,IAAI,GAAG,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,CAAC,KAAY;QACjB,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,KAAK,EAAE;YACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,GAAG,EAAE,KAAK,CAAC,GAAG;aACf,CAAC;YACF,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACnC;YACD,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,MAAM;SACf,CAAC;aACD,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAA6B,CAAC;aAC7D,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,gBAAgB,CAAC,OAAgB;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC,CAAC;YAC5D,MAAM,MAAM,CAAC;YAEb;;eAEG;YACH;YACE,kFAAkF;YAClF,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,CAAC;gBACxB,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,KAAK,KAAK,WAAW,CAAC,EAChF,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,KAAY;QAC5B,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9F,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,QAAQ,CAAC,EAAU,EAAE,EAAE,MAAM,KAAkB,EAAE;QAC/C,OAAO,IAAI,CAAC,OAAO;aAChB,cAAc,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;aACvC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAwB,CAAC;aAC9C,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE,CAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { SonarV3Config } from \"../../common/Config.ts\";\nimport { Job } from \"./Job.ts\";\nimport { Query } from \"../../common/Query.ts\";\nimport { AsyncResult } from \"ts-results-es\";\nimport type { SignalParam } from \"../../common/Params.ts\";\nimport { repeat, shareReplay, takeWhile, tap, timer } from \"rxjs\";\nimport { fromAbortable } from \"../../common/fromAbortable.ts\";\nimport { jobEntityToProperties, type JobEntity } from \"./utils/jobEntityToProperties.ts\";\nimport moize from \"moize\";\n\nexport class JobsResource {\n  #config: SonarV3Config;\n\n  #createJobObservable = (id: string) =>\n    fromAbortable(({ signal }) => this.retrieve(id, { signal })).pipe(\n      repeat({ delay: (count) => timer(jobPollingBackoff(count - 1)) }),\n      takeWhile((jobResult) => jobResult.isOk() && !jobResult.value.settled, true),\n    );\n\n  /**\n   * Reuse the same observable every time the `observe` method is called.\n   */\n  #jobObserverCache = moize.default(\n    (id: string) =>\n      this.#createJobObservable(id).pipe(\n        tap({\n          finalize: () => {\n            this.#jobObserverCache.remove([id]);\n          },\n        }),\n        /**\n         * Reuse the same polling for multiple subscribers, buffering only the latest result.\n         * Make sure to unsubscribe from the source to stop polling when there are no subscribers (refCount: true)\n         */\n        shareReplay({\n          bufferSize: 1,\n          refCount: true,\n        }),\n      ),\n    {\n      /**\n       * Evict cached observables after 60s. We need some way to prevent a memory\n       * leak for long-running SDK processes, and a maxAge of 60 seconds should be\n       * enough to handle multiple subscribers attached programmatically to a job.\n       * If it's not, then the worst case is that we'd make additional API calls.\n       */\n      maxAge: 60_000,\n      maxSize: Infinity,\n    },\n  );\n\n  constructor(config: SonarV3Config) {\n    this.#config = config;\n  }\n\n  _jobFromEntity(id: string, entity: JobEntity): Job {\n    return new Job(jobEntityToProperties(id, entity), this.#config, this.observe.bind(this));\n  }\n\n  create(query: Query) {\n    return this.#config\n      .sonarV3Request(`sql`, {\n        body: JSON.stringify({\n          context: query.context,\n          sql: query.sql,\n        }),\n        headers: {\n          Accept: \"application/json\",\n          \"Content-Type\": \"application/json\",\n        },\n        keepalive: true,\n        method: \"POST\",\n      })\n      .map((response) => response.json() as Promise<{ id: string }>)\n      .map((response) => response.id).promise;\n  }\n\n  /**\n   * Runs multiple queries sequentially, waiting for each one to finish successfully\n   * before starting the next. If a query fails, any subsequent queries will not be\n   * run.\n   */\n  async *createSequential(queries: Query[]) {\n    for (let i = 0; i < queries.length; i++) {\n      const result = await this.createAndRetrieve(queries.at(i)!);\n      yield result;\n\n      /**\n       * Stop processing additional queries if the job prior to it failed\n       */\n      if (\n        // If it's the last query, return immediately rather than waiting for it to finish\n        i !== queries.length - 1 &&\n        (result.isErr() || (await result.value.retrieveSettled()).state !== \"COMPLETED\")\n      ) {\n        break;\n      }\n    }\n  }\n\n  /**\n   * A convenience method to combine job creation and retrieval\n   */\n  createAndRetrieve(query: Query) {\n    return new AsyncResult(this.create(query)).andThen((jobId) => this.retrieve(jobId)).promise;\n  }\n\n  observe(id: string) {\n    return this.#jobObserverCache(id);\n  }\n\n  retrieve(id: string, { signal }: SignalParam = {}) {\n    return this.#config\n      .sonarV3Request(`job/${id}`, { signal })\n      .map((res) => res.json() as Promise<JobEntity>)\n      .map((entity) => this._jobFromEntity(id, entity)).promise;\n  }\n}\n\nconst jobPollingBackoff = (count: number) =>\n  Math.min(Math.ceil((Math.max(count, 0) ** 2 / 40 + 1) * 1000), 3_000);\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dremio/js-sdk",
-  "version": "0.16.2",
+  "version": "0.18.0",
   "description": "JavaScript library for the Dremio API",
   "keywords": [
     "dremio",