Split up error hooks to be more modular, making ordering explicit #1086
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move all of the message rendering and fixed strings into a dedicated `messages` module, and take a pass over the resulting hooks module to try to make things more compact and readable.
Rather than making order driven by definition order, expose the declared hook type (was `_RegisteredHook`), and convert the decorated functions into the declared hook objects. Then, ordering can be done by any sorting function -- currently, a strict ordered listing with no implicit ordering semantics -- and we can explicitly register the results. This allows us to break the giant hook module down into its constituent parts which can be further refined and reorganized over time.
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus,
kurtmckee,
m1yag1 and
MaxTueckeGlobus
as code owners
If the 'message' field is missing (as observed in real cases), the hook fails hard at the start. To rectify, rewrite to rescope where and how we dig into $.error.message as the error message. Do that lookup under a KeyError handler, and if that fails, failover to `$.error.detail` even if it is of length 1.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Two commits:
First a "boring" preparatory move to move some strings and messaging helpers to a distinct module
Second, "the change" itself: "Refactor to make error handler ordering explicit"
Rather than making order driven by definition order, expose the declared hook type (was
_RegisteredHook), and convert the decorated functions into the declared hook objects. Then, ordering can be done by any sorting function -- currently, a strict ordered listing with no implicit ordering semantics -- and we can explicitly register the results.This allows us to break the giant hook module down into its constituent parts which can be further refined and reorganized over time.