codeceptjs 3.5.4 → 3.5.6

package/docs/build/Appium.js

@@ -117,6 +117,43 @@ const vendorPrefix = {
  * }
  * ```
  *
+ * Example Android App using Appiumv2 on BrowserStack:
+ *
+ * ```js
+ * {
+ * helpers: {
+ *   Appium: {
+ *         appiumV2: true,
+ *         host: "hub-cloud.browserstack.com",
+ *         port: 4444,
+ *         user: process.env.BROWSERSTACK_USER,
+ *         key: process.env.BROWSERSTACK_KEY,
+ *         app: `bs://c700ce60cf1gjhgjh3ae8ed9770ghjg5a55b8e022f13c5827cg`,
+ *         browser: '',
+ *         desiredCapabilities: {
+ *             'appPackage': data.packageName,
+ *             'deviceName': process.env.DEVICE || 'Google Pixel 3',
+ *             'platformName': process.env.PLATFORM || 'android',
+ *             'platformVersion': process.env.OS_VERSION || '10.0',
+ *             'automationName': process.env.ENGINE || 'UIAutomator2',
+ *             'newCommandTimeout': 300000,
+ *             'androidDeviceReadyTimeout': 300000,
+ *             'androidInstallTimeout': 90000,
+ *             'appWaitDuration': 300000,
+ *             'autoGrantPermissions': true,
+ *             'gpsEnabled': true,
+ *             'isHeadless': false,
+ *             'noReset': false,
+ *             'noSign': true,
+ *             'bstack:options' : {
+ *                 "appiumVersion" : "2.0.1",
+ *             },
+ *         }
+ *   }
+ * }
+ * }
+ * ```
+ *
  * Additional configuration params can be used from <https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md>
  *
  * ## Access From Helpers
@@ -234,7 +271,9 @@ class Appium extends Webdriver {
     const _convertedCaps = {};
     for (const [key, value] of Object.entries(capabilities)) {
       if (!key.startsWith(vendorPrefix.appium)) {
-        _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        if (key !== 'platformName') {
+          _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        }
       } else {
         _convertedCaps[`${key}`] = value;
       }

package/docs/build/FileSystem.js

@@ -52,7 +52,7 @@ class FileSystem extends Helper {
   }
 
   /**
-   * Writes test to file
+   * Writes text to file
    * @param {string} name
    * @param {string} text
    */

package/docs/build/Nightmare.js

@@ -882,6 +882,8 @@ class Nightmare extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
@@ -916,6 +918,8 @@ class Nightmare extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *

package/docs/build/Playwright.js

@@ -47,7 +47,6 @@ const {
   setRestartStrategy, restartsSession, restartsContext, restartsBrowser,
 } = require('./extras/PlaywrightRestartOpts');
 const { createValueEngine, createDisabledEngine } = require('./extras/PlaywrightPropEngine');
-const { highlightElement } = require('./scripts/highlightElement');
 
 const pathSeparator = path.sep;
 
@@ -94,7 +93,7 @@ const pathSeparator = path.sep;
  * @prop {string[]} [ignoreLog] - An array with console message types that are not logged to debug log. Default value is `['warning', 'log']`. E.g. you can set `[]` to log all messages. See all possible [values](https://playwright.dev/docs/api/class-consolemessage#console-message-type).
  * @prop {boolean} [ignoreHTTPSErrors] - Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
  * @prop {boolean} [bypassCSP] - bypass Content Security Policy or CSP
- * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false
+ * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
  */
 const config = {};
 
@@ -482,6 +481,7 @@ class Playwright extends Helper {
         contextOptions.httpCredentials = this.options.basicAuth;
         this.isAuthenticated = true;
       }
+      if (this.options.bypassCSP) contextOptions.bypassCSP = this.options.bypassCSP;
       if (this.options.recordVideo) contextOptions.recordVideo = this.options.recordVideo;
       if (this.storageState) contextOptions.storageState = this.storageState;
       if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent;
@@ -834,8 +834,9 @@ class Playwright extends Helper {
 
   async _stopBrowser() {
     this.withinLocator = null;
-    this._setPage(null);
+    await this._setPage(null);
     this.context = null;
+    this.frame = null;
     popupStore.clear();
     await this.browser.close();
   }
@@ -857,8 +858,8 @@ class Playwright extends Helper {
         await this.switchTo(null);
         return frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve());
       }
-      await this.switchTo(locator);
-      this.withinLocator = new Locator(locator);
+      await this.switchTo(frame);
+      this.withinLocator = new Locator(frame);
       return;
     }
 
@@ -874,6 +875,7 @@ class Playwright extends Helper {
     this.withinLocator = null;
     this.context = await this.page;
     this.contextLocator = null;
+    this.frame = null;
   }
 
   _extractDataFromPerformanceTiming(timing, ...dataNames) {
@@ -1298,6 +1300,9 @@ class Playwright extends Helper {
    */
   async _locate(locator) {
     const context = await this.context || await this._getContext();
+
+    if (this.frame) return findElements(this.frame, locator);
+
     return findElements(context, locator);
   }
 
@@ -2008,7 +2013,7 @@ class Playwright extends Helper {
 
     await el.clear();
 
-    highlightActiveElement.call(this, el, await this._getContext());
+    await highlightActiveElement.call(this, el);
 
     await el.type(value.toString(), { delay: this.options.pressKeyDelay });
 
@@ -2038,7 +2043,7 @@ class Playwright extends Helper {
 
     const el = els[0];
 
-    highlightActiveElement.call(this, el, this.page);
+    await highlightActiveElement.call(this, el);
 
     await el.clear();
 
@@ -2064,7 +2069,7 @@ class Playwright extends Helper {
   async appendField(field, value) {
     const els = await findFields.call(this, field);
     assertElementExists(els, field, 'Field');
-    highlightActiveElement.call(this, els[0], await this._getContext());
+    await highlightActiveElement.call(this, els[0]);
     await els[0].press('End');
     await els[0].type(value.toString(), { delay: this.options.pressKeyDelay });
     return this._waitForAction();
@@ -2166,7 +2171,7 @@ class Playwright extends Helper {
     assertElementExists(els, select, 'Selectable field');
     const el = els[0];
 
-    highlightActiveElement.call(this, el, await this._getContext());
+    await highlightActiveElement.call(this, el);
 
     if (!Array.isArray(option)) option = [option];
 
@@ -2554,11 +2559,11 @@ class Playwright extends Helper {
    * @returns {Promise<any>}
    */
   async executeScript(fn, arg) {
-    let context = this.page;
-    if (this.context && this.context.constructor.name === 'Frame') {
-      context = this.context; // switching to iframe context
+    if (this.context && this.context.constructor.name === 'FrameLocator') {
+      // switching to iframe context
+      return this.context.locator(':root').evaluate(fn, arg);
     }
-    return context.evaluate.apply(context, [fn, arg]);
+    return this.page.evaluate.apply(this.page, [fn, arg]);
   }
 
   /**
@@ -3312,7 +3317,7 @@ class Playwright extends Helper {
   }
 
   async _getContext() {
-    if (this.context && this.context.constructor.name === 'Frame') {
+    if (this.context && this.context.constructor.name === 'FrameLocator') {
       return this.context;
     }
     return this.page;
@@ -3417,6 +3422,14 @@ class Playwright extends Helper {
         }, [locator.value, text, $XPath.toString()], { timeout: waitTimeout });
       }
     } else {
+      // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
+      if (this.frame) {
+        const { setTimeout } = require('timers/promises');
+        await setTimeout(waitTimeout);
+        waiter = await this.frame.locator(`:has-text('${text}')`).first().isVisible();
+        if (!waiter) throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec`);
+        return;
+      }
       waiter = contextObject.waitForFunction(text => document.body && document.body.innerText.indexOf(text) > -1, text, { timeout: waitTimeout });
     }
     return waiter.catch((err) => {
@@ -3480,39 +3493,42 @@ class Playwright extends Helper {
       }
 
       if (locator >= 0 && locator < childFrames.length) {
-        this.context = childFrames[locator];
+        this.context = await this.page.frameLocator('iframe').nth(locator);
         this.contextLocator = locator;
       } else {
         throw new Error('Element #invalidIframeSelector was not found by text|CSS|XPath');
       }
       return;
     }
-    let contentFrame;
 
     if (!locator) {
-      this.context = await this.page.frames()[0];
+      this.context = this.page;
       this.contextLocator = null;
+      this.frame = null;
       return;
     }
 
     // iframe by selector
-    const els = await this._locate(locator);
-    // assertElementExists(els, locator);
-
-    // get content of the first iframe
-    if ((locator.frame && locator.frame === 'iframe') || locator.toLowerCase() === 'iframe') {
-      contentFrame = await this.page.frames()[1];
-      // get content of the iframe using its name
-    } else if (locator.toLowerCase().includes('name=')) {
-      const frameName = locator.split('=')[1].replace(/"/g, '').replaceAll(/]/g, '');
-      contentFrame = await this.page.frame(frameName);
+    locator = buildLocatorString(new Locator(locator, 'css'));
+    const frame = await this._locateElement(locator);
+
+    if (!frame) {
+      throw new Error(`Frame ${JSON.stringify(locator)} was not found by text|CSS|XPath`);
     }
 
+    if (this.frame) {
+      this.frame = await this.frame.frameLocator(locator);
+    } else {
+      this.frame = await this.page.frameLocator(locator);
+    }
+
+    const contentFrame = this.frame;
+
     if (contentFrame) {
       this.context = contentFrame;
       this.contextLocator = null;
     } else {
-      this.context = els[0];
+      this.context = this.page.frame(this.page.frames()[1].name());
       this.contextLocator = locator;
     }
   }
@@ -4268,7 +4284,7 @@ async function findElement(matcher, locator) {
   if (locator.react) return findReact(matcher, locator);
   locator = new Locator(locator, 'css');
 
-  return matcher.locator(buildLocatorString(locator));
+  return matcher.locator(buildLocatorString(locator)).first();
 }
 
 async function getVisibleElements(elements) {
@@ -4298,7 +4314,7 @@ async function proceedClick(locator, context = null, options = {}) {
     assertElementExists(els, locator, 'Clickable element');
   }
 
-  highlightActiveElement.call(this, els[0], await this._getContext());
+  await highlightActiveElement.call(this, els[0]);
 
   /*
     using the force true options itself but instead dispatching a click
@@ -4348,13 +4364,9 @@ async function proceedSee(assertType, text, context, strict = false) {
   let allText;
 
   if (!context) {
-    let el = await this.context;
-    if (el && !el.getProperty) {
-      // Fallback to body
-      el = await this.page.$('body');
-    }
+    const el = await this.context;
 
-    allText = [await el.innerText()];
+    allText = [await el.locator('body').innerText()];
     description = 'web application';
   } else {
     const locator = new Locator(context, 'css');
@@ -4526,7 +4538,9 @@ async function elementSelected(element) {
 
 function isFrameLocator(locator) {
   locator = new Locator(locator);
-  if (locator.isFrame()) return locator.value;
+  if (locator.isFrame()) {
+    return locator.value;
+  }
   return false;
 }
 
@@ -4721,10 +4735,14 @@ async function saveTraceForContext(context, name) {
   return fileName;
 }
 
-function highlightActiveElement(element, context) {
-  if (!this.options.highlightElement && !store.debugMode) return;
-
-  highlightElement(element, context);
+async function highlightActiveElement(element) {
+  if (this.options.highlightElement && global.debugMode) {
+    await element.evaluate(el => {
+      const prevStyle = el.style.boxShadow;
+      el.style.boxShadow = '0px 0px 4px 3px rgba(255, 0, 0, 0.7)';
+      setTimeout(() => el.style.boxShadow = prevStyle, 2000);
+    });
+  }
 }
 
 const createAdvancedTestResults = (url, dataToCheck, requests) => {

package/docs/build/Protractor.js

@@ -1525,6 +1525,8 @@ class Protractor extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    */
@@ -1556,6 +1558,8 @@ class Protractor extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    */

package/docs/build/Puppeteer.js

@@ -69,7 +69,7 @@ const consoleLogStore = new Console();
  * @prop {boolean} [manualStart=false] - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
  * @prop {string} [browser=chrome] - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
  * @prop {object} [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
- * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false
+ * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
 */
 const config = {};
 
@@ -612,8 +612,8 @@ class Puppeteer extends Helper {
         return this.switchTo(null)
           .then(() => frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve()));
       }
-      await this.switchTo(locator);
-      this.withinLocator = new Locator(locator);
+      await this.switchTo(frame);
+      this.withinLocator = new Locator(frame);
       return;
     }
 
@@ -2314,6 +2314,8 @@ class Puppeteer extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
@@ -2351,6 +2353,8 @@ class Puppeteer extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
@@ -2942,7 +2946,7 @@ class Puppeteer extends Helper {
     assertElementExists(els, locator);
 
     return this.waitForFunction(isElementClickable, [els[0]], waitTimeout).catch(async (e) => {
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`element ${new Locator(locator).toString()} still not clickable after ${waitTimeout || this.options.waitForTimeout / 1000} sec`);
       } else {
         throw e;
@@ -3096,7 +3100,7 @@ class Puppeteer extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, { timeout: waitTimeout }, urlPart).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed:/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;
@@ -3130,7 +3134,7 @@ class Puppeteer extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, { timeout: waitTimeout }, urlPart).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`expected url to be ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;
@@ -3427,6 +3431,10 @@ async function findElements(matcher, locator) {
   if (locator.react) return findReact(matcher.executionContext(), locator);
   locator = new Locator(locator, 'css');
   if (!locator.isXPath()) return matcher.$$(locator.simplify());
+  // puppeteer version < 19.4.0 is no longer supported. This one is backward support.
+  if (puppeteer.default?.defaultBrowserRevision) {
+    return matcher.$$(`xpath/${locator.value}`);
+  }
   return matcher.$x(locator.value);
 }
 
@@ -3681,7 +3689,10 @@ async function elementSelected(element) {
 
 function isFrameLocator(locator) {
   locator = new Locator(locator);
-  if (locator.isFrame()) return locator.value;
+  if (locator.isFrame()) {
+    const _locator = new Locator(locator);
+    return _locator.value;
+  }
   return false;
 }
 
@@ -3799,7 +3810,7 @@ function getNormalizedKey(key) {
 }
 
 function highlightActiveElement(element, context) {
-  if (!this.options.highlightElement && !store.debugMode) return;
-
-  highlightElement(element, context);
+  if (this.options.highlightElement && global.debugMode) {
+    highlightElement(element, context);
+  }
 }

package/docs/build/TestCafe.js

@@ -1270,6 +1270,8 @@ class TestCafe extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *

package/docs/build/WebDriver.js

@@ -62,7 +62,7 @@ const webRoot = 'body';
  * @prop {object} [desiredCapabilities] Selenium's [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
  * @prop {boolean} [manualStart=false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
  * @prop {object} [timeouts] [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
- * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false
+ * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
  */
 const config = {};
 
@@ -2173,6 +2173,8 @@ class WebDriver extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
@@ -2207,6 +2209,8 @@ class WebDriver extends Helper {
    * 
    * @param {string|function} fn function to be executed in browser context.
    * @param {...any} args to be passed to function.
+   * @returns {Promise<any>} script return value
+   * 
    * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
@@ -4079,9 +4083,9 @@ function isModifierKey(key) {
 }
 
 function highlightActiveElement(element) {
-  if (!this.options.highlightElement && !store.debugMode) return;
-
-  highlightElement(element, this.browser);
+  if (this.options.highlightElement && global.debugMode) {
+    highlightElement(element, this.browser);
+  }
 }
 
 function prepareLocateFn(context) {