codeceptjs 3.0.4 → 3.0.5

package/docs/typescript.md

@@ -19,10 +19,10 @@ Example:
 
 ![Quick Info](/img/Quick_info.gif)
 
-- Checks types - thanks to TypeScript support in CodeceptJS now allow to tests your tests. TypeScript can prevent some errors: 
+- Checks types - thanks to TypeScript support in CodeceptJS now allow to tests your tests. TypeScript can prevent some errors:
   - invalid type of variables passed to function;
   - calls no-exist method from PageObject or `I` object;
-  - incorrectly used CodeceptJS features; 
+  - incorrectly used CodeceptJS features;
 
 
 ## Getting Started
@@ -106,7 +106,7 @@ declare namespace CodeceptJS {
 
 ## Types for custom helper or page object
 
-If you want to get types for your [custom helper](https://codecept.io/helpers/#configuration), you can add their automatically with CodeceptJS command `npx codeceptjs def`. 
+If you want to get types for your [custom helper](https://codecept.io/helpers/#configuration), you can add their automatically with CodeceptJS command `npx codeceptjs def`.
 
 For example, if you add the new step `printMessage` for your custom helper like this:
 ```js
@@ -121,9 +121,9 @@ export = CustomHelper
 ```
 
 Then you need to add this helper to your `codecept.conf.js` like in this [docs](https://codecept.io/helpers/#configuration).
-And then run the command `npx codeceptjs def`. 
+And then run the command `npx codeceptjs def`.
 
-As result our `steps.d.ts` file will be updated like this: 
+As result our `steps.d.ts` file will be updated like this:
 ```ts
 /// <reference types='codeceptjs' />
 type CustomHelper = import('./CustomHelper');
@@ -156,3 +156,45 @@ declare namespace CodeceptJS {
   }
 }
 ```
+
+## Types for custom strict locators
+
+You can define [custom strict locators](https://codecept.io/locators/#custom-strict-locators) that can be used in all methods taking a locator (parameter type `LocatorOrString`).
+
+Example: A custom strict locator with a `data` property, which can be used like this:
+
+```ts
+I.click({ data: 'user-login' });
+```
+
+In order to use the custom locator in TypeScript code, its type shape needs to be registered in the interface `CustomLocators` in your `steps.d.ts` file:
+
+```ts
+/// <reference types='codeceptjs' />
+...
+
+declare namespace CodeceptJS {
+  ...
+
+  interface CustomLocators {
+    data: { data: string };
+  }
+}
+```
+
+The property keys used in the `CustomLocators` interface do not matter (only the *types* of the interface properties are used). For simplicity it is recommended to use the name that is also used in your custom locator itself.
+
+You can also define more complicated custom locators with multiple (also optional) properties:
+
+```ts
+/// <reference types='codeceptjs' />
+...
+
+declare namespace CodeceptJS {
+  ...
+
+  interface CustomLocators {
+    data: { data: string, value?: number, flag?: boolean };
+  }
+}
+```

package/docs/webapi/fillField.mustache

@@ -12,4 +12,4 @@ I.fillField('form#login input[name=username]', 'John');
 I.fillField({css: 'form#login input[name=username]'}, 'John');
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {string} value text value to fill.
+@param {CodeceptJS.StringOrSecret} value text value to fill.

package/lib/cli.js

@@ -3,6 +3,7 @@ const ms = require('ms');
 const event = require('./event');
 const AssertionFailedError = require('./assert/error');
 const output = require('./output');
+const { MetaStep } = require('./step');
 
 const cursor = Base.cursor;
 let currentMetaStep = [];
@@ -77,17 +78,22 @@ class Cli extends Base {
       });
 
       event.dispatcher.on(event.step.started, (step) => {
-        output.stepShift = 3;
-        const printMetaStep = (metaStep) => {
-          if (!metaStep) return currentMetaStep.shift();
-          if (currentMetaStep.indexOf(metaStep.toString()) >= 0) return; // step is the same
-          if (metaStep.metaStep) {
-            printMetaStep(metaStep.metaStep);
+        let processingStep = step;
+        const metaSteps = [];
+        while (processingStep.metaStep) {
+          metaSteps.unshift(processingStep.metaStep);
+          processingStep = processingStep.metaStep;
+        }
+        const shift = metaSteps.length;
+
+        for (let i = 0; i < Math.max(currentMetaStep.length, metaSteps.length); i++) {
+          if (currentMetaStep[i] !== metaSteps[i]) {
+            output.stepShift = 3 + 2 * i;
+            if (metaSteps[i]) output.step(metaSteps[i]);
           }
-          currentMetaStep.unshift(metaStep.toString());
-          output.step(metaStep);
-        };
-        printMetaStep(step.metaStep);
+        }
+        currentMetaStep = metaSteps;
+        output.stepShift = 3 + 2 * shift;
         output.step(step);
       });
 

package/lib/command/interactive.js

@@ -4,7 +4,7 @@ const Codecept = require('../codecept');
 const event = require('../event');
 const output = require('../output');
 
-module.exports = function (path, options) {
+module.exports = async function (path, options) {
   // Backward compatibility for --profile
   process.profile = options.profile;
   process.env.profile = options.profile;
@@ -14,11 +14,8 @@ module.exports = function (path, options) {
   const codecept = new Codecept(config, options);
   codecept.init(testsPath);
 
-  codecept.runBootstrap((err) => {
-    if (err) {
-      output.error(`Error while running bootstrap file :${err}`);
-      return;
-    }
+  try {
+    await codecept.bootstrap();
 
     if (options.verbose) output.level(3);
 
@@ -36,5 +33,7 @@ module.exports = function (path, options) {
     recorder.add(() => event.emit(event.suite.after, {}));
     recorder.add(() => event.emit(event.all.result, {}));
     recorder.add(() => codecept.teardown());
-  });
+  } catch (err) {
+    output.error(`Error while running bootstrap file :${err}`);
+  }
 };

package/lib/config.js

@@ -77,7 +77,12 @@ class Config {
       return loadConfigFile(jsonConfig);
     }
 
-    throw new Error(`Can not load config from ${jsConfig} or ${jsonConfig}\nCodeceptJS is not initialized in this dir. Execute 'codeceptjs init' to start`);
+    const tsConfig = path.join(configFile, 'codecept.conf.ts');
+    if (isFile(tsConfig)) {
+      return loadConfigFile(tsConfig);
+    }
+
+    throw new Error(`Can not load config from ${jsConfig} or ${jsonConfig} or ${tsConfig}\nCodeceptJS is not initialized in this dir. Execute 'codeceptjs init' to start`);
   }
 
   /**

package/lib/helper/Nightmare.js

@@ -803,7 +803,7 @@ class Nightmare extends Helper {
   }
 
   /**
-   * {{> grabValueFrom }}
+   * {{> grabValueFromAll }}
    */
   async grabValueFromAll(locator) {
     locator = new Locator(locator, 'css');

package/lib/helper/Playwright.js

@@ -800,11 +800,7 @@ class Playwright extends Helper {
   }
 
   /**
-   * Checks that title is equal to provided one.
-   *
-   * ```js
-   * I.seeTitleEquals('Test title.');
-   * ```
+   * {{> seeTitleEquals }}
    */
   async seeTitleEquals(text) {
     const title = await this.page.title();
@@ -1069,14 +1065,7 @@ class Playwright extends Helper {
   }
 
   /**
-   *
-   * Force clicks an element without waiting for it to become visible and not animating.
-   *
-   * ```js
-   * I.forceClick('#hiddenButton');
-   * I.forceClick('Click me', '#hidden');
-   * ```
-   *
+   * {{> forceClick }}
    */
   async forceClick(locator, context = null) {
     return proceedClick.call(this, locator, context, { force: true });
@@ -1500,6 +1489,10 @@ class Playwright extends Helper {
    * I.executeScript(([x, y]) => x + y, [x, y]);
    * ```
    * If a function returns a Promise it will wait for its resolution.
+   *
+   * @param {string|function} fn function to be executed in browser context.
+   * @param {any} [arg] optional argument to pass to the function
+   * @return {Promise<any>}
    */
   async executeScript(fn, arg) {
     let context = this.page;
@@ -1590,8 +1583,7 @@ class Playwright extends Helper {
   async grabCssPropertyFromAll(locator, cssProperty) {
     const els = await this._locate(locator);
     this.debug(`Matched ${els.length} elements`);
-    const res = await Promise.all(els.map(el => el.$eval('xpath=.', el => JSON.parse(JSON.stringify(getComputedStyle(el))), el)));
-    const cssValues = res.map(props => props[toCamelCase(cssProperty)]);
+    const cssValues = await Promise.all(els.map(el => el.$eval('xpath=.', (el, cssProperty) => getComputedStyle(el).getPropertyValue(cssProperty), cssProperty)));
 
     return cssValues;
   }
@@ -2083,7 +2075,7 @@ class Playwright extends Helper {
   /**
    * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
    *
-   * See [Pupeteer's reference](https://github.com/microsoft/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions)
+   * See [Playwright's reference](https://playwright.dev/docs/api/class-page?_highlight=waitfornavi#pagewaitfornavigationoptions)
    *
    * @param {*} opts
    */

package/lib/helper/REST.js

@@ -1,4 +1,5 @@
 const axios = require('axios').default;
+const Secret = require('../secret');
 
 const Helper = require('../helper');
 
@@ -75,12 +76,18 @@ class REST extends Helper {
    * @param {*} request
    */
   async _executeRequest(request) {
+    const _debugRequest = { ...request };
     axios.defaults.timeout = request.timeout || this.options.timeout;
 
     if (this.headers && this.headers.auth) {
       request.auth = this.headers.auth;
     }
 
+    if (request.data instanceof Secret) {
+      _debugRequest.data = '*****';
+      request.data = typeof request.data === 'object' ? { ...request.data.toString() } : request.data.toString();
+    }
+
     if ((typeof request.data) === 'string') {
       if (!request.headers || !request.headers['Content-Type']) {
         request.headers = { ...request.headers, ...{ 'Content-Type': 'application/x-www-form-urlencoded' } };
@@ -91,7 +98,7 @@ class REST extends Helper {
       await this.config.onRequest(request);
     }
 
-    this.debugSection('Request', JSON.stringify(request));
+    this.debugSection('Request', JSON.stringify(_debugRequest));
 
     let response;
     try {
@@ -149,6 +156,10 @@ class REST extends Helper {
    *
    * ```js
    * I.sendPostRequest('/api/users.json', { "email": "user@user.com" });
+   *
+   * // To mask the payload in logs
+   * I.sendPostRequest('/api/users.json', secret({ "email": "user@user.com" }));
+   *
    * ```
    *
    * @param {*} url
@@ -176,6 +187,10 @@ class REST extends Helper {
    *
    * ```js
    * I.sendPatchRequest('/api/users.json', { "email": "user@user.com" });
+   *
+   * // To mask the payload in logs
+   * I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
+   *
    * ```
    *
    * @param {string} url
@@ -203,6 +218,10 @@ class REST extends Helper {
    *
    * ```js
    * I.sendPutRequest('/api/users.json', { "email": "user@user.com" });
+   *
+   * // To mask the payload in logs
+   * I.sendPutRequest('/api/users.json', secret({ "email": "user@user.com" }));
+   *
    * ```
    *
    * @param {string} url

package/lib/helper/WebDriver.js

@@ -718,7 +718,7 @@ class WebDriver extends Helper {
    * @param {object} locator
    */
   async _smartWait(locator) {
-    this.debugSection(`SmartWait (${this.options.smartWait}ms)`, `Locating ${locator} in ${this.options.smartWait}`);
+    this.debugSection(`SmartWait (${this.options.smartWait}ms)`, `Locating ${JSON.stringify(locator)} in ${this.options.smartWait}`);
     await this.defineTimeout({ implicit: this.options.smartWait });
   }
 
@@ -1370,7 +1370,7 @@ class WebDriver extends Helper {
    */
   async grabBrowserLogs() {
     if (this.browser.isW3C) {
-      this.debug('Logs not awailable in W3C specification');
+      this.debug('Logs not available in W3C specification');
       return;
     }
     return this.browser.getLogs('browser');

package/lib/interfaces/gherkin.js

@@ -31,7 +31,13 @@ module.exports = (text) => {
       const metaStep = new Step.MetaStep(null, step.text);
       metaStep.actor = step.keyword.trim();
       const setMetaStep = (step) => {
-        if (step.metaStep) step = step.metaStep; // assign metastep to metastep for nested steps
+        if (step.metaStep) {
+          if (step.metaStep === metaStep) {
+            return;
+          }
+          setMetaStep(step.metaStep);
+          return;
+        }
         step.metaStep = metaStep;
       };
       const fn = matchStep(step.text);
@@ -46,14 +52,14 @@ module.exports = (text) => {
       step.startTime = Date.now();
       step.match = fn.line;
       event.emit(event.bddStep.before, step);
-      event.dispatcher.on(event.step.before, setMetaStep);
+      event.dispatcher.prependListener(event.step.before, setMetaStep);
       try {
         await fn(...fn.params);
         step.status = 'passed';
       } catch (err) {
         step.status = 'failed';
         step.err = err;
-        return err;
+        throw err;
       } finally {
         step.endTime = Date.now();
         event.dispatcher.removeListener(event.step.before, setMetaStep);

package/lib/output.js

@@ -102,14 +102,14 @@ module.exports = {
     if (!step) return;
     // Avoid to print non-gherkin steps, when gherkin is running for --steps mode
     if (outputLevel === 1) {
-      if (!step.isMetaStep() && step.hasBDDAncestor()) {
+      if (step.hasBDDAncestor()) {
         return;
       }
     }
 
     let stepLine = step.toString();
     if (step.metaStep && outputLevel >= 1) {
-      this.stepShift += 2;
+      // this.stepShift += 2;
       stepLine = colors.green(truncate(stepLine, this.spaceShift));
     }
     if (step.comment) {

package/lib/plugin/allure.js

@@ -261,13 +261,9 @@ module.exports = (config) => {
     if (isHookSteps === false) {
       startMetaStep(step.metaStep);
       if (currentStep !== step) {
-        // The reason we need to do this cause
-        // the step actor contains this and hence
-        // the allure reporter could not parse and
-        // generate the report
-        if (step.actor.includes('\u001b[36m')) {
-          step.actor = step.actor.replace('\u001b[36m', '').replace('\u001b[39m', '');
-        }
+        // In multi-session scenarios, actors' names will be highlighted with ANSI
+        // escape sequences which are invalid XML values
+        step.actor = step.actor.replace(ansiRegExp(), '');
         reporter.startStep(step.toString());
         currentStep = step;
       }

package/lib/plugin/screenshotOnFail.js

@@ -99,8 +99,7 @@ module.exports = function (config) {
         await helper.saveScreenshot(fileName, options.fullPageScreenshots);
 
         test.artifacts.screenshot = path.join(global.output_dir, fileName);
-
-        if (Container.mocha().options.reporterOptions['mocha-junit-reporter'] && Container.mocha().options.reporterOptions['mocha-junit-reporter'].attachments) {
+        if (Container.mocha().options.reporterOptions['mocha-junit-reporter'] && Container.mocha().options.reporterOptions['mocha-junit-reporter'].options.attachments) {
           test.attachments = [path.join(global.output_dir, fileName)];
         }
 

package/lib/step.js

@@ -208,9 +208,10 @@ class MetaStep extends Step {
     let result;
 
     const registerStep = (step) => {
+      this.metaStep = null;
       step.metaStep = this;
     };
-    event.dispatcher.on(event.step.before, registerStep);
+    event.dispatcher.prependListener(event.step.before, registerStep);
     try {
       this.startTime = Date.now();
       result = fn.apply(this.context, this.args);

package/lib/within.js

@@ -20,7 +20,7 @@ function within(context, fn) {
     const defineMetaStep = step => step.metaStep = metaStep;
     recorder.session.start('within');
 
-    event.dispatcher.on(event.step.before, defineMetaStep);
+    event.dispatcher.prependListener(event.step.before, defineMetaStep);
 
     Object.keys(helpers).forEach((helper) => {
       if (helpers[helper]._withinBegin) recorder.add(`[${helper}] start within`, () => helpers[helper]._withinBegin(context));

package/lib/workers.js

@@ -318,11 +318,21 @@ class Workers extends EventEmitter {
   _listenWorkerEvents(worker) {
     worker.on('message', (message) => {
       output.process(message.workerIndex);
+
       switch (message.event) {
+        case event.suite.before:
+          this.emit(event.suite.before, repackTest(message.data));
+          break;
         case event.hook.failed:
           this.emit(event.hook.failed, repackTest(message.data));
           this.errors.push(message.data.err);
           break;
+        case event.test.before:
+          this.emit(event.test.before, repackTest(message.data));
+          break;
+        case event.test.started:
+          this.emit(event.test.started, repackTest(message.data));
+          break;
         case event.test.failed:
           this._updateFinishedTests(repackTest(message.data));
           this.emit(event.test.failed, repackTest(message.data));
@@ -335,7 +345,9 @@ class Workers extends EventEmitter {
           this._updateFinishedTests(repackTest(message.data));
           this.emit(event.test.skipped, repackTest(message.data));
           break;
-        case event.test.finished: this.emit(event.test.finished, repackTest(message.data)); break;
+        case event.test.finished:
+          this.emit(event.test.finished, repackTest(message.data));
+          break;
         case event.test.after:
           this.emit(event.test.after, repackTest(message.data));
           break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -55,11 +55,11 @@
   },
   "dependencies": {
     "@codeceptjs/configure": "^0.6.2",
-    "@codeceptjs/helper": "^1.0.1",
+    "@codeceptjs/helper": "^1.0.2",
     "acorn": "^7.4.1",
     "allure-js-commons": "^1.3.2",
     "arrify": "^2.0.1",
-    "axios": "^0.19.1",
+    "axios": "^0.21.1",
     "chalk": "^4.1.0",
     "commander": "^2.20.3",
     "cross-spawn": "^7.0.3",
@@ -90,8 +90,8 @@
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",
     "@codeceptjs/mock-request": "^0.3.0",
-    "@pollyjs/adapter-puppeteer": "^2.6.3",
-    "@pollyjs/core": "^2.6.3",
+    "@pollyjs/adapter-puppeteer": "^5.1.0",
+    "@pollyjs/core": "^5.1.0",
     "@types/inquirer": "^0.0.35",
     "@types/node": "^8.10.66",
     "@wdio/sauce-service": "^5.22.5",

package/typings/index.d.ts

@@ -22,7 +22,9 @@ declare namespace CodeceptJS {
   interface I {}
   interface IHook {}
   interface IScenario {}
-  interface IFeature {}
+  interface IFeature {
+    (title: string): FeatureConfig
+  }
   interface CallbackOrder extends Array<any> {}
   interface SupportObject {
     I: CodeceptJS.I;
@@ -52,7 +54,10 @@ declare namespace CodeceptJS {
     | { android: string, ios: string }
     | { react: string };
 
-  type LocatorOrString = string | ILocator | Locator;
+  interface CustomLocators { }
+  type LocatorOrString = string | ILocator | Locator | CustomLocators[keyof CustomLocators];
+
+  type StringOrSecret = string | CodeceptJS.Secret;
 
   interface HookCallback { (args: SupportObject): void; }
   interface Scenario extends IScenario { only: IScenario, skip: IScenario, todo: IScenario}