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

[DDW-231] log expected errors as debug messages only #916

Merged
merged 4 commits into from
May 15, 2018

Conversation

DominikGuzei
Copy link
Member

This PR improves our error handling by logging expected error cases only as debug messages instead of spamming our dev console.

Review Checklist:

Basics

  • PR is updated to the most recent version of target branch (and there are no conflicts)
  • PR has good description that summarizes all changes and shows some screenshots or animated GIFs of important UI changes
  • CHANGELOG entry has been added and is linked to the correct PR on GitHub
  • Automated tests: All acceptance tests are passing (npm run test)
  • Manual tests (minimum tests should cover newly added feature/fix): App works correctly in development build (npm run dev)
  • Manual tests (minimum tests should cover newly added feature/fix): App works correctly in production build (npm run package / CI builds)
  • There are no flow errors or warnings (npm run flow-test)
  • There are no lint errors or warnings (npm run lint)
  • Text changes are proofread and approved (Jane Wild)
  • There are no missing translations (running npm run manage-translations produces no changes)
  • UI changes look good in all themes (Alexander Rukin)
  • Storybook works and no stories are broken (npm run storybook)
  • In case of npm dependency changes both package-lock.json and yarn.lock files are updated

Code Quality

  • Important parts of the code are properly documented and commented
  • Code is properly typed with flow
  • React components are split-up enough to avoid unnecessary re-rendering
  • Any code that only works in Electron is neatly separated from components

Testing

  • New feature / change is covered by acceptance tests
  • All existing acceptance tests are still up-to-date
  • New feature / change is covered by Daedalus Testing scenario
  • All existing Daedalus Testing scenarios are still up-to-date

After Review:

  • Merge PR
  • Delete source branch
  • Move ticket to done on the Youtrack board

Copy link
Contributor

@nikolaglumac nikolaglumac left a comment

Choose a reason for hiding this comment

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

Nice work @DominikGuzei!

There are a few things I would like to change:
1). Perhaps we should log handled errors with the Logger.debug and unhandled/unexpected ones with Logger.error same as it is done here: https://github.com/input-output-hk/daedalus/blob/develop/source/renderer/app/api/ada/index.js#L631-L635 - I believe that would be the proper way to go!
2). I think we should apply the same logic to ETC Api too.
3). Please add CHANGELOG entry.
Thanks for making these changes!

@DominikGuzei
Copy link
Member Author

@nikolaglumac i agree that it would be "better" … unfortunately it's not easily possible without a lot of duplicated logging statements or boilerplate around it. Basically I would have to duplicate the error logging into any if statement or set a flag like isHandledError for each case.

@nikolaglumac
Copy link
Contributor

@DominikGuzei roger that!
Let's leave 1). for later. What about 2). and 3).? :)

@DominikGuzei
Copy link
Member Author

working on those now @nikolaglumac 👍

@DominikGuzei
Copy link
Member Author

@nikolaglumac changelog and ETC updates are added!

Copy link
Contributor

@nikolaglumac nikolaglumac left a comment

Choose a reason for hiding this comment

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

Looks good now! Approved @DominikGuzei

@nikolaglumac nikolaglumac merged commit acf7ea1 into develop May 15, 2018
@nikolaglumac nikolaglumac deleted the chore/ddw-231-better-error-handling branch May 15, 2018 09:31
@nikolaglumac nikolaglumac mentioned this pull request Jun 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants