Pass HTTP status code & errcode from CS-API errors #100
Conversation
| message: string; | ||
| } | ||
|
|
||
| interface IMatrixErrorData { |
There was a problem hiding this comment.
Perhaps there's a better place to put this, or a better way to have it as part of IWidgetApiErrorResponseData.
Also, are interface types still supposed to start with I?
Allow client widget drivers to serialize Matrix API error responses into JSON to be received by the requesting widget.
because Typescript has its own version of that rule
Mock client-side responses to test deserializing them on the widget side
As long as the error details payload is extensible, let drivers put more data in them than just the key for Matrix API error responses.
as this makes it too easy for drivers to put data in the wrong section. Still define the payload type as an interface so that it can be extended in a future version of the API. Also don't use a subfield now that non-extensibility makes the format of the details fields unambiguous.
|
With code coverage finally high enough, this is now ready to review. |
|
Code coverage is as high as it can reasonably get now. |
|
| } | ||
|
|
||
| private handleDriverError(e: unknown, request: IWidgetApiRequest, message: string) { | ||
| const data = this.driver.processError(e); |
There was a problem hiding this comment.
I'm not a fan of making driver implementations responsible for serializing errors. I'd much rather have it be done by something akin to a method on the error object itself, but that's not simple because errors are of an unknown type here. For now, the current solution works, but I'm open to suggestions.
Currently, error responses from CS-API requests are re-thrown/rejected without their HTTP status code or
errcodestring. This PR passes them along, because otherwise clients that may run either standalone or as a widget cannot reliably use HTTP status codes on error responses, as the latter would not receive them.Signed-off-by: Andrew Ferrazzutti [email protected]