codeceptjs 4.0.0-beta.5 → 4.0.0-beta.6.esm-aria

package/lib/plugin/analyze.js

@@ -1,14 +1,21 @@
-const debug = require('debug')('codeceptjs:analyze')
-const { isMainThread } = require('node:worker_threads')
-const { arrowRight } = require('figures')
-const container = require('../container')
-const store = require('../store')
-const ai = require('../ai')
-const colors = require('chalk')
-const ora = require('ora-classic')
-const event = require('../event')
-const output = require('../output')
-const { ansiRegExp, base64EncodeFile, markdownToAnsi } = require('../utils')
+import debugFactory from 'debug'
+const debug = debugFactory('codeceptjs:analyze')
+import { isMainThread } from 'node:worker_threads'
+import figures from 'figures'
+const { arrowRight } = figures
+import Container from '../container.js'
+// Container already imported correctly above
+import store from '../store.js'
+
+import aiModule from '../ai.js'
+const ai = aiModule.default || aiModule
+import colors from 'chalk'
+import ora from 'ora'
+import event from '../event.js'
+
+import output from '../output.js'
+
+import { ansiRegExp, base64EncodeFile, markdownToAnsi } from '../utils.js'
 
 const MAX_DATA_LENGTH = 5000
 
@@ -212,7 +219,7 @@ const defaultConfig = {
  * @param {Object} config - Plugin configuration
  * @returns {void}
  */
-module.exports = function (config = {}) {
+export default function (config = {}) {
   config = Object.assign(defaultConfig, config)
 
   event.dispatcher.on(event.workers.before, () => {

package/lib/plugin/auth.js

@@ -1,14 +1,13 @@
-const fs = require('fs')
-const path = require('path')
-const { fileExists } = require('../utils')
-const CommentStep = require('../step/comment')
-const Section = require('../step/section')
-const container = require('../container')
-const store = require('../store')
-const event = require('../event')
-const recorder = require('../recorder')
-const { debug } = require('../output')
-const { isAsyncFunction } = require('../utils')
+import fs from 'fs'
+import path from 'path'
+import { fileExists, isAsyncFunction } from '../utils.js'
+import CommentStep from '../step/comment.js'
+import Section from '../step/section.js'
+import container from '../container.js'
+import store from '../store.js'
+import event from '../event.js'
+import recorder from '../recorder.js'
+import output from '../output.js'
 
 const defaultUser = {
   fetch: I => I.grabCookie(),
@@ -253,7 +252,7 @@ const defaultConfig = {
  *
  *
  */
-module.exports = function (config) {
+export default function (config) {
   config = Object.assign(defaultConfig, config)
   Object.keys(config.users).map(
     u =>
@@ -292,12 +291,12 @@ module.exports = function (config) {
 
     if (isPlaywrightSession() && test?.opts?.cookies) {
       if (test.opts.user == name) {
-        debug(`Cookies already loaded for ${name}`)
+        output.debug(`Cookies already loaded for ${name}`)
 
         alreadyLoggedIn(name)
         return
       } else {
-        debug(`Cookies already loaded for ${test.opts.user}, but not for ${name}`)
+        output.debug(`Cookies already loaded for ${test.opts.user}, but not for ${name}`)
         await I.deleteCookie()
       }
     }
@@ -317,11 +316,11 @@ module.exports = function (config) {
       section.end()
       const cookies = await userSession.fetch(I)
       if (!cookies) {
-        debug("Cannot save user session with empty cookies from auto login's fetch method")
+        output.debug("Cannot save user session with empty cookies from auto login's fetch method")
         return
       }
       if (config.saveToFile) {
-        debug(`Saved user session into file for ${name}`)
+        output.debug(`Saved user session into file for ${name}`)
         fs.writeFileSync(path.join(global.output_dir, `${name}_session.json`), JSON.stringify(cookies))
       }
       store[`${name}_session`] = cookies
@@ -339,13 +338,13 @@ module.exports = function (config) {
     }
     section.end()
     recorder.session.catch(err => {
-      debug(`Failed auto login for ${name} due to ${err}`)
-      debug('Logging in again')
+      output.debug(`Failed auto login for ${name} due to ${err}`)
+      output.debug('Logging in again')
       recorder.session.start('auto login')
       return loginAndSave()
         .then(() => {
           recorder.add(() => recorder.session.restore('auto login'))
-          recorder.catch(() => debug('continue'))
+          recorder.catch(() => output.debug('continue'))
         })
         .catch(err => {
           recorder.session.restore('auto login')
@@ -365,7 +364,7 @@ module.exports = function (config) {
     const suite = store.currentSuite
     if (!suite) return
 
-    debug(`enabling auth as ${name} for each test of suite ${suite.title}`)
+    output.debug(`enabling auth as ${name} for each test of suite ${suite.title}`)
 
     // we are setting test opts so they can be picked up by Playwright if it starts browser for this test
     suite.eachTest(test => {
@@ -420,7 +419,7 @@ function loadCookiesFromFile(config) {
     } catch (err) {
       throw new Error(`Could not load session from ${fileName}\n${err}`)
     }
-    debug(`Loaded user session for ${name}`)
+    output.debug(`Loaded user session for ${name}`)
   }
 }
 

package/lib/plugin/autoDelay.js

@@ -1,8 +1,12 @@
-const Container = require('../container')
-const store = require('../store')
-const recorder = require('../recorder')
-const event = require('../event')
-const { log } = require('../output')
+import Container from '../container.js'
+
+import store from '../store.js'
+
+import recorder from '../recorder.js'
+
+import event from '../event.js'
+
+import output from '../output.js'
 const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
 
 const methodsToDelay = ['click', 'fillField', 'checkOption', 'pressKey', 'doubleClick', 'rightClick']
@@ -51,7 +55,7 @@ const defaultConfig = {
  * * `delayAfter`: put a delay after a command. 200ms by default
  *
  */
-module.exports = function (config) {
+export default function (config) {
   const affectedHelpers = [...standardActingHelpers, 'REST']
   const helpers = Container.helpers()
   let helper
@@ -71,7 +75,7 @@ module.exports = function (config) {
 
     recorder.add('auto-delay', async () => {
       if (store.debugMode) return // no need to delay in debug
-      log(`Delaying for ${config.delayBefore}ms`)
+      output.log(`Delaying for ${config.delayBefore}ms`)
       return new Promise(resolve => {
         setTimeout(resolve, config.delayBefore)
       })
@@ -83,7 +87,7 @@ module.exports = function (config) {
 
     recorder.add('auto-delay', async () => {
       if (store.debugMode) return // no need to delay in debug
-      log(`Delaying for ${config.delayAfter}ms`)
+      output.log(`Delaying for ${config.delayAfter}ms`)
       return new Promise(resolve => {
         setTimeout(resolve, config.delayAfter)
       })

package/lib/plugin/coverage.js

@@ -1,10 +1,14 @@
-const debugModule = require('debug')
-const { CoverageReport } = require('monocart-coverage-reports')
-const Container = require('../container')
-const recorder = require('../recorder')
-const event = require('../event')
-const output = require('../output')
-const { deepMerge } = require('../utils')
+import debugModule from 'debug'
+import { CoverageReport } from 'monocart-coverage-reports'
+import Container from '../container.js'
+
+import recorder from '../recorder.js'
+
+import event from '../event.js'
+
+import output from '../output.js'
+
+import { deepMerge } from '../utils.js'
 
 const defaultConfig = {
   name: 'CodeceptJS Coverage Report',
@@ -113,7 +117,7 @@ const v8CoverageHelpers = {
  * * `sourcePath`: option to resolve a custom path.
  *
  */
-module.exports = function (config) {
+export default function (config) {
   config = deepMerge(defaultConfig, config)
 
   if (config.debug) config.logging = 'debug'

package/lib/plugin/customLocator.js

@@ -1,5 +1,5 @@
-const Locator = require('../locator')
-const { xpathLocator } = require('../utils')
+import Locator from '../locator.js'
+import { xpathLocator } from '../utils.js'
 
 const defaultConfig = {
   prefix: '$',
@@ -111,7 +111,7 @@ const defaultConfig = {
  * I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up]
  * ```
  */
-module.exports = config => {
+export default function (config) {
   config = { ...defaultConfig, ...config }
 
   Locator.addFilter((value, locatorObj) => {

package/lib/plugin/customReporter.js

@@ -1,9 +1,10 @@
-const event = require('../event')
+import event from '../event.js'
+
 
 /**
  * Sample custom reporter for CodeceptJS.
  */
-module.exports = function (config) {
+export default function (config) {
   event.dispatcher.on(event.hook.finished, hook => {
     if (config.onHookFinished) {
       config.onHookFinished(hook)

package/lib/plugin/heal.js

@@ -1,11 +1,16 @@
-const debug = require('debug')('codeceptjs:heal')
-const colors = require('chalk')
-const recorder = require('../recorder')
-const event = require('../event')
-const output = require('../output')
-const heal = require('../heal')
-const store = require('../store')
-const container = require('../container')
+import debugFactory from 'debug'
+const debug = debugFactory('codeceptjs:heal')
+import colors from 'chalk'
+import recorder from '../recorder.js'
+
+import event from '../event.js'
+
+import output from '../output.js'
+
+import healModule from '../heal.js'
+const heal = healModule.default || healModule
+import store from '../store.js'
+
 
 const defaultConfig = {
   healLimit: 2,
@@ -29,7 +34,7 @@ const defaultConfig = {
  * * `healLimit` - how many steps can be healed in a single test (default: 2)
  *
  */
-module.exports = function (config = {}) {
+export default function (config = {}) {
   if (store.debugMode && !process.env.DEBUG) {
     event.dispatcher.on(event.test.failed, () => {
       output.plugin('heal', 'Healing is disabled in --debug mode, use DEBUG="codeceptjs:heal" to enable it in debug mode')

package/lib/plugin/pageInfo.js

@@ -1,13 +1,13 @@
-const path = require('path')
-const fs = require('fs')
-const Container = require('../container')
-const recorder = require('../recorder')
-const event = require('../event')
+import path from 'path'
+import fs from 'fs'
+import Container from '../container.js'
 const supportedHelpers = Container.STANDARD_ACTING_HELPERS
-const { scanForErrorMessages } = require('../html')
-const { output } = require('..')
-const { humanizeString, ucfirst } = require('../utils')
-const { testToFileName } = require('../mocha/test')
+import recorder from '../recorder.js'
+import event from '../event.js'
+import { scanForErrorMessages } from '../html.js'
+import { output } from '../index.js'
+import { humanizeString, ucfirst } from '../utils.js'
+import { testToFileName } from '../mocha/test.js'
 const defaultConfig = {
   errorClasses: ['error', 'warning', 'alert', 'danger'],
   browserLogs: ['error'],
@@ -35,7 +35,7 @@ const defaultConfig = {
  * * `browserLogs` - list of types of errors to search for in browser logs (default: `['error']`)
  *
  */
-module.exports = function (config = {}) {
+export default function (config = {}) {
   const helpers = Container.helpers()
   let helper
 

package/lib/plugin/pauseOnFail.js

@@ -1,5 +1,6 @@
-const event = require('../event')
-const pause = require('../pause')
+import event from '../event.js'
+
+import pause from '../pause.js'
 
 /**
  * Automatically launches [interactive pause](/basics/#pause) when a test fails.
@@ -21,7 +22,7 @@ const pause = require('../pause')
  * ```
  *
  */
-module.exports = () => {
+export default function() {
   let failed = false
 
   event.dispatcher.on(event.test.started, () => {

package/lib/plugin/retryFailedStep.js

@@ -1,6 +1,9 @@
-const event = require('../event')
-const recorder = require('../recorder')
-const store = require('../store')
+import event from '../event.js'
+
+import recorder from '../recorder.js'
+
+import store from '../store.js'
+
 const defaultConfig = {
   retries: 3,
   defaultIgnoredSteps: ['amOnPage', 'wait*', 'send*', 'execute*', 'run*', 'have*'],
@@ -74,7 +77,7 @@ const defaultConfig = {
  * ```
  *
  */
-module.exports = config => {
+export default function (config) {
   config = Object.assign(defaultConfig, config)
   config.ignoredSteps = config.ignoredSteps.concat(config.defaultIgnoredSteps)
   const customWhen = config.when
@@ -85,11 +88,20 @@ module.exports = config => {
     if (!enableRetry) return
     if (store.debugMode) return false
     if (!store.autoRetries) return false
+    // Don't retry terminal errors (e.g., frame detachment errors)
+    if (err && err.isTerminal) return false
+    // Don't retry navigation errors that are known to be terminal
+    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
 
+  // Ensure retry options are available before any steps run
+  if (!recorder.retries.find(r => r === config)) {
+    recorder.retries.push(config)
+  }
+
   event.dispatcher.on(event.step.started, step => {
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
@@ -101,7 +113,8 @@ module.exports = config => {
     enableRetry = true // enable retry for a step
   })
 
-  event.dispatcher.on(event.step.finished, () => {
+  // Disable retry only after a successful step; keep it enabled for failure so retry logic can act
+  event.dispatcher.on(event.step.passed, () => {
     enableRetry = false
   })
 
@@ -112,9 +125,38 @@ module.exports = config => {
       store.autoRetries = false
       return // disable retry when a test is not active
     }
+
+    // Don't apply plugin retry logic if there are already manual retries configured
+    // Check if any retry configs exist that aren't from this plugin
+    const hasManualRetries = recorder.retries.some(retry => retry !== config)
+    if (hasManualRetries) {
+      store.autoRetries = false
+      return
+    }
+
     // this option is used to set the retries inside _before() block of helpers
     store.autoRetries = true
     test.opts.conditionalRetries = config.retries
+    // debug: record applied retries value for tests
+    if (process.env.DEBUG_RETRY_PLUGIN) {
+      // eslint-disable-next-line no-console
+      console.log('[retryFailedStep] applying retries =', config.retries, 'for test', test.title)
+    }
     recorder.retry(config)
   })
+
+  // Fallback for environments where event.test.before wasn't emitted (runner scenarios)
+  event.dispatcher.on(event.test.started, test => {
+    if (test.opts?.disableRetryFailedStep || test.disableRetryFailedStep) return
+
+    // Don't apply plugin retry logic if there are already manual retries configured
+    // Check if any retry configs exist that aren't from this plugin
+    const hasManualRetries = recorder.retries.some(retry => retry !== config)
+    if (hasManualRetries) return
+
+    if (!store.autoRetries) {
+      store.autoRetries = true
+      test.opts.conditionalRetries = test.opts.conditionalRetries || config.retries
+    }
+  })
 }

package/lib/plugin/screenshotOnFail.js

@@ -1,13 +1,17 @@
-const fs = require('fs')
-const path = require('path')
+import fs from 'fs'
+import path from 'path'
 
-const Container = require('../container')
-const recorder = require('../recorder')
-const event = require('../event')
-const output = require('../output')
-const { fileExists } = require('../utils')
-const Codeceptjs = require('../index')
-const { testToFileName } = require('../mocha/test')
+import Container from '../container.js'
+
+import recorder from '../recorder.js'
+
+import event from '../event.js'
+
+import output from '../output.js'
+
+import { fileExists } from '../utils.js'
+import Codeceptjs from '../index.js'
+import { testToFileName } from '../mocha/test.js'
 
 const defaultConfig = {
   uniqueScreenshotNames: false,
@@ -43,7 +47,7 @@ const supportedHelpers = Container.STANDARD_ACTING_HELPERS
  *
  *
  */
-module.exports = function (config) {
+export default function (config) {
   const helpers = Container.helpers()
   let helper
 
@@ -86,11 +90,28 @@ module.exports = function (config) {
         let fileName
 
         if (options.uniqueScreenshotNames && test) {
-          fileName = `${testToFileName(test, { unique: true })}.failed.png`
+          fileName = `${testToFileName(test, { suffix: '', unique: true })}.failed.png`
         } else {
-          fileName = `${testToFileName(test)}.failed.png`
+          fileName = `${testToFileName(test, { suffix: '', unique: false })}.failed.png`
+        }
+        const quietMode = !('output_dir' in global) || !global.output_dir
+        if (!quietMode) {
+          output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot')
+        }
+
+        // Re-check helpers at runtime in case they weren't ready during plugin init
+        const runtimeHelpers = Container.helpers()
+        let runtimeHelper = null
+        for (const helperName of supportedHelpers) {
+          if (Object.keys(runtimeHelpers).indexOf(helperName) > -1) {
+            runtimeHelper = runtimeHelpers[helperName]
+            break
+          }
+        }
+
+        if (runtimeHelper && typeof runtimeHelper.saveScreenshot === 'function') {
+          helper = runtimeHelper
         }
-        output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot')
 
         try {
           if (options.reportDir) {
@@ -100,36 +121,53 @@ module.exports = function (config) {
               fs.mkdirSync(mochaReportDir)
             }
           }
-          await helper.saveScreenshot(fileName, options.fullPageScreenshots)
 
-          if (!test.artifacts) test.artifacts = {}
-          test.artifacts.screenshot = path.join(global.output_dir, fileName)
-          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)]
+          // Check if browser/page is still available before attempting screenshot
+          if (helper.page && helper.page.isClosed && helper.page.isClosed()) {
+            throw new Error('Browser page has been closed')
           }
-
-          const allureReporter = Container.plugins('allure')
-          if (allureReporter) {
-            allureReporter.addAttachment('Main session - Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), dataType)
-
-            if (helper.activeSessionName) {
-              const sessions = helper.sessionPages || helper.sessionWindows
-              for (const sessionName in sessions) {
-                const screenshotFileName = `${sessionName}_${fileName}`
-                test.artifacts[`${sessionName.replace(/ /g, '_')}_screenshot`] = path.join(global.output_dir, screenshotFileName)
-                allureReporter.addAttachment(`${sessionName} - Last Seen Screenshot`, fs.readFileSync(path.join(global.output_dir, screenshotFileName)), dataType)
-              }
-            }
+          if (helper.browser && helper.browser.isConnected && !helper.browser.isConnected()) {
+            throw new Error('Browser has been disconnected')
           }
 
-          const cucumberReporter = Container.plugins('cucumberJsonReporter')
-          if (cucumberReporter) {
-            cucumberReporter.addScreenshot(test.artifacts.screenshot)
+          // Add timeout wrapper to prevent hanging with shorter timeout for ESM
+          const screenshotPromise = helper.saveScreenshot(fileName, options.fullPageScreenshots)
+          const timeoutPromise = new Promise((_, reject) => {
+            setTimeout(() => reject(new Error('Screenshot timeout after 5 seconds')), 5000)
+          })
+
+          await Promise.race([screenshotPromise, timeoutPromise])
+
+          if (!test.artifacts) test.artifacts = {}
+          // Some unit tests may not define global.output_dir; avoid throwing when it is undefined
+          // Detect output directory safely (may not be initialized in narrow unit tests)
+          const baseOutputDir = 'output_dir' in global && typeof global.output_dir === 'string' && global.output_dir ? global.output_dir : null
+          if (baseOutputDir) {
+            test.artifacts.screenshot = path.join(baseOutputDir, fileName)
+            if (Container.mocha().options.reporterOptions['mocha-junit-reporter'] && Container.mocha().options.reporterOptions['mocha-junit-reporter'].options.attachments) {
+              test.attachments = [path.join(baseOutputDir, fileName)]
+            }
+          } else {
+            // Fallback: just store the file name to keep tests stable without triggering path errors
+            test.artifacts.screenshot = fileName
           }
         } catch (err) {
-          output.plugin(err)
-          if (err && err.type && err.type === 'RuntimeError' && err.message && (err.message.indexOf('was terminated due to') > -1 || err.message.indexOf('no such window: target window already closed') > -1)) {
-            output.log(`Can't make screenshot, ${err}`)
+          if (!quietMode) {
+            output.plugin('screenshotOnFail', `Failed to save screenshot: ${err.message}`)
+          }
+          // Enhanced error handling for browser closed scenarios
+          if (
+            err &&
+            ((err.message &&
+              (err.message.includes('Target page, context or browser has been closed') ||
+                err.message.includes('Browser page has been closed') ||
+                err.message.includes('Browser has been disconnected') ||
+                err.message.includes('was terminated due to') ||
+                err.message.includes('no such window: target window already closed') ||
+                err.message.includes('Screenshot timeout after'))) ||
+              (err.type && err.type === 'RuntimeError'))
+          ) {
+            output.log(`Can't make screenshot, ${err.message}`)
             helper.isRunning = false
           }
         }

package/lib/plugin/stepByStepReport.js

@@ -1,16 +1,16 @@
-const colors = require('chalk')
-const crypto = require('crypto')
-const figures = require('figures')
-const fs = require('fs')
-const mkdirp = require('mkdirp')
-const path = require('path')
-const cheerio = require('cheerio')
-
-const Container = require('../container')
-const recorder = require('../recorder')
-const event = require('../event')
-const output = require('../output')
-const { template, deleteDir } = require('../utils')
+import colors from 'chalk'
+import crypto from 'crypto'
+import figures from 'figures'
+import fs from 'fs'
+import mkdirp from 'mkdirp'
+import path from 'path'
+import cheerio from 'cheerio'
+
+import Container from '../container.js'
+import recorder from '../recorder.js'
+import event from '../event.js'
+import output from '../output.js'
+import { template, deleteDir } from '../utils.js'
 
 const supportedHelpers = Container.STANDARD_ACTING_HELPERS
 
@@ -63,7 +63,7 @@ const templates = {}
  * @param {*} config
  */
 
-module.exports = function (config) {
+export default function (config) {
   const helpers = Container.helpers()
   let helper
 

package/lib/plugin/stepTimeout.js

@@ -1,5 +1,6 @@
-const event = require('../event')
-const { TIMEOUT_ORDER } = require('../timeout')
+import event from '../event.js'
+
+import { TIMEOUT_ORDER } from '../timeout.js'
 
 const defaultConfig = {
   timeout: 150,
@@ -61,7 +62,7 @@ const defaultConfig = {
  * ```
  *
  */
-module.exports = config => {
+export default function(config) {
   config = Object.assign(defaultConfig, config)
   // below override rule makes sure customTimeoutSteps go first but then they override noTimeoutSteps in case of exact pattern match
   config.customTimeoutSteps = config.customTimeoutSteps.concat(config.noTimeoutSteps).concat(config.customTimeoutSteps)

package/lib/plugin/subtitles.js

@@ -1,7 +1,8 @@
-const { v4: uuidv4 } = require('uuid')
-const fsPromise = require('fs').promises
-const path = require('path')
-const event = require('../event')
+import { v4 as uuidv4 } from 'uuid'
+import fs from 'fs'
+const fsPromise = fs.promises
+import path from 'path'
+import event from '../event.js'
 
 // This will convert a given timestamp in milliseconds to
 // an SRT recognized timestamp, ie HH:mm:ss,SSS
@@ -28,7 +29,7 @@ let testStartedAt
  * }
  * ```
  */
-module.exports = function () {
+export default function () {
   event.dispatcher.on(event.test.before, _ => {
     testStartedAt = Date.now()
     steps = {}