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

Ensure user-specified error classes take priority #115

Merged
merged 2 commits into from
Apr 12, 2019
Merged

Conversation

kinbiko
Copy link
Contributor

@kinbiko kinbiko commented Apr 4, 2019

Goal

In v1.4.0 we introduced a bug when changing the order of the error and
other metadata in notifier.Notify. This commit rectifies this by
explicitly checking that the error class has not been set previously
before setting it automatically.

Changeset

Added

  • Check to see if the error class has already been set before assigning the default error class from the error itself.

Changed

  • Notify test to catch this bug if it should occur in future releases.

Linked issues

Fixes #98

Testing

@Cawllec could you have a look and see if you think we need another set of maze tests for this case?

Review

For the submitter, initial self-review:

  • Commented on code changes inline explain the reasoning behind the approach
  • Reviewed the test cases added for completeness and possible points for discussion
  • A changelog entry was added for the goal of this pull request
  • Check the scope of the changeset - is everything in the diff required for the pull request?
  • This pull request is ready for:
    • Initial review of the intended approach, not yet feature complete
    • Structural review of the classes, functions, and properties modified
    • Final review

For the pull request reviewer(s), this changeset has been reviewed for:

  • Consistency across platforms for structures or concepts added or modified
  • Consistency between the changeset and the goal stated above
  • Internal consistency with the rest of the library - is there any overlap between existing interfaces and any which have been added?
  • Usage friction - is the proposed change in usage cumbersome or complicated?
  • Performance and complexity - are there any cases of unexpected O(n^3) when iterating, recursing, flat mapping, etc?
  • Concurrency concerns - if components are accessed asynchronously, what issues will arise
  • Thoroughness of added tests and any missing edge cases
  • Idiomatic use of the language

In v1.4.0 we introduced a bug when changing the order of the error and
other metadata in notifier.Notify. This commit rectifies this by
explicitly checking that the error class has not been set previously
before setting it automatically.
@kinbiko kinbiko requested review from Cawllec and mikeewhite April 4, 2019 12:18
Copy link

@mikeewhite mikeewhite left a comment

Choose a reason for hiding this comment

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

LGTM

@kinbiko kinbiko requested review from Cawllec and removed request for Cawllec April 11, 2019 13:38
@klautcomputing
Copy link

I just ran into this, any idea when you are going to release it?

@kinbiko
Copy link
Contributor Author

kinbiko commented Apr 12, 2019

hi @klautcomputing,

We're aiming to release it early next week. Thanks for your patience!

@kinbiko kinbiko merged commit 3b24f76 into next Apr 12, 2019
@kinbiko kinbiko deleted the fix-errorclass branch April 12, 2019 16:01
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.

4 participants