askui 0.10.3 → 0.10.5

package/dist/cjs/execution/dsl.d.ts

@@ -125,7 +125,7 @@ export declare class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    text(text: string | undefined): FluentFiltersOrRelations;
+    text(text?: string): FluentFiltersOrRelations;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -458,7 +458,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    rightOf(optionalIndex?: number | undefined): FluentFilters;
+    rightOf(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element left of another element.
      *
@@ -477,7 +477,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    leftOf(optionalIndex?: number | undefined): FluentFilters;
+    leftOf(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element below another element.
      *
@@ -499,7 +499,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    below(optionalIndex?: number | undefined): FluentFilters;
+    below(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element above another element.
      *
@@ -521,7 +521,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    above(optionalIndex?: number | undefined): FluentFilters;
+    above(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element nearest to another element.
      *
@@ -673,7 +673,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    text(text: string | undefined): FluentFiltersOrRelationsCondition;
+    text(text?: string): FluentFiltersOrRelationsCondition;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -1006,7 +1006,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    rightOf(optionalIndex?: number | undefined): FluentFiltersCondition;
+    rightOf(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element left of another element.
      *
@@ -1025,7 +1025,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    leftOf(optionalIndex?: number | undefined): FluentFiltersCondition;
+    leftOf(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element below another element.
      *
@@ -1047,7 +1047,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    below(optionalIndex?: number | undefined): FluentFiltersCondition;
+    below(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element above another element.
      *
@@ -1069,7 +1069,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    above(optionalIndex?: number | undefined): FluentFiltersCondition;
+    above(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element nearest to another element.
      *
@@ -1666,7 +1666,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    text(text: string | undefined): FluentFiltersOrRelationsGetter;
+    text(text?: string): FluentFiltersOrRelationsGetter;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -1999,7 +1999,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    rightOf(optionalIndex?: number | undefined): FluentFiltersGetter;
+    rightOf(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element left of another element.
      *
@@ -2018,7 +2018,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    leftOf(optionalIndex?: number | undefined): FluentFiltersGetter;
+    leftOf(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element below another element.
      *
@@ -2040,7 +2040,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    below(optionalIndex?: number | undefined): FluentFiltersGetter;
+    below(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element above another element.
      *
@@ -2062,7 +2062,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    above(optionalIndex?: number | undefined): FluentFiltersGetter;
+    above(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element nearest to another element.
      *

package/dist/cjs/execution/inference-client.d.ts

@@ -5,13 +5,13 @@ import { Annotation } from '../core/annotation/annotation';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { ModelCompositionBranch } from './model-composition-branch';
 export declare class InferenceClient {
-    baseUrl: string;
-    httpClient: HttpClientGot;
-    resize?: number | undefined;
+    private readonly baseUrl;
+    private readonly httpClient;
+    private readonly resize?;
     readonly workspaceId?: string | undefined;
     readonly modelComposition?: ModelCompositionBranch[] | undefined;
-    apiVersion: string;
-    url: string;
+    private readonly apiVersion;
+    private urls;
     constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, modelComposition?: ModelCompositionBranch[] | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;

package/dist/cjs/execution/inference-client.js

@@ -29,9 +29,14 @@ class InferenceClient {
         this.modelComposition = modelComposition;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = (0, url_join_1.default)(this.baseUrl, 'api', this.apiVersion);
-        this.url = workspaceId
+        const url = workspaceId
             ? (0, url_join_1.default)(versionedBaseUrl, 'workspaces', workspaceId)
             : versionedBaseUrl;
+        this.urls = {
+            inference: (0, url_join_1.default)(url, 'inference'),
+            isImageRequired: (0, url_join_1.default)(url, 'instruction', 'is-image-required'),
+        };
+        this.httpClient.urlsToRetry = Object.values(this.urls);
         if (this.resize !== undefined && this.resize <= 0) {
             throw new config_error_1.ConfigurationError(`Resize must be a positive number. The current resize value "${this.resize}" is not valid.`);
         }
@@ -39,11 +44,9 @@ class InferenceClient {
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = (0, url_join_1.default)(this.url, 'instruction', 'is-image-required');
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.isImageRequired, {
                 instruction,
-            };
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             return response.body.isImageRequired;
         });
     }
@@ -59,14 +62,12 @@ class InferenceClient {
     inference(customElements = [], image, instruction) {
         return __awaiter(this, void 0, void 0, function* () {
             const resizedImage = yield this.resizeIfNeeded(customElements, image);
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.inference, {
                 image: resizedImage.base64Image,
                 instruction,
                 customElements,
                 modelComposition: this.modelComposition,
-            };
-            const url = (0, url_join_1.default)(this.url, 'inference');
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             InferenceClient.logMetaInformation(response);
             return ui_control_commands_1.InferenceResponse.fromJson(response.body, resizedImage.resizeRatio, image);
         });

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

@@ -12,10 +12,14 @@ export declare class HttpClientGot {
     } | undefined;
     private headers;
     private askuiGot;
+    urlsToRetry: string[];
     constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>, proxyAgents?: {
         http: http.Agent;
         https: https.Agent;
     } | undefined);
+    private buildGotExtendOptions;
+    private shouldRetryOnError;
+    private shouldRetryPostRequest;
     private initHeaders;
     private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<{

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

@@ -25,8 +25,55 @@ class HttpClientGot {
         this.cookies = cookies;
         this.proxyAgents = proxyAgents;
         this.headers = {};
+        this.urlsToRetry = [];
         this.initHeaders(token, customHeaders);
-        this.askuiGot = got_1.default.extend(proxyAgents ? { agent: proxyAgents } : {});
+        const gotExtendOptions = this.buildGotExtendOptions(proxyAgents);
+        this.askuiGot = got_1.default.extend(gotExtendOptions);
+    }
+    buildGotExtendOptions(proxyAgents) {
+        const gotExtendOptions = {
+            retry: {
+                limit: 5,
+                methods: ['POST', 'GET', 'PUT', 'HEAD', 'DELETE', 'OPTIONS', 'TRACE'],
+                statusCodes: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                errorCodes: [
+                    'ETIMEDOUT',
+                    'ECONNRESET',
+                    'EADDRINUSE',
+                    'ECONNREFUSED',
+                    'EPIPE',
+                    'ENOTFOUND',
+                    'ENETUNREACH',
+                    'EAI_AGAIN',
+                ],
+                calculateDelay: ({ attemptCount, retryOptions, error, computedValue, }) => {
+                    var _a, _b, _c;
+                    if (attemptCount > retryOptions.limit
+                        || !this.shouldRetryOnError(error)) {
+                        return 0;
+                    }
+                    if (error.response !== undefined
+                        && error.response.headers['retry-after'] === undefined) {
+                        lib_1.logger.debug(`Request to ${(_a = error.request) === null || _a === void 0 ? void 0 : _a.requestUrl} failed with status code ${(_b = error.response) === null || _b === void 0 ? void 0 : _b.statusCode}.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                        return Math.min(1000 * Math.pow(2, (attemptCount - 1)) + Math.random() * 100, Number.MAX_SAFE_INTEGER);
+                    }
+                    lib_1.logger.debug(`Request to ${(_c = error.request) === null || _c === void 0 ? void 0 : _c.requestUrl} failed.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                    return computedValue;
+                },
+            },
+        };
+        if (proxyAgents) {
+            gotExtendOptions.agent = proxyAgents;
+        }
+        return gotExtendOptions;
+    }
+    shouldRetryOnError(error) {
+        var _a;
+        return (((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.method) !== 'POST'
+            || this.shouldRetryPostRequest(error.request));
+    }
+    shouldRetryPostRequest(request) {
+        return (request !== undefined && this.urlsToRetry.includes(request.requestUrl));
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new credentials_1.Credentials(token) : undefined;

package/dist/esm/execution/dsl.d.ts

@@ -125,7 +125,7 @@ export declare class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    text(text: string | undefined): FluentFiltersOrRelations;
+    text(text?: string): FluentFiltersOrRelations;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -458,7 +458,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    rightOf(optionalIndex?: number | undefined): FluentFilters;
+    rightOf(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element left of another element.
      *
@@ -477,7 +477,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    leftOf(optionalIndex?: number | undefined): FluentFilters;
+    leftOf(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element below another element.
      *
@@ -499,7 +499,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    below(optionalIndex?: number | undefined): FluentFilters;
+    below(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element above another element.
      *
@@ -521,7 +521,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    above(optionalIndex?: number | undefined): FluentFilters;
+    above(optionalIndex?: number): FluentFilters;
     /**
      * Filters for an element nearest to another element.
      *
@@ -673,7 +673,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    text(text: string | undefined): FluentFiltersOrRelationsCondition;
+    text(text?: string): FluentFiltersOrRelationsCondition;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -1006,7 +1006,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    rightOf(optionalIndex?: number | undefined): FluentFiltersCondition;
+    rightOf(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element left of another element.
      *
@@ -1025,7 +1025,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    leftOf(optionalIndex?: number | undefined): FluentFiltersCondition;
+    leftOf(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element below another element.
      *
@@ -1047,7 +1047,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    below(optionalIndex?: number | undefined): FluentFiltersCondition;
+    below(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element above another element.
      *
@@ -1069,7 +1069,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    above(optionalIndex?: number | undefined): FluentFiltersCondition;
+    above(optionalIndex?: number): FluentFiltersCondition;
     /**
      * Filters for an element nearest to another element.
      *
@@ -1666,7 +1666,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    text(text: string | undefined): FluentFiltersOrRelationsGetter;
+    text(text?: string): FluentFiltersOrRelationsGetter;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -1999,7 +1999,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    rightOf(optionalIndex?: number | undefined): FluentFiltersGetter;
+    rightOf(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element left of another element.
      *
@@ -2018,7 +2018,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    leftOf(optionalIndex?: number | undefined): FluentFiltersGetter;
+    leftOf(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element below another element.
      *
@@ -2040,7 +2040,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    below(optionalIndex?: number | undefined): FluentFiltersGetter;
+    below(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element above another element.
      *
@@ -2062,7 +2062,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    above(optionalIndex?: number | undefined): FluentFiltersGetter;
+    above(optionalIndex?: number): FluentFiltersGetter;
     /**
      * Filters for an element nearest to another element.
      *

package/dist/esm/execution/inference-client.d.ts

@@ -5,13 +5,13 @@ import { Annotation } from '../core/annotation/annotation';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { ModelCompositionBranch } from './model-composition-branch';
 export declare class InferenceClient {
-    baseUrl: string;
-    httpClient: HttpClientGot;
-    resize?: number | undefined;
+    private readonly baseUrl;
+    private readonly httpClient;
+    private readonly resize?;
     readonly workspaceId?: string | undefined;
     readonly modelComposition?: ModelCompositionBranch[] | undefined;
-    apiVersion: string;
-    url: string;
+    private readonly apiVersion;
+    private urls;
     constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, modelComposition?: ModelCompositionBranch[] | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;

package/dist/esm/execution/inference-client.js

@@ -23,9 +23,14 @@ export class InferenceClient {
         this.modelComposition = modelComposition;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = urljoin(this.baseUrl, 'api', this.apiVersion);
-        this.url = workspaceId
+        const url = workspaceId
             ? urljoin(versionedBaseUrl, 'workspaces', workspaceId)
             : versionedBaseUrl;
+        this.urls = {
+            inference: urljoin(url, 'inference'),
+            isImageRequired: urljoin(url, 'instruction', 'is-image-required'),
+        };
+        this.httpClient.urlsToRetry = Object.values(this.urls);
         if (this.resize !== undefined && this.resize <= 0) {
             throw new ConfigurationError(`Resize must be a positive number. The current resize value "${this.resize}" is not valid.`);
         }
@@ -33,11 +38,9 @@ export class InferenceClient {
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = urljoin(this.url, 'instruction', 'is-image-required');
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.isImageRequired, {
                 instruction,
-            };
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             return response.body.isImageRequired;
         });
     }
@@ -53,14 +56,12 @@ export class InferenceClient {
     inference(customElements = [], image, instruction) {
         return __awaiter(this, void 0, void 0, function* () {
             const resizedImage = yield this.resizeIfNeeded(customElements, image);
-            const requestBody = {
+            const response = yield this.httpClient.post(this.urls.inference, {
                 image: resizedImage.base64Image,
                 instruction,
                 customElements,
                 modelComposition: this.modelComposition,
-            };
-            const url = urljoin(this.url, 'inference');
-            const response = yield this.httpClient.post(url, requestBody);
+            });
             InferenceClient.logMetaInformation(response);
             return InferenceResponse.fromJson(response.body, resizedImage.resizeRatio, image);
         });

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

@@ -12,10 +12,14 @@ export declare class HttpClientGot {
     } | undefined;
     private headers;
     private askuiGot;
+    urlsToRetry: string[];
     constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>, proxyAgents?: {
         http: http.Agent;
         https: https.Agent;
     } | undefined);
+    private buildGotExtendOptions;
+    private shouldRetryOnError;
+    private shouldRetryPostRequest;
     private initHeaders;
     private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<{

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

@@ -19,8 +19,55 @@ export class HttpClientGot {
         this.cookies = cookies;
         this.proxyAgents = proxyAgents;
         this.headers = {};
+        this.urlsToRetry = [];
         this.initHeaders(token, customHeaders);
-        this.askuiGot = got.extend(proxyAgents ? { agent: proxyAgents } : {});
+        const gotExtendOptions = this.buildGotExtendOptions(proxyAgents);
+        this.askuiGot = got.extend(gotExtendOptions);
+    }
+    buildGotExtendOptions(proxyAgents) {
+        const gotExtendOptions = {
+            retry: {
+                limit: 5,
+                methods: ['POST', 'GET', 'PUT', 'HEAD', 'DELETE', 'OPTIONS', 'TRACE'],
+                statusCodes: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                errorCodes: [
+                    'ETIMEDOUT',
+                    'ECONNRESET',
+                    'EADDRINUSE',
+                    'ECONNREFUSED',
+                    'EPIPE',
+                    'ENOTFOUND',
+                    'ENETUNREACH',
+                    'EAI_AGAIN',
+                ],
+                calculateDelay: ({ attemptCount, retryOptions, error, computedValue, }) => {
+                    var _a, _b, _c;
+                    if (attemptCount > retryOptions.limit
+                        || !this.shouldRetryOnError(error)) {
+                        return 0;
+                    }
+                    if (error.response !== undefined
+                        && error.response.headers['retry-after'] === undefined) {
+                        logger.debug(`Request to ${(_a = error.request) === null || _a === void 0 ? void 0 : _a.requestUrl} failed with status code ${(_b = error.response) === null || _b === void 0 ? void 0 : _b.statusCode}.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                        return Math.min(1000 * Math.pow(2, (attemptCount - 1)) + Math.random() * 100, Number.MAX_SAFE_INTEGER);
+                    }
+                    logger.debug(`Request to ${(_c = error.request) === null || _c === void 0 ? void 0 : _c.requestUrl} failed.\n${error.message}\nRetrying... (attempt ${attemptCount})`);
+                    return computedValue;
+                },
+            },
+        };
+        if (proxyAgents) {
+            gotExtendOptions.agent = proxyAgents;
+        }
+        return gotExtendOptions;
+    }
+    shouldRetryOnError(error) {
+        var _a;
+        return (((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.method) !== 'POST'
+            || this.shouldRetryPostRequest(error.request));
+    }
+    shouldRetryPostRequest(request) {
+        return (request !== undefined && this.urlsToRetry.includes(request.requestUrl));
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new Credentials(token) : undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.10.3",
+    "version": "0.10.5",
     "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",
@@ -52,7 +52,7 @@
         "commander": "8.3.0",
         "fkill": "7.2.1",
         "fs-extra": "10.0.0",
-        "got": "11.8.2",
+        "got": "11.8.6",
         "jsdom": "20.0.0",
         "node-machine-id": "1.1.12",
         "pino": "7.8.1",