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.

Sign up for GitHub

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

Jump to bottom

Error Improvements #6724

Merged
merged 2 commits into from
Mar 17, 2020
Merged

Error Improvements #6724

merged 2 commits into from
Mar 17, 2020

Conversation

chrisbreiding
Copy link
Contributor

@chrisbreiding chrisbreiding commented Mar 13, 2020 •
edited
Loading

@chrisbreiding @jennifer-shehane
@brian-mann @kuceb
Redesign and improve reporter error display (#6467)
88673c8 
* redesign and improve reporter error display

- add markdown support
- collapse stacktrace
- separate docs url and add link in reporter

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* $utils -> $errUtils

* derp

* serializeError -> wrapErr

* cloneErr -> makeErrFromObj

* yarn.lock

* fix unit tests

* move err-model

* fix styles

* fix/improve error logging

* fix non-converted bits

* transfer missed changes

* fix issues

* remove obselete spec

* make type test more reliable

* use should, get retries

* update snapshots

* update e2e network error test

* update more snapshots

* update error whitespace

* update snapshot

* try something out

* nevermind

* fix tooltip

* add some logging

* remove whitespace

* remove spying on window

* update snapshot

* fix test

* update snapshot

* fix merge: snapshot stacktraces

* fix noStackTrace and update snapshot

* update snapshot

* fix yarn.lock

* don't show diff if retrying an existence error

* url -> URL

* don't add newline after docs url and update a few snapshots

* keep opening stack trace from collapsing test

* remove unnecessary global cy reference

* fix tests

* put e2e timeout increase back in the right spot for exit: false

* don't show diff when assertion contains an element

also, keep mocha from messing up extracting error name when it includes a colon

* use backticks for hook error title

* fix appending error message when original message is falsy

* don't show diff on existence failures

* update snapshots

* fix finish/done being called twice due to not returning

* prevent error print button click from propagating

* use correct error methods and remove need for workaround

* create better abstraction around creating cypress error from path, refactor

* fix throwErr and tests

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Brian Mann <brian.mann86@gmail.com>
Co-authored-by: Ben Kucera <14625260+Bkucera@users.noreply.github.com>
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Mar 13, 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 Mar 13, 2020


Test summary

6993 • 0 • 98 • 0

Run details
Project cypress
Status Passed
Commit 689bef0
Started Mar 13, 2020 7:32 PM
Ended Mar 13, 2020 7:38 PM
Duration 05:47 💡
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

@jennifer-shehane jennifer-shehane merged commit 36866da into develop Mar 17, 2020
This was referenced Mar 17, 2020
Closed
Closed
Closed
Closed
This was referenced Mar 17, 2020
Closed
Closed
@flotwig flotwig mentioned this pull request Apr 7, 2020
Merged
19 tasks
@jennifer-shehane jennifer-shehane mentioned this pull request Apr 23, 2020
Closed
4 tasks
@chrisbreiding chrisbreiding deleted the error-improvements-approved branch April 5, 2022 18:29
@karlhorky karlhorky mentioned this pull request May 30, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jennifer-shehane jennifer-shehane jennifer-shehane approved these changes

@brian-mann brian-mann Awaiting requested review from brian-mann

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@chrisbreiding @jennifer-shehane