codeceptjs 3.3.0-beta.4 → 3.3.1

package/docs/webapi/waitForElement.mustache

@@ -7,4 +7,5 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 ```
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
+@param {number} [sec] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitForEnabled.mustache

@@ -2,4 +2,5 @@ Waits for element to become enabled (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
+@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
+@return {Promise<any>}

package/docs/webapi/waitForFunction.mustache

@@ -14,3 +14,4 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 @param {string|function} fn to be executed in browser context.
 @param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
 @param {number} [sec] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitForInvisible.mustache

@@ -6,4 +6,5 @@ I.waitForInvisible('#popup');
 ```
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitForText.mustache

@@ -9,4 +9,5 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 
 @param {string }text to wait for.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
+@return {Promise<any>}

package/docs/webapi/waitForValue.mustache

@@ -7,3 +7,4 @@ I.waitForValue('//input', "GoodValue");
 @param {LocatorOrString} field input field.
 @param {string }value expected value.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitForVisible.mustache

@@ -7,3 +7,4 @@ I.waitForVisible('#popup');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitInUrl.mustache

@@ -5,4 +5,5 @@ I.waitInUrl('/info', 2);
 ```
 
 @param {string} urlPart value to check.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitNumberOfVisibleElements.mustache

@@ -6,4 +6,5 @@ I.waitNumberOfVisibleElements('a', 3);
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitToHide.mustache

@@ -6,4 +6,5 @@ I.waitToHide('#popup');
 ```
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/docs/webapi/waitUrlEquals.mustache

@@ -6,4 +6,5 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 ```
 
 @param {string} urlPart value to check.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@return {Promise<any>}

package/lib/command/definitions.js

@@ -146,10 +146,19 @@ module.exports = function (genPath, options) {
     }
   }
 
+  let autoLogin;
+  if (config.plugins.autoLogin) {
+    autoLogin = config.plugins.autoLogin.inject;
+  }
+
   const supportObject = new Map();
   supportObject.set('I', 'I');
   supportObject.set('current', 'any');
 
+  if (autoLogin) {
+    supportObject.set(autoLogin, 'any');
+  }
+
   if (customHelpers.length > 0) {
     hasCustomHelper = true;
   }

package/lib/command/run.js

@@ -23,8 +23,8 @@ module.exports = async function (test, options) {
   try {
     codecept.init(testRoot);
     await codecept.bootstrap();
-    codecept.loadTests();
-    await codecept.run(test);
+    codecept.loadTests(test);
+    await codecept.run();
   } catch (err) {
     printError(err);
     process.exitCode = 1;

package/lib/command/workers/runTests.js

@@ -115,6 +115,8 @@ function initializeListeners() {
     }
 
     return {
+      opts: test.opts || {},
+      tags: test.tags || [],
       id: test.id,
       workerIndex,
       retries: test._retries,
@@ -126,6 +128,38 @@ function initializeListeners() {
     };
   }
 
+  function simplifyStep(step, err = null) {
+    step = { ...step };
+
+    if (step.startTime && !step.duration) {
+      const end = new Date();
+      step.duration = end - step.startTime;
+    }
+
+    if (step.err) {
+      err = simplifyError(step.err);
+      step.status = 'failed';
+    } else if (err) {
+      err = simplifyError(err);
+      step.status = 'failed';
+    }
+
+    const parent = {};
+    if (step.metaStep) {
+      parent.title = step.metaStep.actor;
+    }
+    return {
+      opts: step.opts || {},
+      workerIndex,
+      title: step.name,
+      status: step.status,
+      duration: step.duration || 0,
+      err,
+      parent,
+      test: simplifyTest(step.test),
+    };
+  }
+
   collectStats();
   // suite
   event.dispatcher.on(event.suite.before, suite => sendToParentThread({ event: event.suite.before, workerIndex, data: simplifyTest(suite) }));
@@ -144,6 +178,12 @@ function initializeListeners() {
   event.dispatcher.on(event.test.started, test => sendToParentThread({ event: event.test.started, workerIndex, data: simplifyTest(test) }));
   event.dispatcher.on(event.test.skipped, test => sendToParentThread({ event: event.test.skipped, workerIndex, data: simplifyTest(test) }));
 
+  // steps
+  event.dispatcher.on(event.step.finished, step => sendToParentThread({ event: event.step.finished, workerIndex, data: simplifyStep(step) }));
+  event.dispatcher.on(event.step.started, step => sendToParentThread({ event: event.step.started, workerIndex, data: simplifyStep(step) }));
+  event.dispatcher.on(event.step.passed, step => sendToParentThread({ event: event.step.passed, workerIndex, data: simplifyStep(step) }));
+  event.dispatcher.on(event.step.failed, step => sendToParentThread({ event: event.step.failed, workerIndex, data: simplifyStep(step) }));
+
   event.dispatcher.on(event.hook.failed, (test, err) => sendToParentThread({ event: event.hook.failed, workerIndex, data: simplifyTest(test, err) }));
   event.dispatcher.on(event.hook.passed, (test, err) => sendToParentThread({ event: event.hook.passed, workerIndex, data: simplifyTest(test, err) }));
   event.dispatcher.on(event.all.failures, (data) => sendToParentThread({ event: event.all.failures, workerIndex, data }));

package/lib/helper/ApiDataFactory.js

@@ -36,7 +36,7 @@ const REST = require('./REST');
  * Install [Rosie](https://github.com/rosiejs/rosie) and [Faker](https://www.npmjs.com/package/faker) libraries.
  *
  * ```sh
- * npm i rosie faker --save-dev
+ * npm i rosie @faker-js/faker --save-dev
  * ```
  *
  * Create a factory file for a resource.
@@ -46,8 +46,8 @@ const REST = require('./REST');
  * ```js
  * // tests/factories/posts.js
  *
- * var Factory = require('rosie').Factory;
- * var faker = require('faker');
+ * const Factory = require('rosie').Factory;
+ * const faker = require('@faker-js/faker');
  *
  * module.exports = new Factory()
  *    // no need to set id, it will be set by REST API
@@ -264,6 +264,7 @@ class ApiDataFactory extends Helper {
    * @param {*} factory factory to use
    * @param {*} params predefined parameters
    * @param {*} options options for programmatically generate the attributes
+   * @returns {Promise<*>}
    */
   have(factory, params, options) {
     const item = this._createItem(factory, params, options);

package/lib/helper/Appium.js

@@ -124,6 +124,7 @@ const webRoot = 'body';
 class Appium extends Webdriver {
   /**
    * Appium Special Methods for Mobile only
+   * @augments WebDriver
    */
 
   constructor(config) {
@@ -492,6 +493,7 @@ class Appium extends Webdriver {
    *
    * @param {string} appId
    * @param {string} [bundleId] ID of bundle
+   * @return {Promise<any>}
    */
   async removeApp(appId, bundleId) {
     onlyForApps.call(this, 'Android');
@@ -728,7 +730,7 @@ class Appium extends Webdriver {
    * Switch to the specified context.
    *
    * @param {*} context the context to switch to
-
+   * @return {Promise<any>}
    */
   async _switchToContext(context) {
     return this.browser.switchContext(context);
@@ -774,7 +776,7 @@ class Appium extends Webdriver {
    * // or set context explicitly
    * I.switchToNative('SOME_OTHER_CONTEXT');
    * ```
-   * @param {*} context
+   * @param {*} [context]
    * @return {Promise<void>}
    */
   async switchToNative(context = null) {
@@ -859,6 +861,7 @@ class Appium extends Webdriver {
    *
    * @param {'tapOutside' | 'pressKey'} [strategy] Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
    * @param {string} [key] Optional key
+   * @return {Promise<any>}
    */
   async hideDeviceKeyboard(strategy, key) {
     onlyForApps.call(this);
@@ -981,6 +984,7 @@ class Appium extends Webdriver {
    *
    * @param {object} from
    * @param {object} to
+   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -1213,6 +1217,7 @@ class Appium extends Webdriver {
    * Appium: support Android and iOS
    *
    * @param {Array} actions Array of touch actions
+   * @return {Promise<any>}
    */
   async touchPerform(actions) {
     onlyForApps.call(this);

package/lib/helper/GraphQL.js

@@ -112,15 +112,15 @@ class GraphQL extends Helper {
    *
    * @param {object} operation
    * @param {object} headers
+   * @return {object} graphQLRequest
    */
   _prepareGraphQLRequest(operation, headers) {
-    const request = {
+    return {
       baseURL: this.options.endpoint,
       method: 'POST',
       data: operation,
       headers,
     };
-    return request;
   }
 
   /**
@@ -142,6 +142,7 @@ class GraphQL extends Helper {
    * @param {object} variables that may go along with the query
    * @param {object} options are additional query options
    * @param {object} headers
+   * @return Promise<any>
    */
   async sendQuery(query, variables, options = {}, headers = {}) {
     if (typeof query !== 'string') {
@@ -181,6 +182,7 @@ class GraphQL extends Helper {
    * @param {object} variables that may go along with the mutation
    * @param {object} options are additional query options
    * @param {object} headers
+   * @return Promise<any>
    */
   async sendMutation(mutation, variables, options = {}, headers = {}) {
     if (typeof mutation !== 'string') {

package/lib/helper/GraphQLDataFactory.js

@@ -36,7 +36,7 @@ const GraphQL = require('./GraphQL');
  * Install [Rosie](https://github.com/rosiejs/rosie) and [Faker](https://www.npmjs.com/package/faker) libraries.
  *
  * ```sh
- * npm i rosie faker --save-dev
+ * npm i rosie @faker-js/faker --save-dev
  * ```
  *
  * Create a factory file for a resource.
@@ -46,8 +46,8 @@ const GraphQL = require('./GraphQL');
  * ```js
  * // tests/factories/users.js
  *
- * var Factory = require('rosie').Factory;
- * var faker = require('faker');
+ * const Factory = require('rosie').Factory;
+ * const faker = require('@faker-js/faker');
  *
  * // Used with a constructor function passed to Factory, so that the final build
  * // object matches the necessary pattern to be sent as the variables object.

package/lib/helper/JSONResponse.js

@@ -218,7 +218,7 @@ class JSONResponse extends Helper {
    * Use it to perform custom checks of response data
    *
    * ```js
-   * I.seeResponseValidByCallback({ data, status, expect } => {
+   * I.seeResponseValidByCallback(({ data, status, expect }) => {
    *   expect(status).to.eql(200);
    *   expect(data).keys.to.include(['user', 'company']);
    * });

package/lib/helper/Playwright.js

@@ -92,6 +92,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
  * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
  * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
+ * * `colorScheme`: (optional) default color scheme. Possible values: `dark` | `light` | `no-preference`.
  * * `userAgent`: (optional) user-agent string.
  * * `locale`: (optional) locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
  * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
@@ -212,7 +213,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * }
  * ```
  *
- * #### Example #7: Launch test with a specifc user locale
+ * #### Example #7: Launch test with a specific user locale
  *
  * ```js
  * {
@@ -225,6 +226,19 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * }
  * ```
  *
+ * * #### Example #8: Launch test with a specific color scheme
+ *
+ * ```js
+ * {
+ *  helpers: {
+ *   Playwright : {
+ *     url: "http://localhost",
+ *     colorScheme: "dark",
+ *   }
+ *  }
+ * }
+ * ```
+ *
  * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
  * ## Access From Helpers
@@ -273,7 +287,7 @@ class Playwright extends Helper {
       waitForAction: 100,
       waitForTimeout: 1000,
       pressKeyDelay: 10,
-      timeout: 1000,
+      timeout: 5000,
       fullPageScreenshots: false,
       disableScreenshots: false,
       ignoreLog: ['warning', 'log'],
@@ -411,6 +425,7 @@ class Playwright extends Helper {
       if (this.storageState) contextOptions.storageState = this.storageState;
       if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent;
       if (this.options.locale) contextOptions.locale = this.options.locale;
+      if (this.options.colorScheme) contextOptions.colorScheme = this.options.colorScheme;
       if (!this.browserContext || !restartsSession()) {
         this.browserContext = await this.browser.newContext(contextOptions); // Adding the HTTPSError ignore in the context so that we can ignore those errors
       }
@@ -539,6 +554,7 @@ class Playwright extends Helper {
   *
   * @param {string} description used to show in logs.
   * @param {function} fn async function that executed with Playwright helper as argument
+  * @return {Promise<any>}
   */
   usePlaywrightTo(description, fn) {
     return this._useTo(...arguments);
@@ -553,6 +569,7 @@ class Playwright extends Helper {
    * I.click('#triggerPopup');
    * I.acceptPopup();
    * ```
+   * @return {Promise<any>}
    */
   amAcceptingPopups() {
     popupStore.actionType = 'accept';
@@ -562,6 +579,7 @@ class Playwright extends Helper {
    * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
    * Don't confuse popups with modal windows, as created by [various
    * libraries](http://jster.net/category/windows-modals-popups).
+   * @return {Promise<any>}
    */
   acceptPopup() {
     popupStore.assertPopupActionType('accept');
@@ -576,6 +594,7 @@ class Playwright extends Helper {
    * I.click('#triggerPopup');
    * I.cancelPopup();
    * ```
+   * @return {Promise<any>}
    */
   amCancellingPopups() {
     popupStore.actionType = 'cancel';
@@ -583,6 +602,7 @@ class Playwright extends Helper {
 
   /**
    * Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
+   * @return {Promise<any>}
    */
   cancelPopup() {
     popupStore.assertPopupActionType('cancel');
@@ -600,6 +620,7 @@ class Playwright extends Helper {
   /**
    * Set current page
    * @param {object} page page to set
+   * @return {Promise<any>}
    */
   async _setPage(page) {
     page = await page;
@@ -624,6 +645,7 @@ class Playwright extends Helper {
   /**
    * Add the 'dialog' event listener to a page
    * @page {playwright.Page}
+   * @return {Promise<any>}
    *
    * The popup listener handles the dialog with the predefined action when it appears on the page.
    * It also saves a reference to the object which is used in seeInPopup.
@@ -654,6 +676,7 @@ class Playwright extends Helper {
 
   /**
    * Gets page URL including hash.
+   * @return {Promise<any>}
    */
   async _getPageUrl() {
     return this.executeScript(() => window.location.href);
@@ -826,6 +849,7 @@ class Playwright extends Helper {
    * ```
    *
    * @param {object} customHeaders headers to set
+   * @return {Promise<any>}
    */
   async haveRequestHeaders(customHeaders) {
     if (!customHeaders) {
@@ -851,7 +875,7 @@ class Playwright extends Helper {
   /**
    * {{> dragAndDrop }}
    *
-   * [Additional options](https://playwright.dev/docs/api/class-page#page-drag-and-drop) can be passed as 3rd argument.
+   * @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
@@ -886,7 +910,7 @@ class Playwright extends Helper {
   /**
    * {{> scrollPageToBottom }}
    */
-  scrollPageToBottom() {
+  async scrollPageToBottom() {
     return this.executeScript(() => {
       const body = document.body;
       const html = document.documentElement;
@@ -972,8 +996,7 @@ class Playwright extends Helper {
    * ```js
    * const elements = await this.helpers['Playwright']._locate({name: 'password'});
    * ```
-   *
-   *
+   * @return {Promise<any>}
    */
   async _locate(locator) {
     const context = await this.context || await this._getContext();
@@ -987,6 +1010,7 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateCheckable('I agree with terms and conditions').then // ...
    * ```
+   * @return {Promise<any>}
    */
   async _locateCheckable(locator, providedContext = null) {
     const context = providedContext || await this._getContext();
@@ -1001,6 +1025,7 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateClickable('Next page').then // ...
    * ```
+   * @return {Promise<any>}
    */
   async _locateClickable(locator) {
     const context = await this._getContext();
@@ -1013,6 +1038,7 @@ class Playwright extends Helper {
    * ```js
    * this.helpers['Playwright']._locateFields('Your email').then // ...
    * ```
+   * @return {Promise<any>}
    */
   async _locateFields(locator) {
     return findFields.call(this, locator);
@@ -1027,6 +1053,7 @@ class Playwright extends Helper {
    * ```
    *
    * @param {number} [num=1]
+   * @return {Promise<any>}
    */
   async switchToNextTab(num = 1) {
     if (this.isElectron) {
@@ -1053,6 +1080,7 @@ class Playwright extends Helper {
    * I.switchToPreviousTab(2);
    * ```
    * @param {number} [num=1]
+   * @return {Promise<any>}
    */
   async switchToPreviousTab(num = 1) {
     if (this.isElectron) {
@@ -1077,6 +1105,7 @@ class Playwright extends Helper {
    * ```js
    * I.closeCurrentTab();
    * ```
+   * @return {Promise<any>}
    */
   async closeCurrentTab() {
     if (this.isElectron) {
@@ -1094,6 +1123,7 @@ class Playwright extends Helper {
    * ```js
    * I.closeOtherTabs();
    * ```
+   * @return {Promise<any>}
    */
   async closeOtherTabs() {
     const pages = await this.browserContext.pages();
@@ -1118,6 +1148,7 @@ class Playwright extends Helper {
    * // enable mobile
    * I.openNewTab({ isMobile: true });
    * ```
+   * @return {Promise<any>}
    */
   async openNewTab(options) {
     if (this.isElectron) {
@@ -1186,6 +1217,7 @@ class Playwright extends Helper {
    * ```
    *
    * @param {string} [fileName] set filename for downloaded file
+   * @return {Promise<void>}
    */
   async handleDownloads(fileName = 'downloads') {
     this.page.waitForEvent('download').then(async (download) => {
@@ -1204,7 +1236,7 @@ class Playwright extends Helper {
   /**
    * {{> click }}
    *
-   * [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
+   * @param {any} [opts] [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
    *
    * Examples:
    *
@@ -1223,6 +1255,7 @@ class Playwright extends Helper {
 
   /**
    * Clicks link and waits for navigation (deprecated)
+   * @return {Promise<any>}
    */
   async clickLink(locator, context = null) {
     console.log('clickLink deprecated: Playwright automatically waits for navigation to happen.');
@@ -1992,7 +2025,7 @@ class Playwright extends Helper {
       test.artifacts = {};
     }
 
-    if (this.options.recordVideo && this.page.video()) {
+    if (this.options.recordVideo && this.page && this.page.video()) {
       test.artifacts.video = await this.page.video().path();
     }
 
@@ -2004,7 +2037,7 @@ class Playwright extends Helper {
   }
 
   async _passed(test) {
-    if (this.options.recordVideo && this.page.video()) {
+    if (this.options.recordVideo && this.page && this.page.video()) {
       if (this.options.keepVideoForPassedTests) {
         test.artifacts.video = await this.page.video().path();
       } else {
@@ -2270,6 +2303,7 @@ class Playwright extends Helper {
    *
    * @param {string|function} urlOrPredicate
    * @param {?number} [sec=null] seconds to wait
+   * @return {Promise<any>}
    */
   async waitForRequest(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2286,6 +2320,7 @@ class Playwright extends Helper {
    *
    * @param {string|function} urlOrPredicate
    * @param {?number} [sec=null] number of seconds to wait
+   * @return {Promise<any>}
    */
   async waitForResponse(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -2357,6 +2392,7 @@ class Playwright extends Helper {
    * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
    *
    * @param {*} opts
+   * @return {Promise<any>}
    */
   async waitForNavigation(opts = {}) {
     opts = {
@@ -2427,9 +2463,9 @@ class Playwright extends Helper {
   * ```
   * This method allows intercepting and mocking requests & responses. [Learn more about it](https://playwright.dev/docs/network#handle-requests)
   *
-  * @param {string} [url] URL, regex or pattern for to match URL
+  * @param {string|RegExp} [url] URL, regex or pattern for to match URL
   * @param {function} [handler] a function to process request
-  *
+  * @return {Promise<any>}
   */
   async mockRoute(url, handler) {
     return this.browserContext.route(...arguments);
@@ -2444,9 +2480,9 @@ class Playwright extends Helper {
   * ```
   * If no handler is passed, all mock requests for the rote are disabled.
   *
-  * @param {string} [url] URL, regex or pattern for to match URL
+  * @param {string|RegExp} [url] URL, regex or pattern for to match URL
   * @param {function} [handler] a function to process request
-  *
+  * @return {Promise<any>}
   */
   async stopMockingRoute(url, handler) {
     return this.browserContext.unroute(...arguments);

package/lib/helper/REST.js

@@ -98,7 +98,7 @@ class REST extends Helper {
    * I.amBearerAuthenticated(secret('heregoestoken'))
    * ```
    *
-   * @param {string} accessToken  Bearer access token
+   * @param {string | CodeceptJS.Secret} accessToken  Bearer access token
    */
   amBearerAuthenticated(accessToken) {
     this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` });
@@ -112,6 +112,9 @@ class REST extends Helper {
    * @returns {Promise<*>} response
    */
   async _executeRequest(request) {
+    // Add custom headers. They can be set by amBearerAuthenticated() or haveRequestHeaders()
+    request.headers = { ...request.headers, ...this.headers };
+
     const _debugRequest = { ...request };
     this.axios.defaults.timeout = request.timeout || this.options.timeout;
 

package/lib/helper/WebDriver.js

@@ -2551,6 +2551,9 @@ class WebDriver extends Helper {
 
   /**
    * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
+   * @param {*} caps
+   * @param {*} fn
+   * @return {Promise<any>}
    */
   /* eslint-disable */
   runOnIOS(caps, fn) {
@@ -2558,6 +2561,9 @@ class WebDriver extends Helper {
 
   /**
    * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
+   * @param {*} caps
+   * @param {*} fn
+   * @return {Promise<any>}
    */
   runOnAndroid(caps, fn) {
   }