codeceptjs 3.5.5 → 3.5.7-beta.1

package/lib/helper/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 = {};
 
@@ -827,8 +826,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();
   }
@@ -867,6 +867,7 @@ class Playwright extends Helper {
     this.withinLocator = null;
     this.context = await this.page;
     this.contextLocator = null;
+    this.frame = null;
   }
 
   _extractDataFromPerformanceTiming(timing, ...dataNames) {
@@ -941,14 +942,14 @@ class Playwright extends Helper {
    * Set headers for all next requests
    *
    * ```js
-   * I.haveRequestHeaders({
+   * I.setPlaywrightRequestHeaders({
    *    'X-Sent-By': 'CodeceptJS',
    * });
    * ```
    *
    * @param {object} customHeaders headers to set
    */
-  async haveRequestHeaders(customHeaders) {
+  async setPlaywrightRequestHeaders(customHeaders) {
     if (!customHeaders) {
       throw new Error('Cannot send empty headers.');
     }
@@ -1156,6 +1157,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);
   }
 
@@ -1579,7 +1583,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 });
 
@@ -1609,7 +1613,7 @@ class Playwright extends Helper {
 
     const el = els[0];
 
-    highlightActiveElement.call(this, el, this.page);
+    await highlightActiveElement.call(this, el);
 
     await el.clear();
 
@@ -1624,7 +1628,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();
@@ -1670,7 +1674,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];
 
@@ -1882,11 +1886,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]);
   }
 
   /**
@@ -2361,10 +2365,11 @@ class Playwright extends Helper {
     locator = new Locator(locator, 'css');
 
     const context = await this._getContext();
-    const waiter = context.waitForSelector(buildLocatorString(locator), { timeout: waitTimeout, state: 'attached' });
-    return waiter.catch((err) => {
-      throw new Error(`element (${locator.toString()}) still not present on page after ${waitTimeout / 1000} sec\n${err.message}`);
-    });
+    try {
+      await context.locator(buildLocatorString(locator)).first().waitFor({ timeout: waitTimeout, state: 'attached' });
+    } catch (e) {
+      throw new Error(`element (${locator.toString()}) still not present on page after ${waitTimeout / 1000} sec\n${e.message}`);
+    }
   }
 
   /**
@@ -2376,10 +2381,26 @@ class Playwright extends Helper {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
     locator = new Locator(locator, 'css');
     const context = await this._getContext();
-    const waiter = context.waitForSelector(buildLocatorString(locator), { timeout: waitTimeout, state: 'visible' });
-    return waiter.catch((err) => {
-      throw new Error(`element (${locator.toString()}) still not visible after ${waitTimeout / 1000} sec\n${err.message}`);
-    });
+    let count = 0;
+
+    // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
+    let waiter;
+    if (this.frame) {
+      do {
+        waiter = await this.frame.locator(buildLocatorString(locator)).first().isVisible();
+        await this.wait(1);
+        count += 1000;
+        if (waiter) break;
+      } while (count <= waitTimeout);
+
+      if (!waiter) throw new Error(`element (${locator.toString()}) still not visible after ${waitTimeout / 1000} sec.`);
+    }
+
+    try {
+      await context.locator(buildLocatorString(locator)).first().waitFor({ timeout: waitTimeout, state: 'visible' });
+    } catch (e) {
+      throw new Error(`element (${locator.toString()}) still not visible after ${waitTimeout / 1000} sec\n${e.message}`);
+    }
   }
 
   /**
@@ -2389,10 +2410,27 @@ class Playwright extends Helper {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
     locator = new Locator(locator, 'css');
     const context = await this._getContext();
-    const waiter = context.waitForSelector(buildLocatorString(locator), { timeout: waitTimeout, state: 'hidden' });
-    return waiter.catch((err) => {
-      throw new Error(`element (${locator.toString()}) still visible after ${waitTimeout / 1000} sec\n${err.message}`);
-    });
+    let waiter;
+    let count = 0;
+
+    // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
+    if (this.frame) {
+      do {
+        waiter = await this.frame.locator(buildLocatorString(locator)).first().isHidden();
+        await this.wait(1);
+        count += 1000;
+        if (waiter) break;
+      } while (count <= waitTimeout);
+
+      if (!waiter) throw new Error(`element (${locator.toString()}) still visible after ${waitTimeout / 1000} sec.`);
+      return;
+    }
+
+    try {
+      await context.locator(buildLocatorString(locator)).first().waitFor({ timeout: waitTimeout, state: 'hidden' });
+    } catch (e) {
+      throw new Error(`element (${locator.toString()}) still visible after ${waitTimeout / 1000} sec\n${e.message}`);
+    }
   }
 
   /**
@@ -2402,13 +2440,29 @@ class Playwright extends Helper {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
     locator = new Locator(locator, 'css');
     const context = await this._getContext();
-    return context.waitForSelector(buildLocatorString(locator), { timeout: waitTimeout, state: 'hidden' }).catch((err) => {
+    let waiter;
+    let count = 0;
+
+    // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
+    if (this.frame) {
+      do {
+        waiter = await this.frame.locator(buildLocatorString(locator)).first().isHidden();
+        await this.wait(1);
+        count += 1000;
+        if (waiter) break;
+      } while (count <= waitTimeout);
+
+      if (!waiter) throw new Error(`element (${locator.toString()}) still not hidden after ${waitTimeout / 1000} sec.`);
+      return;
+    }
+
+    return context.locator(buildLocatorString(locator)).first().waitFor({ timeout: waitTimeout, state: 'hidden' }).catch((err) => {
       throw new Error(`element (${locator.toString()}) still not hidden after ${waitTimeout / 1000} sec\n${err.message}`);
     });
   }
 
   async _getContext() {
-    if (this.context && this.context.constructor.name === 'Frame') {
+    if (this.context && this.context.constructor.name === 'FrameLocator') {
       return this.context;
     }
     return this.page;
@@ -2469,7 +2523,12 @@ class Playwright extends Helper {
     if (context) {
       const locator = new Locator(context, 'css');
       if (!locator.isXPath()) {
-        waiter = contextObject.waitForSelector(`${locator.isCustom() ? `${locator.type}=${locator.value}` : locator.simplify()} >> text=${text}`, { timeout: waitTimeout, state: 'visible' });
+        try {
+          await contextObject.locator(`${locator.isCustom() ? `${locator.type}=${locator.value}` : locator.simplify()} >> text=${text}`).first().waitFor({ timeout: waitTimeout, state: 'visible' });
+        } catch (e) {
+          console.log(e);
+          throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec\n${e.message}`);
+        }
       }
 
       if (locator.isXPath()) {
@@ -2481,11 +2540,18 @@ class Playwright extends Helper {
         }, [locator.value, text, $XPath.toString()], { timeout: waitTimeout });
       }
     } else {
-      waiter = contextObject.waitForFunction(text => document.body && document.body.innerText.indexOf(text) > -1, text, { timeout: waitTimeout });
+      // we have this as https://github.com/microsoft/playwright/issues/26829 is not yet implemented
+      // eslint-disable-next-line no-lonely-if
+      const _contextObject = this.frame ? this.frame : contextObject;
+      let count = 0;
+      do {
+        waiter = await _contextObject.locator(`:has-text('${text}')`).first().isVisible();
+        await this.wait(1);
+        count += 1000;
+      } while (count <= waitTimeout);
+
+      if (!waiter) throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec`);
     }
-    return waiter.catch((err) => {
-      throw new Error(`Text "${text}" was not found on page after ${waitTimeout / 1000} sec\n${err.message}`);
-    });
   }
 
   /**
@@ -2535,37 +2601,37 @@ 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);
-    if (!els[0]) {
-      throw new Error(`Element ${JSON.stringify(locator)} was not found by text|CSS|XPath`);
+    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`);
     }
 
-    // get content of the first iframe
-    locator = new Locator(locator, 'css');
-    if ((locator.frame && locator.frame === 'iframe') || locator.value.toLowerCase() === 'iframe') {
-      contentFrame = await this.page.frames()[1];
-      // get content of the iframe using its name
-    } else if (locator.value.toLowerCase().includes('name=')) {
-      const frameName = locator.value.split('=')[1].replace(/"/g, '').replaceAll(/]/g, '');
-      contentFrame = await this.page.frame(frameName);
+    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;
@@ -2644,17 +2710,21 @@ class Playwright extends Helper {
     let waiter;
     const context = await this._getContext();
     if (!locator.isXPath()) {
-      waiter = context.waitForSelector(`${locator.isCustom() ? `${locator.type}=${locator.value}` : locator.simplify()}`, { timeout: waitTimeout, state: 'detached' });
+      try {
+        await context.locator(`${locator.isCustom() ? `${locator.type}=${locator.value}` : locator.simplify()}`).first().waitFor({ timeout: waitTimeout, state: 'detached' });
+      } catch (e) {
+        throw new Error(`element (${locator.toString()}) still on page after ${waitTimeout / 1000} sec\n${e.message}`);
+      }
     } else {
       const visibleFn = function ([locator, $XPath]) {
         eval($XPath); // eslint-disable-line no-eval
         return $XPath(null, locator).length === 0;
       };
       waiter = context.waitForFunction(visibleFn, [locator.value, $XPath.toString()], { timeout: waitTimeout });
+      return waiter.catch((err) => {
+        throw new Error(`element (${locator.toString()}) still on page after ${waitTimeout / 1000} sec\n${err.message}`);
+      });
     }
-    return waiter.catch((err) => {
-      throw new Error(`element (${locator.toString()}) still on page after ${waitTimeout / 1000} sec\n${err.message}`);
-    });
   }
 
   async _waitForAction() {
@@ -3260,7 +3330,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) {
@@ -3290,7 +3360,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
@@ -3340,13 +3410,10 @@ 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 = el.constructor.name ? [await el.locator('body').innerText()] : [await el.innerText()];
 
-    allText = [await el.innerText()];
     description = 'web application';
   } else {
     const locator = new Locator(context, 'css');
@@ -3519,8 +3586,7 @@ async function elementSelected(element) {
 function isFrameLocator(locator) {
   locator = new Locator(locator);
   if (locator.isFrame()) {
-    const _locator = new Locator(locator.value);
-    return _locator.value;
+    return locator.value;
   }
   return false;
 }
@@ -3716,10 +3782,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/lib/helper/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 = {};
 
@@ -682,14 +682,14 @@ class Puppeteer extends Helper {
    * Set headers for all next requests
    *
    * ```js
-   * I.haveRequestHeaders({
+   * I.setPuppeteerRequestHeaders({
    *    'X-Sent-By': 'CodeceptJS',
    * });
    * ```
    *
    * @param {object} customHeaders headers to set
    */
-  async haveRequestHeaders(customHeaders) {
+  async setPuppeteerRequestHeaders(customHeaders) {
     if (!customHeaders) {
       throw new Error('Cannot send empty headers.');
     }
@@ -2727,7 +2727,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/lib/helper/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 = {};
 
@@ -2918,9 +2918,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) {

package/lib/helper/scripts/highlightElement.js

@@ -7,7 +7,7 @@ module.exports.highlightElement = (element, context) => {
   };
 
   try {
-    // Playwright, Puppeteer
+    // Puppeteer
     context.evaluate(clientSideHighlightFn, element).catch(err => console.error(err));
   } catch (e) {
     // WebDriver

package/lib/html.js

@@ -1,7 +1,7 @@
 const { parse, serialize } = require('parse5');
-const { minify } = require('html-minifier');
+const { minify } = require('html-minifier-terser');
 
-function minifyHtml(html) {
+async function minifyHtml(html) {
   return minify(html, {
     collapseWhitespace: true,
     removeComments: true,
@@ -11,7 +11,7 @@ function minifyHtml(html) {
     removeStyleLinkTypeAttributes: true,
     collapseBooleanAttributes: true,
     useShortDoctype: true,
-  }).toString();
+  });
 }
 
 const defaultHtmlOpts = {

package/lib/interfaces/gherkin.js

@@ -18,6 +18,11 @@ parser.stopAtFirstError = false;
 
 module.exports = (text, file) => {
   const ast = parser.parse(text);
+  let currentLanguage;
+
+  if (ast.feature) {
+    currentLanguage = getTranslation(ast.feature.language);
+  }
 
   if (!ast.feature) {
     throw new Error(`No 'Features' available in Gherkin '${file}' provided!`);
@@ -96,7 +101,7 @@ module.exports = (text, file) => {
       suite.beforeEach('Before', scenario.injected(async () => runSteps(child.background.steps), suite, 'before'));
       continue;
     }
-    if (child.scenario && child.scenario.keyword === 'Scenario Outline') {
+    if (child.scenario && (currentLanguage ? child.scenario.keyword === currentLanguage.contexts.ScenarioOutline : child.scenario.keyword === 'Scenario Outline')) {
       for (const examples of child.scenario.examples) {
         const fields = examples.tableHeader.cells.map(c => c.value);
         for (const example of examples.tableBody) {
@@ -141,7 +146,7 @@ function transformTable(table) {
   let str = '';
   for (const id in table.rows) {
     const cells = table.rows[id].cells;
-    str += cells.map(c => c.value).map(c => c.slice(0, 15).padEnd(15)).join(' | ');
+    str += cells.map(c => c.value).map(c => c.padEnd(15)).join(' | ');
     str += '\n';
   }
   return str;
@@ -162,3 +167,17 @@ function addExampleInTable(exampleSteps, placeholders) {
   }
   return steps;
 }
+
+function getTranslation(language) {
+  const translations = Object.keys(require('../../translations'));
+
+  for (const availableTranslation of translations) {
+    if (!language) {
+      break;
+    }
+
+    if (availableTranslation.includes(language)) {
+      return require('../../translations')[availableTranslation];
+    }
+  }
+}

package/lib/output.js

@@ -106,7 +106,7 @@ module.exports = {
     if (!step) return;
     // Avoid to print non-gherkin steps, when gherkin is running for --steps mode
     if (outputLevel === 1) {
-      if (step.hasBDDAncestor()) {
+      if (typeof step === 'object' && step.hasBDDAncestor()) {
         return;
       }
     }

package/lib/pause.js

@@ -18,8 +18,7 @@ let nextStep;
 let finish;
 let next;
 let registeredVariables = {};
-const aiAssistant = new AiAssistant();
-
+let aiAssistant;
 /**
  * Pauses test execution and starts interactive shell
  * @param {Object<string, *>} [passedObject]
@@ -45,6 +44,8 @@ function pauseSession(passedObject = {}) {
     let vars = Object.keys(registeredVariables).join(', ');
     if (vars) vars = `(vars: ${vars})`;
 
+    aiAssistant = AiAssistant.getInstance();
+
     output.print(colors.yellow(' Interactive shell started'));
     output.print(colors.yellow(' Use JavaScript syntax to try steps in action'));
     output.print(colors.yellow(` - Press ${colors.bold('ENTER')} to run the next step`));
@@ -78,7 +79,6 @@ async function parseInput(cmd) {
   rl.pause();
   next = false;
   recorder.session.start('pause');
-  store.debugMode = false;
   if (cmd === '') next = true;
   if (!cmd || cmd === 'resume' || cmd === 'exit') {
     finish();
@@ -98,13 +98,14 @@ async function parseInput(cmd) {
     return cmd;
   };
 
-  store.debugMode = true;
   let isCustomCommand = false;
   let lastError = null;
   let isAiCommand = false;
   let $res;
   try {
+    // eslint-disable-next-line
     const locate = global.locate; // enable locate in this context
+    // eslint-disable-next-line
     const I = container.support('I');
     if (cmd.trim().startsWith('=>')) {
       isCustomCommand = true;
@@ -117,7 +118,7 @@ async function parseInput(cmd) {
       executeCommand = executeCommand.then(async () => {
         try {
           const html = await res;
-          aiAssistant.setHtmlContext(html);
+          await aiAssistant.setHtmlContext(html);
         } catch (err) {
           output.print(output.styles.error(' ERROR '), 'Can\'t get HTML context', err.stack);
           return;