@testim/testim-cli 3.253.0 → 3.254.0

package/agent/routers/playground/service.js

@@ -1,12 +1,13 @@
-"use strict";
+'use strict';
 
 const Promise = require('bluebird');
 const util = require('util');
 const writeFileAsync = util.promisify(require('fs').writeFile);
 const path = require('path');
-const {fork} = require('child_process');
+const { fork } = require('child_process');
 const os = require('os');
-const {ClientError, PlaygroundCodeError} = require('../../../errors');
+const { ClientError, PlaygroundCodeError } = require('../../../errors');
+
 const CODE_TYPES = ['playwright', 'selenium', 'puppeteer'];
 
 const runForks = {};
@@ -21,28 +22,28 @@ const forkAsync = (fileFullPath) => {
     let gotResolved;
     const promise = new Promise(resolve => gotResolved = resolve);
 
-    const child = fork(fileFullPath, {stdio: [ 'inherit', 'inherit', 'inherit', 'ipc' ]});
+    const child = fork(fileFullPath, { stdio: ['inherit', 'inherit', 'inherit', 'ipc'] });
     promise.child = child;
     child.on('message', (message) => {
-        if(!message) {
+        if (!message) {
             return;
         }
-        const {type, error} = message;
-        if(error && ['uncaughtException', 'unhandledRejection'].includes(type)) {
-            return gotResolved({error: Object.assign(new PlaygroundCodeError(), {innerStack: message.error.stack})})
+        const { type, error } = message;
+        if (error && ['uncaughtException', 'unhandledRejection'].includes(type)) {
+            return gotResolved({ error: Object.assign(new PlaygroundCodeError(), { innerStack: message.error.stack }) });
         }
     });
     child.on('error', (error) => {
-        gotResolved({error});
+        gotResolved({ error });
     });
     child.on('exit', (exitCode) => {
-        gotResolved({exitCode});
+        gotResolved({ exitCode });
     });
 
     return promise;
 };
 
-async function runCodeLocally({code}) {
+async function runCodeLocally({ code }) {
     const forkId = Date.now();
     try {
         const codeWithExtra = `
@@ -60,25 +61,25 @@ async function runCodeLocally({code}) {
         const fileFullPath = await createTempFile(`tst-playground-${Date.now()}.js`, codeWithExtra);
         const promiseExec = forkAsync(fileFullPath);
         runForks[forkId] = promiseExec.child;
-        const {error, exitCode} = await promiseExec;
-        if(error) {
+        const { error, exitCode } = await promiseExec;
+        if (error) {
             throw error;
         }
-        if(exitCode !== 0) {
+        if (exitCode !== 0) {
             throw new Error(`Process exited with exit code: ${exitCode}`);
         }
         return undefined;
     } finally {
-        if(runForks[forkId]) {
+        if (runForks[forkId]) {
             runForks[forkId].kill();
             delete runForks[forkId];
         }
     }
 }
 
-async function runPlaygroundTest({code, type}) {
-    if(['playwright', 'puppeteer', 'selenium'].includes(type)) {
-        return runCodeLocally({code});
+async function runPlaygroundTest({ code, type }) {
+    if (['playwright', 'puppeteer', 'selenium'].includes(type)) {
+        return runCodeLocally({ code });
     }
     throw new ClientError();
 }

package/agent/routers/standalone-browser/registerRoutes.js

@@ -1,11 +1,12 @@
 // @ts-check
-"use strict";
+
+'use strict';
 
 const express = require('express');
 
 module.exports = {
-    standaloneBrowserRoutes
-}
+    standaloneBrowserRoutes,
+};
 
 /**
  * @param {{
@@ -13,33 +14,32 @@ module.exports = {
 }} [testimStandaloneBrowser]
  */
 function standaloneBrowserRoutes(testimStandaloneBrowser) {
-
     const router = express.Router();
 
-    router.get("/cdp-url", (req, res) => {
+    router.get('/cdp-url', (req, res) => {
         if (!testimStandaloneBrowser) {
             res.status(503).send({
-                error: "Testim standalone browser is not running"
+                error: 'Testim standalone browser is not running',
             });
 
             return;
         }
 
         res.status(200).send({
-            url: testimStandaloneBrowser.webdriverApi.cdpUrl
+            url: testimStandaloneBrowser.webdriverApi.cdpUrl,
         });
     });
 
-    router.get("/status", (req, res) => {
+    router.get('/status', (req, res) => {
         if (!testimStandaloneBrowser) {
             res.status(503).send({
-                ok: false
+                ok: false,
             });
             return;
         }
 
         res.status(200).send({
-            ok: true
+            ok: true,
         });
     });
 

package/cdpTestRunner.js

@@ -1,5 +1,6 @@
 const WebSocket = require('ws');
 const Promise = require('bluebird');
+const { promiseFromCallback } = require('./utils');
 
 
 class CDPTestRunner {
@@ -20,11 +21,11 @@ class CDPTestRunner {
         }
         const websocket = new WebSocket(this._cdpUrl, { timeout });
 
-        const openPromise = Promise.fromCallback((cb) => {
+        const openPromise = promiseFromCallback((cb) => {
             websocket.once('open', cb);
         });
 
-        const errorPromise = Promise.fromCallback((cb) => {
+        const errorPromise = promiseFromCallback((cb) => {
             websocket.once('error', cb);
         }).catch(() => {
             websocket.close();
@@ -46,7 +47,7 @@ class CDPTestRunner {
         this._cdpCallbacks.delete(object.id);
         if (object.error) {
             callback.reject(new Error(object.error));
-        } else if (object.result.exceptionDetails && object.result.exceptionDetails.exception) {
+        } else if (object.result.exceptionDetails?.exception) {
             callback.reject(new Error(object.result.exceptionDetails.exception.description));
         } else {
             callback.resolve(object.result);

package/chromiumInstaller.js

@@ -2,8 +2,7 @@ const path = require('path');
 const os = require('os');
 const fs = require('fs-extra');
 const { ArgError } = require('./errors');
-const { unzipFile } = require('./utils');
-const { downloadAndSave, TESTIM_BROWSER_DIR } = require('./utils');
+const { downloadAndSave, unzipFile, TESTIM_BROWSER_DIR } = require('./utils');
 const ora = require('ora');
 
 
@@ -30,7 +29,7 @@ async function downloadAndInstallChromium() {
     const platformFolder = {
         linux: 'Linux_x64',
         mac: 'Mac',
-        mac_arm: 'Mac_Arm',
+        mac_arm: 'Mac_Arm', // eslint-disable-line camelcase
         win32: 'Win',
         win64: 'Win_x64',
     };
@@ -42,14 +41,14 @@ async function downloadAndInstallChromium() {
     const platformArchiveName = {
         linux: 'chrome-linux',
         mac: 'chrome-mac',
-        mac_arm: 'chrome-mac',
+        mac_arm: 'chrome-mac', // eslint-disable-line camelcase
         win32: winArchiveName,
         win64: winArchiveName,
     };
     const binaryPaths = {
         linux: 'chrome',
         mac: 'Chromium.app/Contents/MacOS/Chromium',
-        mac_arm: 'Chromium.app/Contents/MacOS/Chromium',
+        mac_arm: 'Chromium.app/Contents/MacOS/Chromium', // eslint-disable-line camelcase
         win32: 'chrome.exe',
         win64: 'chrome.exe',
     };

package/cli/onExit.js

@@ -48,12 +48,12 @@ module.exports.ignoreFailingTestsInExitCode = function () {
 
 
 module.exports.onExit = async function onExit(exitValue) {
-    if (exitValue && exitValue.stack) {
+    if (exitValue?.stack) {
         if (!isCi) {
             writeStackTrace(exitValue);
         } else {
             // eslint-disable-next-line no-console
-            console.error(exitValue, exitValue && exitValue.stack);
+            console.error(exitValue, exitValue.stack);
         }
     }
 

package/cli.js

@@ -35,15 +35,16 @@ async function checkNodeVersion() {
         throw new ArgError(`Required node version ${version} not satisfied with current version ${process.version}`);
     }
 
-    const majorVersion = Number(process.version.replace('v', '').split('.')[0]);
-    const dateHasPassed = new Date('2022-08-01T00:00:00.000Z') <= new Date();
+    const minimalNodeVersion = 16;
+    const majorVersion = Number(process.versions.node.split('.')[0]);
+    const dateHasPassed = new Date('2023-04-30T00:00:00.000Z') <= new Date();
 
-    if (majorVersion < 14 && dateHasPassed) {
-        throw new ArgError('Testim.io CLI supports Node.js 14 and above, please upgrade to a newer Node.js version');
+    if (majorVersion < minimalNodeVersion && dateHasPassed) {
+        throw new ArgError(`Testim.io CLI supports Node.js ${minimalNodeVersion} and above, please upgrade to a newer Node.js version`);
     }
 
-    if (majorVersion < 14) {
-        console.log('\x1b[33m%s\x1b[0m', 'Testim.io CLI will stop supporting Node.js < 14 on August 1st 2022, please upgrade to a newer Node.js version');
+    if (majorVersion < minimalNodeVersion) {
+        console.log('\x1b[33m%s\x1b[0m', `Testim.io CLI will stop supporting Node.js < ${minimalNodeVersion} on April 30 2023, please upgrade to a newer Node.js version`);
     }
 }
 

package/cliAgentMode.js

@@ -7,13 +7,12 @@ const path = require('path');
 const fs = require('fs-extra');
 const ms = require('ms');
 const WebSocket = require('ws');
-const Bluebird = require('bluebird');
 const ChromeLauncher = require('chrome-launcher');
 const config = require('./commons/config');
 const { ArgError } = require('./errors');
 const lazyRequire = require('./commons/lazyRequire');
 const prepareUtils = require('./commons/prepareRunnerAndTestimStartUtils');
-const { downloadAndSave, unzipFile, getCdpAddressForHost, TESTIM_BROWSER_DIR } = require('./utils');
+const { downloadAndSave, unzipFile, getCdpAddressForHost, TESTIM_BROWSER_DIR, promiseFromCallback } = require('./utils');
 const ora = require('ora');
 const { downloadAndInstallChromium, CHROMIUM_VERSION } = require('./chromiumInstaller');
 
@@ -361,7 +360,7 @@ async function readAndValidateChromedriverDevToolsActivePortFile() {
 async function tryToCloseBrowserWithCDPUrl(webSocketDebuggerUrl, timeout = 100) {
     const websocketConnection = await wsConnectAndOpen(webSocketDebuggerUrl, timeout);
 
-    return Bluebird.fromCallback(cb => {
+    return promiseFromCallback(cb => {
         websocketConnection.send(JSON.stringify({
             id: 0,
             method: 'Browser.close',
@@ -376,13 +375,13 @@ async function tryToCloseBrowserWithCDPUrl(webSocketDebuggerUrl, timeout = 100)
 async function wsConnectAndOpen(webSocketDebuggerUrl, timeout = 100) {
     const websocket = new WebSocket(webSocketDebuggerUrl, { timeout });
 
-    const openPromise = Bluebird.fromCallback((cb) => {
+    const openPromise = promiseFromCallback((cb) => {
         websocket.once('open', cb);
     }).then(() => {
         websocket.removeAllListeners();
     });
 
-    const errorPromise = Bluebird.fromCallback((cb) => {
+    const errorPromise = promiseFromCallback((cb) => {
         websocket.once('error', cb);
     }).catch(() => {
         websocket.close();

package/codim/codim-cli.js

@@ -1,10 +1,12 @@
-"use strict";
+/* eslint-disable no-console */
+
+'use strict';
 
 const { promisifyAll } = require('bluebird');
 const fse = require('fs-extra');
 const exec = promisifyAll(require('child_process')).execAsync;
 const path = require('path');
-const validateNpmPackageName = require("validate-npm-package-name");
+const validateNpmPackageName = require('validate-npm-package-name');
 const ArgError = require('../errors.js').ArgError;
 
 module.exports.init = async function init(name) {
@@ -16,19 +18,19 @@ module.exports.init = async function init(name) {
             type: 'text',
             name: 'project',
             message: 'Please enter Project name',
-            validate: value => String(value).length > 3
+            validate: value => String(value).length > 3,
         });
         name = response.project;
     }
 
-    const fullpath = path.resolve(name);
+    const fullPath = path.resolve(name);
 
-    if (fse.existsSync(fullpath) && fse.readdirSync(fullpath).length !== 0) {
-        console.log(`${fullpath} is not empty. Quiting...`);
+    if (fse.existsSync(fullPath) && fse.readdirSync(fullPath).length !== 0) {
+        console.log(`${fullPath} is not empty. Quitting...`);
         process.exit(1);
     }
 
-    const packageName = fullpath.substr(Math.max(fullpath.lastIndexOf('/'), fullpath.lastIndexOf('\\')) + 1);
+    const packageName = fullPath.substr(Math.max(fullPath.lastIndexOf('/'), fullPath.lastIndexOf('\\')) + 1);
 
     const nameValidity = validateNpmPackageName(packageName);
 
@@ -36,7 +38,7 @@ module.exports.init = async function init(name) {
         if (nameValidity.errors) nameValidity.errors.forEach((e) => console.log(e));
         if (nameValidity.warnings) nameValidity.warnings.forEach((e) => console.log(e));
 
-        throw new ArgError("Package name is not valid");
+        throw new ArgError('Package name is not valid');
     }
 
     const response = await prompts({
@@ -45,7 +47,7 @@ module.exports.init = async function init(name) {
         message: 'Add support for TypeScript?',
         initial: true,
         active: 'no',
-        inactive: 'yes'
+        inactive: 'yes',
     });
 
     const sourceFolder = response.isJs ? 'template.js' : 'template.ts';
@@ -77,5 +79,4 @@ module.exports.init = async function init(name) {
     spinner.succeed();
 
     console.log(`Testim Dev Kit project folder successfully created in ${dest}.`);
-
 };

package/codim/hybrid-utils.js

@@ -4,7 +4,7 @@ module.exports.getArgumentsFromContext = async function getArgumentsFromContext(
     step,
     context,
     locatorStrategy
-)  {
+) {
     const argsInCorrectOrder = fixArgsOrdering(step.parameterNames.map(p => p.displayName), context.incomingParams.as);
 
     return await Promise.all(argsInCorrectOrder.map(arg => {

package/codim/measure-perf.js

@@ -1,8 +1,9 @@
+/* eslint-disable no-console */
 const startTime = Date.now();
 let last = 0;
 global.log = function time(message) {
-    let time = Date.now() - startTime;
-    console.log(time, time - last ,message);
+    const time = Date.now() - startTime;
+    console.log(time, time - last, message);
     last = time;
 };
 global.perf = function perf(fn) {
@@ -12,22 +13,24 @@ global.perf = function perf(fn) {
     } finally {
         console.log(fn.name, 'took', Date.now() - start);
     }
-}
+};
 
 require('bluebird').prototype.log = function log(message) {
     return this.tap(() => global.log(message));
-}
+};
 
 global.measureRequireTimes = () => {
     'use strict';
+
     const {
         performance,
-        PerformanceObserver
+        PerformanceObserver,
     } = require('perf_hooks');
     const mod = require('module');
 
     // Monkey patch the require function
     mod.Module.prototype.require = performance.timerify(mod.Module.prototype.require);
+    // eslint-disable-next-line no-global-assign
     require = performance.timerify(require);
 
     // Activate the observer
@@ -39,4 +42,4 @@ global.measureRequireTimes = () => {
         obs.disconnect();
     });
     obs.observe({ entryTypes: ['function'], buffered: true });
-}
+};

package/codim/template.js/tests/examples/01-simple-text-validation.test.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 // Import Testim Dev Kit methods
 const { go, text, test, l, Locator } = require('testim');
@@ -10,12 +10,12 @@ const { expect } = require('chai');
 Locator.set(require('./locators/locators.js'));
 
 test('Simple text validation', async () => {
-  await go("http://demo.testim.io");
+    await go('http://demo.testim.io');
 
-  // Grab the title text and store it in a const
-  const title = await text(l("SPACE_&_BEYOND"));
+    // Grab the title text and store it in a const
+    const title = await text(l('SPACE_&_BEYOND'));
 
-  // Use Chai to assert the title text is correct
-  expect(title).to.eq('Space & Beyond');
+    // Use Chai to assert the title text is correct
+    expect(title).to.eq('Space & Beyond');
 }); // end of test
 

package/codim/template.js/tests/examples/02-using-locators.test.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 // Import Testim Dev Kit methods
 const { go, waitForText, scrollToElement, click, test, l, Locator } = require('testim');
@@ -7,24 +7,22 @@ const { go, waitForText, scrollToElement, click, test, l, Locator } = require('t
 Locator.set(require('./locators/locators.js'));
 
 test('Using locators', async () => {
+    await go('http://demo.testim.io');
 
-  await go("http://demo.testim.io");
+    // Load the SELECT DESTINATION button smart locator. This locator
+    // can now be used by any method that accepts a smart locator as
+    // as argument.
+    //
+    // You can read more about the advantages of working with smart
+    // locators in the Testim documentation:
+    // https://help.testim.io/docs/working-with-locators
+    const selectDestButton = l('SELECT_DESTINATION');
 
-  // Load the SELECT DESTINATION button smart locator. This locator
-  // can now be used by any method that accepts a smart locator as
-  // as argument.
-  //
-  // You can read more about the advantages of working with smart
-  // locators in the Testim documentation:
-  // https://help.testim.io/docs/working-with-locators
-  const selectDestButton = l("SELECT_DESTINATION");
+    await waitForText(selectDestButton, 'Select Destination');
 
-  await waitForText(selectDestButton, 'Select Destination');
-
-  await scrollToElement(selectDestButton);
-
-  await click(selectDestButton);
+    await scrollToElement(selectDestButton);
 
+    await click(selectDestButton);
 }); // end of test
 
 

package/codim/template.js/tests/examples/03-using-hooks.test.js

@@ -7,30 +7,28 @@ const { go, test, describe, before, beforeEach, afterEach, after, text } = requi
 const { expect } = require('chai');
 
 describe('Using hooks', () => {
+    before(() => {
+        // runs before all tests in this block
+    });
 
-	before(function() {
-		// runs before all tests in this block
-  });
+    beforeEach(async () => {
+        // runs before each test in this block
+        await go('http://demo.testim.io');
+    });
 
-	beforeEach(async () => {
-		// runs before each test in this block
-		await go('http://demo.testim.io');
-	});
-
-	afterEach(function() {
+    afterEach(() => {
     // runs after each test in this block
-  });
+    });
 
-  after(function() {
+    after(() => {
     // runs after all tests in this block
-  });
+    });
 
-	test('finds text element', async () => {
+    test('finds text element', async () => {
     // Find an element using a vanilla CSS selector and extract its text
-    const title = await text('.theme__title___35Wsy');
-    
-    // Validate the extracted text
-		expect(title).to.eq('Madan');
-  });
-  
+        const title = await text('.theme__title___35Wsy');
+
+        // Validate the extracted text
+        expect(title).to.eq('Madan');
+    });
 });

package/codim/template.js/tests/examples/04-skip-and-only.test.js

@@ -8,25 +8,24 @@ const { expect } = require('chai');
 
 // Using `.only()`
 describe.only('Test suite', () => {
+    beforeEach(async () => {
+        await go('http://demo.testim.io');
+    });
 
-	beforeEach(async () => {
-		await go('http://demo.testim.io');
-	});
+    test('finds text element', async () => {
+        const title = await text('.theme__title___35Wsy');
+        expect(title).to.eq('Madan');
+    });
 
-	test('finds text element', async () => {
-		const title = await text('.theme__title___35Wsy');
-		expect(title).to.eq('Madan');
-	});
-
-	// Using `skip()`
-	test.skip('skips this test', async () => {
-		// this test will not be run
-		const title = await text('.Gallery__headline-1___2lHj5');
-		expect(title).to.eq('Your next destination');
-	});
+    // Using `skip()`
+    test.skip('skips this test', async () => {
+        // this test will not be run
+        const title = await text('.Gallery__headline-1___2lHj5');
+        expect(title).to.eq('Your next destination');
+    });
 });
 
-describe('Just another test', async() => {
-	// this describe will not be run since the first describe
-	// above is using `.only()`
+describe('Just another test', async () => {
+    // this describe will not be run since the first describe
+    // above is using `.only()`
 });

package/codim/template.js/tests/examples/05-multiple-windows.test.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 // Import Testim Dev Kit methods
 const { go, click, waitForText, withContext, test, l, Locator } = require('testim');
@@ -7,26 +7,25 @@ const { go, click, waitForText, withContext, test, l, Locator } = require('testi
 Locator.set(require('./locators/locators.js'));
 
 test('Working with multiple windows', async () => {
-  await go("https://the-internet.herokuapp.com/");
+    await go('https://the-internet.herokuapp.com/');
 
-  await click(l("Multiple_Windows"));
+    await click(l('Multiple_Windows'));
 
-  // Open a new tab
-  await click(l("Click_Here"));
+    // Open a new tab
+    await click(l('Click_Here'));
 
-  // Run validation on the main tab
-  await waitForText(l("Opening_a_new_window"), 'Opening a new window');
-  
-  // Import a `waitForText` method in the context of the newly opened tab
-  // using the `withContext` method (@see https://help.testim.io/docs/with-context)
-  // Please note we're using an alias since we've already imported `waitForText`
-  // to be used in the context of the main tab.
-  const { waitForText: waitForTextForTab } = withContext({
-    tabUrl: 'https://the-internet.herokuapp.com/windows/new'
-  });
+    // Run validation on the main tab
+    await waitForText(l('Opening_a_new_window'), 'Opening a new window');
 
-  // Run validation on the newly opened tab
-  await waitForTextForTab(l("New_Window"), 'New Window');
+    // Import a `waitForText` method in the context of the newly opened tab
+    // using the `withContext` method (@see https://help.testim.io/docs/with-context)
+    // Please note we're using an alias since we've already imported `waitForText`
+    // to be used in the context of the main tab.
+    const { waitForText: waitForTextForTab } = withContext({
+        tabUrl: 'https://the-internet.herokuapp.com/windows/new',
+    });
 
+    // Run validation on the newly opened tab
+    await waitForTextForTab(l('New_Window'), 'New Window');
 }); // end of test
 

package/codim/template.js/webpack.config.js

@@ -1,4 +1,4 @@
 module.exports = {
     mode: 'development', // always run with development and source maps
     devtool: 'inline-source-map', // always debuggable
-};
+};

package/codim/template.ts/webpack.config.js

@@ -8,9 +8,9 @@ module.exports = {
                 loader: 'ts-loader',
                 exclude: /node_modules/,
             },
-        ]
+        ],
     },
     resolve: {
-        extensions: [".tsx", ".ts", ".js"]
+        extensions: ['.tsx', '.ts', '.js'],
     },
-};
+};

package/commons/AbortError.js

@@ -1,12 +1,12 @@
 'use strict';
 
 class AbortError extends Error {
-    constructor(message = "aborted") {
+    constructor(message = 'aborted') {
         super(message);
-        this.name = "AbortError";
+        this.name = 'AbortError';
     }
 }
 
 module.exports = {
-    AbortError
-}
+    AbortError,
+};