codeceptjs 4.0.0-rc.2 → 4.0.0-rc.20

package/lib/plugin/screenshotOnFail.js

@@ -1,178 +1,15 @@
-import fs from 'fs'
-import path from 'path'
-
-import Container from '../container.js'
-
-import recorder from '../recorder.js'
-
-import event from '../event.js'
-
 import output from '../output.js'
+import screenshot from './screenshot.js'
 
-import { fileExists } from '../utils.js'
-import Codeceptjs from '../index.js'
-import { testToFileName } from '../mocha/test.js'
-
-const defaultConfig = {
-  uniqueScreenshotNames: false,
-  disableScreenshots: false,
-  fullPageScreenshots: false,
-}
-
-const supportedHelpers = Container.STANDARD_ACTING_HELPERS
+let warned = false
 
 /**
- * Creates screenshot on failure. Screenshot is saved into `output` directory.
- *
- * Initially this functionality was part of corresponding helper but has been moved into plugin since 1.4
- *
- * This plugin is **enabled by default**.
- *
- * #### Configuration
- *
- * Configuration can either be taken from a corresponding helper (deprecated) or a from plugin config (recommended).
- *
- * ```js
- * plugins: {
- *    screenshotOnFail: {
- *      enabled: true
- *    }
- * }
- * ```
- *
- * Possible config options:
- *
- * * `uniqueScreenshotNames`: use unique names for screenshot. Default: false.
- * * `fullPageScreenshots`: make full page screenshots. Default: false.
- *
- *
+ * @deprecated Use the `screenshot` plugin with `on: 'fail'` (the default).
  */
-export default function (config) {
-  const helpers = Container.helpers()
-  let helper
-
-  for (const helperName of supportedHelpers) {
-    if (Object.keys(helpers).indexOf(helperName) > -1) {
-      helper = helpers[helperName]
-    }
-  }
-
-  if (!helper) return // no helpers for screenshot
-
-  const options = Object.assign(defaultConfig, helper.options, config)
-
-  if (helpers.Mochawesome) {
-    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
-  }
-
-  if (options.disableScreenshots) {
-    // old version of disabling screenshots
-    return
+export default function (config = {}) {
+  if (!warned) {
+    output.error('screenshotOnFail is deprecated; use the `screenshot` plugin (default on=fail).')
+    warned = true
   }
-
-  event.dispatcher.on(event.test.failed, (test, _err, hookName) => {
-    if (hookName === 'BeforeSuite' || hookName === 'AfterSuite') {
-      // no browser here
-      return
-    }
-
-    recorder.add(
-      'screenshot of failed test',
-      async () => {
-        const dataType = 'image/png'
-        // This prevents data driven to be included in the failed screenshot file name
-        let fileName
-
-        if (options.uniqueScreenshotNames && test) {
-          fileName = `${testToFileName(test, { suffix: '', unique: true })}.failed.png`
-        } else {
-          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
-        }
-
-        try {
-          if (options.reportDir) {
-            fileName = path.join(options.reportDir, fileName)
-            const mochaReportDir = path.resolve(process.cwd(), options.reportDir)
-            if (!fileExists(mochaReportDir)) {
-              fs.mkdirSync(mochaReportDir)
-            }
-          }
-
-          // 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')
-          }
-          if (helper.browser && helper.browser.isConnected && !helper.browser.isConnected()) {
-            throw new Error('Browser has been disconnected')
-          }
-
-          // 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) {
-          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
-          }
-        }
-      },
-      true,
-    )
-  })
+  return screenshot({ ...config, on: 'fail' })
 }

package/lib/rerun.js

@@ -1,4 +1,5 @@
 import fsPath from 'path'
+import store from './store.js'
 import container from './container.js'
 import event from './event.js'
 import BaseCodecept from './codecept.js'
@@ -29,7 +30,7 @@ class CodeceptRerunner extends BaseCodecept {
         let filesToRun = this.testFiles
         if (test) {
           if (!fsPath.isAbsolute(test)) {
-            test = fsPath.join(global.codecept_dir, test)
+            test = fsPath.join(store.codeceptDir, test)
           }
           filesToRun = this.testFiles.filter(t => fsPath.basename(t, '.js') === test || t === test)
         }

package/lib/result.js

@@ -1,6 +1,7 @@
 import fs from 'fs'
 import path from 'path'
 import { serializeTest } from './mocha/test.js'
+import store from './store.js'
 
 /**
  * @typedef {Object} Stats Statistics for a test result.
@@ -212,7 +213,7 @@ class Result {
    */
   save(fileName) {
     if (!fileName) fileName = 'result.json'
-    fs.writeFileSync(path.join(global.output_dir, fileName), JSON.stringify(this.simplify(), null, 2))
+    fs.writeFileSync(path.join(store.outputDir, fileName), JSON.stringify(this.simplify(), null, 2))
   }
 
   /**

package/lib/step/base.js

@@ -3,6 +3,7 @@ import Secret from '../secret.js'
 import { getCurrentTimeout } from '../timeout.js'
 import { ucfirst, humanizeString, serializeError } from '../utils.js'
 import recordStep from './record.js'
+import store from '../store.js'
 
 const STACK_LINE = 5
 
@@ -148,11 +149,11 @@ class Step {
     const lines = this.stack.split('\n')
     if (lines[STACK_LINE]) {
       let line = lines[STACK_LINE].trim()
-        .replace(global.codecept_dir || '', '.')
+        .replace(store.codeceptDir || '', '.')
         .trim()
 
       // Map .temp.mjs back to original .ts files using container's tsFileMapping
-      const fileMapping = global.container?.tsFileMapping?.()
+      const fileMapping = store.tsFileMapping
       if (line.includes('.temp.mjs') && fileMapping) {
         for (const [tsFile, mjsFile] of fileMapping.entries()) {
           if (line.includes(mjsFile)) {

package/lib/step/config.js

@@ -1,20 +1,33 @@
+/**
+ * @typedef {Object} StepOptions
+ * @property {number|'first'|'last'} [elementIndex] - Select a specific element when multiple match. 1-based positive index, negative from end, or 'first'/'last'.
+ * @property {boolean} [exact] - Enable strict mode for this step. Throws if multiple elements match.
+ * @property {boolean} [strictMode] - Alias for exact.
+ * @property {boolean} [ignoreCase] - Perform case-insensitive text matching.
+ */
+
 /**
  * StepConfig is a configuration object for a step.
  * It is used to create a new step that is a combination of other steps.
  */
 class StepConfig {
   constructor(opts = {}) {
-    /** @member {{ opts: Record<string, any>, timeout: number|undefined, retry: number|undefined }} */
+    /** @member {{ opts: StepOptions, timeout: number|undefined, retry: number|undefined }} */
     this.config = {
       opts,
       timeout: undefined,
       retry: undefined,
     }
+    this.__isStepConfig = true
+  }
+
+  static isStepConfig(obj) {
+    return obj && (obj instanceof StepConfig || obj.__isStepConfig === true)
   }
 
   /**
    * Set the options for the step.
-   * @param {object} opts - The options for the step.
+   * @param {StepOptions} opts - The options for the step.
    * @returns {StepConfig} - The step configuration object.
    */
   opts(opts) {

package/lib/step/record.js

@@ -11,7 +11,7 @@ function recordStep(step, args) {
 
   // apply step configuration
   const lastArg = args[args.length - 1]
-  if (lastArg instanceof StepConfig) {
+  if (StepConfig.isStepConfig(lastArg)) {
     const stepConfig = args.pop()
     const { opts, timeout, retry } = stepConfig.getConfig()
 
@@ -63,7 +63,7 @@ function recordStep(step, args) {
     step.endTime = +Date.now()
     
     // Fix error stack to point to original .ts files (lazy import to avoid circular dependency)
-    const fileMapping = global.container?.tsFileMapping?.()
+    const fileMapping = store.tsFileMapping
     if (fileMapping) {
       fixErrorStack(err, fileMapping)
     }

package/lib/store.js

@@ -1,8 +1,34 @@
 /**
- * global values for current session
+ * Global store for current session
  * @namespace
  */
 const store = {
+  // --- Required (set once via initialize(), immutable after) ---
+
+  /** @type {string | null} */
+  _codeceptDir: null,
+  /** @type {string | null} */
+  _outputDir: null,
+
+  get codeceptDir() {
+    return this._codeceptDir || global.codecept_dir || null
+  },
+  set codeceptDir(val) {
+    this._codeceptDir = val
+  },
+
+  get outputDir() {
+    return this._outputDir || global.output_dir || null
+  },
+  set outputDir(val) {
+    this._outputDir = val
+  },
+
+  /** @type {boolean} */
+  workerMode: false,
+
+  // --- Session config (per-session, mutable, set at session start) ---
+
   /**
    * If we are in --debug mode
    * @type {boolean}
@@ -27,20 +53,63 @@ const store = {
    * @type {boolean}
    */
   dryRun: false,
+
+  /**
+   * Feature.only() was used
+   * @type {boolean}
+   */
+  featureOnly: false,
+
+  /**
+   * Scenario.only() was used
+   * @type {boolean}
+   */
+  scenarioOnly: false,
+
+  /**
+   * Mask sensitive data config
+   * @type {boolean|object}
+   */
+  maskSensitiveData: false,
+
+  /**
+   * noGlobals mode — user imports everything
+   * @type {boolean}
+   */
+  noGlobals: false,
+
+  // --- State (tracks current execution, changes constantly) ---
+
   /**
    * If we are in pause mode
    * @type {boolean}
    */
   onPause: false,
 
-  // current object states
-
   /** @type {CodeceptJS.Test | null} */
   currentTest: null,
   /** @type {CodeceptJS.Step | null} */
   currentStep: null,
   /** @type {CodeceptJS.Suite | null} */
   currentSuite: null,
+
+  /** @type {Map<string, string> | null} */
+  tsFileMapping: null,
+
+  /**
+   * Initialize required store fields.
+   * These values cannot be overwritten after initialization.
+   * @param {object} opts
+   * @param {string} opts.codeceptDir - root directory of tests
+   * @param {string} opts.outputDir - resolved output directory
+   */
+  initialize(opts) {
+    if (!opts.codeceptDir) throw new Error('codeceptDir is required')
+    if (!opts.outputDir) throw new Error('outputDir is required')
+
+    this._codeceptDir = opts.codeceptDir
+    this._outputDir = opts.outputDir
+  },
 }
 
 export default store

package/lib/translation.js

@@ -1,6 +1,7 @@
 import merge from 'lodash.merge'
 import path from 'path'
 import { createRequire } from 'module'
+import store from './store.js'
 
 const defaultVocabulary = {
   I: 'I',
@@ -15,7 +16,7 @@ class Translation {
 
   loadVocabulary(vocabularyFile) {
     if (!vocabularyFile) return
-    const filePath = path.join(global.codecept_dir, vocabularyFile)
+    const filePath = path.join(store.codeceptDir, vocabularyFile)
 
     try {
       const require = createRequire(import.meta.url)

package/lib/utils/mask_data.js

@@ -1,4 +1,5 @@
 import { maskSensitiveData } from 'invisi-data'
+import store from '../store.js'
 
 /**
  * Mask sensitive data utility for CodeceptJS
@@ -33,7 +34,7 @@ export function maskData(input, config) {
  * @returns {boolean|object} - Current masking configuration
  */
 export function getMaskConfig() {
-  return global.maskSensitiveData || false
+  return store.maskSensitiveData || global.maskSensitiveData || false
 }
 
 /**

package/lib/utils/pluginParser.js

@@ -0,0 +1,151 @@
+import Container from '../container.js'
+import output from '../output.js'
+
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
+
+const RESERVED_KEYS = new Set(['on', 'path', 'line', 'pattern'])
+const ALL_MODES = ['fail', 'test', 'step', 'file', 'url']
+
+/**
+ * Parse a plugin's _args (from CLI `-p plugin:key=value:key=value`) into a flat dict.
+ * Each entry is split on `;` then on the first `=`. Bare segments become `{ key: true }`.
+ *
+ * Examples:
+ *   parsePluginArgs(['on=fail'])
+ *     → { on: 'fail' }
+ *   parsePluginArgs(['on=file', 'path=tests/foo.js;line=43'])
+ *     → { on: 'file', path: 'tests/foo.js', line: '43' }
+ *   parsePluginArgs(['on=file', 'path=tests/foo.js', 'line=43'])
+ *     → { on: 'file', path: 'tests/foo.js', line: '43' }
+ *   parsePluginArgs(['show'])
+ *     → { show: true }
+ */
+export function parsePluginArgs(args = []) {
+  const opts = {}
+  for (const arg of args) {
+    if (!arg) continue
+    for (const segment of arg.split(';')) {
+      if (!segment) continue
+      if (segment.includes('=')) {
+        const eq = segment.indexOf('=')
+        const key = segment.slice(0, eq)
+        const value = segment.slice(eq + 1)
+        opts[key] = coerce(value)
+      } else {
+        opts[segment] = true
+      }
+    }
+  }
+  return opts
+}
+
+function coerce(v) {
+  if (v === 'true') return true
+  if (v === 'false') return false
+  return v
+}
+
+/**
+ * Compose CLI args > config > defaults into a normalized trigger spec, then
+ * validate it. Returns `{ on, path, line, pattern, ...rest }` with `line`
+ * coerced to a number, or `null` if validation failed (an error is printed).
+ *
+ * @param {object} cliArgs           — output of parsePluginArgs(config._args)
+ * @param {object} config            — full plugin config object
+ * @param {object} defaults          — fallback values, e.g. `{ on: 'fail' }`
+ * @param {object} options
+ * @param {string} options.name      — plugin name, used in error messages
+ * @param {string[]} [options.validModes] — accepted values for `on`
+ *                                          (default: fail, test, step, file, url)
+ */
+export function resolveTrigger(cliArgs = {}, config = {}, defaults = {}, options = {}) {
+  const { name = 'plugin', validModes = ALL_MODES } = options
+  const merged = { ...defaults, ...pickKnown(config), ...cliArgs }
+  if (merged.line != null) merged.line = parseInt(merged.line, 10)
+
+  const valid = new Set(validModes)
+  if (!valid.has(merged.on)) {
+    output.error(`${name}: unknown on="${merged.on}". Valid: ${validModes.join(', ')}`)
+    return null
+  }
+  if (merged.on === 'file' && !merged.path) {
+    output.error(`${name}:on=file requires path=. Example: -p ${name}:on=file:path=tests/foo.js`)
+    return null
+  }
+  if (merged.on === 'url' && !merged.pattern) {
+    output.error(`${name}:on=url requires pattern=. Example: -p ${name}:on=url:pattern=/users/*`)
+    return null
+  }
+
+  return merged
+}
+
+function pickKnown(config) {
+  const out = {}
+  for (const key of Object.keys(config || {})) {
+    if (RESERVED_KEYS.has(key)) out[key] = config[key]
+  }
+  return out
+}
+
+/**
+ * Match a step's source location against a `path` (substring/suffix) and optional `line`.
+ * Reads the step's stack via `step.line()` to get `file:row:col`.
+ */
+export function matchStepFile(step, targetPath, targetLine) {
+  if (!targetPath) return false
+  const stepLine = step.line && step.line()
+  if (!stepLine) return false
+
+  const parsed = parseStepLine(stepLine)
+  if (!parsed) return false
+
+  const fileMatches = parsed.file.includes(targetPath) || parsed.file.endsWith(targetPath)
+  if (!fileMatches) return false
+
+  if (targetLine != null && !Number.isNaN(targetLine) && parsed.line !== targetLine) return false
+  return true
+}
+
+function parseStepLine(stepLine) {
+  let line = stepLine.trim()
+  if (line.startsWith('at ')) line = line.substring(3).trim()
+
+  const lastColon = line.lastIndexOf(':')
+  if (lastColon < 0) return null
+  const secondLastColon = line.lastIndexOf(':', lastColon - 1)
+  if (secondLastColon < 0) return null
+
+  const file = line.substring(0, secondLastColon)
+  const lineNum = parseInt(line.substring(secondLastColon + 1, lastColon), 10)
+
+  if (Number.isNaN(lineNum)) return null
+  return { file, line: lineNum }
+}
+
+/**
+ * Match a URL string against a glob-style pattern (supports `*` wildcards).
+ */
+export function matchUrl(currentUrl, pattern) {
+  if (!pattern || !currentUrl) return false
+  return patternToRegex(pattern).test(currentUrl)
+}
+
+function patternToRegex(pattern) {
+  const escaped = pattern.replace(/[.+?^${}()|[\]\\]/g, '\\$&')
+  const regexStr = escaped.replace(/\*/g, '.*')
+  return new RegExp(regexStr)
+}
+
+/**
+ * Return the first available standard browser helper, or null.
+ */
+export function getBrowserHelper() {
+  const helpers = Container.helpers()
+  for (const name of supportedHelpers) {
+    if (Object.keys(helpers).indexOf(name) > -1) {
+      return helpers[name]
+    }
+  }
+  return null
+}