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

Update project error UI #6432

Merged
merged 8 commits into from
Feb 14, 2020
Merged

Update project error UI #6432

merged 8 commits into from
Feb 14, 2020

Conversation

flotwig
Copy link
Contributor

@flotwig flotwig commented Feb 12, 2020

User facing changelog

  • Improved the error experience for errors reported to the cypress open GUI.

Additional details

  • selecting "copy to clipboard" will copy a markdown-formatted version of the error to the clipboard
  • error titles can be specified to override the default "An unexpected error occurred"
    • currently browser launch errors and plugin errors have custom titles

How has the user experience changed?

Before

All project-level errors pretty much look like this:

image

After

Examples of browser launch errors

image

image

Example of plugin error

image

image

PR Tasks

  • Have tests been added/updated?
  • Has the original issue been tagged with a release in ZenHub?
  • [na] Has a PR for user-facing changes been opened in cypress-documentation?
  • [na] Have API changes been updated in the type definitions?
  • [na] Have new configuration options been added to the cypress.schema.json?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Feb 12, 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.

@flotwig
Copy link
Contributor Author

flotwig commented Feb 12, 2020

example of markdown formatting from 'copy to clipboard':


Title: Error launching browser

Message: Cypress requires at least Chrome 64.

Details:
A minimum CDP version of v1.6 is required, but the current browser has v1.3.

Stack trace:

Error: Cypress requires at least Chrome 64.

Details:
A minimum CDP version of v1.6 is required, but the current browser has v1.3.
    at /home/flotwig/Projects/cypress/issue-6416-project-open-error/packages/server/lib/browsers/chrome.ts:446:39
    at processImmediate (internal/timers.js:439:21)
From previous event:
    at Object.<anonymous> (/home/flotwig/Projects/cypress/issue-6416-project-open-error/packages/server/lib/browsers/chrome.ts:445:39)
    at step (/home/flotwig/Projects/cypress/issue-6416-project-open-error/packages/server/lib/browsers/chrome.ts:33:23)
    at Object.next (/home/flotwig/Projects/cypress/issue-6416-project-open-error/packages/server/lib/browsers/chrome.ts:14:53)
    at fulfilled (/home/flotwig/Projects/cypress/issue-6416-project-open-error/packages/server/lib/browsers/chrome.ts:5:58)

@cypress
Copy link

cypress bot commented Feb 12, 2020



Test summary

6865 0 97 0


Run details

Project cypress
Status Passed
Commit cd4ccb0
Started Feb 12, 2020 6:04 PM
Ended Feb 12, 2020 6:10 PM
Duration 06:12 💡
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

@flotwig flotwig changed the title [WIP] Update project error UI Update project error UI Feb 12, 2020
@flotwig flotwig requested review from a team, chrisbreiding and brian-mann and removed request for a team, chrisbreiding and brian-mann February 12, 2020 18:52
@flotwig flotwig requested review from chrisbreiding, brian-mann and a team February 14, 2020 21:27
@brian-mann brian-mann merged commit dd3b63a into develop Feb 14, 2020
@chrisbreiding chrisbreiding removed their request for review February 18, 2020 17:20
@flotwig flotwig deleted the issue-6416-project-open-error branch January 24, 2022 18:19
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.

"Can't start server" error is confusing
2 participants