codeceptjs 4.0.0-rc.22 → 4.0.0-rc.24

package/lib/plugin/retryFailedStep.js

@@ -8,7 +8,10 @@ const debug = debugModule('codeceptjs:retryFailedStep')
 const defaultConfig = {
   retries: 3,
   defaultIgnoredSteps: ['amOnPage', 'wait*', 'send*', 'execute*', 'run*', 'have*'],
+  minTimeout: 150,
+  maxTimeout: 10000,
   factor: 1.5,
+  randomize: false,
   ignoredSteps: [],
   deferToScenarioRetries: true,
 }
@@ -44,10 +47,9 @@ const RETRY_PRIORITIES = {
  * #### Configuration:
  *
  * * `retries` - number of retries (by default 3),
- * * `when` - function, when to perform a retry (accepts error as parameter)
  * * `factor` - The exponential factor to use. Default is 1.5.
- * * `minTimeout` - The number of milliseconds before starting the first retry. Default is 1000.
- * * `maxTimeout` - The maximum number of milliseconds between two retries. Default is Infinity.
+ * * `minTimeout` - The number of milliseconds before starting the first retry. Default is 150.
+ * * `maxTimeout` - The maximum number of milliseconds between two retries. Default is 10000.
  * * `randomize` - Randomizes the timeouts by multiplying with a factor from 1 to 2. Default is false.
  * * `defaultIgnoredSteps` - an array of steps to be ignored for retry. Includes:
  *     * `amOnPage`
@@ -77,7 +79,7 @@ const RETRY_PRIORITIES = {
  *
  * #### Disable Per Test
  *
- * This plugin can be disabled per test. In this case you will need to stet `I.retry()` to all flaky steps:
+ * This plugin can be disabled per test. In this case you will need to add `step.retry()` to all flaky steps:
  *
  * Use scenario configuration to disable plugin for a test
  *
@@ -89,9 +91,8 @@ const RETRY_PRIORITIES = {
  *
  */
 export default function (config) {
-  config = Object.assign(defaultConfig, config)
+  config = Object.assign({}, defaultConfig, config)
   config.ignoredSteps = config.ignoredSteps.concat(config.defaultIgnoredSteps)
-  const customWhen = config.when
 
   let enableRetry = false
 
@@ -101,7 +102,6 @@ export default function (config) {
     if (!store.autoRetries) return false
     if (err && err.isTerminal) return false
     if (err && err.message && (err.message.includes('ERR_ABORTED') || err.message.includes('frame was detached') || err.message.includes('Target page, context or browser has been closed'))) return false
-    if (customWhen) return customWhen(err)
     return true
   }
   config.when = when
@@ -111,11 +111,12 @@ export default function (config) {
   }
 
   event.dispatcher.on(event.step.started, step => {
+    if (!step.title) return
     for (const ignored of config.ignoredSteps) {
-      if (step.name === ignored) return
+      if (step.title === ignored) return
       if (ignored instanceof RegExp) {
-        if (step.name.match(ignored)) return
-      } else if (ignored.indexOf('*') && step.name.startsWith(ignored.slice(0, -1))) return
+        if (step.title.match(ignored)) return
+      } else if (ignored.indexOf('*') && step.title.startsWith(ignored.slice(0, -1))) return
     }
     enableRetry = true
   })

package/lib/plugin/screencast.js

@@ -258,7 +258,7 @@ function formatTimestamp(timestampInMs) {
 }
 
 function stepTitle(step) {
-  let title = `${step.actor}.${step.name}(${step.args ? step.args.join(',') : ''})`
+  let title = `${step.actor}.${step.title}(${step.args ? step.args.join(',') : ''})`
   if (title.length > 100) title = `${title.substring(0, 100)}...`
   return title
 }

package/lib/plugin/screenshot.js

@@ -86,14 +86,9 @@ export default function (config = {}) {
   const trigger = resolveTrigger(cliArgs, config, { on: defaultConfig.on }, { name: 'screenshot' })
   if (!trigger) return
 
-  const helpers = Container.helpers()
   const options = Object.assign({}, defaultConfig, helper.options, config)
   options.slides = cliArgs.slides ?? config.slides ?? defaultConfig.slides
 
-  if (helpers.Mochawesome?.config) {
-    options.uniqueScreenshotNames = helpers.Mochawesome.config.uniqueScreenshotNames
-  }
-
   if (Codeceptjs.container.mocha()) {
     options.reportDir = Codeceptjs.container.mocha()?.options?.reporterOptions
       && Codeceptjs.container.mocha()?.options?.reporterOptions?.reportDir
@@ -325,7 +320,7 @@ function wireSlides(options, trigger) {
     if (stepNum === -1) return
     if (savedStep === step) return
     if (scenarioFailed) return
-    if (step.metaStep && step.metaStep.name === 'BeforeSuite') return
+    if (step.metaStep && step.metaStep.title === 'BeforeSuite') return
     if (!currentTest) return
     if (!stepFilter(step)) return
     if (isStepIgnored(step, options.ignoreSteps)) return
@@ -404,7 +399,7 @@ function makeStepFilter(trigger, options) {
 function isStepIgnored(step, patterns) {
   if (!patterns || !patterns.length) return false
   for (const pattern of patterns) {
-    if (step.name && step.name.match(pattern)) return true
+    if (step.title && step.title.match(pattern)) return true
   }
   return false
 }

package/lib/plugin/screenshotOnFail.js

@@ -4,7 +4,9 @@ import screenshot from './screenshot.js'
 let warned = false
 
 /**
- * @deprecated Use the `screenshot` plugin with `on: 'fail'` (the default).
+ * Saves a screenshot when a test fails.
+ *
+ * **Deprecated:** use the `screenshot` plugin with `on: 'fail'`, which is the default behavior.
  */
 export default function (config = {}) {
   if (!warned) {

package/lib/plugin/stepTimeout.js

@@ -32,7 +32,7 @@ const defaultConfig = {
  * #### Configuration:
  *
  * * `timeout` - global step timeout, default 150 seconds
- * * `overrideStepLimits` - whether to use timeouts set in plugin config to override step timeouts set in code with I.limitTime(x).action(...), default false
+ * * `overrideStepLimits` - whether to use timeouts set in plugin config to override step timeouts set in code with `I.action(..., step.timeout(x))`, default false
  * * `noTimeoutSteps` - an array of steps with no timeout. Default:
  *     * `amOnPage`
  *     * `wait*`
@@ -68,6 +68,7 @@ export default function(config) {
   config.customTimeoutSteps = config.customTimeoutSteps.concat(config.noTimeoutSteps).concat(config.customTimeoutSteps)
 
   event.dispatcher.on(event.step.before, step => {
+    if (!step.title) return
     let stepTimeout
     for (let stepRule of config.customTimeoutSteps) {
       let customTimeout = 0
@@ -75,7 +76,7 @@ export default function(config) {
         if (stepRule.length > 1) customTimeout = stepRule[1]
         stepRule = stepRule[0]
       }
-      if (stepRule instanceof RegExp ? step.name.match(stepRule) : step.name === stepRule || (stepRule.indexOf('*') && step.name.startsWith(stepRule.slice(0, -1)))) {
+      if (stepRule instanceof RegExp ? step.title.match(stepRule) : step.title === stepRule || (stepRule.indexOf('*') && step.title.startsWith(stepRule.slice(0, -1)))) {
         stepTimeout = customTimeout
         break
       }

package/lib/recorder.js

@@ -217,7 +217,7 @@ export default {
       }
 
       const retryRules = this.retries.slice().reverse()
-      return promiseRetry(Object.assign(defaultRetryOptions, retryOpts), (retry, number) => {
+      return promiseRetry(Object.assign({}, defaultRetryOptions, retryOpts), (retry, number) => {
         if (number > 1) output.log(`${currentQueue()}Retrying... Attempt #${number}`)
         const [promise, timer] = getTimeoutPromise(timeout, taskName)
         return Promise.race([promise, Promise.resolve(res).then(fn)])

package/lib/step/base.js

@@ -10,12 +10,12 @@ const STACK_LINE = 5
 /**
  * Each command in test executed through `I.` object is wrapped in Step.
  * Step allows logging executed commands and triggers hook before and after step execution.
- * @param {string} name
+ * @param {string} title
  */
 class Step {
-  constructor(name) {
+  constructor(title) {
     /** @member {string} */
-    this.name = name
+    this.title = title
     /** @member {Map<number, number>} */
     this.timeouts = new Map()
 
@@ -43,7 +43,7 @@ class Step {
     /** @member {any} */
     this.helper = null
     /** @member {string} */
-    this.helperMethod = name
+    this.helperMethod = title
 
     this.startTime = 0
     this.endTime = 0
@@ -103,7 +103,7 @@ class Step {
 
   /** @return {string} */
   humanize() {
-    return humanizeString(this.name)
+    return humanizeString(this.title)
   }
 
   /** @return {string} */
@@ -180,7 +180,7 @@ class Step {
 
   /** @return {string} */
   toCode() {
-    return `${this.prefix}${this.actor}.${this.name}(${this.humanizeArgs()})${this.suffix}`
+    return `${this.prefix}${this.actor}.${this.title}(${this.humanizeArgs()})${this.suffix}`
   }
 
   isMetaStep() {
@@ -223,7 +223,7 @@ class Step {
 
     return {
       opts: step.opts || {},
-      title: step.name,
+      title: step.title,
       args: args,
       status: step.status,
       startTime: step.startTime,

package/lib/step/comment.js

@@ -1,8 +1,8 @@
 import FuncStep from './func.js'
 
 class CommentStep extends FuncStep {
-  constructor(name, comment) {
-    super(name)
+  constructor(title, comment) {
+    super(title)
     this.fn = () => {}
   }
 }

package/lib/step/helper.js

@@ -2,12 +2,12 @@ import Step from './base.js'
 import store from '../store.js'
 
 class HelperStep extends Step {
-  constructor(helper, name) {
-    super(name)
+  constructor(helper, title) {
+    super(title)
     /** @member {CodeceptJS.Helper} helper corresponding helper */
     this.helper = helper
-    /** @member {string} helperMethod name of method to be executed */
-    this.helperMethod = name
+    /** @member {string} helperMethod title of method to be executed */
+    this.helperMethod = title
   }
 
   /**

package/lib/step/meta.js

@@ -29,7 +29,7 @@ class MetaStep extends Step {
     const actorText = this.actor
 
     if (this.isBDD()) {
-      return `${this.prefix}${actorText} ${this.name} "${this.humanizeArgs()}${this.suffix}"`
+      return `${this.prefix}${actorText} ${this.title} "${this.humanizeArgs()}${this.suffix}"`
     }
 
     if (actorText === 'I') {
@@ -37,14 +37,14 @@ class MetaStep extends Step {
     }
 
     if (!this.actor) {
-      return `${this.name} ${this.humanizeArgs()}${this.suffix}`.trim()
+      return `${this.title} ${this.humanizeArgs()}${this.suffix}`.trim()
     }
 
     return `On ${this.prefix}${actorText}: ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`.trim()
   }
 
   humanize() {
-    return humanizeString(this.name)
+    return humanizeString(this.title)
   }
 
   setTrace() {}

package/lib/step/record.js

@@ -16,12 +16,12 @@ function recordStep(step, args) {
     const { opts, timeout, retry } = stepConfig.getConfig()
 
     if (opts) {
-      output.debug(`Step ${step.name}: options applied ${JSON.stringify(opts)}`)
+      output.debug(`Step ${step.title}: options applied ${JSON.stringify(opts)}`)
       store.stepOptions = opts
       step.opts = opts
     }
     if (timeout) {
-      output.debug(`Step ${step.name} timeout ${timeout}s`)
+      output.debug(`Step ${step.title} timeout ${timeout}s`)
       step.setTimeout(timeout * 1000, TIMEOUT_ORDER.codeLimitTime)
     }
     if (retry) retryStep(retry)
@@ -31,7 +31,7 @@ function recordStep(step, args) {
   // run async before step hooks
   event.emit(event.step.before, step)
 
-  const task = `${step.name}: ${step.humanizeArgs()}`
+  const task = `${step.title}: ${step.humanizeArgs()}`
   let val
 
   // run step inside promise

package/lib/workers.js

@@ -118,11 +118,9 @@ const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns
   const workersToExecute = []
 
   const currentOutputFolder = config.output
-  let currentMochawesomeReportDir
   let currentMochaJunitReporterFile
 
   if (config.mocha && config.mocha.reporterOptions) {
-    currentMochawesomeReportDir = config.mocha.reporterOptions?.mochawesome.options.reportDir
     currentMochaJunitReporterFile = config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile
   }
 
@@ -132,8 +130,6 @@ const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns
     let workerName = worker.name.replace(':', '_')
     _config.output = `${currentOutputFolder}${separator}${workerName}`
     if (config.mocha && config.mocha.reporterOptions) {
-      _config.mocha.reporterOptions.mochawesome.options.reportDir = `${currentMochawesomeReportDir}${separator}${workerName}`
-
       const _tempArray = currentMochaJunitReporterFile.split(separator)
       _tempArray.splice(
         _tempArray.findIndex(item => item.includes('.xml')),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.0-rc.22",
+  "version": "4.0.0-rc.24",
   "type": "module",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
@@ -27,7 +27,8 @@
     "translations",
     "typings/**/*.d.ts",
     "docs/*.md",
-    "docs/helpers/**"
+    "docs/helpers/**",
+    "docs/plugins/**"
   ],
   "main": "lib/index.js",
   "module": "lib/index.js",
@@ -130,7 +131,6 @@
     "parse-function": "5.6.10",
     "parse5": "7.3.0",
     "promise-retry": "1.1.1",
-    "resq": "1.11.0",
     "sprintf-js": "1.1.3",
     "uuid": "11.1.0",
     "xpath": "0.0.34",
@@ -175,7 +175,6 @@
     "jsdoc": "^3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
-    "mochawesome": "^7.1.3",
     "playwright": "^1.59.0",
     "prettier": "^3.3.2",
     "puppeteer": "24.36.0",

package/docs/helpers/Mochawesome.md

@@ -1,8 +0,0 @@
----
-permalink: /helpers/Mochawesome
-editLink: false
-sidebar: auto
-title: Mochawesome
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

package/docs/helpers/MockServer.md

@@ -1,212 +0,0 @@
----
-permalink: /helpers/MockServer
-editLink: false
-sidebar: auto
-title: MockServer
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## MockServer
-
-MockServer
-
-The MockServer Helper in CodeceptJS empowers you to mock any server or service via HTTP or HTTPS, making it an excellent tool for simulating REST endpoints and other HTTP-based APIs.
-
-
-
-## Configuration
-
-This helper should be configured in codecept.conf.(js|ts)
-
-Type: [object][1]
-
-### Properties
-
--   `port` **[number][2]?** Mock server port
--   `host` **[string][3]?** Mock server host
--   `httpsOpts` **[object][1]?** key & cert values are the paths to .key and .crt files
-
-
-
-#### Examples
-
-You can seamlessly integrate MockServer with other helpers like REST or Playwright. Here's a configuration example inside the `codecept.conf.js` file:
-
-```javascript
-{
-  helpers: {
-    REST: {...},
-    MockServer: {
-      // default mock server config
-      port: 9393,
-      host: '0.0.0.0',
-      httpsOpts: {
-        key: '',
-        cert: '',
-      },
-    },
-  }
-}
-```
-
-#### Adding Interactions
-
-Interactions add behavior to the mock server. Use the `I.addInteractionToMockServer()` method to include interactions. It takes an interaction object as an argument, containing request and response details.
-
-```javascript
-I.addInteractionToMockServer({
-   request: {
-     method: 'GET',
-     path: '/api/hello'
-   },
-   response: {
-     status: 200,
-     body: {
-       'say': 'hello to mock server'
-     }
-   }
-});
-```
-
-#### Request Matching
-
-When a real request is sent to the mock server, it matches the received request with the interactions. If a match is found, it returns the specified response; otherwise, a 404 status code is returned.
-
--   Strong match on HTTP Method, Path, Query Params & JSON body.
--   Loose match on Headers.
-
-##### Strong Match on Query Params
-
-You can send different responses based on query parameters:
-
-```javascript
-I.addInteractionToMockServer({
-  request: {
-    method: 'GET',
-    path: '/api/users',
-    queryParams: {
-      id: 1
-    }
-  },
-  response: {
-    status: 200,
-    body: 'user 1'
-  }
-});
-
-I.addInteractionToMockServer({
-  request: {
-    method: 'GET',
-    path: '/api/users',
-    queryParams: {
-      id: 2
-    }
-  },
-  response: {
-    status: 200,
-    body: 'user 2'
-  }
-});
-```
-
--   GET to `/api/users?id=1` will return 'user 1'.
--   GET to `/api/users?id=2` will return 'user 2'.
--   For all other requests, it returns a 404 status code.
-
-##### Loose Match on Body
-
-When `strict` is set to false, it performs a loose match on query params and response body:
-
-```javascript
-I.addInteractionToMockServer({
-  strict: false,
-  request: {
-    method: 'POST',
-    path: '/api/users',
-    body: {
-      name: 'john'
-    }
-  },
-  response: {
-    status: 200
-  }
-});
-```
-
--   POST to `/api/users` with the body containing `name` as 'john' will return a 200 status code.
--   POST to `/api/users` without the `name` property in the body will return a 404 status code.
-
-Happy testing with MockServer in CodeceptJS! 🚀
-
-## Methods
-
-### Parameters
-
--   `passedConfig`  
-
-### addInteractionToMockServer
-
-An interaction adds behavior to the mock server
-
-```js
-I.addInteractionToMockServer({
-   request: {
-     method: 'GET',
-     path: '/api/hello'
-   },
-   response: {
-     status: 200,
-     body: {
-       'say': 'hello to mock server'
-     }
-   }
-});
-```
-
-```js
-// with query params
-I.addInteractionToMockServer({
-   request: {
-     method: 'GET',
-     path: '/api/hello',
-     queryParams: {
-      id: 2
-    }
-   },
-   response: {
-     status: 200,
-     body: {
-       'say': 'hello to mock server'
-     }
-   }
-});
-```
-
-#### Parameters
-
--   `interaction` **(CodeceptJS.MockInteraction | [object][1])** add behavior to the mock server
-
-Returns **any** void
-
-### startMockServer
-
-Start the mock server
-
-#### Parameters
-
--   `port` **[number][2]?** start the mock server with given port
-
-Returns **any** void
-
-### stopMockServer
-
-Stop the mock server
-
-Returns **any** void
-
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

package/docs/helpers/Polly.md

@@ -1,44 +0,0 @@
----
-id: Polly
-title: Polly
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## Polly
-
-**Extends MockRequest**
-
-This helper works the same as MockRequest helper. It has been included for backwards compatibility
-reasons. So use MockRequest helper instead of this.
-
-Please refer to MockRequest helper documentation for details.
-
-### Installations
-
-Requires [Polly.js][1] library by Netflix installed
-
-    npm i @pollyjs/core @pollyjs/adapter-puppeteer --save-dev
-
-Requires Puppeteer helper or WebDriver helper enabled
-
-### Configuration
-
-Just enable helper in config file:
-
-```js
-helpers: {
-   Puppeteer: {
-     // regular Puppeteer config here
-   },
-   Polly: {}
-}
-```
-
-The same can be done when using WebDriver helper..
-
-### Usage
-
-Use `I.mockRequest` to intercept and mock requests.
-
-[1]: https://netflix.github.io/pollyjs/#/