codeceptjs 4.0.0-rc.10 → 4.0.0-rc.15

package/lib/plugin/pauseOn.js

@@ -0,0 +1,167 @@
+import event from '../event.js'
+import pause from '../pause.js'
+import recorder from '../recorder.js'
+import Container from '../container.js'
+import output from '../output.js'
+
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
+
+/**
+ * Pauses test execution in different modes. Unlike `pauseOnFail`, this plugin supports
+ * multiple triggers for pausing and is controlled via CLI arguments.
+ *
+ * Enable it via `-p` option with a mode:
+ *
+ * ```
+ * npx codeceptjs run -p pauseOn:fail
+ * npx codeceptjs run -p pauseOn:step
+ * npx codeceptjs run -p pauseOn:file:tests/login_test.js
+ * npx codeceptjs run -p pauseOn:file:tests/login_test.js:43
+ * npx codeceptjs run -p pauseOn:url:/users/*
+ * ```
+ *
+ * #### Modes
+ *
+ * * **fail** — pause when a step fails (same as `pauseOnFail` plugin)
+ * * **step** — pause before first step, use `next` to advance step-by-step
+ * * **file** — pause when execution reaches a specific file (and optionally line)
+ * * **url** — pause when the browser URL matches a pattern (supports `*` wildcards)
+ *
+ */
+export default function (config = {}) {
+  const args = config._args || []
+  const mode = args[0] || 'fail'
+
+  switch (mode) {
+    case 'fail':
+      return initFailMode()
+    case 'step':
+      return initStepMode()
+    case 'file':
+      return initFileMode(args.slice(1))
+    case 'url':
+      return initUrlMode(args.slice(1))
+    default:
+      output.error(`pauseOn: unknown mode "${mode}". Available: fail, step, file, url`)
+  }
+}
+
+function initFailMode() {
+  let failed = false
+
+  event.dispatcher.on(event.test.started, () => {
+    failed = false
+  })
+
+  event.dispatcher.on(event.step.failed, () => {
+    failed = true
+  })
+
+  event.dispatcher.on(event.test.after, () => {
+    if (failed) pause()
+  })
+}
+
+function initStepMode() {
+  let activated = false
+
+  event.dispatcher.on(event.test.before, () => {
+    if (activated) return
+    activated = true
+    recorder.add('pauseOn:step', () => pause())
+  })
+}
+
+function initFileMode(fileArgs) {
+  if (fileArgs.length === 0) {
+    output.error('pauseOn:file requires a path. Usage: -p pauseOn:file:<path>[:<line>]')
+    return
+  }
+
+  const targetFile = fileArgs[0]
+  const targetLine = fileArgs[1] ? parseInt(fileArgs[1], 10) : null
+  let paused = false
+
+  event.dispatcher.on(event.step.before, (step) => {
+    if (paused) return
+
+    const stepLine = step.line()
+    if (!stepLine) return
+
+    const match = parseStepLine(stepLine)
+    if (!match) return
+
+    const fileMatches = match.file.includes(targetFile) || match.file.endsWith(targetFile)
+    if (!fileMatches) return
+
+    if (targetLine !== null && match.line !== targetLine) return
+
+    paused = true
+    recorder.add('pauseOn:file', () => pause())
+  })
+}
+
+function initUrlMode(urlArgs) {
+  if (urlArgs.length === 0) {
+    output.error('pauseOn:url requires a pattern. Usage: -p pauseOn:url:<pattern>')
+    return
+  }
+
+  const urlPattern = urlArgs.join(':')
+
+  const helpers = Container.helpers()
+  let helper = null
+  for (const helperName of supportedHelpers) {
+    if (Object.keys(helpers).indexOf(helperName) > -1) {
+      helper = helpers[helperName]
+    }
+  }
+
+  if (!helper) {
+    output.error('pauseOn:url requires a browser helper (Playwright, WebDriver, Puppeteer, Appium)')
+    return
+  }
+
+  const regex = patternToRegex(urlPattern)
+  let paused = false
+
+  event.dispatcher.on(event.step.after, () => {
+    if (paused) return
+
+    recorder.add('pauseOn:url check', async () => {
+      if (paused) return
+      try {
+        const currentUrl = await helper.grabCurrentUrl()
+        if (regex.test(currentUrl)) {
+          paused = true
+          return pause()
+        }
+      } catch (err) {
+        // page may not be loaded yet
+      }
+    })
+  })
+}
+
+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 (isNaN(lineNum)) return null
+
+  return { file, line: lineNum }
+}
+
+function patternToRegex(pattern) {
+  const escaped = pattern.replace(/[.+?^${}()|[\]\\]/g, '\\$&')
+  const regexStr = escaped.replace(/\*/g, '.*')
+  return new RegExp(regexStr)
+}

package/lib/plugin/screenshotOnFail.js

@@ -8,6 +8,7 @@ import recorder from '../recorder.js'
 import event from '../event.js'
 
 import output from '../output.js'
+import store from '../store.js'
 
 import { fileExists } from '../utils.js'
 import Codeceptjs from '../index.js'
@@ -94,7 +95,7 @@ export default function (config) {
         } else {
           fileName = `${testToFileName(test, { suffix: '', unique: false })}.failed.png`
         }
-        const quietMode = !('output_dir' in global) || !global.output_dir
+        const quietMode = !store.outputDir
         if (!quietMode) {
           output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot')
         }
@@ -139,9 +140,7 @@ export default function (config) {
           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
+          const baseOutputDir = store.outputDir || 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) {

package/lib/plugin/stepByStepReport.js

@@ -4,8 +4,9 @@ import figures from 'figures'
 import fs from 'fs'
 import { mkdirp } from 'mkdirp'
 import path from 'path'
-import cheerio from 'cheerio'
+import * as cheerio from 'cheerio'
 
+import store from '../store.js'
 import Container from '../container.js'
 import recorder from '../recorder.js'
 import event from '../event.js'
@@ -19,7 +20,7 @@ const defaultConfig = {
   animateSlides: true,
   ignoreSteps: [],
   fullPageScreenshots: false,
-  output: global.output_dir,
+  output: store.outputDir,
   screenshotsForAllureReport: false,
   disableScreenshotOnFail: true,
 }
@@ -87,7 +88,7 @@ export default function (config) {
 
   const recordedTests = {}
   const pad = '0000'
-  const reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
+  const reportDir = config.output ? path.resolve(store.codeceptDir, config.output) : defaultConfig.output
 
   event.dispatcher.on(event.suite.before, suite => {
     stepNum = -1
@@ -198,7 +199,7 @@ export default function (config) {
     // Ignore steps from BeforeSuite function
     if (scenarioFailed && config.disableScreenshotOnFail) return
     if (step.metaStep && step.metaStep.name === 'BeforeSuite') return
-    if (!step.test) return // Ignore steps from AfterSuite
+    if (!currentTest) return // Ignore steps from AfterSuite
 
     const fileName = `${pad.substring(0, pad.length - stepNum.toString().length) + stepNum.toString()}.png`
     if (step.status === 'failed') {

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/record.js

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

@@ -7,6 +7,7 @@ import getFunctionArguments from 'fn-args'
 import deepClone from 'lodash.clonedeep'
 import merge from 'lodash.merge'
 import { convertColorToRGBA, isColorProperty } from './colorUtils.js'
+import store from './store.js'
 import Fuse from 'fuse.js'
 import crypto from 'crypto'
 import jsBeautify from 'js-beautify'
@@ -335,13 +336,13 @@ export const screenshotOutputFolder = function (fileName) {
   const fileSep = path.sep
 
   if (!fileName.includes(fileSep) || fileName.includes('record_')) {
-    return path.resolve(global.output_dir, fileName)
+    return path.resolve(store.outputDir, fileName)
   }
-  return path.resolve(global.codecept_dir, fileName)
+  return path.resolve(store.codeceptDir, fileName)
 }
 
 export const relativeDir = function (fileName) {
-  return fileName.replace(global.codecept_dir, '').replace(/^\//, '')
+  return fileName.replace(store.codeceptDir, '').replace(/^\//, '')
 }
 
 export const beautify = function (code) {

package/lib/workers.js

@@ -20,6 +20,7 @@ import event from './event.js'
 import { deserializeTest } from './mocha/test.js'
 import { deserializeSuite } from './mocha/suite.js'
 import recorder from './recorder.js'
+import store from './store.js'
 import runHook from './hooks.js'
 import WorkerStorage from './workerStorage.js'
 import { createRuns } from './command/run-multiple/collection.js'
@@ -504,6 +505,7 @@ class Workers extends EventEmitter {
     await this._ensureInitialized()
     recorder.startUnlessRunning()
     event.dispatcher.emit(event.workers.before)
+    store.workerMode = true
     process.env.RUNS_WITH_WORKERS = 'true'
 
     // Create workers and set up message handlers immediately (not in recorder queue)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.0-rc.10",
+  "version": "4.0.0-rc.15",
   "type": "module",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
@@ -41,7 +41,8 @@
     "./els": "./lib/els.js",
     "./effects": "./lib/effects.js",
     "./steps": "./lib/steps.js",
-    "./store": "./lib/store.js"
+    "./store": "./lib/store.js",
+    "./assertions": "./lib/assertions.js"
   },
   "bin": {
     "codeceptjs": "./bin/codecept.js",
@@ -214,6 +215,7 @@
     }
   },
   "overrides": {
-    "tmp": "0.2.5"
+    "tmp": "0.2.5",
+    "js-yaml": "^4.1.1"
   }
 }