codeceptjs 3.7.0-rc.1 → 3.7.1-beta.1

package/bin/codecept.js

@@ -62,7 +62,7 @@ program
   .command('check')
   .option(commandFlags.config.flag, commandFlags.config.description)
   .description('Checks configuration and environment before running tests')
-  .option('-t, --timeout [ms]', 'timeout for checks in ms, 20000 by default')
+  .option('-t, --timeout [ms]', 'timeout for checks in ms, 50000 by default')
   .action(errorHandler(require('../lib/command/check')))
 
 program

package/lib/command/check.js

@@ -25,6 +25,7 @@ module.exports = async function (options) {
     ai: true, // we don't need to check AI
     helpers: false,
     setup: false,
+    teardown: false,
     tests: false,
     def: false,
   }
@@ -87,9 +88,9 @@ module.exports = async function (options) {
 
   if (config?.ai?.request) {
     checks.ai = true
-    printCheck('ai', checks['ai'], 'AI configuration is enabled, request function is set')
+    printCheck('ai', checks['ai'], 'Configuration is enabled, request function is set')
   } else {
-    printCheck('ai', checks['ai'], 'AI is disabled')
+    printCheck('ai', checks['ai'], 'Disabled')
   }
 
   printCheck('tests', checks['tests'], `Total: ${numTests} tests`)
@@ -131,22 +132,36 @@ module.exports = async function (options) {
   if (Object.keys(helpers).length) {
     const suite = container.mocha().suite
     const test = createTest('test', () => {})
-    try {
-      for (const helper of Object.values(helpers)) {
+    checks.setup = true
+    for (const helper of Object.values(helpers)) {
+      try {
         if (helper._beforeSuite) await helper._beforeSuite(suite)
         if (helper._before) await helper._before(test)
+      } catch (err) {
+        err.message = `${helper.constructor.name} helper: ${err.message}`
+        if (checks.setup instanceof Error) err.message = `${err.message}\n\n${checks.setup?.message || ''}`.trim()
+        checks.setup = err
+      }
+    }
+
+    printCheck('Helpers Before', checks['setup'], standardActingHelpers.some(h => Object.keys(helpers).includes(h)) ? 'Initializing browser' : '')
+
+    checks.teardown = true
+    for (const helper of Object.values(helpers).reverse()) {
+      try {
         if (helper._passed) await helper._passed(test)
         if (helper._after) await helper._after(test)
         if (helper._finishTest) await helper._finishTest(suite)
         if (helper._afterSuite) await helper._afterSuite(suite)
+      } catch (err) {
+        err.message = `${helper.constructor.name} helper: ${err.message}`
+        if (checks.teardown instanceof Error) err.message = `${err.message}\n\n${checks.teardown?.message || ''}`.trim()
+        checks.teardown = err
       }
-      checks.setup = true
-    } catch (err) {
-      checks.setup = err
     }
-  }
 
-  printCheck('Helpers Before/After', checks['setup'], standardActingHelpers.some(h => Object.keys(helpers).includes(h)) ? 'Initializing and closing browser' : '')
+    printCheck('Helpers After', checks['teardown'], standardActingHelpers.some(h => Object.keys(helpers).includes(h)) ? 'Closing browser' : '')
+  }
 
   try {
     definitions(configFile, { dryRun: true })

package/lib/effects.js

@@ -2,6 +2,7 @@ const recorder = require('./recorder')
 const { debug } = require('./output')
 const store = require('./store')
 const event = require('./event')
+const within = require('./within')
 
 /**
  * A utility function for CodeceptJS tests that acts as a soft assertion.
@@ -178,11 +179,14 @@ async function tryTo(callback) {
   const sessionName = 'tryTo'
 
   let result = false
+  let isAutoRetriesEnabled = store.autoRetries
   return recorder.add(
     sessionName,
     () => {
       recorder.session.start(sessionName)
-      store.tryTo = true
+      isAutoRetriesEnabled = store.autoRetries
+      if (isAutoRetriesEnabled) debug('Auto retries disabled inside tryTo effect')
+      store.autoRetries = false
       callback()
       recorder.add(() => {
         result = true
@@ -199,7 +203,7 @@ async function tryTo(callback) {
       return recorder.add(
         'result',
         () => {
-          store.tryTo = undefined
+          store.autoRetries = isAutoRetriesEnabled
           return result
         },
         true,
@@ -215,4 +219,5 @@ module.exports = {
   hopeThat,
   retryTo,
   tryTo,
+  within,
 }

package/lib/event.js

@@ -54,6 +54,8 @@ module.exports = {
    * @inner
    * @property {'hook.start'} started
    * @property {'hook.passed'} passed
+   * @property {'hook.failed'} failed
+   * @property {'hook.finished'} finished
    */
   hook: {
     started: 'hook.start',

package/lib/helper/Playwright.js

@@ -484,7 +484,7 @@ class Playwright extends Helper {
     this.currentRunningTest = test
 
     recorder.retry({
-      retries: process.env.FAILED_STEP_RETRIES || 3,
+      retries: test?.opts?.conditionalRetries || 3,
       when: err => {
         if (!err || typeof err.message !== 'string') {
           return false

package/lib/helper/Puppeteer.js

@@ -312,7 +312,7 @@ class Puppeteer extends Helper {
     this.sessionPages = {}
     this.currentRunningTest = test
     recorder.retry({
-      retries: process.env.FAILED_STEP_RETRIES || 3,
+      retries: test?.opts?.conditionalRetries || 3,
       when: err => {
         if (!err || typeof err.message !== 'string') {
           return false

package/lib/helper/extras/Popup.js

@@ -2,66 +2,66 @@
  * Class to handle the interaction with the Dialog (Popup) Class from Puppeteer
  */
 class Popup {
-  constructor(popup, defaultAction) {
-    this._popup = popup || null;
-    this._actionType = '';
-    this._defaultAction = defaultAction || '';
+  constructor(popup = null, defaultAction = '') {
+    this._popup = popup
+    this._actionType = ''
+    this._defaultAction = defaultAction
   }
 
   _assertValidActionType(action) {
     if (['accept', 'cancel'].indexOf(action) === -1) {
-      throw new Error('Invalid Popup action type. Only "accept" or "cancel" actions are accepted');
+      throw new Error('Invalid Popup action type. Only "accept" or "cancel" actions are accepted')
     }
   }
 
   set defaultAction(action) {
-    this._assertValidActionType(action);
-    this._defaultAction = action;
+    this._assertValidActionType(action)
+    this._defaultAction = action
   }
 
   get defaultAction() {
-    return this._defaultAction;
+    return this._defaultAction
   }
 
   get popup() {
-    return this._popup;
+    return this._popup
   }
 
   set popup(popup) {
     if (this._popup) {
-      console.error('Popup already exists and was not closed. Popups must always be closed by calling either I.acceptPopup() or I.cancelPopup()');
+      return
     }
-    this._popup = popup;
+    this._popup = popup
   }
 
   get actionType() {
-    return this._actionType;
+    return this._actionType
   }
 
   set actionType(action) {
-    this._assertValidActionType(action);
-    this._actionType = action;
+    this._assertValidActionType(action)
+    this._actionType = action
   }
 
   clear() {
-    this._popup = null;
-    this._actionType = '';
+    this._popup = null
+    this._actionType = ''
   }
 
   assertPopupVisible() {
     if (!this._popup) {
-      throw new Error('There is no Popup visible');
+      throw new Error('There is no Popup visible')
     }
   }
 
   assertPopupActionType(type) {
-    this.assertPopupVisible();
-    const expectedAction = this._actionType || this._defaultAction;
+    this.assertPopupVisible()
+    const expectedAction = this._actionType || this._defaultAction
     if (expectedAction !== type) {
-      throw new Error(`Popup action does not fit the expected action type. Expected popup action to be '${expectedAction}' not '${type}`);
+      throw new Error(`Popup action does not fit the expected action type. Expected popup action to be '${expectedAction}' not '${type}`)
     }
-    this.clear();
+    this.clear()
   }
 }
 
-module.exports = Popup;
+module.exports = Popup

package/lib/mocha/test.js

@@ -133,8 +133,10 @@ function cloneTest(test) {
   return deserializeTest(serializeTest(test))
 }
 
-function testToFileName(test) {
-  let fileName = clearString(test.title)
+function testToFileName(test, suffix = '') {
+  let fileName = test.title
+
+  if (suffix) fileName = `${fileName}_${suffix}`
   // remove tags with empty string (disable for now)
   // fileName = fileName.replace(/\@\w+/g, '')
   fileName = fileName.slice(0, 100)
@@ -146,6 +148,7 @@ function testToFileName(test) {
   // if (test.parent && test.parent.title) {
   //   fileName = `${clearString(test.parent.title)}_${fileName}`
   // }
+  fileName = clearString(fileName).slice(0, 100)
   return fileName
 }
 

package/lib/plugin/analyze.js

@@ -60,7 +60,7 @@ const defaultConfig = {
 
         If there is no groups of tests, say: "No patterns found"
         Preserve error messages but cut them if they are too long.
-        Respond clearly and directly, without introductory words or phrases like ‘Of course,’ ‘Here is the answer,’ etc.
+        Respond clearly and directly, without introductory words or phrases like 'Of course,' 'Here is the answer,' etc.
         Do not list more than 3 errors in the group.
         If you identify that all tests in the group have the same tag, add this tag to the group report, otherwise ignore TAG section.
         If you identify that all tests in the group have the same suite, add this suite to the group report, otherwise ignore SUITE section.
@@ -161,8 +161,56 @@ const defaultConfig = {
 
 /**
  *
- * @param {*} config
- * @returns
+ * Uses AI to analyze test failures and provide insights
+ *
+ * This plugin analyzes failed tests using AI to provide detailed explanations and group similar failures.
+ * When enabled with --ai flag, it generates reports after test execution.
+ *
+ * #### Usage
+ *
+ * ```js
+ * // in codecept.conf.js
+ * exports.config = {
+ *   plugins: {
+ *     analyze: {
+ *       enabled: true,
+ *       clusterize: 5,
+ *       analyze: 2,
+ *       vision: false
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * #### Configuration
+ *
+ * * `clusterize` (number) - minimum number of failures to trigger clustering analysis. Default: 5
+ * * `analyze` (number) - maximum number of individual test failures to analyze in detail. Default: 2
+ * * `vision` (boolean) - enables visual analysis of test screenshots. Default: false
+ * * `categories` (array) - list of failure categories for classification. Defaults to:
+ *   - Browser connection error / browser crash
+ *   - Network errors (server error, timeout, etc)
+ *   - HTML / page elements (not found, not visible, etc)
+ *   - Navigation errors (404, etc)
+ *   - Code errors (syntax error, JS errors, etc)
+ *   - Library & framework errors
+ *   - Data errors (password incorrect, invalid format, etc)
+ *   - Assertion failures
+ *   - Other errors
+ * * `prompts` (object) - customize AI prompts for analysis
+ *   - `clusterize` - prompt for clustering analysis
+ *   - `analyze` - prompt for individual test analysis
+ *
+ * #### Features
+ *
+ * * Groups similar failures when number of failures >= clusterize value
+ * * Provides detailed analysis of individual failures
+ * * Analyzes screenshots if vision=true and screenshots are available
+ * * Classifies failures into predefined categories
+ * * Suggests possible causes and solutions
+ *
+ * @param {Object} config - Plugin configuration
+ * @returns {void}
  */
 module.exports = function (config = {}) {
   config = Object.assign(defaultConfig, config)

package/lib/plugin/retryFailedStep.js

@@ -1,8 +1,6 @@
 const event = require('../event')
 const recorder = require('../recorder')
-const container = require('../container')
-const { log } = require('../output')
-
+const store = require('../store')
 const defaultConfig = {
   retries: 3,
   defaultIgnoredSteps: ['amOnPage', 'wait*', 'send*', 'execute*', 'run*', 'have*'],
@@ -70,9 +68,9 @@ const defaultConfig = {
  * Use scenario configuration to disable plugin for a test
  *
  * ```js
- * Scenario('scenario tite', () => {
+ * Scenario('scenario tite', { disableRetryFailedStep: true }, () => {
  *    // test goes here
- * }).config(test => test.disableRetryFailedStep = true)
+ * })
  * ```
  *
  */
@@ -85,19 +83,14 @@ module.exports = config => {
 
   const when = err => {
     if (!enableRetry) return
-    const store = require('../store')
     if (store.debugMode) return false
+    if (!store.autoRetries) return false
     if (customWhen) return customWhen(err)
     return true
   }
   config.when = when
 
   event.dispatcher.on(event.step.started, step => {
-    if (process.env.TRY_TO === 'true') {
-      log('Info: RetryFailedStep plugin is disabled inside tryTo block')
-      return
-    }
-
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
       if (step.name === ignored) return
@@ -113,9 +106,15 @@ module.exports = config => {
   })
 
   event.dispatcher.on(event.test.before, test => {
-    if (test && test.disableRetryFailedStep) return // disable retry when a test is not active
-    // this env var is used to set the retries inside _before() block of helpers
-    process.env.FAILED_STEP_RETRIES = config.retries
+    // pass disableRetryFailedStep is a preferred way to disable retries
+    // test.disableRetryFailedStep is used for backward compatibility
+    if (test.opts.disableRetryFailedStep || test.disableRetryFailedStep) {
+      store.autoRetries = false
+      return // disable retry when a test is not active
+    }
+    // this option is used to set the retries inside _before() block of helpers
+    store.autoRetries = true
+    test.opts.conditionalRetries = config.retries
     recorder.retry(config)
   })
 }

package/lib/plugin/retryTo.js

@@ -6,7 +6,7 @@ const defaultConfig = {
 
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config)
-  console.log(`Deprecation Warning: 'retryTo' has been moved to the 'codeceptjs/effects' module`)
+  console.log(`Deprecation Warning: 'retryTo' has been moved to the 'codeceptjs/effects' module. Disable retryTo plugin to remove this warning.`)
 
   if (config.registerGlobal) {
     global.retryTo = retryTo

package/lib/plugin/screenshotOnFail.js

@@ -83,13 +83,12 @@ module.exports = function (config) {
       async () => {
         const dataType = 'image/png'
         // This prevents data driven to be included in the failed screenshot file name
-        let fileName = testToFileName(test)
+        let fileName
 
         if (options.uniqueScreenshotNames && test) {
-          const uuid = _getUUID(test)
-          fileName = `${fileName.substring(0, 10)}_${uuid}.failed.png`
+          fileName = `${testToFileName(test, _getUUID(test))}.failed.png`
         } else {
-          fileName += '.failed.png'
+          fileName = `${testToFileName(test)}.failed.png`
         }
         output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot')
 

package/lib/plugin/tryTo.js

@@ -6,7 +6,7 @@ const defaultConfig = {
 
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config)
-  console.log(`Deprecation Warning: 'tryTo' has been moved to the 'codeceptjs/effects' module`)
+  console.log(`Deprecation Warning: 'tryTo' has been moved to the 'codeceptjs/effects' module. Disable tryTo plugin to remove this warning.`)
 
   if (config.registerGlobal) {
     global.tryTo = tryTo

package/lib/recorder.js

@@ -192,6 +192,7 @@ module.exports = {
         .pop()
       // no retries or unnamed tasks
       debug(`${currentQueue()} Running | ${taskName} | Timeout: ${timeout || 'None'}`)
+      if (retryOpts) debug(`${currentQueue()} Retry opts`, JSON.stringify(retryOpts))
 
       if (!retryOpts || !taskName || !retry) {
         const [promise, timer] = getTimeoutPromise(timeout, taskName)

package/lib/store.js

@@ -3,17 +3,41 @@
  * @namespace
  */
 const store = {
-  /** @type {boolean} */
+  /**
+   * If we are in --debug mode
+   * @type {boolean}
+   */
   debugMode: false,
-  /** @type {boolean} */
+
+  /**
+   * Is timeouts enabled
+   * @type {boolean}
+   */
   timeouts: true,
-  /** @type {boolean} */
+
+  /**
+   * If auto-retries are enabled by retryFailedStep plugin
+   * tryTo effect disables them
+   * @type {boolean}
+   */
+  autoRetries: false,
+
+  /**
+   * Tests are executed via dry-run
+   * @type {boolean}
+   */
   dryRun: false,
-  /** @type {boolean} */
+  /**
+   * If we are in pause mode
+   * @type {boolean}
+   */
   onPause: false,
+
+  // current object states
+
   /** @type {CodeceptJS.Test | null} */
   currentTest: null,
-  /** @type {any} */
+  /** @type {CodeceptJS.Step | null} */
   currentStep: null,
   /** @type {CodeceptJS.Suite | null} */
   currentSuite: null,

package/lib/utils.js

@@ -13,7 +13,7 @@ function deepMerge(target, source) {
 }
 
 module.exports.genTestId = test => {
-  return require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64').slice(0, -2)
+  return this.clearString(require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64').slice(0, -2))
 }
 
 module.exports.deepMerge = deepMerge
@@ -94,19 +94,19 @@ module.exports.template = function (template, data) {
 /**
  * Make first char uppercase.
  * @param {string} str
- * @returns {string}
+ * @returns {string | undefined}
  */
 module.exports.ucfirst = function (str) {
-  return str.charAt(0).toUpperCase() + str.substr(1)
+  if (str) return str.charAt(0).toUpperCase() + str.substr(1)
 }
 
 /**
  * Make first char lowercase.
  * @param {string} str
- * @returns {string}
+ * @returns {string | undefined}
  */
 module.exports.lcfirst = function (str) {
-  return str.charAt(0).toLowerCase() + str.substr(1)
+  if (str) return str.charAt(0).toLowerCase() + str.substr(1)
 }
 
 module.exports.chunkArray = function (arr, chunk) {

package/lib/within.js

@@ -7,6 +7,8 @@ const MetaStep = require('./step/meta')
 const { isAsyncFunction } = require('./utils')
 
 /**
+ * TODO: move to effects
+ *
  * @param {CodeceptJS.LocatorOrString}  context
  * @param {Function}  fn
  * @return {Promise<*> | undefined}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-rc.1",
+  "version": "3.7.1-beta.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -98,7 +98,7 @@
     "glob": ">=9.0.0 <12",
     "fuse.js": "^7.0.0",
     "html-minifier-terser": "7.2.0",
-    "inquirer": "6.5.2",
+    "inquirer": "8.2.6",
     "invisi-data": "^1.0.0",
     "joi": "17.13.3",
     "js-beautify": "1.15.1",