codeceptjs 3.3.1 → 3.3.4

package/lib/helper/WebDriver.js

@@ -907,7 +907,7 @@ class WebDriver extends Helper {
    * {{ react }}
    */
   async click(locator, context = null) {
-    const clickMethod = this.browser.isMobile ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findClickable.call(this, locator, locateFn);
@@ -1117,7 +1117,7 @@ class WebDriver extends Helper {
    * Appium: not tested
    */
   async checkOption(field, context = null) {
-    const clickMethod = this.browser.isMobile ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findCheckable.call(this, field, locateFn);
@@ -1136,7 +1136,7 @@ class WebDriver extends Helper {
    * Appium: not tested
    */
   async uncheckOption(field, context = null) {
-    const clickMethod = this.browser.isMobile ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findCheckable.call(this, field, locateFn);
@@ -1623,7 +1623,7 @@ class WebDriver extends Helper {
       assertElementExists(res);
       const elem = usingFirstElement(res);
       const elementId = getElementId(elem);
-      if (this.browser.isMobile) return this.browser.touchScroll(offsetX, offsetY, elementId);
+      if (this.browser.isMobile && this.browser.capabilities.platformName !== 'android') return this.browser.touchScroll(offsetX, offsetY, elementId);
       const location = await elem.getLocation();
       assertElementExists(location, 'Failed to receive', 'location');
       /* eslint-disable prefer-arrow-callback */
@@ -1631,7 +1631,7 @@ class WebDriver extends Helper {
       /* eslint-enable */
     }
 
-    if (this.browser.isMobile) return this.browser.touchScroll(locator, offsetX, offsetY);
+    if (this.browser.isMobile && this.browser.capabilities.platformName !== 'android') 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); }, offsetX, offsetY);
@@ -2553,7 +2553,6 @@ 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) {
@@ -2563,7 +2562,6 @@ 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) {
   }

package/lib/output.js

@@ -26,6 +26,10 @@ module.exports = {
   /** @type {number} */
   stepShift: 0,
 
+  standWithUkraine() {
+    return `#${colors.bold.yellow('StandWith')}${colors.bold.cyan('Ukraine')}`;
+  },
+
   /**
    * Set or return current verbosity level
    * @param {number} [level]

package/lib/plugin/customLocator.js

@@ -70,23 +70,70 @@ const defaultConfig = {
  * I.seeElement('=user'); // matches => [data-qa=user]
  * I.click('=sign-up'); // matches => [data-qa=sign-up]
  * ```
+ *
+ * Using `data-qa` OR `data-test` attribute with `=` prefix:
+ *
+ * ```js
+ * // in codecept.conf.js
+ * plugins: {
+ *  customLocator: {
+ *    enabled: true,
+ *    prefix: '=',
+ *    attribute: ['data-qa', 'data-test'],
+ *    strategy: 'xpath'
+ *  }
+ * }
+ * ```
+ *
+ * In a test:
+ *
+ * ```js
+ * I.seeElement('=user'); // matches => //*[@data-qa=user or @data-test=user]
+ * I.click('=sign-up'); // matches => //*[data-qa=sign-up or @data-test=sign-up]
+ * ```
+ *
+ * ```js
+ * // in codecept.conf.js
+ * plugins: {
+ *  customLocator: {
+ *    enabled: true,
+ *    prefix: '=',
+ *    attribute: ['data-qa', 'data-test'],
+ *    strategy: 'css'
+ *  }
+ * }
+ * ```
+ *
+ * In a test:
+ *
+ * ```js
+ * I.seeElement('=user'); // matches => [data-qa=user],[data-test=user]
+ * I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up]
+ * ```
  */
 module.exports = (config) => {
-  config = Object.assign(defaultConfig, config);
+  config = { ...defaultConfig, ...config };
 
   Locator.addFilter((value, locatorObj) => {
     if (typeof value !== 'string') return;
     if (!value.startsWith(config.prefix)) return;
 
+    if (!['String', 'Array'].includes(config.attribute.constructor.name)) return;
+
     const val = value.substr(config.prefix.length);
 
     if (config.strategy.toLowerCase() === 'xpath') {
-      locatorObj.value = `.//*[@${config.attribute}=${xpathLocator.literal(val)}]`;
+      locatorObj.value = `.//*[${
+        [].concat(config.attribute)
+          .map((attr) => `@${attr}=${xpathLocator.literal(val)}`)
+          .join(' or ')}]`;
       locatorObj.type = 'xpath';
     }
 
     if (config.strategy.toLowerCase() === 'css') {
-      locatorObj.value = `[${config.attribute}=${val}]`;
+      locatorObj.value = [].concat(config.attribute)
+        .map((attr) => `[${attr}=${val}]`)
+        .join(',');
       locatorObj.type = 'css';
     }
 

package/lib/plugin/retryFailedStep.js

@@ -60,7 +60,7 @@ const defaultConfig = {
  * plugins: {
  *     retryFailedStep: {
  *         enabled: true,
- *         ignoreSteps: [
+ *         ignoredSteps: [
  *           'scroll*', // ignore all scroll steps
  *           /Cookie/, // ignore all steps with a Cookie in it (by regexp)
  *         ]

package/lib/plugin/retryTo.js

@@ -101,27 +101,20 @@ module.exports = function (config) {
           err = e;
           recorder.session.restore(`retryTo ${tries}`);
           tries++;
-          // recorder.session.restore(`retryTo`);
           if (tries <= maxTries) {
             debug(`Error ${err}... Retrying`);
             err = null;
 
-            recorder.add(`retryTo ${tries}`, () => {
-              tryBlock();
-              // recorder.add(() => new Promise(done => setTimeout(done, pollInterval)));
-            });
+            recorder.add(`retryTo ${tries}`, () => setTimeout(tryBlock, pollInterval));
           } else {
-            // recorder.throw(err);
             done(null);
           }
         });
-        // return recorder.promise();
       };
 
       recorder.add('retryTo', async () => {
         store.debugMode = true;
         tryBlock();
-        // recorder.add(() => recorder.session.restore(`retryTo ${tries-1}`));
       });
     }).then(() => {
       if (err) recorder.throw(err);

package/lib/secret.js

@@ -1,3 +1,6 @@
+/* eslint-disable max-classes-per-file */
+const { deepClone } = require('./utils');
+
 /** @param {string} secret */
 class Secret {
   constructor(secret) {
@@ -9,13 +12,40 @@ class Secret {
     return this._secret;
   }
 
+  getMasked() {
+    return '*****';
+  }
+
   /**
    * @param {*} secret
    * @returns {Secret}
    */
   static secret(secret) {
+    if (typeof secret === 'object') {
+      const fields = Array.from(arguments);
+      fields.shift();
+      return secretObject(secret, fields);
+    }
     return new Secret(secret);
   }
 }
 
+function secretObject(obj, fieldsToHide = []) {
+  const handler = {
+    get(obj, prop) {
+      if (prop === 'toString') {
+        return function () {
+          const maskedObject = deepClone(obj);
+          fieldsToHide.forEach(f => maskedObject[f] = '****');
+          return JSON.stringify(maskedObject);
+        };
+      }
+
+      return obj[prop];
+    },
+  };
+
+  return new Proxy(obj, handler);
+}
+
 module.exports = Secret;

package/lib/step.js

@@ -168,7 +168,7 @@ class Step {
       } else if (typeof arg === 'undefined') {
         return `${arg}`;
       } else if (arg instanceof Secret) {
-        return '*****';
+        return arg.getMasked();
       } else if (arg.toString && arg.toString() !== '[object Object]') {
         return arg.toString();
       } else if (typeof arg === 'object') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.3.1",
+  "version": "3.3.4",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -90,7 +90,7 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@codeceptjs/detox-helper": "^1.0.2",
+    "@codeceptjs/detox-helper": "^1.0.2",    
     "@codeceptjs/mock-request": "^0.3.1",
     "@faker-js/faker": "^5.5.3",
     "@pollyjs/adapter-puppeteer": "^5.1.0",
@@ -101,7 +101,7 @@
     "@wdio/selenium-standalone-service": "^5.16.10",
     "@wdio/utils": "^5.23.0",
     "apollo-server-express": "^2.25.3",
-    "chai-as-promised": "^5.2.0",
+    "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
     "contributor-faces": "^1.0.3",
     "documentation": "^12.3.0",
@@ -122,7 +122,7 @@
     "mocha-parallel-tests": "^2.3.0",
     "nightmare": "^3.0.2",
     "nodemon": "^1.19.4",
-    "playwright": "^1.18.1",
+    "playwright": "^1.23.2",
     "puppeteer": "^10.4.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",