Improve takeoffer error handing #5294
Merged
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
- Add PRICE_CHECK_FAILED to enum AvailabilityResult. - Add enum AvailabilityResult to TakeOfferReply message.
- GrpcErrorMessageHandler A new ErrorMessageHandler implementation to get around the api specific problem of having to use Task ErrorMessageHandlers that build task error messages for the UI. - GrpcExceptionHandler A new method for working with the ErrorMessageHandler interface. - GrpcTradesService, CoreApi, CoreTradesService: Ajdusted takeoffer error handling to give a failure reason provided by the new GrpcErrorMessageHandler.
|
PR #5292 should be reviewed and merged before this one. |
ghubstan
changed the title
ghubstan
changed the title
wallclockbuilder
previously approved these changes
Mar 11, 2021
- Add description msg TakeOfferReply proto, and fromProto method to core.offer.enum AvailabilityResult. The description field maps a client usable error message to the enum. - Adjust GrpcErrorMessageHandler to add AvailabilityResult.description() to takeoffer reply. - Refactor (split up) GrpcClient's takeOffer. Add getTakeOfferReply() to give clients a chance to make choices based on the reply's AvailabilityResult when the takeoffer command did not result in a trade. (Some errors are fatal, some not.)
sqrrm
reviewed
Mar 16, 2021
| UNCONF_TX_LIMIT_HIT, | ||
| MAKER_DENIED_API_USER | ||
| MAKER_DENIED_API_USER, | ||
| PRICE_CHECK_FAILED |
There was a problem hiding this comment.
Just to confirm, this would fail to parse by old clients and thus use the first element in the enum, which is UNKNOWN_FAILURE, which makes sense.
There was a problem hiding this comment.
I confirmed this by sending protobuf.AvailabilityResult.PRICE_CHECK_FAILED(13) to a client that does not have that proto enum value, and the client received UNKNOWN_ENUM_VALUE_AvailabilityResult_13.
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.
UI specific task runner validation errors cannot be passed to the client via a typical
ErrorMessageHandler. This change uses a newGrpcErrorMessageHandlerimplementation that places an optionalAvailabilityResultin thetakeofferresponse if an offer is not available. The client can derive a better failure reason message from the reply's AvailabilityResult.GrpcErrorMessageHandlerAdd newErrorMessageHandlerimplementation to get around the api specific problem of having to use an interface that is designed to build task error messages for the UI.GrpcExceptionHandlerAdd a method for working with theErrorMessageHandlerinterface.GrpcTradesService, CoreApi, CoreTradesService: Adjust thetakeoffererror handling to give a failure reason provided by the newGrpcErrorMessageHandler.pb.protoAddPRICE_CHECK_FAILEDto enumAvailabilityResult.grpc.protoAdd enumAvailabilityResulttoTakeOfferReplymessage. This field is populated by theGrpcErrorMessageHandlerwhentakeofferfails, making it easier to give CLI users a stylistically consistent failure reason.OpenOfferManagerInjectCoreContexto know isApiUser. Set AvailabilityResult =PRICE_CHECK_FAILEDif isApiUser=true, leaving it asUNKNOWN_FAILUREfor isApiUser=false.OpenOfferManagerTest Adjusted to new
CoreContextconstructor arg.GrpcClientAdjustedtakeOfferto convertAvailabilityResultto user error message if the call fails -- does not return a trade.Added grpc exception catch blocks missing from some api test cases in
apitest/src/test/java/bisq/apitest/method/trade.