codeceptjs 4.0.0-beta.3 → 4.0.0-beta.4

package/lib/helper/WebDriver.js

@@ -72,7 +72,6 @@ const webRoot = 'body'
  * @prop {object} [timeouts] [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
  * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
  * @prop {string} [logLevel=silent] - level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: https://webdriver.io/docs/configuration/#loglevel
- * @prop {boolean} [devtoolsProtocol=false] - enable devtools protocol. Default: false. More info: https://webdriver.io/docs/automationProtocols/#devtools-protocol.
  */
 const config = {}
 
@@ -180,7 +179,6 @@ const config = {}
  *      WebDriver : {
  *        url: "http://localhost",
  *        browser: "chrome",
- *        devtoolsProtocol: true,
  *        desiredCapabilities: {
  *          chromeOptions: {
  *            args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
@@ -614,11 +612,6 @@ class WebDriver extends Helper {
         delete this.options.capabilities.hostname
         delete this.options.capabilities.port
         delete this.options.capabilities.path
-        if (this.options.devtoolsProtocol) {
-          if (!['chrome', 'chromium'].includes(this.options.browser.toLowerCase()))
-            throw Error('The devtools protocol is only working with Chrome or Chromium')
-          this.options.automationProtocol = 'devtools'
-        }
         this.browser = await webdriverio.remote(this.options)
       }
     } catch (err) {
@@ -649,11 +642,6 @@ class WebDriver extends Helper {
       this.browser.capabilities.platformName = this.browser.capabilities.platformName.toLowerCase()
     }
 
-    if (this.options.automationProtocol) {
-      this.puppeteerBrowser = await this.browser.getPuppeteer()
-      this.page = (await this.puppeteerBrowser.pages())[0]
-    }
-
     return this.browser
   }
 
@@ -1143,10 +1131,6 @@ class WebDriver extends Helper {
     assertElementExists(res, field, 'Field')
     const elem = usingFirstElement(res)
     highlightActiveElement.call(this, elem)
-    if (this.options.automationProtocol) {
-      const curentValue = await elem.getValue()
-      return elem.setValue(curentValue + value.toString())
-    }
     return elem.addValue(value.toString())
   }
 
@@ -1159,9 +1143,6 @@ class WebDriver extends Helper {
     assertElementExists(res, field, 'Field')
     const elem = usingFirstElement(res)
     highlightActiveElement.call(this, elem)
-    if (this.options.automationProtocol) {
-      return elem.setValue('')
-    }
     return elem.clearValue(getElementId(elem))
   }
 
@@ -1231,7 +1212,7 @@ class WebDriver extends Helper {
     const el = usingFirstElement(res)
 
     // Remote Upload (when running Selenium Server)
-    if (this.options.remoteFileUpload && !this.options.automationProtocol) {
+    if (this.options.remoteFileUpload) {
       try {
         this.debugSection('File', 'Uploading file to remote server')
         file = await this.browser.uploadFile(file)
@@ -1793,7 +1774,7 @@ class WebDriver extends Helper {
       if (this.browser.isMobile && !this.browser.isW3C) return this.browser.touchScroll(offsetX, offsetY, elementId)
       const location = await elem.getLocation()
       assertElementExists(location, locator, 'Failed to receive', 'location')
-      /* eslint-disable prefer-arrow-callback */
+
       return this.browser.execute(
         function (x, y) {
           return window.scrollTo(x, y)
@@ -1801,12 +1782,10 @@ class WebDriver extends Helper {
         location.x + offsetX,
         location.y + offsetY,
       )
-      /* eslint-enable */
     }
 
     if (this.browser.isMobile && !this.browser.isW3C) return this.browser.touchScroll(locator, offsetX, offsetY)
 
-    /* eslint-disable prefer-arrow-callback, comma-dangle */
     return this.browser.execute(
       function (x, y) {
         return window.scrollTo(x, y)
@@ -1814,7 +1793,6 @@ class WebDriver extends Helper {
       offsetX,
       offsetY,
     )
-    /* eslint-enable */
   }
 
   /**
@@ -1873,7 +1851,6 @@ class WebDriver extends Helper {
       return this.browser.saveScreenshot(outputFile)
     }
 
-    /* eslint-disable prefer-arrow-callback, comma-dangle, prefer-const */
     const originalWindowSize = await this.browser.getWindowSize()
 
     let { width, height } = await this.browser
@@ -1886,7 +1863,6 @@ class WebDriver extends Helper {
       .then((res) => res)
 
     if (height < 100) height = 500 // errors for very small height
-    /* eslint-enable */
 
     await this.browser.setWindowSize(width, height)
     this.debug(`Screenshot has been saved to ${outputFile}, size: ${width}x${height}`)
@@ -2593,9 +2569,6 @@ class WebDriver extends Helper {
   async switchTo(locator) {
     this.browser.isInsideFrame = true
     if (Number.isInteger(locator)) {
-      if (this.options.automationProtocol) {
-        return this.browser.switchToFrame(locator + 1)
-      }
       return this.browser.switchToFrame(locator)
     }
     if (!locator) {
@@ -2695,11 +2668,10 @@ class WebDriver extends Helper {
    */
   scrollPageToTop() {
     const client = this.browser
-    /* eslint-disable prefer-arrow-callback */
+
     return client.execute(function () {
       window.scrollTo(0, 0)
     })
-    /* eslint-enable */
   }
 
   /**
@@ -2707,7 +2679,7 @@ class WebDriver extends Helper {
    */
   scrollPageToBottom() {
     const client = this.browser
-    /* eslint-disable prefer-arrow-callback, comma-dangle */
+
     return client.execute(function () {
       const body = document.body
       const html = document.documentElement
@@ -2716,60 +2688,20 @@ class WebDriver extends Helper {
         Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight),
       )
     })
-    /* eslint-enable */
   }
 
   /**
    * {{> grabPageScrollPosition }}
    */
   async grabPageScrollPosition() {
-    /* eslint-disable comma-dangle */
     function getScrollPosition() {
       return {
         x: window.pageXOffset,
         y: window.pageYOffset,
       }
     }
-    /* eslint-enable comma-dangle */
-    return this.executeScript(getScrollPosition)
-  }
-
-  /**
-   * This method is **deprecated**.
-   *
-   *
-   * {{> setGeoLocation }}
-   */
-  async setGeoLocation(latitude, longitude) {
-    if (!this.options.automationProtocol) {
-      console.log(`setGeoLocation deprecated:
-    * This command is deprecated due to using deprecated JSON Wire Protocol command. More info: https://webdriver.io/docs/api/jsonwp/#setgeolocation
-    * Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration`)
-      return
-    }
-    this.geoLocation = { latitude, longitude }
 
-    await this.browser.call(async () => {
-      const pages = await this.puppeteerBrowser.pages()
-      await pages[0].setGeolocation({ latitude, longitude })
-    })
-  }
-
-  /**
-   * This method is **deprecated**.
-   *
-   * {{> grabGeoLocation }}
-   *
-   */
-  async grabGeoLocation() {
-    if (!this.options.automationProtocol) {
-      console.log(`grabGeoLocation deprecated:
-    * This command is deprecated due to using deprecated JSON Wire Protocol command. More info: https://webdriver.io/docs/api/jsonwp/#getgeolocation
-    * Switch to devtools protocol to use this command by setting devtoolsProtocol: true in the configuration`)
-      return
-    }
-    if (!this.geoLocation) return 'No GeoLocation is set!'
-    return this.geoLocation
+    return this.executeScript(getScrollPosition)
   }
 
   /**
@@ -2793,7 +2725,7 @@ class WebDriver extends Helper {
    * @param {*} caps
    * @param {*} fn
    */
-  /* eslint-disable */
+
   runOnIOS(caps, fn) {}
 
   /**
@@ -2802,135 +2734,13 @@ class WebDriver extends Helper {
    * @param {*} fn
    */
   runOnAndroid(caps, fn) {}
-  /* eslint-enable */
 
   /**
    * Placeholder for ~ locator only test case write once run on both Appium and WebDriver.
    */
-  runInWeb(fn) {
+  async 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
-
-    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
-    }
-    return grabRecordedNetworkTraffics.call(this)
-  }
-
-  /**
-   *
-   * _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
-    }
-    await seeTraffic.call(this, ...arguments)
-  }
-
-  /**
-   *
-   * _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
-    }
-    dontSeeTraffic.call(this, ...arguments)
-  }
 }
 
 async function proceedSee(assertType, text, context, strict = false) {
@@ -3213,7 +3023,6 @@ function getElementId(el) {
 // List of known key values to unicode code points
 // https://www.w3.org/TR/webdriver/#keyboard-actions
 const keyUnicodeMap = {
-  /* eslint-disable quote-props */
   Unidentified: '\uE000',
   Cancel: '\uE001',
   Clear: '\uE005',
@@ -3328,7 +3137,6 @@ const keyUnicodeMap = {
   Semicolon: '\uE018', // ';' alias
   Slash: '/', // '/' alias
   ZenkakuHankaku: '\uE040',
-  /* eslint-enable quote-props */
 }
 
 function convertKeyToRawKey(key) {

package/lib/helper/extras/PlaywrightPropEngine.js

@@ -2,7 +2,7 @@ module.exports.createValueEngine = () => {
   return {
     // Creates a selector that matches given target when queried at the root.
     // Can return undefined if unable to create one.
-    // eslint-disable-next-line no-unused-vars
+
     create(root, target) {
       return null;
     },
@@ -29,7 +29,7 @@ module.exports.createDisabledEngine = () => {
   return {
     // Creates a selector that matches given target when queried at the root.
     // Can return undefined if unable to create one.
-    // eslint-disable-next-line no-unused-vars
+
     create(root, target) {
       return null;
     },

package/lib/helper/network/utils.js

@@ -34,7 +34,7 @@ const extractQueryObjects = (queryString) => {
   queryParameters.forEach((queryParameter) => {
     const keyValue = queryParameter.split('=');
     const queryObject = {};
-    // eslint-disable-next-line prefer-destructuring
+
     queryObject.name = keyValue[0];
     queryObject.value = decodeURIComponent(keyValue[1]);
     queryObjects.push(queryObject);

package/lib/helper/testcafe/testcafe-utils.js

@@ -48,7 +48,7 @@ function getFuncBody(func) {
   const arrowIndex = fnStr.indexOf('=>');
   if (arrowIndex >= 0) {
     fnStr = fnStr.slice(arrowIndex + 2);
-    // eslint-disable-next-line no-new-func
+
     // eslint-disable-next-line no-eval
     return eval(`() => ${fnStr}`);
   }

package/lib/locator.js

@@ -389,7 +389,7 @@ class Locator {
 }
 
 /**
- * @param {CodeceptJS.LocatorOrString} locator
+ * @param {CodeceptJS.LocatorOrString} [locator]
  * @returns {Locator}
  */
 Locator.build = (locator) => {

package/lib/output.js

@@ -1,5 +1,6 @@
 const colors = require('chalk');
 const figures = require('figures');
+const { maskSensitiveData } = require('invisi-data')
 
 const styles = {
   error: colors.bgRed.white.bold,
@@ -57,8 +58,9 @@ module.exports = {
    * @param {string} msg
    */
   debug(msg) {
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 2) {
-      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${msg}`));
+      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${_msg}`));
     }
   },
 
@@ -67,8 +69,9 @@ module.exports = {
    * @param {string} msg
    */
   log(msg) {
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 3) {
-      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${msg}`, this.spaceShift)));
+      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)));
     }
   },
 
@@ -117,10 +120,11 @@ module.exports = {
       stepLine = colors.green(truncate(stepLine, this.spaceShift));
     }
     if (step.comment) {
-      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4))); // eslint-disable-line
+      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4)));
     }
 
-    print(' '.repeat(this.stepShift), truncate(stepLine, this.spaceShift));
+    const _stepLine = isMaskedData() ? maskSensitiveData(stepLine) : stepLine
+    print(' '.repeat(this.stepShift), truncate(_stepLine, this.spaceShift));
   },
 
   /** @namespace */
@@ -167,10 +171,10 @@ module.exports = {
   scenario: {
     /**
      * @param {Mocha.Test} test
-    */
-    /* eslint-disable */
+     */
+
     started(test) {},
-    /* eslint-enable */
+
     /**
      * @param {Mocha.Test} test
      */
@@ -254,3 +258,7 @@ function truncate(msg, gap = 0) {
   }
   return msg;
 }
+
+function isMaskedData() {
+  return global.maskSensitiveData === true || false
+}

package/lib/pause.js

@@ -91,7 +91,7 @@ async function parseInput(cmd) {
     return nextStep();
   }
   for (const k of Object.keys(registeredVariables)) {
-    eval(`var ${k} = registeredVariables['${k}'];`); // eslint-disable-line no-eval
+    eval(`var ${k} = registeredVariables['${k}'];`);  
   }
 
   let executeCommand = Promise.resolve();
@@ -106,9 +106,9 @@ async function parseInput(cmd) {
   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;
@@ -143,7 +143,7 @@ async function parseInput(cmd) {
     executeCommand = executeCommand.then(async () => {
       const cmd = getCmd();
       if (!cmd) return;
-      return eval(cmd); // eslint-disable-line no-eval
+      return eval(cmd);  
     }).catch((err) => {
       debug(err);
       if (isAiCommand) return;
@@ -156,7 +156,7 @@ async function parseInput(cmd) {
     const val = await executeCommand;
 
     if (isCustomCommand) {
-      if (val !== undefined) console.log('Result', '$res=', val); // eslint-disable-line
+      if (val !== undefined) console.log('Result', '$res=', val);  
       $res = val;
     }
 

package/lib/plugin/coverage.js

@@ -143,9 +143,6 @@ module.exports = function (config) {
 
   const helper = helpers[helperName]
 
-  if (helperName === 'WebDriver' && !helper.config.devtoolsProtocol)
-    throw Error('Coverage is currently supporting the WebDriver running with Devtools protocol.')
-
   const v8Helper = v8CoverageHelpers[helperName]
 
   const coverageOptions = {

package/lib/secret.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-classes-per-file */
 const { deepClone } = require('./utils');
 
 const maskedString = '*****';

package/lib/step.js

@@ -1,5 +1,5 @@
 // TODO: place MetaStep in other file, disable rule
-/* eslint-disable max-classes-per-file */
+
 const store = require('./store');
 const Secret = require('./secret');
 const event = require('./event');

package/lib/workers.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-classes-per-file */
 const path = require('path');
 const mkdirp = require('mkdirp');
 const { Worker } = require('worker_threads');