askui 0.7.0 → 0.7.2

package/dist/esm/lib/download-binaries.js

@@ -1,7 +1,18 @@
+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 fs from 'fs';
 import got from 'got';
 import os from 'os';
 import path from 'path';
+import { promisify } from 'util';
+import stream from 'stream';
 import { getPathToNodeModulesRoot } from '../utils/path';
 import { logger } from './logger';
 var SupportedPlatform;
@@ -25,10 +36,13 @@ export function platform() {
     }
     throw new Error(`Platform "${pf}" is not supported.`);
 }
-function buildBinaryNotAvailbleError(binaryVersion) {
-    return new Error(`It seems that the UI Controller version "${binaryVersion}" for your system "${platform()} ${os.arch}" is not availble, Please contact as at info@askui.com for more information`);
+function buildBinaryNotAvailableError(binaryVersion) {
+    return new Error(`There was an error during downloading and creating the askui UI Controller. You can try a fresh install.
+   If you specified a binary version it is possible that the askui UI Controller version "${binaryVersion}" 
+   for your system "${platform()} ${os.arch}" is not available. 
+   If this problem still occurs, please contact us at info@askui.com for more information`);
 }
-export function getBinaryPath(version) {
+export function getBinaryFilePath(version) {
     return path.join(getPathToNodeModulesRoot(), 'release', version, ...binarySubPathsByPlatform[platform()]);
 }
 function getBinaryDownloadUrl(binaryVersion) {
@@ -37,31 +51,30 @@ function getBinaryDownloadUrl(binaryVersion) {
     return `${baseUrl}/${platform()}/${arch}/${binarySubPathsByPlatform[platform()][1]}`;
 }
 export function downloadServerBinaries(binaryVersion, proxyAgent) {
-    return new Promise((resolve, reject) => {
-        const url = getBinaryDownloadUrl(binaryVersion);
-        const binaryOutputPath = getBinaryPath(binaryVersion);
-        const binaryFolder = path.dirname(binaryOutputPath);
+    return __awaiter(this, void 0, void 0, function* () {
         logger.info(`Start downloading UI Controller version "${binaryVersion}"`);
-        if (!(fs.existsSync(binaryFolder))) {
-            fs.mkdirSync(binaryFolder, { recursive: true });
-        }
+        const url = getBinaryDownloadUrl(binaryVersion);
+        const binaryFilePath = getBinaryFilePath(binaryVersion);
+        const binaryFolderPath = path.dirname(binaryFilePath);
+        const tempFilePath = path.join(binaryFolderPath, 'askui-ui-controller.temp');
+        const pipeline = promisify(stream.pipeline);
         const downloadStream = got.stream(url, proxyAgent ? { agent: proxyAgent } : {});
-        const fileWriterStream = fs.createWriteStream(binaryOutputPath);
-        downloadStream.on('error', () => {
-            reject();
-            fs.unlink(binaryOutputPath, (err) => { logger.error(err); });
-            throw buildBinaryNotAvailbleError(binaryVersion);
-        });
-        fileWriterStream
-            .on('error', () => {
-            fs.unlink(binaryOutputPath, () => { });
-            reject(new Error('oops, an error during the downloaded occurred, try again with fresh install'));
-        })
-            .on('finish', () => {
-            logger.info(`UI Controller version ${binaryVersion} for your system "${platform()} ${os.arch}" was downloaded`);
-            logger.debug(`Binary of UI Controller is located at "${binaryOutputPath}".`);
-            resolve();
-        });
-        downloadStream.pipe(fileWriterStream);
+        const fileWriterStream = fs.createWriteStream(tempFilePath);
+        if (!(fs.existsSync(binaryFolderPath))) {
+            fs.mkdirSync(binaryFolderPath, { recursive: true });
+        }
+        try {
+            yield pipeline(downloadStream, fileWriterStream);
+            fs.rename(tempFilePath, binaryFilePath, () => {
+                logger.info(`UI Controller version ${binaryVersion} for your system "${platform()} ${os.arch}" was downloaded`);
+                logger.debug(`Binary of UI Controller is located at "${binaryFilePath}".`);
+            });
+        }
+        catch (error) {
+            logger.error(error);
+            fs.unlink(tempFilePath, (err) => { logger.error(err); });
+            throw buildBinaryNotAvailableError(binaryVersion);
+        }
+        return Promise.resolve();
     });
 }

package/dist/esm/lib/ui-controller-args.spec.d.ts

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

package/dist/esm/lib/ui-controller-args.spec.js

@@ -0,0 +1,21 @@
+import { createArgsWithDefaults, createCliFlagsFromArgs } from './ui-controller-args';
+describe('createCliFlagsFromArgs()', () => {
+    test('test createCliFlagsFromArgs should return -d 0 as default output', () => {
+        const expected = ['-d 0', '-p 6769', '--action_wait_time 1000', '--host 127.0.0.1', '-m ', '--log-level debug'];
+        const argsWithDefaults = createArgsWithDefaults();
+        const actual = createCliFlagsFromArgs(argsWithDefaults);
+        expect(actual).toStrictEqual(expected);
+    });
+    test('test createCliFlagsFromArgs  output should include -d 0 when no display was selected', () => {
+        const expected = ['-d 0', '-p 6777', '--action_wait_time 1000', '--host 0.0.0.0', '-m ', '--log-level debug'];
+        const argsWithDefaults = createArgsWithDefaults({ port: 6777, host: '0.0.0.0' });
+        const actual = createCliFlagsFromArgs(argsWithDefaults);
+        expect(actual).toStrictEqual(expected);
+    });
+    test('test createCliFlagsFromArgs  output should include the display that was selected ', () => {
+        const expected = ['-d 99', '-p 6777', '--action_wait_time 1000', '--host 0.0.0.0', '-m ', '--log-level debug'];
+        const argsWithDefaults = createArgsWithDefaults({ port: 6777, host: '0.0.0.0', display: 99 });
+        const actual = createCliFlagsFromArgs(argsWithDefaults);
+        expect(actual).toStrictEqual(expected);
+    });
+});

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

@@ -8,7 +8,7 @@ export class UiControllerDarwin extends UiControllerFacade {
         this.makeDiskImageExecutable();
     }
     getStartingCommand() {
-        return `"${path.dirname(this.binaryPath)}/askui-ui-controller.app/Contents/MacOS/askui-ui-controller"`;
+        return `"${path.dirname(this.binaryFilePath)}/askui-ui-controller.app/Contents/MacOS/askui-ui-controller"`;
     }
     makeDiskImageExecutable() {
         const mountPoint = '/Volumes/askui-ui-controller.dmg';
@@ -19,11 +19,11 @@ export class UiControllerDarwin extends UiControllerFacade {
             '-noautofsck',
             '-noautoopen',
             `-mountpoint "${mountPoint}"`,
-            `"${this.binaryPath}"`,
+            `"${this.binaryFilePath}"`,
         ].join(' '));
         const appBaseName = 'askui-ui-controller.app';
         const appSrcPath = `${mountPoint}/${appBaseName}`;
-        const appDestPath = `${path.dirname(this.binaryPath)}/${appBaseName}`;
+        const appDestPath = `${path.dirname(this.binaryFilePath)}/${appBaseName}`;
         fs.removeSync(appDestPath);
         fs.copySync(appSrcPath, appDestPath);
         exec(`hdiutil detach "${mountPoint}"`, (_exception, stdout) => logger.debug(stdout));

package/dist/esm/lib/ui-controller-facade.d.ts

@@ -1,6 +1,6 @@
 import { UiControllerArgs, UiControllerArgsWithDefaults } from './ui-controller-args';
 export declare abstract class UiControllerFacade {
-    protected binaryPath: string;
+    protected binaryFilePath: string;
     protected serverLogFile: string;
     protected readonly DefaultmaxWaitingForStartingInMs: number;
     start(args?: UiControllerArgs, maxWaitingForStartingInSeconds?: number): Promise<void>;
@@ -11,7 +11,6 @@ export declare abstract class UiControllerFacade {
     protected makeBinaryExecutable(): void;
     protected runPreStartChecks(): Promise<void>;
     protected waitUntilStarted(args: UiControllerArgsWithDefaults, maxWaitingForStartingInSeconds?: number): Promise<void>;
-    private isBinaryValid;
     private getBinary;
     private startWithDefaults;
 }

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

@@ -14,14 +14,14 @@ import fkill from 'fkill';
 import os from 'os';
 import path from 'path';
 import { createArgsWithDefaults, createCliFlagsFromArgs, } from './ui-controller-args';
-import { downloadServerBinaries, getBinaryPath } from './download-binaries';
+import { downloadServerBinaries, getBinaryFilePath } 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');
+        this.binaryFilePath = getBinaryFilePath('latest');
         this.DefaultmaxWaitingForStartingInMs = 30 * 1000;
     }
     start(args, maxWaitingForStartingInSeconds) {
@@ -29,7 +29,7 @@ export class UiControllerFacade {
             yield this.runPreStartChecks();
             const argsWithDefaults = createArgsWithDefaults(args);
             const argsWithLogPath = this.serverLogFilePath(argsWithDefaults);
-            this.binaryPath = getBinaryPath(argsWithLogPath.binaryVersion);
+            this.binaryFilePath = getBinaryFilePath(argsWithLogPath.binaryVersion);
             yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary, argsWithLogPath.proxyAgents || (yield buildProxyAgentArgsFromEnvironment()));
             this.makeBinaryExecutable();
             logger.debug(`UI Controller log path "${this.serverLogFile}"`);
@@ -65,7 +65,7 @@ export class UiControllerFacade {
         });
     }
     getStartingCommand() {
-        return `"${this.binaryPath}"`;
+        return `"${this.binaryFilePath}"`;
     }
     // eslint-disable-next-line class-methods-use-this
     makeBinaryExecutable() {
@@ -99,19 +99,14 @@ export class UiControllerFacade {
             }
         });
     }
-    isBinaryValid() {
-        const sizeThresholdInMB = 100;
-        const binarysizeInMB = fs.statSync(this.binaryPath).size / (1024 * 1024);
-        return binarysizeInMB > sizeThresholdInMB;
-    }
     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}"`);
+            if (!fs.existsSync(this.binaryFilePath) || overWriteBinary) {
+                logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryFilePath}"`);
                 yield downloadServerBinaries(binaryVersion, proxyAgent);
             }
             else {
-                logger.debug(`Binary of UI Controller is already present at "${this.binaryPath}".`);
+                logger.debug(`Binary of UI Controller is already present at "${this.binaryFilePath}".`);
             }
         });
     }

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

@@ -16,7 +16,7 @@ import { LibfuseError } from './libfuse-error';
 export class UiControllerLinux extends UiControllerFacade {
     // eslint-disable-next-line class-methods-use-this
     makeBinaryExecutable() {
-        exec(`chmod +x "${this.binaryPath}"`, (_exception, stdout) => logger.debug(stdout));
+        exec(`chmod +x "${this.binaryFilePath}"`, (_exception, stdout) => logger.debug(stdout));
     }
     // eslint-disable-next-line class-methods-use-this
     runPreStartChecks() {

package/dist/esm/utils/http/credentials.spec.d.ts

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

package/dist/esm/utils/http/credentials.spec.js

@@ -0,0 +1,9 @@
+import { Credentials } from './credentials';
+describe('Credentials', () => {
+    describe('base64Encoded()', () => {
+        test('should return base64-encoded credentials', () => {
+            const credentials = new Credentials('password');
+            expect(credentials.base64Encoded).toBe('cGFzc3dvcmQ=');
+        });
+    });
+});

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

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { OptionsOfJSONResponseBody } from 'got';
 import http from 'http';
 import https from 'https';
@@ -17,6 +18,9 @@ export declare class HttpClientGot {
     } | undefined);
     private initHeaders;
     private injectHeadersAndCookies;
-    post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;
+    post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<{
+        headers: http.IncomingHttpHeaders;
+        body: T;
+    }>;
     get<T>(url: string, options?: OptionsOfJSONResponseBody): Promise<T>;
 }

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

@@ -24,18 +24,26 @@ export class HttpClientGot {
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new Credentials(token) : undefined;
-        this.headers = Object.assign(Object.assign({}, (credentials ? { Authorization: `Basic ${credentials === null || credentials === void 0 ? void 0 : credentials.base64Encoded}` } : {})), customHeaders);
+        this.headers = Object.assign(Object.assign({}, (credentials
+            ? { Authorization: `Basic ${credentials === null || credentials === void 0 ? void 0 : credentials.base64Encoded}` }
+            : {})), customHeaders);
     }
     injectHeadersAndCookies(url, options) {
         const cookieJar = new CookieJar();
-        Object.keys(this.cookies).map((key) => `${key}=${this.cookies[key]}`).forEach((cookie) => {
+        Object.keys(this.cookies)
+            .map((key) => `${key}=${this.cookies[key]}`)
+            .forEach((cookie) => {
             cookieJar.setCookieSync(cookie, url);
         });
         return Object.assign(Object.assign({}, options), { headers: this.headers, cookieJar });
     }
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const options = this.injectHeadersAndCookies(url, { json: data, responseType: 'json', throwHttpErrors: false });
+            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']);
@@ -43,7 +51,7 @@ export class HttpClientGot {
             if (statusCode !== 200) {
                 throw httpClientErrorHandler(statusCode, JSON.stringify(body));
             }
-            return body;
+            return { headers, body };
         });
     }
     get(url, options = { responseType: 'json' }) {

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

@@ -1,15 +1,14 @@
 import { aui } from './helper/jest.setup';
 
 describe('jest with askui', () => {
-  it('should click on text', async () => {
-    // Run this to see what askui annotates
+
+  it('should generate an interactive annotation', async () => {
     await aui.annotateInteractively();
+  });
 
-    await aui.moveMouse(0, 0).exec();
+  it('should click on my element', async () => {
     await aui
       .click()
-      .text()
-      .withText('Click on this text right here!')
-      .exec();
+      // <INSERT YOUR COPIED FILTER HERE AND UNCOMMENT THIS LINE>.exec();
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.7.0",
+    "version": "0.7.2",
     "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",