Feat/esm

[DavertMik]

Refactored to be fully ESM

Should be the base for 4.x branch

[Copilot]

Pull Request Overview

This PR refactors the codebase from CommonJS (CJS) to ECMAScript Modules (ESM) syntax, representing a foundational change for the 4.x branch. The conversion includes updating import/export statements, removing semicolons following ESM standards, and adapting module loading patterns for better compatibility.

Key changes include:

• Converting require() statements to import statements and module.exports to export statements
• Removing semicolons from most statements to align with ESM conventions
• Updating dynamic module loading patterns with proper ESM compatibility fallbacks
• Complete removal of the deprecated Protractor helper

Reviewed Changes

Copilot reviewed 111 out of 467 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
lib/hooks.js	Converted to ESM imports/exports with semicolon removal
lib/history.js	Updated module syntax and removed semicolons
lib/helper/testcafe/testcafe-utils.js	Mixed conversion retaining some CJS patterns
lib/helper/network/utils.js	Full ESM conversion with export syntax changes
lib/helper/network/actions.js	Updated imports and exports to ESM format
lib/helper/extras/Popup.js	Converted exports while keeping CJS compatibility
lib/helper/extras/PlaywrightRestartOpts.js	Converted to named ESM exports
lib/helper/errors/ElementNotFound.js	Updated to ESM import/export syntax
lib/helper/WebDriver.js	Extensive ESM conversion with dynamic import handling
lib/helper/TestCafe.js	Mixed compatibility handling for ESM/CJS modules
lib/helper/REST.js	Full ESM conversion with error handling improvements
lib/helper/Puppeteer.js	Complete ESM refactoring with dynamic imports
lib/helper/Protractor.js	Complete file removal (deprecated helper)

Comments suppressed due to low confidence (1)

lib/helper/WebDriver.js:32

• The line 'this.context = this.root' appears to be incorrectly placed outside of a constructor or method. This will cause a syntax error as it's attempting to assign a property at the module level.

 *

[Copilot]

This file mixes ESM and CommonJS syntax. The first line uses CommonJS require() while other files in this PR use ESM imports. Consider converting all require() statements to import statements for consistency.

[Copilot]

This file uses module.exports instead of ESM export syntax. For consistency with the ESM conversion, this should be 'export default Popup' to match the pattern used in other converted files.

Suggested change

	module.exports = Popup
	export default Popup

[Copilot]

[nitpick] The arrow function parameter should be parenthesized for consistency. Use 'await new Promise((done) => {' instead of 'await new Promise(done => {' to maintain consistent parameter formatting.

Suggested change

	await new Promise(done => {
	await new Promise((done) => {

[github-actions]

	🔴 UNIT-TESTS FAILED
Tests	✔️ 314 tests run
Summary	🔴 21 failed; 🟢 292 passed; 🟡 1 skipped
Duration	🕐 44 seconds
Job	🗂️ Run Unit tests / unit-tests
Operating System	🖥️ Linux X64

🟥 Failures (20)

🔴 Container: should support object by name

expected [Function] to throw Error

################[ Failure ]################
AssertionError (strictEqual): expected [Function] to throw Error
   124 |      expect(container.support('support1')).is.ok
   125 |      expect(container.support('support1').name).to.eql('hello')
   126 |      expect(container.support('support2')).is.ok
   127 |      expect(container.support('support2').name).to.eql('world')
   128 |
 > 129 |      expect(() => container.support('support3').name).to.throw(Error)
   130 |    })
   131 |  })
   132 |
   133 |  describe('#plugins', () => {
   134 |    beforeEach(async () => {

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/container_test.js:129:64)

---

🔴 Container: should load DI and return a reference to the module

container.support(...).toString is not a function

################[ Failure ]################
TypeError: container.support(...).toString is not a function
   184 |        include: {
   185 |          dummyPage: './data/dummy_page',
   186 |        },
   187 |      })
   188 |      const dummyPage = await import('../data/dummy_page.js')
 > 189 |      expect(container.support('dummyPage').toString()).is.eql((dummyPage.default || dummyPage).toString())
   190 |    })
   191 |
   192 |    it('should load I from path and execute', async () => {
   193 |      await container.create({
   194 |        include: {

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/container_test.js:189:45)

---

🔴 Container: should load I from path and execute

Custom actor loading from path './data/I' must be handled asynchronously during container creation

################[ Failure ]################
Error: Custom actor loading from path './data/I' must be handled asynchronously during container creation
   485 |function createActor(actorPath) {
   486 |  if (container.support.I) return container.support.I
   487 |
   488 |  if (actorPath) {
   489 |    // Actor path loading must be handled async during container creation
 > 490 |    throw new Error(`Custom actor loading from path '${actorPath}' must be handled asynchronously during container creation`)
   491 |  } else {
   492 |    container.support.I = actorFactory({}, Container)
   493 |  }
   494 |
   495 |  return container.support.I

   at createActor (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/container.js:490:11)
   at Container.create (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/container.js:71:5)
   at async Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/container_test.js:193:7)

---

🔴 Container: should load DI includes provided as require paths

expected {} to contain key 'openDummyPage'

################[ Failure ]################
AssertionError (deepStrictEqual): expected {} to contain key 'openDummyPage'


+ expected - actual
+ [
+   "openDummyPage"
+ ]
- []

   206 |        include: {
   207 |          dummyPage: './data/dummy_page',
   208 |        },
   209 |      })
   210 |      expect(container.support('dummyPage')).is.ok
 > 211 |      expect(container.support('dummyPage')).to.include.keys('openDummyPage')
   212 |    })
   213 |
   214 |    it('should load DI and inject I into PO', async () => {
   215 |      await container.create({
   216 |        include: {

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/container_test.js:211:57)

---

🔴 Container: should load DI and inject I into PO

Custom actor loading from path './data/I' must be handled asynchronously during container creation

################[ Failure ]################
Error: Custom actor loading from path './data/I' must be handled asynchronously during container creation
   485 |function createActor(actorPath) {
   486 |  if (container.support.I) return container.support.I
   487 |
   488 |  if (actorPath) {
   489 |    // Actor path loading must be handled async during container creation
 > 490 |    throw new Error(`Custom actor loading from path '${actorPath}' must be handled asynchronously during container creation`)
   491 |  } else {
   492 |    container.support.I = actorFactory({}, Container)
   493 |  }
   494 |
   495 |  return container.support.I

   at createActor (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/container.js:490:11)
   at Container.create (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/container.js:71:5)
   at async Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/container_test.js:215:7)

---

🔴 Container: should load DI and inject custom I into PO

Custom actor loading from path './data/I' must be handled asynchronously during container creation

################[ Failure ]################
Error: Custom actor loading from path './data/I' must be handled asynchronously during container creation
   485 |function createActor(actorPath) {
   486 |  if (container.support.I) return container.support.I
   487 |
   488 |  if (actorPath) {
   489 |    // Actor path loading must be handled async during container creation
 > 490 |    throw new Error(`Custom actor loading from path '${actorPath}' must be handled asynchronously during container creation`)
   491 |  } else {
   492 |    container.support.I = actorFactory({}, Container)
   493 |  }
   494 |
   495 |  return container.support.I

   at createActor (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/container.js:490:11)
   at Container.create (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/container.js:71:5)
   at async Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/container_test.js:228:7)

---

🔴 els: should fail when condition is false

e.cliMessage is not a function

################[ Failure ]################
TypeError: e.cliMessage is not a function
   169 |
   170 |      try {
   171 |        await els.expectElement('.selector', async () => false)
   172 |        throw new Error('should have thrown error')
   173 |      } catch (e) {
 > 174 |        expect(e.cliMessage()).to.include('element (.selector)')
   175 |      }
   176 |    })
   177 |  })
   178 |
   179 |  describe('#expectAnyElement', () => {

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/els_test.js:174:18)

---

🔴 els: should fail when no element matches condition

e.cliMessage is not a function

################[ Failure ]################
TypeError: e.cliMessage is not a function
   188 |
   189 |      try {
   190 |        await els.expectAnyElement('.selector', async () => false)
   191 |        throw new Error('should have thrown error')
   192 |      } catch (e) {
 > 193 |        expect(e.cliMessage()).to.include('any element of (.selector)')
   194 |      }
   195 |    })
   196 |  })
   197 |
   198 |  describe('#expectAllElements', () => {

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/els_test.js:193:18)

---

🔴 els: should fail when any element does not match condition

e.cliMessage is not a function

################[ Failure ]################
TypeError: e.cliMessage is not a function
   207 |
   208 |      try {
   209 |        await els.expectAllElements('.selector', async el => el !== 'el2')
   210 |        throw new Error('should have thrown error')
   211 |      } catch (e) {
 > 212 |        expect(e.cliMessage()).to.include('element #2 of (.selector)')
   213 |      }
   214 |    })
   215 |  })
   216 |})
   217 |

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/els_test.js:212:18)

---

🔴 AsyncWrapper: should work with async func

expected +0 to equal 4

################[ Failure ]################
AssertionError (strictEqual): expected +0 to equal 4


+ expected - actual
+ 4
- 0

   65 |      })
   66 |    }
   67 |
   68 |    await setup()
   69 |    testWrapper(test).fn(() => null)
 > 70 |    recorder.add('validation', () => expect(counter).to.eq(4))
   71 |    return recorder.promise()
   72 |  })
   73 |
   74 |  describe('events', () => {
   75 |    beforeEach(async () => {

   at <anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/mocha/asyncWrapper_test.js:70:57)

---

🔴 AsyncWrapper: should fire events

expected false to be truthy

################[ Failure ]################
AssertionError (strictEqual): expected false to be truthy
   88 |      await teardown()
   89 |      await suiteTeardown()
   90 |      return recorder
   91 |        .promise()
   92 |        .then(() => {
 > 93 |          expect(started.called).is.ok
   94 |          expect(beforeSuite.called).is.ok
   95 |          expect(afterSuite.called).is.ok
   96 |          expect(before.called).is.ok
   97 |          expect(after.called).is.ok
   98 |        })

   at <anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/mocha/asyncWrapper_test.js:93:36)

---

🔴 ui: context should contain BeforeAll

expected undefined to be truthy

################[ Failure ]################
AssertionError (strictEqual): expected undefined to be truthy
   22 |
   23 |  describe('basic constants', () => {
   24 |    const constants = ['Before', 'Background', 'BeforeAll', 'After', 'AfterAll', 'Scenario', 'xScenario']
   25 |
   26 |    constants.forEach(c => {
 > 27 |      it(`context should contain ${c}`, () => expect(context[c]).is.ok)
   28 |    })
   29 |  })
   30 |
   31 |  describe('Feature', () => {
   32 |    let suiteConfig

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/mocha/ui_test.js:27:68)

---

🔴 ui: context should contain AfterAll

expected undefined to be truthy

################[ Failure ]################
AssertionError (strictEqual): expected undefined to be truthy
   22 |
   23 |  describe('basic constants', () => {
   24 |    const constants = ['Before', 'Background', 'BeforeAll', 'After', 'AfterAll', 'Scenario', 'xScenario']
   25 |
   26 |    constants.forEach(c => {
 > 27 |      it(`context should contain ${c}`, () => expect(context[c]).is.ok)
   28 |    })
   29 |  })
   30 |
   31 |  describe('Feature', () => {
   32 |    let suiteConfig

   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/mocha/ui_test.js:27:68)

---

🔴 retryFailedStep: "before each" hook for "should retry failed step"

Cannot read properties of undefined (reading 'stepShift')

################[ Failure ]################
TypeError: Cannot read properties of undefined (reading 'stepShift')
   70 |   * @param {string} msg
   71 |   */
   72 |  log(msg) {
   73 |    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
   74 |    if (outputLevel >= 3) {
 > 75 |      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)))
   76 |    }
   77 |  },
   78 |
   79 |  /**
   80 |   * Print error

   at log (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/output.js:75:29)
   at Object.reset (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/recorder.js:95:5)
   at Object.start (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/recorder.js:51:10)
   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/plugin/retryFailedStep_test.js:20:14)

---

🔴 screenshotOnFail: "before each" hook for "should remove the . at the end of test title"

Cannot read properties of undefined (reading 'stepShift')

################[ Failure ]################
TypeError: Cannot read properties of undefined (reading 'stepShift')
   70 |   * @param {string} msg
   71 |   */
   72 |  log(msg) {
   73 |    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
   74 |    if (outputLevel >= 3) {
 > 75 |      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)))
   76 |    }
   77 |  },
   78 |
   79 |  /**
   80 |   * Print error

   at log (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/output.js:75:29)
   at Object.reset (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/recorder.js:95:5)
   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/plugin/screenshotOnFail_test.js:15:14)

---

🔴 subtitles: "before each" hook for "should not capture subtitle as video artifact was missing"

Cannot read properties of undefined (reading 'stepShift')

################[ Failure ]################
TypeError: Cannot read properties of undefined (reading 'stepShift')
   70 |   * @param {string} msg
   71 |   */
   72 |  log(msg) {
   73 |    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
   74 |    if (outputLevel >= 3) {
 > 75 |      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)))
   76 |    }
   77 |  },
   78 |
   79 |  /**
   80 |   * Print error

   at log (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/output.js:75:29)
   at Object.reset (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/recorder.js:95:5)
   at Object.start (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/recorder.js:51:10)
   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/plugin/subtitles_test.js:22:14)

---

🔴 Recorder: "before each" hook for "should create a promise"

Cannot read properties of undefined (reading 'stepShift')

################[ Failure ]################
TypeError: Cannot read properties of undefined (reading 'stepShift')
   70 |   * @param {string} msg
   71 |   */
   72 |  log(msg) {
   73 |    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
   74 |    if (outputLevel >= 3) {
 > 75 |      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)))
   76 |    }
   77 |  },
   78 |
   79 |  /**
   80 |   * Print error

   at log (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/output.js:75:29)
   at Object.reset (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/recorder.js:95:5)
   at Object.start (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/recorder.js:51:10)
   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/recorder_test.js:5:29)

---

🔴 Workers: should run worker with custom config

expected +0 to equal 3

################[ Failure ]################
AssertionError (strictEqual): expected +0 to equal 3


+ expected - actual
+ 3
- 0

   107 |      passedCount += 1
   108 |    })
   109 |
   110 |    workers.on(event.all.result, result => {
   111 |      expect(result.hasFailed).equal(true)
 > 112 |      expect(passedCount).equal(3)
   113 |      expect(failedCount).equal(2)
   114 |      done()
   115 |    })
   116 |  })
   117 |

   at Workers.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/worker_test.js:112:27)
   at Workers._finishRun (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/workers.js:475:10)
   at Worker.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/workers.js:462:14)

---

🔴 Workers: should able to add tests to each worker

Timeout of 40000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (/home/runner/work/CodeceptJS/CodeceptJS/test/unit/worker_test.js)

################[ Failure ]################
Error: Timeout of 40000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (/home/runner/work/CodeceptJS/CodeceptJS/test/unit/worker_test.js)

---

🔴 Workers: should able to add tests to using createGroupsOfTests

Cannot read properties of null (reading 'testFiles')

################[ Failure ]################
TypeError: Cannot read properties of null (reading 'testFiles')
   327 |
   328 |  /**
   329 |   * @param {Number} numberOfWorkers
   330 |   */
   331 |  createGroupsOfSuites(numberOfWorkers) {
 > 332 |    const files = this.codecept.testFiles
   333 |    const groups = populateGroups(numberOfWorkers)
   334 |
   335 |    const mocha = Container.mocha()
   336 |    mocha.files = files
   337 |    mocha.loadFiles()

   at Workers.createGroupsOfSuites (file:///home/runner/work/CodeceptJS/CodeceptJS/lib/workers.js:332:33)
   at Context.<anonymous> (file:///home/runner/work/CodeceptJS/CodeceptJS/test/unit/worker_test.js:159:32)

---

🐢 Slowest Tests

• Workers: should able to add tests to each worker (40.001 seconds)
• Workers: should run worker with multiple config (1.739 seconds)
• Workers: should run simple worker (0.58 seconds)
• Workers: should create worker by function (0.547 seconds)
• Workers: should run worker with custom config (0.529 seconds)