|
1 | | -{-# LANGUAGE DeriveGeneric #-} |
2 | | -{-# LANGUAGE LambdaCase #-} |
3 | | -{-# LANGUAGE OverloadedStrings #-} |
4 | | -{-# LANGUAGE TemplateHaskell #-} |
5 | | - |
6 | 1 | module Cardano.Wallet.API.V1.Errors where |
7 | 2 |
|
8 | 3 | import Universum |
9 | 4 |
|
10 | | -import Data.Aeson |
11 | | -import Generics.SOP.TH (deriveGeneric) |
12 | | -import Servant |
13 | | -import Test.QuickCheck (Arbitrary (arbitrary)) |
14 | | -import Test.QuickCheck.Gen (oneof) |
15 | | - |
16 | | -import Cardano.Wallet.API.Response.JSend (ResponseStatus (ErrorStatus)) |
17 | | -import Cardano.Wallet.API.V1.Generic (gparseJsend, gtoJsend) |
18 | 5 | import Cardano.Wallet.API.V1.Headers (applicationJson) |
19 | | -import Cardano.Wallet.API.V1.Types (SyncPercentage, SyncProgress (..), V1 (..), WalletId, |
20 | | - exampleWalletId, mkEstimatedCompletionTime, |
21 | | - mkSyncPercentage, mkSyncThroughput) |
| 6 | +import Data.Aeson (ToJSON, encode) |
| 7 | +import Formatting (build, sformat) |
| 8 | +import Servant (ServantErr (..)) |
22 | 9 |
|
23 | 10 | import qualified Network.HTTP.Types as HTTP |
24 | 11 |
|
25 | 12 |
|
26 | | --- |
27 | | --- Error handling |
28 | | --- |
29 | | - |
30 | | --- | Type representing any error which might be thrown by wallet. |
31 | | --- |
32 | | --- Errors are represented in JSON in the JSend format (<https://labs.omniti.com/labs/jsend>): |
33 | | --- ``` |
34 | | --- { |
35 | | --- "status": "error" |
36 | | --- "message" : <constr_name>, |
37 | | --- "diagnostic" : <data> |
38 | | --- } |
39 | | --- ``` |
40 | | --- where `<constr_name>` is a string containing name of error's constructor (e. g. `NotEnoughMoney`), |
41 | | --- and `<data>` is an object containing additional error data. |
42 | | --- Additional data contains constructor fields, field names are record field names without |
43 | | --- a `we` prefix, e. g. for `OutputIsRedeem` error "diagnostic" field will be the following: |
44 | | --- ``` |
45 | | --- { |
46 | | --- "address" : <address> |
47 | | --- } |
48 | | --- ``` |
49 | | --- |
50 | | --- Additional data in constructor should be represented as record fields. |
51 | | --- Otherwise TemplateHaskell will raise an error. |
52 | | --- |
53 | | --- If constructor does not have additional data (like in case of `WalletNotFound` error), |
54 | | --- then "diagnostic" field will be empty object. |
55 | | --- |
56 | | --- TODO: change fields' types to actual Cardano core types, like `Coin` and `Address` |
57 | | -data WalletError address syncProgress syncPercentage = |
58 | | - NotEnoughMoney { weNeedMore :: !Int } |
59 | | - | OutputIsRedeem { weAddress :: !address } |
60 | | - | MigrationFailed { weDescription :: !Text } |
61 | | - | JSONValidationFailed { weValidationError :: !Text } |
62 | | - | UnknownError { weMsg :: !Text } |
63 | | - | InvalidAddressFormat { weMsg :: !Text } |
64 | | - | WalletNotFound |
65 | | - -- FIXME(akegalj): https://iohk.myjetbrains.com/youtrack/issue/CSL-2496 |
66 | | - | WalletAlreadyExists { weWalletId :: WalletId } |
67 | | - | AddressNotFound |
68 | | - | TxFailedToStabilize |
69 | | - | TxRedemptionDepleted |
70 | | - | TxSafeSignerNotFound { weAddress :: address } |
71 | | - | MissingRequiredParams { requiredParams :: NonEmpty (Text, Text) } |
72 | | - | WalletIsNotReadyToProcessPayments { weStillRestoring :: syncProgress } |
73 | | - -- ^ The @Wallet@ where a @Payment@ is being originated is not fully |
74 | | - -- synced (its 'WalletSyncState' indicates it's either syncing or |
75 | | - -- restoring) and thus cannot accept new @Payment@ requests. |
76 | | - | NodeIsStillSyncing { wenssStillSyncing :: syncPercentage } |
77 | | - -- ^ The backend couldn't process the incoming request as the underlying |
78 | | - -- node is still syncing with the blockchain. |
79 | | - deriving (Show, Eq) |
80 | | - |
81 | | - |
82 | | --- |
83 | | --- Instances for `WalletError` |
84 | | - |
85 | | --- deriveWalletErrorJSON ''WalletError |
86 | | -deriveGeneric ''WalletError |
87 | | - |
88 | | -instance (ToJSON a, ToJSON b, ToJSON c) => ToJSON (WalletError a b c) where |
89 | | - toJSON = gtoJsend ErrorStatus |
90 | | - |
91 | | -instance (FromJSON a, FromJSON b, FromJSON c) => FromJSON (WalletError a b c) where |
92 | | - parseJSON = gparseJsend |
93 | | - |
94 | | -instance (Typeable a, Show a, Typeable b, Show b, Typeable c, Show c) => |
95 | | - Exception (WalletError a b c) |
96 | | - |
97 | | -instance (Arbitrary a, Arbitrary b, Arbitrary c) => Arbitrary (WalletError a b c) where |
98 | | - arbitrary = oneof |
99 | | - [ NotEnoughMoney <$> arbitrary |
100 | | - , OutputIsRedeem <$> arbitrary |
101 | | - , pure (MigrationFailed "Migration failed.") |
102 | | - , pure (JSONValidationFailed "Expected String, found Null.") |
103 | | - , pure (UnknownError "Unknown error.") |
104 | | - , pure (InvalidAddressFormat "Invalid Base58 representation.") |
105 | | - , pure WalletNotFound |
106 | | - , pure WalletAlreadyExists |
107 | | - , pure AddressNotFound |
108 | | - , pure TxFailedToStabilize |
109 | | - , pure TxRedemptionDepleted |
110 | | - , TxSafeSignerNotFound <$> arbitrary |
111 | | - , pure (MissingRequiredParams (("wallet_id", "walletId") :| [])) |
112 | | - , WalletIsNotReadyToProcessPayments <$> arbitrary |
113 | | - , NodeIsStillSyncing <$> arbitrary |
114 | | - ] |
115 | | - |
116 | | - |
117 | | --- |
118 | | --- Helpers |
119 | | --- |
120 | | - |
121 | | --- | Give a short description of an error |
122 | | -describe :: forall a b c. WalletError a b c -> String |
123 | | -describe = \case |
124 | | - NotEnoughMoney _ -> |
125 | | - "Not enough available coins to proceed." |
126 | | - OutputIsRedeem _ -> |
127 | | - "One of the TX outputs is a redemption address." |
128 | | - MigrationFailed _ -> |
129 | | - "Error while migrating a legacy type into the current version." |
130 | | - JSONValidationFailed _ -> |
131 | | - "Couldn't decode a JSON input." |
132 | | - UnknownError _ -> |
133 | | - "Unexpected internal error." |
134 | | - InvalidAddressFormat _ -> |
135 | | - "Provided address format is not valid." |
136 | | - WalletNotFound -> |
137 | | - "Reference to an unexisting wallet was given." |
138 | | - WalletAlreadyExists _ -> |
139 | | - "Can't create or restore a wallet. The wallet already exists." |
140 | | - AddressNotFound -> |
141 | | - "Reference to an unexisting address was given." |
142 | | - MissingRequiredParams _ -> |
143 | | - "Missing required parameters in the request payload." |
144 | | - WalletIsNotReadyToProcessPayments _ -> |
145 | | - "This wallet is restoring, and it cannot send new transactions until restoration completes." |
146 | | - NodeIsStillSyncing _ -> |
147 | | - "The node is still syncing with the blockchain, and cannot process the request yet." |
148 | | - TxRedemptionDepleted -> |
149 | | - "The redemption address was already used." |
150 | | - TxSafeSignerNotFound _ -> |
151 | | - "The safe signer at the specified address was not found." |
152 | | - TxFailedToStabilize -> |
153 | | - "We were unable to find a set of inputs to satisfy this transaction." |
154 | | - |
155 | | - |
156 | | --- | Convert wallet errors to Servant errors |
157 | | -toServantError |
158 | | - :: forall a b c. (ToJSON a, ToJSON b, ToJSON c) |
159 | | - => WalletError a b c |
160 | | - -> ServantErr |
161 | | -toServantError err = |
162 | | - mkServantErr $ case err of |
163 | | - NotEnoughMoney{} -> |
164 | | - err403 |
165 | | - OutputIsRedeem{} -> |
166 | | - err403 |
167 | | - MigrationFailed{} -> |
168 | | - err422 |
169 | | - JSONValidationFailed{} -> |
170 | | - err400 |
171 | | - UnknownError{} -> |
172 | | - err500 |
173 | | - WalletNotFound{} -> |
174 | | - err404 |
175 | | - WalletAlreadyExists{} -> |
176 | | - err403 |
177 | | - InvalidAddressFormat{} -> |
178 | | - err401 |
179 | | - AddressNotFound{} -> |
180 | | - err404 |
181 | | - MissingRequiredParams{} -> |
182 | | - err400 |
183 | | - WalletIsNotReadyToProcessPayments{} -> |
184 | | - err403 |
185 | | - NodeIsStillSyncing{} -> |
186 | | - err412 -- Precondition failed |
187 | | - TxFailedToStabilize{} -> |
188 | | - err500 |
189 | | - TxRedemptionDepleted{} -> |
190 | | - err400 |
191 | | - TxSafeSignerNotFound{} -> |
192 | | - err400 |
193 | | - where |
194 | | - mkServantErr serr@ServantErr{..} = serr |
195 | | - { errBody = encode err |
196 | | - , errHeaders = applicationJson : errHeaders |
197 | | - } |
198 | | - |
199 | | --- | |
200 | | -toHttpStatus |
201 | | - :: forall a b c. (ToJSON a, ToJSON b, ToJSON c) |
202 | | - => WalletError a b c |
203 | | - -> HTTP.Status |
204 | | -toHttpStatus err = HTTP.Status (errHTTPCode $ toServantError err) |
205 | | - (encodeUtf8 $ describe err) |
| 13 | +class (ToJSON e) => ToServantError e where |
| 14 | + declareServantError :: e -> ServantErr |
| 15 | + toServantError :: e -> ServantErr |
| 16 | + toServantError err = |
| 17 | + mkServantErr (declareServantError err) |
| 18 | + where |
| 19 | + mkServantErr serr@ServantErr{..} = serr |
| 20 | + { errBody = encode err |
| 21 | + , errHeaders = applicationJson : errHeaders |
| 22 | + } |
| 23 | + |
| 24 | +class (ToServantError e, Buildable e) => ToHttpErrorStatus e where |
| 25 | + toHttpErrorStatus :: e -> HTTP.Status |
| 26 | + toHttpErrorStatus err = |
| 27 | + HTTP.Status (errHTTPCode $ toServantError err) (encodeUtf8 $ sformat build err) |
0 commit comments