Mocha reports "expect" reporterOption passed into it

[KamalAman]

Current behavior

Currently, the Cypress integration with mocha assumes that reporters take in an option called reporterOptions however reporterOptions is actually an alias for reporterOption

The current implementation

cypress/packages/server/lib/reporter.js

Line 293 in a6a2c49

reporterOptions: this.reporterOptions,

The change to the API is stated here mochajs/mocha#4741 (comment)
and documented here: https://mochajs.org/#-reporter-option-option-o-option-reporter-options-option

That being said, you cannot just pass in reporterOption instead of reporterOptions since some reporters still reference the legacy variable.

Desired behavior

Should be able to use any mocha reporter, and it should respect reporterOptions Cypress CLI parameter.

For example the JSON reporter here uses the new variable reporterOption https://github.com/mochajs/mocha/blob/master/lib/reporters/json.js

Test code to reproduce

In the latest version of the JSON version in v9.11 of mocha it has an output option. Currently the render options do not get properly passed in.

nx affected --target=e2e  --reporter json --reporterOptions "output=results.json"

Cypress Version

8.3.1

Other

The proposed change would be to make the following change

this.reporter = new this.mocha._reporter(this.runner, {
      reporterOptions: this.reporterOptions,
      reporterOption: this.reporterOptions,
})

[patcon]

I believe I'm hitting this, where mocha reporters can't be output to file:

// cypress.json
{
  "reporter": "json",
  "reporterOption": {
    "mochaFile": "output.txt"
  }
}

Cypress package version: 9.6.0

Wondering if there's a way to force an old version of mocha in the meantime...

[patcon]

Thanks @KamalAman! Pushed this just a little bit further in #21224 😆

[patcon]

The breaking commit in mocha:
mochajs/mocha@eed38d7

The attempted backward compat that should ideally work for us: mochajs/mocha@9c10ada

[jholmes-seek]

Is there anything we can do to help get this through?

[cypress-app-bot]

This issue has not had any activity in 180 days. Cypress evolves quickly and the reported behavior should be tested on the latest version of Cypress to verify the behavior is still occurring. It will be closed in 14 days if no updates are provided.

[cypress-app-bot]

This issue has been closed due to inactivity.