codeceptjs 3.5.10 → 3.5.11

package/lib/helper/Expect.js

@@ -20,7 +20,7 @@ chai.use(require('chai-match-pattern'));
  *{
  *   helpers: {
  *     Playwright: {...},
- *     ExpectHelper: {},
+ *     Expect: {},
  *   }
  *}
  * ```
@@ -32,7 +32,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -44,7 +44,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -56,7 +56,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
 
      */
   expectDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
@@ -69,7 +69,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -81,7 +81,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToContain
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectContain(actualValue, expectedValueToContain, customErrorMsg = '') {
     // @ts-ignore
@@ -95,7 +95,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToNotContain
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotContain(
     actualValue,
@@ -113,7 +113,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToStartWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectStartsWith(actualValue, expectedValueToStartWith, customErrorMsg = '') {
     // @ts-ignore
@@ -127,7 +127,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToNotStartWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotStartsWith(
     actualValue,
@@ -144,7 +144,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValueToEndWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEndsWith(actualValue, expectedValueToEndWith, customErrorMsg = '') {
     // @ts-ignore
@@ -157,7 +157,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValueToNotEndWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotEndsWith(
     actualValue,
@@ -174,7 +174,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} jsonSchema
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectJsonSchema(targetData, jsonSchema, customErrorMsg = '') {
     // @ts-ignore
@@ -186,7 +186,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} jsonSchema
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      * @param {*} ajvOptions Pass AJV options
      */
   expectJsonSchemaUsingAJV(
@@ -204,7 +204,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} propertyName
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectHasProperty(targetData, propertyName, customErrorMsg = '') {
     // @ts-ignore
@@ -215,7 +215,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} propertyName
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectHasAProperty(targetData, propertyName, customErrorMsg = '') {
     // @ts-ignore
@@ -226,7 +226,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} type
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectToBeA(targetData, type, customErrorMsg = '') {
     // @ts-ignore
@@ -237,7 +237,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} type
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectToBeAn(targetData, type, customErrorMsg = '') {
     // @ts-ignore
@@ -248,7 +248,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} regex
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectMatchRegex(targetData, regex, customErrorMsg = '') {
     // @ts-ignore
@@ -259,7 +259,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} length
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthOf(targetData, length, customErrorMsg = '') {
     // @ts-ignore
@@ -269,7 +269,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEmpty(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -279,7 +279,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectTrue(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -289,7 +289,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectFalse(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -299,8 +299,8 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} aboveThan number | Date
-     * @param {*} customErrorMsg
+     * @param {*} aboveThan
+     * @param {*} [customErrorMsg]
      */
   expectAbove(targetData, aboveThan, customErrorMsg = '') {
     // @ts-ignore
@@ -310,8 +310,8 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} belowThan number | Date
-     * @param {*} customErrorMsg
+     * @param {*} belowThan
+     * @param {*} [customErrorMsg]
      */
   expectBelow(targetData, belowThan, customErrorMsg = '') {
     // @ts-ignore
@@ -322,7 +322,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} lengthAboveThan
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthAboveThan(targetData, lengthAboveThan, customErrorMsg = '') {
     // @ts-ignore
@@ -335,7 +335,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} lengthBelowThan
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthBelowThan(targetData, lengthBelowThan, customErrorMsg = '') {
     // @ts-ignore
@@ -348,7 +348,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEqualIgnoreCase(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -362,7 +362,7 @@ class ExpectHelper {
      * expects members of two arrays are deeply equal
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepMembers(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -376,7 +376,7 @@ class ExpectHelper {
      * expects an array to be a superset of another array
      * @param {*} superset
      * @param {*} set
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepIncludeMembers(superset, set, customErrorMsg = '') {
     // @ts-ignore
@@ -391,7 +391,7 @@ class ExpectHelper {
      * @param {*} actualValue
      * @param {*} expectedValue
      * @param {*} fieldsToExclude
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepEqualExcluding(
     actualValue,
@@ -410,7 +410,7 @@ class ExpectHelper {
      * expects a JSON object matches a provided pattern
      * @param {*} actualValue
      * @param {*} expectedPattern
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectMatchesPattern(actualValue, expectedPattern, customErrorMsg = '') {
     // @ts-ignore

package/lib/helper/Playwright.js

@@ -33,7 +33,7 @@ const ElementNotFound = require('./errors/ElementNotFound');
 const RemoteBrowserConnectionRefused = require('./errors/RemoteBrowserConnectionRefused');
 const Popup = require('./extras/Popup');
 const Console = require('./extras/Console');
-const findReact = require('./extras/React');
+const { findReact, findVue } = require('./extras/PlaywrightReactVueLocator');
 
 let playwright;
 let perfTiming;
@@ -666,7 +666,7 @@ class Playwright extends Helper {
    * ```
    *
    * @param {string} description used to show in logs.
-   * @param {function} fn async function that executed with Playwright helper as argumen
+   * @param {function} fn async function that executed with Playwright helper as arguments
    */
   usePlaywrightTo(description, fn) {
     return this._useTo(...arguments);
@@ -946,10 +946,9 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> resizeWindow }}
    *
    * Unlike other drivers Playwright changes the size of a viewport, not the window!
-   * Playwright does not control the window of a browser so it can't adjust its real size.
+   * Playwright does not control the window of a browser, so it can't adjust its real size.
    * It also can't maximize a window.
    *
    * Update configuration to change real window size on start:
@@ -959,6 +958,8 @@ class Playwright extends Helper {
    * // @codeceptjs/configure package must be installed
    * { setWindowSize } = require('@codeceptjs/configure');
    * ````
+   *
+   * {{> resizeWindow }}
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -1058,8 +1059,6 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> dragAndDrop }}
-   * @param {any} [options] [Additional options](https://playwright.dev/docs/api/class-page#page-drag-and-drop) can be passed as 3rd argument.
    *
    * ```js
    * // specify coordinates for source position
@@ -1067,6 +1066,10 @@ class Playwright extends Helper {
    * ```
    *
    * > When no option is set, custom drag and drop would be used, to use the dragAndDrop API from Playwright, please set options, for example `force: true`
+   *
+   * {{> dragAndDrop }}
+   * @param {any} [options] [Additional options](https://playwright.dev/docs/api/class-page#page-drag-and-drop) can be passed as 3rd argument.
+   *
    */
   async dragAndDrop(srcElement, destElement, options) {
     const src = new Locator(srcElement);
@@ -1514,7 +1517,7 @@ class Playwright extends Helper {
    *
    * @param {any} [options] [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
    *
-   * Examples:
+   * @example
    *
    * ```js
    * // click on element at position
@@ -1547,8 +1550,6 @@ class Playwright extends Helper {
 
   /**
    * {{> doubleClick }}
-   *
-   *
    */
   async doubleClick(locator, context = null) {
     return proceedClick.call(this, locator, context, { clickCount: 2 });
@@ -1556,15 +1557,12 @@ class Playwright extends Helper {
 
   /**
    * {{> rightClick }}
-   *
-   *
    */
   async rightClick(locator, context = null) {
     return proceedClick.call(this, locator, context, { button: 'right' });
   }
 
   /**
-   * {{> checkOption }}
    *
    * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-check) for check available as 3rd argument.
    *
@@ -1575,6 +1573,9 @@ class Playwright extends Helper {
    * I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
    * ```
    * > ⚠️ To avoid flakiness, option `force: true` is set by default
+   *
+   * {{> checkOption }}
+   *
    */
   async checkOption(field, context = null, options = { force: true }) {
     const elm = await this._locateCheckable(field, context);
@@ -1583,7 +1584,6 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> uncheckOption }}
    *
    * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck) for uncheck available as 3rd argument.
    *
@@ -1594,6 +1594,8 @@ class Playwright extends Helper {
    * I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
    * ```
    * > ⚠️ To avoid flakiness, option `force: true` is set by default
+   *
+   * {{> uncheckOption }}
    */
   async uncheckOption(field, context = null, options = { force: true }) {
     const elm = await this._locateCheckable(field, context);
@@ -1634,9 +1636,10 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> pressKeyWithKeyNormalization }}
    *
    * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
+   *
+   * {{> pressKeyWithKeyNormalization }}
    */
   async pressKey(key) {
     const modifiers = [];
@@ -1728,8 +1731,6 @@ class Playwright extends Helper {
 
   /**
    * {{> appendField }}
-   *
-   *
    */
   async appendField(field, value) {
     const els = await findFields.call(this, field);
@@ -1953,9 +1954,9 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> grabCookie }}
-   *
    * Returns cookie in JSON format. If name not passed returns all cookies for this domain.
+   *
+   * {{> grabCookie }}
    */
   async grabCookie(name) {
     const cookies = await this.browserContext.cookies();
@@ -1986,8 +1987,8 @@ class Playwright extends Helper {
    * ```js
    * I.executeScript(({x, y}) => x + y, {x, y});
    * ```
-   * You can pass only one parameter into a function
-   * but you can pass in array or object.
+   * You can pass only one parameter into a function,
+   * or you can pass in array or object.
    *
    * ```js
    * I.executeScript(([x, y]) => x + y, [x, y]);
@@ -2167,7 +2168,8 @@ class Playwright extends Helper {
     let chunked = chunkArray(attrs, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (!val[i].includes(values[i])) return false;
+        // if the attribute doesn't exist, returns false as well
+        if (!val[i] || !val[i].includes(values[i])) return false;
       }
       return true;
     });
@@ -2493,9 +2495,9 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> waitForVisible }}
-   *
    * This method accepts [React selectors](https://codecept.io/react).
+   *
+   * {{> waitForVisible }}
    */
   async waitForVisible(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -3260,7 +3262,7 @@ class Playwright extends Helper {
   /**
    * Returns all URLs of all network requests recorded so far during execution of test scenario.
    *
-   * @return {string} List of URLs recorded as a string, seperaeted by new lines after each URL
+   * @return {string} List of URLs recorded as a string, separated by new lines after each URL
    * @private
    */
   _getTrafficDump() {
@@ -3442,6 +3444,7 @@ function buildLocatorString(locator) {
 
 async function findElements(matcher, locator) {
   if (locator.react) return findReact(matcher, locator);
+  if (locator.vue) return findVue(matcher, locator);
   locator = new Locator(locator, 'css');
 
   return matcher.locator(buildLocatorString(locator)).all();
@@ -3503,6 +3506,7 @@ async function proceedClick(locator, context = null, options = {}) {
 
 async function findClickable(matcher, locator) {
   if (locator.react) return findReact(matcher, locator);
+  if (locator.vue) return findVue(matcher, locator);
 
   locator = new Locator(locator);
   if (!locator.isFuzzy()) return findElements.call(this, matcher, locator);

package/lib/helper/Puppeteer.js

@@ -259,6 +259,7 @@ class Puppeteer extends Helper {
       headless: !this.options.show,
       ...this._getOptions(config),
     };
+    if (this.puppeteerOptions.headless) this.puppeteerOptions.headless = 'new';
     this.isRemoteBrowser = !!this.puppeteerOptions.browserWSEndpoint;
     popupStore.defaultAction = this.options.defaultPopupAction;
   }
@@ -684,11 +685,13 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * {{> resizeWindow }}
    *
    * Unlike other drivers Puppeteer changes the size of a viewport, not the window!
-   * Puppeteer does not control the window of a browser so it can't adjust its real size.
+   * Puppeteer does not control the window of a browser, so it can't adjust its real size.
    * It also can't maximize a window.
+   *
+   * {{> resizeWindow }}
+   *
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -740,7 +743,8 @@ class Puppeteer extends Helper {
     assertElementExists(els, locator, 'Element to focus');
     const el = els[0];
 
-    await focusElement(el, this.page);
+    await el.click();
+    await el.focus();
     return this._waitForAction();
   }
 
@@ -880,7 +884,7 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Find a checkbox by providing human readable text:
+   * Find a checkbox by providing human-readable text:
    * NOTE: Assumes the checkable element exists
    *
    * ```js
@@ -895,7 +899,7 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Find a clickable element by providing human readable text:
+   * Find a clickable element by providing human-readable text:
    *
    * ```js
    * this.helpers['Puppeteer']._locateClickable('Next page').then // ...
@@ -907,7 +911,7 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Find field elements by providing human readable text:
+   * Find field elements by providing human-readable text:
    *
    * ```js
    * this.helpers['Puppeteer']._locateFields('Your email').then // ...
@@ -1119,7 +1123,7 @@ class Puppeteer extends Helper {
    * Sets a directory to where save files. Allows to test file downloads.
    * Should be used with [FileSystem helper](https://codecept.io/helpers/FileSystem) to check that file were downloaded correctly.
    *
-   * By default files are saved to `output/downloads`.
+   * By default, files are saved to `output/downloads`.
    * This directory is cleaned on every `handleDownloads` call, to ensure no old files are kept.
    *
    * ```js
@@ -1291,9 +1295,9 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * {{> pressKeyWithKeyNormalization }}
-   *
    * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
+   *
+   * {{> pressKeyWithKeyNormalization }}
    */
   async pressKey(key) {
     const modifiers = [];
@@ -1395,9 +1399,9 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * {{> attachFile }}
-   *
    * > ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1](https://github.com/puppeteer/puppeteer/issues/5420), downgrade to 2.0.0 if you face it.
+   *
+   * {{> attachFile }}
    */
   async attachFile(locator, pathToFile) {
     const file = path.join(global.codecept_dir, pathToFile);
@@ -1628,9 +1632,9 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * {{> executeScript }}
+   * If a function returns a Promise, tt will wait for its resolution.
    *
-   * If a function returns a Promise It will wait for it resolution.
+   * {{> executeScript }}
    */
   async executeScript(...args) {
     let context = this.page;
@@ -1641,9 +1645,8 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * {{> executeAsyncScript }}
-   *
    * Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
+   * {{> executeAsyncScript }}
    */
   async executeAsyncScript(...args) {
     const asyncFn = function () {
@@ -1822,7 +1825,8 @@ class Puppeteer extends Helper {
       for (let i = 0; i < val.length; ++i) {
         const _actual = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(values[i], 10);
         const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
-        if (!_actual.includes(_expected)) return false;
+        // if the attribute doesn't exist, returns false as well
+        if (!_actual || !_actual.includes(_expected)) return false;
       }
       return true;
     });
@@ -2092,7 +2096,7 @@ class Puppeteer extends Helper {
   /**
    * {{> waitForVisible }}
    *
-   * This method accepts [React selectors](https://codecept.io/react).
+   * {{ react }}
    */
   async waitForVisible(locator, sec) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2321,9 +2325,9 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
+   * Waits for navigation to finish. By default, takes configured `waitForNavigation` option.
    *
-   * See [Pupeteer's reference](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
+   * See [Puppeteer's reference](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions)
    *
    * @param {*} opts
    */