[ADP-3306] Make additional API errors machine-readable. #4590
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
There was a problem hiding this comment.
This looks great!
Before merging though, it's still missing a couple of things, including Swagger definitions for the new info fields, and JSON golden tests.
I've added the missing things in: #4592
This is necessary to avoid failures of the following type:
```
src/Test/Aeson/Internal/GoldenSpecs.hs:77:5:
1) Cardano.Wallet.Api.Types, JSON golden roundtrip, JSON encoding of ApiError, produces the same JSON as is found in /home/jsk/projects/input-output-hk/cardano-wallet-0/lib/unit/test/data/Cardano/Wallet/Api/ApiError.json
uncaught exception: AesonDecodeError
AesonDecodeError "Error in $.samples[14]: parsing Cardano.Wallet.Api.Types.Error.ApiErrorInfo(MissingWitnessesInTransaction) failed, key \"info\" not found"
To rerun use: --match "/Cardano.Wallet.Api.Types/JSON golden roundtrip/JSON encoding of ApiError/produces the same JSON as is found in /home/jsk/projects/input-output-hk/cardano-wallet-0/lib/unit/test/data/Cardano/Wallet/Api/ApiError.json/" --seed 1949888530
Randomized with seed 1949888530
```
The above error appears because we recently added a non-optional `info`
field to the `errMissingWitnessesInTransaction` error.
paweljakubas
force-pushed
the
paweljakubas/adp-3306/use-decode-error-info
branch
from
72066e0 to
e9cd7df
Compare
jonathanknowles
approved these changes
May 15, 2024
| errMsg403InvalidConstructTx = | ||
| "It looks like I've created an empty transaction that does not have \ | ||
| \any payments, withdrawals, delegations, metadata nor minting. \ | ||
| \Include at least one of them." |
jonathanknowles
changed the title
WilliamKingNoel-Bot
pushed a commit
that referenced
this pull request
May 15, 2024
… This PR makes the following API errors machine-readable: - `ApiErrorNoSuchPool` - `ApiErrorMissingWitnessesInTransaction` In addition, we adjust the integration test suite to express expectations in terms of rich error objects instead of interpolated error message strings. ### Issue ADP-3306 Source commit: bfbb5b8
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 16, 2024
…4594) This PR follows on from #4590, and: - Extracts out witness count validation into a common function `validateWitnessCounts`. - Replaces `fromIntegral` with `intCastMaybe` and `fromJustNote` with a unique and identifiable error message. - Changes the types of fields `{expected,detected}NumberOfKeyWits` to `Natural`. - Changes the name of `ErrSubmitTransactionPartiallySignedOrNoSignedTx` to `ErrSubmitTransactionMissingWitnesses`. ## Issue ADP-3306
paweljakubas
added a commit
that referenced
this pull request
May 16, 2024
…4594) This PR follows on from #4590, and: - Extracts out witness count validation into a common function `validateWitnessCounts`. - Replaces `fromIntegral` with `intCastMaybe` and `fromJustNote` with a unique and identifiable error message. - Changes the types of fields `{expected,detected}NumberOfKeyWits` to `Natural`. - Changes the name of `ErrSubmitTransactionPartiallySignedOrNoSignedTx` to `ErrSubmitTransactionMissingWitnesses`. ## Issue ADP-3306
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.
This PR makes the following API errors machine-readable:
ApiErrorNoSuchPoolApiErrorMissingWitnessesInTransactionIn addition, we adjust the integration test suite to express expectations in terms of rich error objects instead of interpolated error message strings.
Issue
ADP-3306