Add details to exceptions raised in LobbyClient #898
Merged
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.
This pull request customizes the error type used in
LobbyClient
to enable passing-through to callers additional details about the specific error that the client encountered. Amongst others, this behavior is useful in situations where the errors thrown by the Lobby API may contain remediation hints for the user. For example, when using custom setupData validation (see #831), the errors returned by the API may contain instructions to the user setting up a game on what exactly is incorrect about their configuration.An alternative implementation could also expose the
response
object directly onLobbyClientError
which would allow more flexibility to callers but also increase coupling with the client's implementation (e.g. changing away fromfetch
would be a breaking change).Checklist
master
).