codeceptjs 3.5.9 → 3.5.10

package/lib/workers.js

@@ -359,6 +359,7 @@ class Workers extends EventEmitter {
     this.stats.start = new Date();
     recorder.startUnlessRunning();
     event.dispatcher.emit(event.workers.before);
+    process.env.RUNS_WITH_WORKERS = 'true';
     recorder.add('starting workers', () => {
       for (const worker of this.workers) {
         const workerThread = createWorker(worker);
@@ -492,6 +493,7 @@ class Workers extends EventEmitter {
     }
 
     output.result(this.stats.passes, this.stats.failures, this.stats.pending, ms(this.stats.duration));
+    process.env.RUNS_WITH_WORKERS = 'false';
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.9",
+  "version": "3.5.10",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -59,7 +59,8 @@
     "publish:site": "./runok.js publish:site",
     "update-contributor-faces": "./runok.js contributor:faces",
     "dtslint": "dtslint typings --localTs './node_modules/typescript/lib'",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "prepare-release": "./runok.js versioning && ./runok.js get:commit-log"
   },
   "dependencies": {
     "@codeceptjs/configure": "0.10.0",
@@ -68,9 +69,9 @@
     "@cucumber/gherkin": "26",
     "@cucumber/messages": "22.0.0",
     "@xmldom/xmldom": "0.8.10",
-    "acorn": "8.10.0",
+    "acorn": "8.11.2",
     "arrify": "2.0.1",
-    "axios": "1.3.3",
+    "axios": "1.6.2",
     "chai": "4.3.8",
     "chai-deep-match": "1.2.1",
     "chai-exclude": "^2.1.0",
@@ -79,19 +80,19 @@
     "chai-match-pattern": "^1.3.0",
     "chai-string": "^1.5.0",
     "chalk": "4.1.2",
-    "commander": "11.0.0",
+    "commander": "11.1.0",
+    "convert-cssxpath": "1.0.2",
     "cross-spawn": "7.0.3",
-    "css-to-xpath": "0.1.0",
-    "envinfo": "7.8.1",
+    "envinfo": "7.11.0",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
     "fn-args": "4.0.0",
-    "fs-extra": "8.1.0",
+    "fs-extra": "11.2.0",
     "glob": "6.0.1",
-    "html-minifier": "4.0.0",
+    "html-minifier-terser": "^7.2.0",
     "inquirer": "6.5.2",
     "joi": "17.11.0",
-    "js-beautify": "1.14.9",
+    "js-beautify": "1.14.11",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
@@ -106,8 +107,10 @@
     "sprintf-js": "1.1.1",
     "uuid": "9.0"
   },
+  "optionalDependencies": {
+    "@codeceptjs/detox-helper": "1.0.2"
+  },
   "devDependencies": {
-    "@codeceptjs/detox-helper": "1.0.2",
     "@codeceptjs/mock-request": "0.3.1",
     "@faker-js/faker": "7.6.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
@@ -125,7 +128,7 @@
     "documentation": "12.3.0",
     "dtslint": "4.2.1",
     "electron": "27.0.4",
-    "eslint": "8.53.0",
+    "eslint": "8.55.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-plugin-import": "2.29.0",
     "eslint-plugin-mocha": "6.3.0",
@@ -137,7 +140,7 @@
     "jsdoc": "3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
-    "playwright": "1.39.0",
+    "playwright": "1.40.1",
     "puppeteer": "21.1.1",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.0",
@@ -154,7 +157,7 @@
     "wdio-docker-service": "1.5.0",
     "webdriverio": "8.3.8",
     "xml2js": "0.6.2",
-    "xmldom": "0.6.0",
+    "@xmldom/xmldom": "0.7.7",
     "xpath": "0.0.33"
   },
   "engines": {

package/typings/promiseBasedTypes.d.ts

@@ -458,7 +458,7 @@ declare namespace CodeceptJS {
          * Switch to the specified context.
          * @param context - the context to switch to
          */
-        _switchToContext(context: any): Promise<any>;
+        switchToContext(context: any): Promise<any>;
         /**
          * Switches to web context.
          * If no context is provided switches to the first detected web context
@@ -749,7 +749,7 @@ declare namespace CodeceptJS {
          * ```js
          * I.closeApp();
          * ```
-         * @returns Appium: support only iOS
+         * @returns Appium: support both Android and iOS
          */
         closeApp(): Promise<void>;
         /**
@@ -2761,6 +2761,21 @@ declare namespace CodeceptJS {
      * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
      * * `keepTraceForPassedTests`: - save trace for passed tests
      *
+     * #### HAR Recording Customization
+     *
+     * A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded.
+     * It contains information about the request and response headers, cookies, content, timings, and more. You can use HAR files to mock network requests in your tests.
+     * HAR will be saved to `output/har`. More info could be found here https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har.
+     *
+     * ```
+     * ...
+     * recordHar: {
+     *     mode: 'minimal', // possible values: 'minimal'|'full'.
+     *     content: 'embed' // possible values:  "omit"|"embed"|"attach".
+     * }
+     * ...
+     * ```
+     *
      * #### Example #1: Wait for 0 network connections.
      *
      * ```js
@@ -3135,6 +3150,21 @@ declare namespace CodeceptJS {
          * ```
          */
         refreshPage(): Promise<any>;
+        /**
+         * Replaying from HAR
+         *
+         * ```js
+         *  // Replay API requests from HAR.
+         *  // Either use a matching response from the HAR,
+         *  // or abort the request if nothing matches.
+         *    I.replayFromHar('./output/har/something.har', { url: "*\/**\/api/v1/fruits" });
+         *    I.amOnPage('https://demo.playwright.dev/api-mocking');
+         *    I.see('CodeceptJS');
+         * ```
+         * @param harFilePath - Path to recorded HAR file
+         * @param [opts] - [Options for replaying from HAR](https://playwright.dev/docs/api/class-page#page-route-from-har)
+         */
+        replayFromHar(harFilePath: string, opts?: any): Promise<any>;
         /**
          * Scroll page to the top.
          *
@@ -3254,6 +3284,28 @@ declare namespace CodeceptJS {
          * ```
          */
         _locateFields(): Promise<any>;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -6329,6 +6381,17 @@ declare namespace CodeceptJS {
          * ```
          */
         _locateFields(): Promise<any>;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -8951,6 +9014,17 @@ declare namespace CodeceptJS {
          * @param locator - element located by CSS|XPath|strict locator.
          */
         _locateFields(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
          *

package/typings/types.d.ts

@@ -458,7 +458,7 @@ declare namespace CodeceptJS {
          * Switch to the specified context.
          * @param context - the context to switch to
          */
-        _switchToContext(context: any): void;
+        switchToContext(context: any): void;
         /**
          * Switches to web context.
          * If no context is provided switches to the first detected web context
@@ -749,7 +749,7 @@ declare namespace CodeceptJS {
          * ```js
          * I.closeApp();
          * ```
-         * @returns Appium: support only iOS
+         * @returns Appium: support both Android and iOS
          */
         closeApp(): Promise<void>;
         /**
@@ -2848,6 +2848,7 @@ declare namespace CodeceptJS {
      * @property [ignoreHTTPSErrors] - Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
      * @property [bypassCSP] - bypass Content Security Policy or CSP
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
+     * @property [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
      */
     type PlaywrightConfig = {
         url?: string;
@@ -2884,6 +2885,7 @@ declare namespace CodeceptJS {
         ignoreHTTPSErrors?: boolean;
         bypassCSP?: boolean;
         highlightElement?: boolean;
+        recordHar?: any;
     };
     /**
      * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
@@ -2929,6 +2931,21 @@ declare namespace CodeceptJS {
      * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
      * * `keepTraceForPassedTests`: - save trace for passed tests
      *
+     * #### HAR Recording Customization
+     *
+     * A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded.
+     * It contains information about the request and response headers, cookies, content, timings, and more. You can use HAR files to mock network requests in your tests.
+     * HAR will be saved to `output/har`. More info could be found here https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har.
+     *
+     * ```
+     * ...
+     * recordHar: {
+     *     mode: 'minimal', // possible values: 'minimal'|'full'.
+     *     content: 'embed' // possible values:  "omit"|"embed"|"attach".
+     * }
+     * ...
+     * ```
+     *
      * #### Example #1: Wait for 0 network connections.
      *
      * ```js
@@ -3324,6 +3341,22 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         refreshPage(): void;
+        /**
+         * Replaying from HAR
+         *
+         * ```js
+         *  // Replay API requests from HAR.
+         *  // Either use a matching response from the HAR,
+         *  // or abort the request if nothing matches.
+         *    I.replayFromHar('./output/har/something.har', { url: "*\/**\/api/v1/fruits" });
+         *    I.amOnPage('https://demo.playwright.dev/api-mocking');
+         *    I.see('CodeceptJS');
+         * ```
+         * @param harFilePath - Path to recorded HAR file
+         * @param [opts] - [Options for replaying from HAR](https://playwright.dev/docs/api/class-page#page-route-from-har)
+         * @returns Promise<void>
+         */
+        replayFromHar(harFilePath: string, opts?: any): any;
         /**
          * Scroll page to the top.
          *
@@ -3449,6 +3482,28 @@ declare namespace CodeceptJS {
          * ```
          */
         _locateFields(): void;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -6754,6 +6809,17 @@ declare namespace CodeceptJS {
          * ```
          */
         _locateFields(): void;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -9620,6 +9686,17 @@ declare namespace CodeceptJS {
          * @param locator - element located by CSS|XPath|strict locator.
          */
         _locateFields(locator: CodeceptJS.LocatorOrString): void;
+        /**
+         * Grab WebElements for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElements = await I.grabWebElements('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
          *
@@ -11354,6 +11431,7 @@ declare namespace CodeceptJS {
         const workers: {
             before: 'workers.before';
             after: 'workers.after';
+            result: 'workers.result';
         };
         function emit(event: string, param?: any): void;
         /**