Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Force custom reporters to use bundled mocha version #6951

Merged
merged 18 commits into from
Apr 22, 2020

Conversation

kuceb
Copy link
Contributor

@kuceb kuceb commented Apr 7, 2020

  • force custom reporters to use our bundled mocha, which means users no longer need to install mocha to satisfy mocha reporter peer dependencies
  • remove npmInstall logic in helper/e2e script

details:

  • this is tested by changing some of our e2e test script logic to use mocha 7.x, which would normally fail.
  • this should be a bugfix

docs changes:

  • need to remove instructions to add mocha as a devDependency since the mocha reporter will be forced to use our bundled mocha
    image

User facing changelog

  • Bug Fix: Custom mocha reporters will now correctly use the version of mocha bundled with Cypress

Additional details

How has the user experience changed?

PR Tasks

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Apr 7, 2020

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@cypress
Copy link

cypress bot commented Apr 7, 2020



Test summary

7182 0 98 0


Run details

Project cypress
Status Passed
Commit 3f1cb80
Started Apr 22, 2020 3:50 AM
Ended Apr 22, 2020 3:55 AM
Duration 05:44 💡
OS Linux Debian - 10.1
Browser Multiple

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so the main benefit of this PR is they don't need to install mocha to use a custom reporter, right?

is there a docs PR?

packages/driver/test/support/server.coffee Show resolved Hide resolved
packages/server/lib/reporter.coffee Outdated Show resolved Hide resolved
packages/server/lib/overrideRequire.ts Outdated Show resolved Hide resolved
packages/server/lib/reporter.coffee Show resolved Hide resolved
packages/server/package.json Outdated Show resolved Hide resolved
packages/server/test/scripts/run.js Show resolved Hide resolved
@kuceb kuceb requested a review from flotwig April 9, 2020 21:03
Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a docs PR?

packages/server/lib/reporter.coffee Outdated Show resolved Hide resolved
packages/server/lib/reporter.coffee Show resolved Hide resolved
packages/server/test/scripts/run.js Show resolved Hide resolved
@kuceb kuceb requested a review from flotwig April 10, 2020 20:24
@kuceb
Copy link
Contributor Author

kuceb commented Apr 10, 2020

ok, fixed the spec globbing issue...finally

@kuceb
Copy link
Contributor Author

kuceb commented Apr 10, 2020

note the docs PR

flotwig
flotwig previously approved these changes Apr 20, 2020
packages/server/package.json Show resolved Hide resolved
chrisbreiding
chrisbreiding previously approved these changes Apr 21, 2020
@kuceb kuceb dismissed stale reviews from chrisbreiding and flotwig via 3f1cb80 April 22, 2020 03:45
@cypress-io cypress-io deleted a comment from froggies00 Apr 22, 2020
@kuceb kuceb merged commit bbde737 into develop Apr 22, 2020
@emilyrohrbough emilyrohrbough deleted the use-bundled-mocha-for-reporters branch August 1, 2024 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

use mocha 7.0.1 in packages/server TypeError when using custom reporter
4 participants