askui 0.31.0 → 0.32.0

package/dist/cjs/utils/http/http-client-got.d.ts

@@ -16,7 +16,22 @@ export declare class HttpClientGot {
         http: http.Agent;
         https: https.Agent;
     } | undefined);
+    /**
+     * Configures got with retry behavior for transient server errors.
+     *
+     * Got retries requests that fail with retryable status codes
+     * (500, 502, 503, 504, etc.) up to `limit` times using exponential backoff.
+     *
+     * POST requests are only retried if their URL is registered in `urlsToRetry`
+     * (see `shouldRetryOnError`), to avoid retrying non-idempotent calls
+     * to unknown endpoints.
+     */
     private buildGotExtendOptions;
+    /**
+     * Only retry POST requests if the URL is explicitly registered in `urlsToRetry`
+     * (populated by InferenceClient with inference endpoint URLs).
+     * Non-POST requests (GET, PUT, etc.) are always retried.
+     */
     private shouldRetryOnError;
     private shouldRetryPostRequest;
     private initHeaders;

package/dist/cjs/utils/http/http-client-got.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -8,16 +31,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpClientGot = void 0;
-const got_1 = __importDefault(require("got"));
+const got_1 = __importStar(require("got"));
 const tough_cookie_1 = require("tough-cookie");
 const lib_1 = require("../../lib");
 const credentials_1 = require("./credentials");
 const custom_errors_1 = require("./custom-errors");
+const unkown_http_client_error_1 = require("./custom-errors/unkown-http-client-error");
 function buildRetryLog(requestUrl, errorCode, statusCode, errorMessage, delayInMs, delayReason, attemptCount) {
     const failureReasons = [];
     if (statusCode !== undefined && statusCode >= 400) {
@@ -46,6 +67,16 @@ class HttpClientGot {
         const gotExtendOptions = this.buildGotExtendOptions(proxyAgents);
         this.askuiGot = got_1.default.extend(gotExtendOptions);
     }
+    /**
+     * Configures got with retry behavior for transient server errors.
+     *
+     * Got retries requests that fail with retryable status codes
+     * (500, 502, 503, 504, etc.) up to `limit` times using exponential backoff.
+     *
+     * POST requests are only retried if their URL is registered in `urlsToRetry`
+     * (see `shouldRetryOnError`), to avoid retrying non-idempotent calls
+     * to unknown endpoints.
+     */
     buildGotExtendOptions(proxyAgents) {
         const gotExtendOptions = {
             retry: {
@@ -93,6 +124,11 @@ class HttpClientGot {
         }
         return gotExtendOptions;
     }
+    /**
+     * Only retry POST requests if the URL is explicitly registered in `urlsToRetry`
+     * (populated by InferenceClient with inference endpoint URLs).
+     * Non-POST requests (GET, PUT, etc.) are always retried.
+     */
     shouldRetryOnError(error) {
         var _a;
         return (((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.method) !== 'POST'
@@ -118,19 +154,31 @@ class HttpClientGot {
     }
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Note: We intentionally do NOT set `throwHttpErrors: false` here.
+            // Got must throw on non-2xx responses so that its built-in retry mechanism
+            // (configured in buildGotExtendOptions) can kick in for transient server errors
+            // (500, 502, 503, 504). After all retries are exhausted, got throws an HTTPError
+            // which we catch below and convert into our custom error hierarchy.
             const options = this.injectHeadersAndCookies(url, {
                 json: data,
                 responseType: 'json',
-                throwHttpErrors: false,
             });
-            const { body, statusCode, headers } = yield this.askuiGot.post(url, options);
-            if (headers['deprecation'] !== undefined) {
-                lib_1.logger.warn(headers['deprecation']);
+            try {
+                const { body, headers } = yield this.askuiGot.post(url, options);
+                if (headers['deprecation'] !== undefined) {
+                    lib_1.logger.warn(headers['deprecation']);
+                }
+                return { body, headers };
             }
-            if (statusCode !== 200) {
-                throw (0, custom_errors_1.httpClientErrorHandler)(statusCode, JSON.stringify(body));
+            catch (error) {
+                // After got exhausts all retries, it throws HTTPError.
+                // Convert it to our custom error types (ServerHttpClientError,
+                // AuthenticationHttpClientError, etc.) for consistent error handling.
+                if (error instanceof got_1.HTTPError) {
+                    throw (0, custom_errors_1.httpClientErrorHandler)(error.response.statusCode, error.response.body);
+                }
+                throw new unkown_http_client_error_1.UnkownHttpClientError(error instanceof Error ? error.message : String(error));
             }
-            return { body, headers };
         });
     }
     get(url_1) {

package/dist/esm/utils/http/http-client-got.d.ts

@@ -16,7 +16,22 @@ export declare class HttpClientGot {
         http: http.Agent;
         https: https.Agent;
     } | undefined);
+    /**
+     * Configures got with retry behavior for transient server errors.
+     *
+     * Got retries requests that fail with retryable status codes
+     * (500, 502, 503, 504, etc.) up to `limit` times using exponential backoff.
+     *
+     * POST requests are only retried if their URL is registered in `urlsToRetry`
+     * (see `shouldRetryOnError`), to avoid retrying non-idempotent calls
+     * to unknown endpoints.
+     */
     private buildGotExtendOptions;
+    /**
+     * Only retry POST requests if the URL is explicitly registered in `urlsToRetry`
+     * (populated by InferenceClient with inference endpoint URLs).
+     * Non-POST requests (GET, PUT, etc.) are always retried.
+     */
     private shouldRetryOnError;
     private shouldRetryPostRequest;
     private initHeaders;

package/dist/esm/utils/http/http-client-got.js

@@ -7,11 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import got from 'got';
+import got, { HTTPError, } from 'got';
 import { CookieJar } from 'tough-cookie';
 import { logger } from '../../lib';
 import { Credentials } from './credentials';
 import { httpClientErrorHandler } from './custom-errors';
+import { UnkownHttpClientError } from './custom-errors/unkown-http-client-error';
 function buildRetryLog(requestUrl, errorCode, statusCode, errorMessage, delayInMs, delayReason, attemptCount) {
     const failureReasons = [];
     if (statusCode !== undefined && statusCode >= 400) {
@@ -40,6 +41,16 @@ export class HttpClientGot {
         const gotExtendOptions = this.buildGotExtendOptions(proxyAgents);
         this.askuiGot = got.extend(gotExtendOptions);
     }
+    /**
+     * Configures got with retry behavior for transient server errors.
+     *
+     * Got retries requests that fail with retryable status codes
+     * (500, 502, 503, 504, etc.) up to `limit` times using exponential backoff.
+     *
+     * POST requests are only retried if their URL is registered in `urlsToRetry`
+     * (see `shouldRetryOnError`), to avoid retrying non-idempotent calls
+     * to unknown endpoints.
+     */
     buildGotExtendOptions(proxyAgents) {
         const gotExtendOptions = {
             retry: {
@@ -87,6 +98,11 @@ export class HttpClientGot {
         }
         return gotExtendOptions;
     }
+    /**
+     * Only retry POST requests if the URL is explicitly registered in `urlsToRetry`
+     * (populated by InferenceClient with inference endpoint URLs).
+     * Non-POST requests (GET, PUT, etc.) are always retried.
+     */
     shouldRetryOnError(error) {
         var _a;
         return (((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.method) !== 'POST'
@@ -112,19 +128,31 @@ export class HttpClientGot {
     }
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Note: We intentionally do NOT set `throwHttpErrors: false` here.
+            // Got must throw on non-2xx responses so that its built-in retry mechanism
+            // (configured in buildGotExtendOptions) can kick in for transient server errors
+            // (500, 502, 503, 504). After all retries are exhausted, got throws an HTTPError
+            // which we catch below and convert into our custom error hierarchy.
             const options = this.injectHeadersAndCookies(url, {
                 json: data,
                 responseType: 'json',
-                throwHttpErrors: false,
             });
-            const { body, statusCode, headers } = yield this.askuiGot.post(url, options);
-            if (headers['deprecation'] !== undefined) {
-                logger.warn(headers['deprecation']);
+            try {
+                const { body, headers } = yield this.askuiGot.post(url, options);
+                if (headers['deprecation'] !== undefined) {
+                    logger.warn(headers['deprecation']);
+                }
+                return { body, headers };
             }
-            if (statusCode !== 200) {
-                throw httpClientErrorHandler(statusCode, JSON.stringify(body));
+            catch (error) {
+                // After got exhausts all retries, it throws HTTPError.
+                // Convert it to our custom error types (ServerHttpClientError,
+                // AuthenticationHttpClientError, etc.) for consistent error handling.
+                if (error instanceof HTTPError) {
+                    throw httpClientErrorHandler(error.response.statusCode, error.response.body);
+                }
+                throw new UnkownHttpClientError(error instanceof Error ? error.message : String(error));
             }
-            return { body, headers };
         });
     }
     get(url_1) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.31.0",
+    "version": "0.32.0",
     "license": "MIT",
     "author": "askui GmbH <info@askui.com> (http://www.askui.com/)",
     "description": "Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on",
@@ -42,7 +42,8 @@
         "test": "cross-env NODE_EXTRA_CA_CERTS='test/proxy/certs/unit_test.pem' jest '/src'",
         "postinstall": "node -e \"require('./bin/askui-postinstall')\"",
         "release:prerelease": "cross-env HUSKY=0 release-it --preRelease=next",
-        "release": "cross-env HUSKY=0 release-it"
+        "release": "cross-env HUSKY=0 release-it",
+        "generate:SBOM": "cyclonedx-npm package.json --omit dev --gather-license-texts --output-file bom.json --output-format JSON"
     },
     "files": [
         "dist/cjs/",
@@ -73,6 +74,7 @@
         "yup": "1.4.0"
     },
     "devDependencies": {
+        "@cyclonedx/cyclonedx-npm": "^4.1.2",
         "@release-it/bumper": "6.0.1",
         "@release-it/conventional-changelog": "8.0.2",
         "@types/fs-extra": "11.0.4",