askui 0.4.0 → 0.6.0

package/dist/esm/lib/ui-controller-facade.js

@@ -18,6 +18,7 @@ import { downloadServerBinaries, getBinaryPath } from './download-binaries';
 import { logger } from './logger';
 import { TimeoutError } from './timeout-error';
 import { UnkownError } from './unkown-error';
+import { buildProxyAgentArgsFromEnvironment } from '../utils/proxy/proxy-builder';
 export class UiControllerFacade {
     constructor() {
         this.binaryPath = getBinaryPath('latest');
@@ -29,7 +30,7 @@ export class UiControllerFacade {
             const argsWithDefaults = createArgsWithDefaults(args);
             const argsWithLogPath = this.serverLogFilePath(argsWithDefaults);
             this.binaryPath = getBinaryPath(argsWithLogPath.binaryVersion);
-            yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary);
+            yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary, argsWithLogPath.proxyAgents || (yield buildProxyAgentArgsFromEnvironment()));
             this.makeBinaryExecutable();
             logger.debug(`UI Controller log path "${this.serverLogFile}"`);
             yield this.startWithDefaults(argsWithLogPath, maxWaitingForStartingInSeconds);
@@ -103,11 +104,11 @@ export class UiControllerFacade {
         const binarysizeInMB = fs.statSync(this.binaryPath).size / (1024 * 1024);
         return binarysizeInMB > sizeThresholdInMB;
     }
-    getBinary(binaryVersion, overWriteBinary = false) {
+    getBinary(binaryVersion, overWriteBinary = false, proxyAgent) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!fs.existsSync(this.binaryPath) || overWriteBinary || !this.isBinaryValid()) {
                 logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryPath}"`);
-                yield downloadServerBinaries(binaryVersion);
+                yield downloadServerBinaries(binaryVersion, proxyAgent);
             }
             else {
                 logger.debug(`Binary of UI Controller is already present at "${this.binaryPath}".`);

package/dist/esm/shared/proxy-agent-args.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="node" />
+import http from 'http';
+import https from 'https';
+/**
+ * Proxy agent configuration for HTTP(S) requests
+ *
+ * All modules which implement the `http.Agent`'s or `https.Agent`'s
+ * interface, respectively, can be used.
+ * We recommend to use [hpagent](https://github.com/delvedore/hpagent).
+ *
+ * Installation:
+ * ```shell
+ * npm install --save hpagent
+ * ```
+ *
+ * Configuration:
+ * ```typescript
+ *  const httpProxyUrl = "http://your-proxy:3128";
+ *  const httpsProxyUrl = "https://your-proxy:3129";
+ *
+ *  const aui = await UiControlClient.build({
+ *    proxyAgents: {
+ *      http: new HttpProxyAgent({ proxy: httpProxyUrl }),
+ *      https: new HttpsProxyAgent({ proxy: httpsProxyUrl }),
+ *    },
+ *  });
+ * ```
+ *
+ * @param {http.Agent} http - Agent for http requests
+ * @param {https.Agent} https - Agent for https requests
+ ** */
+export interface ProxyAgentArgs {
+    http: http.Agent;
+    https: https.Agent;
+}

package/dist/esm/shared/proxy-agent-args.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,10 +1,20 @@
 import { OptionsOfJSONResponseBody } from 'got';
+import http from 'http';
+import https from 'https';
 export declare class HttpClientGot {
     readonly token?: string | undefined;
     readonly customHeaders?: Record<string, string> | undefined;
     private readonly cookies;
+    readonly proxyAgents?: {
+        http: http.Agent;
+        https: https.Agent;
+    } | undefined;
     private headers;
-    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>);
+    private askuiGot;
+    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>, proxyAgents?: {
+        http: http.Agent;
+        https: https.Agent;
+    } | undefined);
     private initHeaders;
     private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;

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

@@ -13,12 +13,14 @@ import { logger } from '../../lib';
 import { Credentials } from './credentials';
 import { httpClientErrorHandler } from './custom-errors';
 export class HttpClientGot {
-    constructor(token, customHeaders, cookies = {}) {
+    constructor(token, customHeaders, cookies = {}, proxyAgents) {
         this.token = token;
         this.customHeaders = customHeaders;
         this.cookies = cookies;
+        this.proxyAgents = proxyAgents;
         this.headers = {};
         this.initHeaders(token, customHeaders);
+        this.askuiGot = got.extend(proxyAgents ? { agent: proxyAgents } : {});
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new Credentials(token) : undefined;
@@ -34,7 +36,7 @@ export class HttpClientGot {
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.injectHeadersAndCookies(url, { json: data, responseType: 'json', throwHttpErrors: false });
-            const { body, statusCode, headers } = yield got.post(url, options);
+            const { body, statusCode, headers } = yield this.askuiGot.post(url, options);
             if (headers['deprecation'] !== undefined) {
                 logger.warn(headers['deprecation']);
             }
@@ -46,7 +48,7 @@ export class HttpClientGot {
     }
     get(url, options = { responseType: 'json' }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield got.get(url, this.injectHeadersAndCookies(url, options));
+            const response = yield this.askuiGot.get(url, this.injectHeadersAndCookies(url, options));
             return response.body;
         });
     }

package/dist/esm/utils/proxy/proxy-builder.d.ts

@@ -0,0 +1,4 @@
+import { ProxyAgentArgs } from '../../shared/proxy-agent-args';
+export declare class ProxyImportError extends Error {
+}
+export declare function buildProxyAgentArgsFromEnvironment(): Promise<ProxyAgentArgs | undefined>;

package/dist/esm/utils/proxy/proxy-builder.js

@@ -0,0 +1,43 @@
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { logger } from '../../lib/logger';
+export class ProxyImportError extends Error {
+}
+function dynmicImportHpagent() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // eslint-disable-next-line import/no-extraneous-dependencies
+            return yield import('hpagent');
+        }
+        catch (err) {
+            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy! Please, install hpagent for proxy support with "npm install --save-dev hpagent".');
+        }
+    });
+}
+export function buildProxyAgentArgsFromEnvironment() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const httpProxyUrl = process.env['HTTP_PROXY'];
+        const httpsProxyUrl = process.env['HTTPS_PROXY'];
+        if (httpProxyUrl === undefined && httpsProxyUrl === undefined) {
+            logger.debug('No proxy defined. "HTTPS_PROXY" and "HTTP_PROXY" environment variables are empty.');
+            return undefined;
+        }
+        const hpagent = yield dynmicImportHpagent();
+        logger.info('Using proxy! One of following environment variables are defined: "HTTPS_PROXY", "https_proxy", "HTTP_PROXY" and "http_proxy"');
+        return {
+            http: new hpagent.HttpProxyAgent({
+                proxy: (httpProxyUrl || httpsProxyUrl),
+            }),
+            https: new hpagent.HttpsProxyAgent({
+                proxy: (httpsProxyUrl || httpProxyUrl),
+            }),
+        };
+    });
+}

package/dist/example_projects_templates/typescript_jest/test/helper/jest.setup.ts

@@ -20,15 +20,20 @@ beforeAll(async () => {
 
   await uiController.start();
 
-  aui = await UiControlClient.build();
+  aui = await UiControlClient.build({
+    credentials: {
+      workspaceId: '<your workspace id>',
+      token: '<your access token>',
+    },
+  });
 
   await aui.connect();
 });
 
 afterAll(async () => {
-  await uiController.stop();
-
   aui.close();
+
+  await uiController.stop();
 });
 
 export { aui };

package/dist/example_projects_templates/typescript_jest/test/my-first-askui-test-suite.test.ts

@@ -2,9 +2,14 @@ import { aui } from './helper/jest.setup';
 
 describe('jest with askui', () => {
   it('should click on text', async () => {
+    // Run this to see what askui annotates
+    await aui.annotateInteractively();
+
+    await aui.moveMouse(0, 0).exec();
     await aui
       .click()
       .text()
+      .withText('Click on this text right here!')
       .exec();
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.4.0",
+    "version": "0.6.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",
@@ -39,7 +39,7 @@
         "copyExampleProject": "shx cp  -r example_projects_templates/ dist/  && shx cp -r bin/* dist/",
         "lint": "eslint --cache --fix --max-warnings 0 \"./**/*.{js,ts}\"",
         "lint:staged": "lint-staged",
-        "test": "jest '/src'",
+        "test": "NODE_EXTRA_CA_CERTS='test/proxy/certs/unit_test.pem' jest '/src'",
         "postinstall": "node -e \"require('./bin/askui-postinstall')\""
     },
     "files": [
@@ -73,7 +73,10 @@
         "@types/url-join": "4.0.1",
         "@types/webrtc": "0.0.30",
         "@types/ws": "7.4.4",
+        "hpagent": "^1.2.0",
         "jest": "28.1.1",
+        "proxy": "^1.0.2",
+        "proxy-agent": "^5.0.0",
         "sharp": "0.30.6",
         "shx": "0.3.4",
         "ts-jest": "28.0.4",