codeceptjs 3.5.10 → 3.5.11

package/docs/helpers/Puppeteer.md

@@ -44,7 +44,7 @@ Type: [object][4]
 -   `disableScreenshots` **[boolean][20]?** don't save screenshot on failure.
 -   `fullPageScreenshots` **[boolean][20]?** make full page screenshots on failure.
 -   `uniqueScreenshotNames` **[boolean][20]?** option to prevent screenshot override if you have scenarios with the same name in different suites.
--   `trace` **[boolean][20]?** record [tracing information][25] with screenshots.
+-   `trace` **[boolean][20]?** record [tracing information][24] with screenshots.
 -   `keepTraceForPassedTests` **[boolean][20]?** save trace for passed tests.
 -   `keepBrowserState` **[boolean][20]?** keep browser state between tests when `restart` is set to false.
 -   `keepCookies` **[boolean][20]?** keep cookies between tests when `restart` is set to false.
@@ -57,7 +57,7 @@ Type: [object][4]
 -   `userAgent` **[string][6]?** user-agent string.
 -   `manualStart` **[boolean][20]?** do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
 -   `browser` **[string][6]?** can be changed to `firefox` when using [puppeteer-firefox][2].
--   `chrome` **[object][4]?** pass additional [Puppeteer run options][26].
+-   `chrome` **[object][4]?** pass additional [Puppeteer run options][25].
 -   `highlightElement` **[boolean][20]?** highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
 
 
@@ -211,7 +211,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### _locateCheckable
 
-Find a checkbox by providing human readable text:
+Find a checkbox by providing human-readable text:
 NOTE: Assumes the checkable element exists
 
 ```js
@@ -225,7 +225,7 @@ this.helpers['Puppeteer']._locateCheckable('I agree with terms and conditions').
 
 ### _locateClickable
 
-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 // ...
@@ -237,7 +237,7 @@ this.helpers['Puppeteer']._locateClickable('Next page').then // ...
 
 ### _locateFields
 
-Find field elements by providing human readable text:
+Find field elements by providing human-readable text:
 
 ```js
 this.helpers['Puppeteer']._locateFields('Your email').then // ...
@@ -324,6 +324,8 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### attachFile
 
+> ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1][7], downgrade to 2.0.0 if you face it.
+
 Attaches a file to element located by label, name, CSS or XPath
 Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
 File will be uploaded to remote system (if tests are running remotely).
@@ -338,7 +340,7 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 -   `locator` **([string][6] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 -   `pathToFile` **[string][6]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
 
-Returns **void** automatically synchronized promise through #recorder> ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1][7], downgrade to 2.0.0 if you face it.
+Returns **void** automatically synchronized promise through #recorder
 
 ### blur
 
@@ -718,6 +720,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### executeAsyncScript
 
+Asynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
 Executes async script on page.
 Provided function should execute a passed callback (as first argument) to signal it is finished.
 
@@ -744,10 +747,12 @@ let val = await I.executeAsyncScript(function(url, done) {
 -   `args` **...any** to be passed to function.
 -   `fn` **([string][6] | [function][12])** function to be executed in browser context.
 
-Returns **[Promise][13]<any>** script return valueAsynchronous scripts can also be executed with `executeScript` if a function returns a Promise.
+Returns **[Promise][13]<any>** script return value
 
 ### executeScript
 
+If a function returns a Promise, tt will wait for its resolution.
+
 Executes sync script on a page.
 Pass arguments to function as additional parameters.
 Will return execution result to a test.
@@ -777,7 +782,7 @@ let date = await I.executeScript(function(el) {
 -   `args` **...any** to be passed to function.
 -   `fn` **([string][6] | [function][12])** function to be executed in browser context.
 
-Returns **[Promise][13]<any>** script return valueIf a function returns a Promise It will wait for it resolution.
+Returns **[Promise][13]<any>** script return value
 
 ### fillField
 
@@ -1236,7 +1241,7 @@ Returns **[Promise][13]<any>** WebElement of being used Web helper
 Sets a directory to where save files. Allows to test file downloads.
 Should be used with [FileSystem helper][16] 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
@@ -1282,9 +1287,11 @@ I.openNewTab();
 
 ### pressKey
 
+_Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][17]).
+
 Presses a key in the browser (on a focused element).
 
-_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][17].
+_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][18].
 
 ```js
 I.pressKey('Backspace');
@@ -1345,7 +1352,7 @@ Some of the supported key names are:
 
 -   `key` **([string][6] | [Array][15]<[string][6]>)** key or array of keys to press.
 
-Returns **void** automatically synchronized promise through #recorder_Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313][18]).
+Returns **void** automatically synchronized promise through #recorder
 
 ### pressKeyDown
 
@@ -1395,6 +1402,10 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### 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.
+It also can't maximize a window.
+
 Resize the current window to provided width and height.
 First parameter can be set to `maximize`.
 
@@ -1403,9 +1414,7 @@ First parameter can be set to `maximize`.
 -   `width` **[number][10]** width in pixels or `maximize`.
 -   `height` **[number][10]** height in pixels.
 
-Returns **void** automatically synchronized promise through #recorderUnlike 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.
-It also can't maximize a window.
+Returns **void** automatically synchronized promise through #recorder
 
 ### rightClick
 
@@ -1898,7 +1907,7 @@ I.switchToPreviousTab(2);
 
 Types out the given text into an active field.
 To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`][17] is not an option.
+_Note:_ Should be used when [`fillField`][18] is not an option.
 
 ```js
 // passing in a string
@@ -2084,9 +2093,9 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### waitForNavigation
 
-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][23]
+See [Puppeteer's reference][23]
 
 #### Parameters
 
@@ -2169,7 +2178,11 @@ I.waitForVisible('#popup');
 -   `locator` **([string][6] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
 
-Returns **void** automatically synchronized promise through #recorderThis method accepts [React selectors][24].
+Returns **void** automatically synchronized promise through #recorder
+
+
+This action supports [React locators](https://codecept.io/react#locators)
+
 
 ### waitInUrl
 
@@ -2270,9 +2283,9 @@ Returns **void** automatically synchronized promise through #recorder
 
 [16]: https://codecept.io/helpers/FileSystem
 
-[17]: #fillfield
+[17]: https://github.com/GoogleChrome/puppeteer/issues/1313
 
-[18]: https://github.com/GoogleChrome/puppeteer/issues/1313
+[18]: #fillfield
 
 [19]: #click
 
@@ -2284,8 +2297,6 @@ Returns **void** automatically synchronized promise through #recorder
 
 [23]: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions
 
-[24]: https://codecept.io/react
-
-[25]: https://pptr.dev/api/puppeteer.tracing
+[24]: https://pptr.dev/api/puppeteer.tracing
 
-[26]: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions
+[25]: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions

package/docs/helpers/WebDriver.md

@@ -482,6 +482,8 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### attachFile
 
+Appium: not tested
+
 Attaches a file to element located by label, name, CSS or XPath
 Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
 File will be uploaded to remote system (if tests are running remotely).
@@ -496,7 +498,7 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 -   `locator` **([string][17] | [object][16])** field located by label|name|CSS|XPath|strict locator.
 -   `pathToFile` **[string][17]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
 
-Returns **void** automatically synchronized promise through #recorderAppium: not tested
+Returns **void** automatically synchronized promise through #recorder
 
 ### blur
 
@@ -525,10 +527,11 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### cancelPopup
 
-Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
+Dismisses the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`.
 
 ### checkOption
 
+Appium: not tested
 Selects a checkbox or radio button.
 Element is located by label or name or CSS or XPath.
 
@@ -545,7 +548,7 @@ I.checkOption('agree', '//form');
 -   `field` **([string][17] | [object][16])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][17]? | [object][16])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
 
-Returns **void** automatically synchronized promise through #recorderAppium: not tested
+Returns **void** automatically synchronized promise through #recorder
 
 ### clearCookie
 
@@ -671,6 +674,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### dontSeeCheckboxIsChecked
 
+Appium: not tested
 Verifies that the specified checkbox is not checked.
 
 ```js
@@ -683,7 +687,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 -   `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
 
-Returns **void** automatically synchronized promise through #recorderAppium: not tested
+Returns **void** automatically synchronized promise through #recorder
 
 ### dontSeeCookie
 
@@ -828,6 +832,7 @@ This action supports [React locators](https://codecept.io/react#locators)
 
 ### dragAndDrop
 
+Appium: not tested
 Drag an item to a destination element.
 
 ```js
@@ -839,7 +844,7 @@ I.dragAndDrop('#dragHandle', '#container');
 -   `srcElement` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
 -   `destElement` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
 
-Returns **void** automatically synchronized promise through #recorderAppium: not tested
+Returns **void** automatically synchronized promise through #recorder
 
 ### dragSlider
 
@@ -890,6 +895,8 @@ Returns **[Promise][25]<any>** script return value
 
 ### executeScript
 
+Wraps [execute][26] command.
+
 Executes sync script on a page.
 Pass arguments to function as additional parameters.
 Will return execution result to a test.
@@ -919,7 +926,7 @@ let date = await I.executeScript(function(el) {
 -   `args` **...any** to be passed to function.
 -   `fn` **([string][17] | [function][24])** function to be executed in browser context.
 
-Returns **[Promise][25]<any>** script return valueWraps [execute][26] command.
+Returns **[Promise][25]<any>** script return value
 
 ### fillField
 
@@ -1419,6 +1426,8 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### pressKey
 
+_Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
+
 Presses a key in the browser (on a focused element).
 
 _Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][30].
@@ -1482,7 +1491,7 @@ Some of the supported key names are:
 
 -   `key` **([string][17] | [Array][28]<[string][17]>)** key or array of keys to press.
 
-Returns **void** automatically synchronized promise through #recorder_Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
+Returns **void** automatically synchronized promise through #recorder
 
 ### pressKeyDown
 
@@ -1532,6 +1541,8 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### resizeWindow
 
+Appium: not tested in web, in apps doesn't work
+
 Resize the current window to provided width and height.
 First parameter can be set to `maximize`.
 
@@ -1540,7 +1551,7 @@ First parameter can be set to `maximize`.
 -   `width` **[number][22]** width in pixels or `maximize`.
 -   `height` **[number][22]** height in pixels.
 
-Returns **void** automatically synchronized promise through #recorderAppium: not tested in web, in apps doesn't work
+Returns **void** automatically synchronized promise through #recorder
 
 ### rightClick
 
@@ -1639,7 +1650,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 #### Parameters
 
 -   `locator` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
--   `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][33].
+-   `scrollIntoViewOptions` **(ScrollIntoViewOptions | [boolean][32])** either alignToTop=true|false or scrollIntoViewOptions. See [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][33].
 
 Returns **void** automatically synchronized promise through #recorder
 
@@ -1720,6 +1731,7 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### seeCheckboxIsChecked
 
+Appium: not tested
 Verifies that the specified checkbox is checked.
 
 ```js
@@ -1732,7 +1744,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 -   `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
 
-Returns **void** automatically synchronized promise through #recorderAppium: not tested
+Returns **void** automatically synchronized promise through #recorder
 
 ### seeCookie
 
@@ -1983,6 +1995,7 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### setCookie
 
+Uses Selenium's JSON [cookie format][34].
 Sets cookie(s).
 
 Can be a single cookie object or an array of cookies:
@@ -2001,8 +2014,7 @@ I.setCookie([
 
 -   `cookie` **(Cookie | [Array][28]<Cookie>)** a cookie object or array of cookie objects.
 
-Returns **void** automatically synchronized promise through #recorderUses Selenium's JSON [cookie
-format][34].
+Returns **void** automatically synchronized promise through #recorder
 
 ### setGeoLocation
 
@@ -2116,6 +2128,7 @@ Returns **void** automatically synchronized promise through #recorder
 
 ### uncheckOption
 
+Appium: not tested
 Unselects a checkbox or radio button.
 Element is located by label or name or CSS or XPath.
 
@@ -2132,7 +2145,7 @@ I.uncheckOption('agree', '//form');
 -   `field` **([string][17] | [object][16])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][17]? | [object][16])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
 
-Returns **void** automatically synchronized promise through #recorderAppium: not tested
+Returns **void** automatically synchronized promise through #recorder
 
 ### useWebDriverTo
 

package/docs/parallel.md

@@ -96,7 +96,7 @@ FAIL  | 7 passed, 1 failed, 1 skipped   // 2s
           "actor": "I",
           "name": "amOnPage",
           "status": "success",
-          "agrs": [
+          "args": [
             "https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST"
           ],
           "startedAt": 1698760652610,
@@ -109,7 +109,7 @@ FAIL  | 7 passed, 1 failed, 1 skipped   // 2s
           "actor": "I",
           "name": "grabCurrentUrl",
           "status": "success",
-          "agrs": [],
+          "args": [],
           "startedAt": 1698760653098,
           "startTime": 1698760653098,
           "endTime": 1698760653099,

package/docs/plugins.md

@@ -721,7 +721,7 @@ Run tests with plugin enabled:
 -   `factor` - The exponential factor to use. Default is 1.5.
 -   `minTimeout` - The number of milliseconds before starting the first retry. Default is 1000.
 -   `maxTimeout` - The maximum number of milliseconds between two retries. Default is Infinity.
--   `randomize` - Randomizes the timeouts by multiplying with a factor between 1 to 2. Default is false.
+-   `randomize` - Randomizes the timeouts by multiplying with a factor from 1 to 2. Default is false.
 -   `defaultIgnoredSteps` - an array of steps to be ignored for retry. Includes:
     -   `amOnPage`
     -   `wait*`
@@ -1085,7 +1085,7 @@ plugins: {
 
 ## tryTo
 
-Adds global `tryTo` function inside of which all failed steps won't fail a test but will return true/false.
+Adds global `tryTo` function in which all failed steps won't fail a test but will return true/false.
 
 Enable this plugin in `codecept.conf.js` (enabled by default for new setups):
 
@@ -1124,7 +1124,7 @@ Add assert requires first:
 const assert = require('assert');
 ````
 
-Then use the assert:
+Then use the assertion:
 const result1 = await tryTo(() => I.see('Hello, user'));
 const result2 = await tryTo(() => I.seeElement('.welcome'));
 assert.ok(result1 && result2, 'Assertions were not succesful');

package/docs/react.md

@@ -66,4 +66,5 @@ To find React element names and props in a tree use [React DevTools](https://chr
 
 > Turn off minification for application builds otherwise component names will be uglified as well
 
-React locators work via [resq](https://github.com/baruchvlz/resq) library, which handles React 16 and above.
+- With WebDriver and Puppeteer, React locators work via [resq](https://github.com/baruchvlz/resq) library, which handles React 16 and above.
+- With Playwright, React locators work via [Playwright React Locator](https://playwright.dev/docs/other-locators#react-locator).

package/docs/vue.md

@@ -104,6 +104,28 @@ tests
 
 If you agreed to create a demo component, you will also see `TestMe` component in `src/components` folder.
 
+## Locators
+
+For Vue apps a special `vue` locator is available. It allows to select an element by its component name, and props.
+
+```js
+{ vue: 'MyComponent' }
+{ vue: 'Button', props: { title: 'Click Me' }}
+```
+
+With Playwright, you can use Vue locators in any method where locator is required:
+
+```js
+I.click({ vue: 'Tab', props: { title: 'Click Me!' }});
+I.seeElement({ vue: 't', props: { title: 'Clicked' }});
+```
+
+To find Vue element names and props in a tree use [Vue DevTools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd) extension.
+
+> Turn off minification for application builds otherwise component names will be uglified as well
+
+Vue locators work via [Playwright Vue Locator](https://playwright.dev/docs/other-locators#vue-locator).
+
 ## How to write tests?
 
 * Open `tests/e2e/app_js` and see the demo test

package/docs/webapi/scrollIntoView.mustache

@@ -7,5 +7,5 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 ```
 
 @param {LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
+@param {ScrollIntoViewOptions|boolean} scrollIntoViewOptions either alignToTop=true|false or scrollIntoViewOptions. See https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
 @returns {void} automatically synchronized promise through #recorder

package/lib/command/workers/runTests.js

@@ -141,11 +141,27 @@ function initializeListeners() {
     const _steps = [];
 
     for (step of steps) {
+      const _args = [];
+
+      if (step.args) {
+        for (const arg of step.args) {
+          // check if arg is a JOI object
+          if (arg && arg.$_root) {
+            _args.push(JSON.stringify(arg).slice(0, 300));
+          // check if arg is a function
+          } else if (arg && typeof arg === 'function') {
+            _args.push(arg.name);
+          } else {
+            _args.push(arg);
+          }
+        }
+      }
+
       _steps.push({
         actor: step.actor,
         name: step.name,
         status: step.status,
-        agrs: step.args,
+        agrs: _args,
         startedAt: step.startedAt,
         startTime: step.startTime,
         endTime: step.endTime,