Skip to content
New issue

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

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

Already on GitHub? # to your account

throw specific error when cannot parse Cypress arguments #6280

Merged
merged 9 commits into from
Feb 1, 2020

Conversation

bahmutov
Copy link
Contributor

@bahmutov bahmutov commented Jan 30, 2020

User facing changelog

Cypress can silently fail to parse custom config string, or fail with a weird "cannot call split of undefined" error. This change catches config-parsing errors, prints an error message and the config string before exiting.

Example error message

Cypress encountered an error while parsing the argument config

You passed: xyz

The error was: Cannot read property 'split' of undefined

Same guard for parsing env and reporterOptions arguments.

PR Tasks

  • Have tests been added/updated?
  • Has the original issue been tagged with a release in ZenHub?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jan 30, 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 Jan 30, 2020



Test summary

3615 0 47 0


Run details

Project cypress
Status Passed
Commit 40e30dc
Started Feb 1, 2020 3:28 AM
Ended Feb 1, 2020 3:33 AM
Duration 04:48 💡
OS Linux Debian - 9.11
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

@bahmutov bahmutov changed the title WIP: throw specific error when cannot parse Cypress arguments throw specific error when cannot parse Cypress arguments Jan 31, 2020
@bahmutov bahmutov requested a review from flotwig January 31, 2020 20:55
@bahmutov
Copy link
Contributor Author

I have updated code to treat env, reporterOptions and config the same way and follow that error message

@bahmutov bahmutov requested a review from flotwig January 31, 2020 21:43
@bahmutov
Copy link
Contributor Author

bahmutov commented Jan 31, 2020 via email

@bahmutov
Copy link
Contributor Author

snapshots back to normal

flotwig
flotwig previously approved these changes Jan 31, 2020
@bahmutov bahmutov merged commit 76a1830 into develop Feb 1, 2020
@emilyrohrbough emilyrohrbough deleted the print-config-parsing-error-6279 branch August 1, 2024 13:48
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Gitlab build fails with docker image cypress/included:3.8.3
2 participants