Merge branch '4.x' into clone-fix-appium-touchPerform

kobenguyent · web-flow · commit 3e5434d5da25 · 2026-06-02T14:40:45.000+02:00
diff --git a/.github/workflows/appium_Android.yml b/.github/workflows/appium_Android.yml
@@ -2,6 +2,9 @@ name: Appium Tests - Android
 
 on:
   push:
+    branches:
+      - 4.x
+  pull_request:
     branches:
       - 4.x
       - clone-fix-appium-touchPerform
diff --git a/lib/command/init.js b/lib/command/init.js
@@ -245,14 +245,12 @@ export default async function (initPath, options = {}) {
     }
 
     const tsconfig = {
-      'ts-node': {
-        files: true,
-      },
       compilerOptions: {
-        target: 'es2018',
-        lib: ['es2018', 'DOM'],
+        target: 'ES2022',
+        lib: ['ES2022', 'DOM'],
         esModuleInterop: true,
-        module: 'commonjs',
+        module: 'ESNext',
+        moduleResolution: 'bundler',
         strictNullChecks: false,
         types: ['codeceptjs', 'node'],
         declaration: true,
diff --git a/lib/element/WebElement.js b/lib/element/WebElement.js
@@ -15,10 +15,13 @@ class WebElement {
   _detectHelperType(helper) {
     if (!helper) return 'unknown'
 
-    const className = helper.constructor.name
-    if (className === 'Playwright') return 'playwright'
-    if (className === 'WebDriver') return 'webdriver'
-    if (className === 'Puppeteer') return 'puppeteer'
+    let ctor = helper.constructor
+    while (ctor && ctor.name) {
+      if (ctor.name === 'Playwright') return 'playwright'
+      if (ctor.name === 'WebDriver') return 'webdriver'
+      if (ctor.name === 'Puppeteer') return 'puppeteer'
+      ctor = Object.getPrototypeOf(ctor)
+    }
 
     return 'unknown'
   }
diff --git a/lib/helper/Appium.js b/lib/helper/Appium.js
@@ -179,13 +179,13 @@ class Appium extends Webdriver {
     super(config)
 
     this.isRunning = false
-    this.appiumV2 = config.appiumV2 || true
+    this.appiumV2 = config.appiumV2 !== false
     this.axios = axios.create()
 
-    if (!config.appiumV2) {
-      console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Appium 2.x is used by default.')
+    if (this.appiumV2 === false) {
+      console.log('Appium 1.x is no longer maintained by the Appium team (since 2022-01-01).')
       console.log('More info: https://bit.ly/appium-v2-migration')
-      console.log('This Appium 1.x support will be removed in next major release.')
+      console.log('Appium 1.x support will be removed in the next major CodeceptJS release.')
     }
   }
 
@@ -220,6 +220,9 @@ class Appium extends Webdriver {
       deprecationWarnings: false,
       restart: true,
       manualStart: false,
+      // Mobile emulator/device cold starts (esp. on cloud grids like Sauce Labs)
+      // routinely exceed webdriverio's 2-minute default. Bump to 5 min.
+      connectionRetryTimeout: 300000, // ms
       timeouts: {
         script: 0, // ms
       },
@@ -331,6 +334,24 @@ class Appium extends Webdriver {
     }
     this.$$ = this.browser.$$.bind(this.browser)
 
+    // wdio v9 implements `element.isDisplayed()` for non-mobile contexts by
+    // injecting a JS visibility check via POST /execute/sync. Appium's native
+    // context cannot execute JS, so each call logs an ugly
+    // "Method is not implemented" ERROR before the existing catch swallows it.
+    // Short-circuit isDisplayed to `true` while in native context so the
+    // request is never issued (matches existing _isDisplayedSafe semantics).
+    const helper = this
+    if (typeof this.browser.overwriteCommand === 'function') {
+      this.browser.overwriteCommand(
+        'isDisplayed',
+        async function (origFn, ...args) {
+          if (helper.isWeb) return origFn.call(this, ...args)
+          return true
+        },
+        true,
+      )
+    }
+
     this.isRunning = true
     if (this.options.timeouts && this.isWeb) {
       await this.defineTimeout(this.options.timeouts)
diff --git a/lib/helper/WebDriver.js b/lib/helper/WebDriver.js
@@ -1264,7 +1264,7 @@ class WebDriver extends Helper {
     const elem = selectElement(res, field, this)
     highlightActiveElement.call(this, elem)
 
-    if (await fillRichEditor(this, elem, value)) {
+    if (this.isWeb !== false && await fillRichEditor(this, elem, value)) {
       return
     }
 
diff --git a/lib/mocha/asyncWrapper.js b/lib/mocha/asyncWrapper.js
@@ -199,7 +199,7 @@ export function setup(suite) {
     recorder.startUnlessRunning()
     import('./test.js').then(testModule => {
       const { enhanceMochaTest } = testModule.default || testModule
-      event.emit(event.test.before, enhanceMochaTest(suite?.ctx?.currentTest))
+      event.emit(event.test.before, enhanceMochaTest(suite?.ctx?.currentTest ?? suite?.currentTest))
       recorder.add(() => doneFn())
     })
   }
@@ -211,7 +211,7 @@ export function teardown(suite) {
     recorder.startUnlessRunning()
     import('./test.js').then(testModule => {
       const { enhanceMochaTest } = testModule.default || testModule
-      event.emit(event.test.after, enhanceMochaTest(suite?.ctx?.currentTest))
+      event.emit(event.test.after, enhanceMochaTest(suite?.ctx?.currentTest ?? suite?.currentTest))
       recorder.add(() => doneFn())
     })
   }
diff --git a/lib/mocha/gherkin.js b/lib/mocha/gherkin.js
@@ -42,13 +42,12 @@ const gherkinParser = (text, file) => {
   suite.file = file
   suite.timeout(0)
 
-  suite.beforeEach('codeceptjs.before', function () {
-    // In Mocha, 'this' refers to the current test in beforeEach/afterEach hooks
-    setup(this)(() => {})
+  suite.beforeEach('codeceptjs.before', function (done) {
+    // In Mocha, 'this' is the hook Context; currentTest is the running scenario
+    setup(this)(done)
   })
-  suite.afterEach('codeceptjs.after', function () {
-    // In Mocha, 'this' refers to the current test in beforeEach/afterEach hooks
-    teardown(this)(() => {})
+  suite.afterEach('codeceptjs.after', function (done) {
+    teardown(this)(done)
   })
   suite.beforeAll('codeceptjs.beforeSuite', suiteSetup(suite))
   suite.afterAll('codeceptjs.afterSuite', suiteTeardown(suite))
diff --git a/package.json b/package.json
@@ -100,7 +100,7 @@
     "acorn": "8.15.0",
     "ai": "^6.0.43",
     "arrify": "3.0.0",
-    "axios": "1.13.2",
+    "axios": "1.16.1",
     "chalk": "4.1.2",
     "cheerio": "^1.0.0",
     "chokidar": "^5.0.0",
diff --git a/test/acceptance/gherkin/before_hook.feature b/test/acceptance/gherkin/before_hook.feature
@@ -0,0 +1,9 @@
+@Playwright @Puppeteer @WebDriverIO @bdd @hookCapture
+Feature: Before hooks receive the real scenario
+
+  Background:
+    Given I opened website
+
+  @scenarioHook
+  Scenario: Before hook captures scenario metadata
+    Then the Before hook should have captured this scenario
diff --git a/test/acceptance/gherkin/steps.js b/test/acceptance/gherkin/steps.js
@@ -1,10 +1,71 @@
 const I = actor();
+const event = codeceptjs.event;
+
+const capturedScenarios = [];
+
+Before(test => {
+  capturedScenarios.push({
+    phase: 'Before-hook',
+    title: test && test.title,
+    tags: test && Array.isArray(test.tags) ? [...test.tags] : null,
+  });
+});
+
+After(test => {
+  capturedScenarios.push({
+    phase: 'After-hook',
+    title: test && test.title,
+    tags: test && Array.isArray(test.tags) ? [...test.tags] : null,
+  });
+});
+
+event.dispatcher.on(event.test.before, test => {
+  capturedScenarios.push({
+    phase: 'event.test.before',
+    title: test && test.title,
+    tags: test && Array.isArray(test.tags) ? [...test.tags] : null,
+  });
+});
+
+event.dispatcher.on(event.test.after, test => {
+  capturedScenarios.push({
+    phase: 'event.test.after',
+    title: test && test.title,
+    tags: test && Array.isArray(test.tags) ? [...test.tags] : null,
+  });
+});
 
 Given('I opened website', () => {
   // From "gherkin/basic.feature" {"line":8,"column":5}
   I.amOnPage('/');
 });
 
+Then('the Before hook should have captured this scenario', () => {
+  const captureSnapshot = JSON.stringify(capturedScenarios, null, 2);
+
+  const matchesScenario = entry =>
+    entry.tags && entry.tags.includes('@scenarioHook') && entry.tags.includes('@hookCapture');
+
+  const bddBefore = capturedScenarios.find(
+    entry => entry.phase === 'Before-hook' && matchesScenario(entry),
+  );
+  const eventBefore = capturedScenarios.find(
+    entry => entry.phase === 'event.test.before' && matchesScenario(entry),
+  );
+
+  if (!bddBefore) throw new Error(`BDD Before() did not fire for @scenarioHook. Captured:\n${captureSnapshot}`);
+  if (!eventBefore) throw new Error(`event.test.before did not fire with real test. Captured:\n${captureSnapshot}`);
+
+  for (const entry of [bddBefore, eventBefore]) {
+    if (!entry.title || entry.title === '...') {
+      throw new Error(`Placeholder title in ${entry.phase}: ${JSON.stringify(entry)}`);
+    }
+    if (!entry.title.includes('Before hook captures scenario metadata')) {
+      throw new Error(`Unexpected title in ${entry.phase}: ${JSON.stringify(entry)}`);
+    }
+  }
+});
+
 When('go to {string} page', (url) => {
   // From "gherkin/basic.feature" {"line":9,"column":5}
   I.amOnPage(url);
diff --git a/test/data/sandbox/codecept.bdd.events.js b/test/data/sandbox/codecept.bdd.events.js
@@ -0,0 +1,27 @@
+export const config = {
+  tests: './*_no_test.js',
+  timeout: 10000,
+  output: './output',
+  helpers: {
+    BDD: {
+      require: './support/bdd_helper.js',
+    },
+  },
+  gherkin: {
+    features: './features/*.feature',
+    steps: [
+      './features/step_definitions/my_steps.js',
+      './features/step_definitions/my_other_steps.js',
+    ],
+  },
+  include: {},
+  bootstrap: false,
+  mocha: {},
+  plugins: {
+    captureTestBefore: {
+      require: './support/capture_test_before.js',
+      enabled: true,
+    },
+  },
+  name: 'sandbox',
+}
diff --git a/test/data/sandbox/support/capture_test_before.js b/test/data/sandbox/support/capture_test_before.js
@@ -0,0 +1,31 @@
+import fs from 'fs'
+import event from '../../../../lib/event.js'
+
+export default function (config) {
+  const captured = []
+
+  event.dispatcher.on(event.test.before, test => {
+    captured.push({
+      phase: 'test.before',
+      title: test?.title ?? null,
+      tags: Array.isArray(test?.tags) ? [...test.tags] : null,
+    })
+  })
+
+  event.dispatcher.on(event.test.after, test => {
+    captured.push({
+      phase: 'test.after',
+      title: test?.title ?? null,
+      tags: Array.isArray(test?.tags) ? [...test.tags] : null,
+    })
+  })
+
+  const flush = () => {
+    const outPath = config.outputFile || process.env.CAPTURE_OUTPUT
+    if (!outPath) return
+    fs.writeFileSync(outPath, JSON.stringify(captured, null, 2))
+  }
+
+  event.dispatcher.on(event.all.result, flush)
+  event.dispatcher.on(event.all.after, flush)
+}
diff --git a/test/helper/Appium_test.js b/test/helper/Appium_test.js
@@ -21,7 +21,7 @@ const apk_path = 'storage:filename=selendroid-test-app-0.17.0.apk'
 const smallWait = 3
 
 describe('Appium', function () {
-  // this.retries(1);
+  this.retries(1)
   this.timeout(0)
 
   before(async () => {
diff --git a/test/runner/bdd_test.js b/test/runner/bdd_test.js
@@ -1,6 +1,8 @@
 import * as chai from 'chai'
 chai.should()
 import assert from 'assert'
+import fs from 'fs'
+import os from 'os'
 import path from 'path'
 import { exec } from 'child_process'
 import { fileURLToPath } from 'url'
@@ -347,6 +349,35 @@ When(/^I define a step with a \\( paren and a "(.*?)" string$/, () => {
     })
   })
 
+  it('emits event.test.before/after with the real scenario title and tags', done => {
+    const captureFile = path.join(os.tmpdir(), `codeceptjs-capture-${process.pid}-${Date.now()}.json`)
+    const cmd = `${config_run_config('codecept.bdd.events.js')} --grep "@important"`
+    exec(cmd, { env: { ...process.env, CAPTURE_OUTPUT: captureFile } }, (err, stdout, stderr) => {
+      try {
+        assert(!err, `runner failed: ${stderr || stdout}`)
+        const captured = JSON.parse(fs.readFileSync(captureFile, 'utf8'))
+
+        const beforeEvents = captured.filter(e => e.phase === 'test.before')
+        const afterEvents = captured.filter(e => e.phase === 'test.after')
+
+        beforeEvents.length.should.be.greaterThan(0)
+        afterEvents.length.should.be.greaterThan(0)
+
+        for (const entry of [...beforeEvents, ...afterEvents]) {
+          entry.title.should.not.equal('...')
+          entry.title.should.include('checkout')
+          entry.tags.should.include('@important')
+          entry.tags.should.include('@very')
+        }
+        done()
+      } catch (assertErr) {
+        done(assertErr)
+      } finally {
+        try { fs.unlinkSync(captureFile) } catch {}
+      }
+    })
+  })
+
   describe('i18n', () => {
     const codecept_dir = path.join(__dirname, '/../data/sandbox/i18n')
     const config_run_config = config => `${codecept_run} --config ${codecept_dir}/${config}`
diff --git a/test/unit/WebElement_test.js b/test/unit/WebElement_test.js
@@ -36,6 +36,22 @@ describe('WebElement', () => {
 
       expect(webElement.helperType).to.equal('unknown')
     })
+
+    it('should detect Appium as webdriver via prototype chain', () => {
+      class WebDriver {}
+      class Appium extends WebDriver {}
+      const webElement = new WebElement({}, new Appium())
+
+      expect(webElement.helperType).to.equal('webdriver')
+    })
+
+    it('should detect subclasses of Playwright as playwright', () => {
+      class Playwright {}
+      class CustomPlaywright extends Playwright {}
+      const webElement = new WebElement({}, new CustomPlaywright())
+
+      expect(webElement.helperType).to.equal('playwright')
+    })
   })
 
   describe('getText()', () => {
diff --git a/test/unit/bdd_test.js b/test/unit/bdd_test.js

Original file line number	Diff line number	Diff line change
`@@ -1264,7 +1264,7 @@ class WebDriver extends Helper {`
`1264`	`1264`	`const elem = selectElement(res, field, this)`
`1265`	`1265`	`highlightActiveElement.call(this, elem)`
`1266`	`1266`
`1267`		`- if (await fillRichEditor(this, elem, value)) {`
	`1267`	`+ if (this.isWeb !== false && await fillRichEditor(this, elem, value)) {`
`1268`	`1268`	`return`
`1269`	`1269`	`}`
`1270`	`1270`