codeceptjs 4.0.0-rc.22 → 4.0.0-rc.23

package/lib/actor.js

@@ -94,7 +94,7 @@ export default function (obj = {}, container) {
             actor[action] = actor[actionAlias] = function () {
               const step = new Step(helper, action)
               if (translation.loaded) {
-                step.name = actionAlias
+                step.title = actionAlias
                 step.actor = translation.I
               }
               // add methods to promise chain

package/lib/heal.js

@@ -49,12 +49,12 @@ class Heal {
   }
 
   hasCorrespondingRecipes(step) {
-    return matchRecipes(this.recipes, this.contextName).filter(r => !r.steps || r.steps.includes(step.name)).length > 0
+    return matchRecipes(this.recipes, this.contextName).filter(r => !r.steps || r.steps.includes(step.title)).length > 0
   }
 
   async getCodeSuggestions(context) {
     const suggestions = []
-    const stepName = context.step?.name
+    const stepName = context.step?.title
     const recipes = matchRecipes(this.recipes, this.contextName)
       .filter(r => !r.steps || !stepName || r.steps.includes(stepName))
 

package/lib/plugin/aiTrace.js

@@ -195,7 +195,7 @@ export default function (config = {}) {
     } else {
       if (stepNum === -1) return
       if (isStepIgnored(step)) return
-      if (step.metaStep && step.metaStep.name === 'BeforeSuite') return
+      if (step.metaStep && step.metaStep.title === 'BeforeSuite') return
 
       const stepPrefix = generateStepPrefix(step, stepNum)
       stepNum++
@@ -247,7 +247,7 @@ export default function (config = {}) {
   async function persistStep(step) {
     if (stepNum === -1) return
     if (isStepIgnored(step)) return
-    if (step.metaStep && step.metaStep.name === 'BeforeSuite') return
+    if (step.metaStep && step.metaStep.title === 'BeforeSuite') return
 
     const stepKey = step.toString()
 
@@ -437,8 +437,9 @@ export default function (config = {}) {
 
   function isStepIgnored(step) {
     if (!config.ignoreSteps) return false
+    if (!step.title) return false
     for (const pattern of config.ignoreSteps || []) {
-      if (step.name.match(pattern)) return true
+      if (step.title.match(pattern)) return true
     }
     return false
   }

package/lib/plugin/junitReporter.js

@@ -242,7 +242,7 @@ function stepLogLine(entry) {
 
 function stepText(step) {
   if (step && typeof step.toString === 'function' && step.toString !== Object.prototype.toString) return step.toString()
-  return (step && (step.title || step.name)) || 'step'
+  return (step && step.title) || 'step'
 }
 
 function stepDuration(step) {

package/lib/plugin/retryFailedStep.js

@@ -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

@@ -325,7 +325,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 +404,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/stepTimeout.js

@@ -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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.0-rc.22",
+  "version": "4.0.0-rc.23",
   "type": "module",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [