codeceptjs 3.5.15 → 3.6.0-beta.1.ai-healers

package/lib/helper/WebDriver.js

@@ -6,7 +6,6 @@ const fs = require('fs');
 
 const Helper = require('@codeceptjs/helper');
 const crypto = require('crypto');
-const promiseRetry = require('promise-retry');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals, equals } = require('../assert/equal');
 const { debug } = require('../output');
@@ -33,10 +32,6 @@ const { highlightElement } = require('./scripts/highlightElement');
 const store = require('../store');
 const { focusElement } = require('./scripts/focusElement');
 const { blurElement } = require('./scripts/blurElement');
-const {
-  dontSeeElementError, seeElementError, seeElementInDOMError, dontSeeElementInDOMError,
-} = require('./errors/ElementAssertion');
-const { allParameterValuePairsMatchExtreme, extractQueryObjects, createAdvancedTestResults } = require('./networkTraffics/utils');
 
 const SHADOW = 'shadow';
 const webRoot = 'body';
@@ -453,11 +448,6 @@ class WebDriver extends Helper {
     this.activeSessionName = '';
     this.customLocatorStrategies = config.customLocatorStrategies;
 
-    // for network stuff
-    this.requests = [];
-    this.recording = false;
-    this.recordedAtLeastOnce = false;
-
     this._setConfig(config);
 
     Locator.addFilter((locator, result) => {
@@ -497,9 +487,8 @@ class WebDriver extends Helper {
     if (config.host) {
       // webdriverio spec
       config.hostname = config.host;
-      config.path = config.path ? config.path : '/wd/hub';
+      config.path = '/wd/hub';
     }
-
     config.baseUrl = config.url || config.baseUrl;
     if (config.desiredCapabilities && Object.keys(config.desiredCapabilities).length) {
       config.capabilities = config.desiredCapabilities;
@@ -640,11 +629,6 @@ class WebDriver extends Helper {
     if (this.browser.capabilities && this.browser.capabilities.platformName) {
       this.browser.capabilities.platformName = this.browser.capabilities.platformName.toLowerCase();
     }
-
-    if (this.options.automationProtocol) {
-      this.puppeteerBrowser = await this.browser.getPuppeteer();
-    }
-
     return this.browser;
   }
 
@@ -977,12 +961,12 @@ class WebDriver extends Helper {
    */
   amOnPage(url) {
     let split_url;
-    if (this.options.basicAuth) {
+    if (this.config.basicAuth) {
       if (url.startsWith('/')) {
-        url = this.options.url + url;
+        url = this.config.url + url;
       }
       split_url = url.split('//');
-      url = `${split_url[0]}//${this.options.basicAuth.username}:${this.options.basicAuth.password}@${split_url[1]}`;
+      url = `${split_url[0]}//${this.config.basicAuth.username}:${this.config.basicAuth.password}@${split_url[1]}`;
     }
     return this.browser.url(url);
   }
@@ -1477,11 +1461,7 @@ class WebDriver extends Helper {
     const res = await this._locate(locator, true);
     assertElementExists(res, locator);
     const selected = await forEachAsync(res, async el => el.isDisplayed());
-    try {
-      return truth(`elements of ${(new Locator(locator))}`, 'to be seen').assert(selected);
-    } catch (e) {
-      dontSeeElementError(locator);
-    }
+    return truth(`elements of ${(new Locator(locator))}`, 'to be seen').assert(selected);
   }
 
   /**
@@ -1494,11 +1474,7 @@ class WebDriver extends Helper {
       return truth(`elements of ${(new Locator(locator))}`, 'to be seen').negate(false);
     }
     const selected = await forEachAsync(res, async el => el.isDisplayed());
-    try {
-      return truth(`elements of ${(new Locator(locator))}`, 'to be seen').negate(selected);
-    } catch (e) {
-      seeElementError(locator);
-    }
+    return truth(`elements of ${(new Locator(locator))}`, 'to be seen').negate(selected);
   }
 
   /**
@@ -1507,11 +1483,7 @@ class WebDriver extends Helper {
    */
   async seeElementInDOM(locator) {
     const res = await this._res(locator);
-    try {
-      return empty('elements').negate(res);
-    } catch (e) {
-      dontSeeElementInDOMError(locator);
-    }
+    return empty('elements').negate(res);
   }
 
   /**
@@ -1520,11 +1492,7 @@ class WebDriver extends Helper {
    */
   async dontSeeElementInDOM(locator) {
     const res = await this._res(locator);
-    try {
-      return empty('elements').assert(res);
-    } catch (e) {
-      seeElementInDOMError(locator);
-    }
+    return empty('elements').assert(res);
   }
 
   /**
@@ -1644,8 +1612,6 @@ class WebDriver extends Helper {
       for (let i = 0; i < val.length; ++i) {
         const _actual = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
         const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
-        // the attribute could be a boolean
-        if (typeof _actual === 'boolean') return _actual === _expected;
         if (_actual !== _expected) return false;
       }
       return true;
@@ -1873,37 +1839,6 @@ class WebDriver extends Helper {
     return cookie[0];
   }
 
-  /**
-   * {{> waitForCookie }}
-   */
-  async waitForCookie(name, sec) {
-    // by default, we will retry 3 times
-    let retries = 3;
-    const waitTimeout = sec || this.options.waitForTimeoutInSeconds;
-
-    if (sec) {
-      retries = sec;
-    } else {
-      retries = waitTimeout - 1;
-    }
-
-    return promiseRetry(async (retry, number) => {
-      const _grabCookie = async (name) => {
-        const cookie = await this.browser.getCookies([name]);
-        if (cookie.length === 0) throw Error(`Cookie ${name} is not found after ${retries}s`);
-      };
-
-      this.debugSection('Wait for cookie: ', name);
-      if (number > 1) this.debugSection('Retrying... Attempt #', number);
-
-      try {
-        await _grabCookie(name);
-      } catch (e) {
-        retry(e);
-      }
-    }, { retries, maxTimeout: 1000 });
-  }
-
   /**
    * 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
@@ -2615,9 +2550,9 @@ class WebDriver extends Helper {
       return;
     }
     this.geoLocation = { latitude, longitude };
-
+    const puppeteerBrowser = await this.browser.getPuppeteer();
     await this.browser.call(async () => {
-      const pages = await this.puppeteerBrowser.pages();
+      const pages = await puppeteerBrowser.pages();
       await pages[0].setGeolocation({ latitude, longitude });
     });
   }
@@ -2679,255 +2614,6 @@ class WebDriver extends Helper {
   runInWeb(fn) {
     return fn();
   }
-
-  /**
-   *
-   * _Note:_ Only works when devtoolsProtocol is enabled.
-   *
-   * {{> flushNetworkTraffics }}
-   */
-  flushNetworkTraffics() {
-    if (!this.options.automationProtocol) {
-      console.log('* Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration');
-      return;
-    }
-    this.requests = [];
-  }
-
-  /**
-   *
-   * _Note:_ Only works when devtoolsProtocol is enabled.
-   *
-   * {{> stopRecordingTraffic }}
-   */
-  stopRecordingTraffic() {
-    if (!this.options.automationProtocol) {
-      console.log('* Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration');
-      return;
-    }
-    this.page.removeAllListeners('request');
-    this.recording = false;
-  }
-
-  /**
-   *
-   * _Note:_ Only works when devtoolsProtocol is enabled.
-   *
-   * {{> startRecordingTraffic }}
-   *
-   */
-  async startRecordingTraffic() {
-    if (!this.options.automationProtocol) {
-      console.log('* Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration');
-      return;
-    }
-    this.flushNetworkTraffics();
-    this.recording = true;
-    this.recordedAtLeastOnce = true;
-
-    this.page = (await this.puppeteerBrowser.pages())[0];
-    await this.page.setRequestInterception(true);
-
-    this.page.on('request', (request) => {
-      const information = {
-        url: request.url(),
-        method: request.method(),
-        requestHeaders: request.headers(),
-        requestPostData: request.postData(),
-        response: request.response(),
-      };
-
-      this.debugSection('REQUEST: ', JSON.stringify(information));
-
-      if (typeof information.requestPostData === 'object') {
-        information.requestPostData = JSON.parse(information.requestPostData);
-      }
-      request.continue();
-      this.requests.push(information);
-    });
-  }
-
-  /**
-   *
-   * _Note:_ Only works when devtoolsProtocol is enabled.
-   *
-   * {{> grabRecordedNetworkTraffics }}
-   */
-  async grabRecordedNetworkTraffics() {
-    if (!this.options.automationProtocol) {
-      console.log('* Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration');
-      return;
-    }
-    if (!this.recording || !this.recordedAtLeastOnce) {
-      throw new Error('Failure in test automation. You use "I.grabRecordedNetworkTraffics", but "I.startRecordingTraffic" was never called before.');
-    }
-
-    const promises = this.requests.map(async (request) => {
-      const resp = await request.response;
-
-      if (!resp) {
-        return {
-          url: '',
-          response: {
-            status: '',
-            statusText: '',
-            body: '',
-          },
-        };
-      }
-
-      let body;
-      try {
-        // There's no 'body' for some requests (redirect etc...)
-        body = JSON.parse((await resp.body()).toString());
-      } catch (e) {
-        // only interested in JSON, not HTML responses.
-      }
-
-      return {
-        url: resp.url(),
-        response: {
-          status: resp.status(),
-          statusText: resp.statusText(),
-          body,
-        },
-      };
-    });
-    return Promise.all(promises);
-  }
-
-  /**
-   *
-   * _Note:_ Only works when devtoolsProtocol is enabled.
-   *
-   * {{> seeTraffic }}
-   */
-  async seeTraffic({
-    name, url, parameters, requestPostData, timeout = 10,
-  }) {
-    if (!this.options.automationProtocol) {
-      console.log('* Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration');
-      return;
-    }
-    if (!name) {
-      throw new Error('Missing required key "name" in object given to "I.seeTraffic".');
-    }
-
-    if (!url) {
-      throw new Error('Missing required key "url" in object given to "I.seeTraffic".');
-    }
-
-    if (!this.recording || !this.recordedAtLeastOnce) {
-      throw new Error('Failure in test automation. You use "I.seeTraffic", but "I.startRecordingTraffic" was never called before.');
-    }
-
-    for (let i = 0; i <= timeout * 2; i++) {
-      const found = this._isInTraffic(url, parameters);
-      if (found) {
-        return true;
-      }
-      await new Promise((done) => {
-        setTimeout(done, 1000);
-      });
-    }
-
-    // check request post data
-    if (requestPostData && this._isInTraffic(url)) {
-      const advancedTestResults = createAdvancedTestResults(url, requestPostData, this.requests);
-
-      assert.equal(advancedTestResults, true, `Traffic named "${name}" found correct URL ${url}, BUT the post data did not match:\n ${advancedTestResults}`);
-    } else if (parameters && this._isInTraffic(url)) {
-      const advancedTestResults = createAdvancedTestResults(url, parameters, this.requests);
-
-      assert.fail(
-        `Traffic named "${name}" found correct URL ${url}, BUT the query parameters did not match:\n`
-        + `${advancedTestResults}`,
-      );
-    } else {
-      assert.fail(
-        `Traffic named "${name}" not found in recorded traffic within ${timeout} seconds.\n`
-        + `Expected url: ${url}.\n`
-        + `Recorded traffic:\n${this._getTrafficDump()}`,
-      );
-    }
-  }
-
-  /**
-   *
-   * _Note:_ Only works when devtoolsProtocol is enabled.
-   *
-   * {{> dontSeeTraffic }}
-   *
-   */
-  dontSeeTraffic({ name, url }) {
-    if (!this.options.automationProtocol) {
-      console.log('* Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration');
-      return;
-    }
-    if (!this.recordedAtLeastOnce) {
-      throw new Error('Failure in test automation. You use "I.dontSeeTraffic", but "I.startRecordingTraffic" was never called before.');
-    }
-
-    if (!name) {
-      throw new Error('Missing required key "name" in object given to "I.dontSeeTraffic".');
-    }
-
-    if (!url) {
-      throw new Error('Missing required key "url" in object given to "I.dontSeeTraffic".');
-    }
-
-    if (this._isInTraffic(url)) {
-      assert.fail(`Traffic with name "${name}" (URL: "${url}') found, but was not expected to be found.`);
-    }
-  }
-
-  /**
-   * Checks if URL with parameters is part of network traffic. Returns true or false. Internal method for this helper.
-   *
-   * @param url URL to look for.
-   * @param [parameters] Parameters that this URL needs to contain
-   * @return {boolean} Whether or not URL with parameters is part of network traffic.
-   * @private
-   */
-  _isInTraffic(url, parameters) {
-    let isInTraffic = false;
-    this.requests.forEach((request) => {
-      if (isInTraffic) {
-        return; // We already found traffic. Continue with next request
-      }
-
-      if (!request.url.match(new RegExp(url))) {
-        return; // url not found in this request. continue with next request
-      }
-
-      // URL has matched. Now we check the parameters
-
-      if (parameters) {
-        const advancedReport = allParameterValuePairsMatchExtreme(extractQueryObjects(request.url), parameters);
-        if (advancedReport === true) {
-          isInTraffic = true;
-        }
-      } else {
-        isInTraffic = true;
-      }
-    });
-
-    return isInTraffic;
-  }
-
-  /**
-   * Returns all URLs of all network requests recorded so far during execution of test scenario.
-   *
-   * @return {string} List of URLs recorded as a string, separated by new lines after each URL
-   * @private
-   */
-  _getTrafficDump() {
-    let dumpedTraffic = '';
-    this.requests.forEach((request) => {
-      dumpedTraffic += `${request.method} - ${request.url}\n`;
-    });
-    return dumpedTraffic;
-  }
 }
 
 async function proceedSee(assertType, text, context, strict = false) {

package/lib/index.js

@@ -39,5 +39,8 @@ module.exports = {
   /** @type {typeof CodeceptJS.Locator} */
   locator: require('./locator'),
 
+  heal: require('./heal'),
+  ai: require('./ai'),
+
   Workers: require('./workers'),
 };

package/lib/listener/steps.js

@@ -67,7 +67,6 @@ module.exports = function () {
   });
 
   event.dispatcher.on(event.step.started, (step) => {
-    if (store.debugMode) return;
     step.startedAt = +new Date();
     step.test = currentTest;
     if (currentHook && Array.isArray(currentHook.steps)) {
@@ -78,7 +77,6 @@ module.exports = function () {
   });
 
   event.dispatcher.on(event.step.finished, (step) => {
-    if (store.debugMode) return;
     step.finishedAt = +new Date();
     if (step.startedAt) step.duration = step.finishedAt - step.startedAt;
     debug(`Step '${step}' finished; Duration: ${step.duration || 0}ms`);

package/lib/locator.js

@@ -1,4 +1,4 @@
-let cssToXPath;
+const cssToXPath = require('csstoxpath');
 const { sprintf } = require('sprintf-js');
 
 const { xpathLocator } = require('./utils');
@@ -162,17 +162,8 @@ class Locator {
    * @returns {string}
    */
   toXPath(pseudoSelector = '') {
-    const locator = `${this.value}${pseudoSelector}`;
-    const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang', ':nth-child'];
-
-    if (limitation.some(item => locator.includes(item))) {
-      cssToXPath = require('css-to-xpath');
-    } else {
-      cssToXPath = require('csstoxpath');
-    }
-
     if (this.isXPath()) return this.value;
-    if (this.isCSS()) return cssToXPath(locator);
+    if (this.isCSS()) return cssToXPath(`${this.value}${pseudoSelector}`);
 
     throw new Error('Can\'t be converted to XPath');
   }
@@ -259,7 +250,7 @@ class Locator {
    */
   withText(text) {
     text = xpathLocator.literal(text);
-    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(., ${text})`);
+    const xpath = this.toXPath(`:text-contains-case(${text})`);
     return new Locator({ xpath });
   }
 
@@ -270,7 +261,7 @@ class Locator {
    */
   withTextEquals(text) {
     text = xpathLocator.literal(text);
-    const xpath = sprintf('%s[%s]', this.toXPath(), `.= ${text}`);
+    const xpath = this.toXPath(`:text-case(${text})`);
     return new Locator({ xpath });
   }