This repository has been archived by the owner on Jun 28, 2022. It is now read-only.
Update error events to carry additional properties #36
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
This approach allows us to embed additional information about the error in the message. The old approach didn't because it only marshalled a simple string that identified the error (not a key/value pair).
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 sets the foundation for a better user experience when it comes to mutes. In doing so, a backwards-incompatible change to error events was introduced. Projects that connect to chat may break when this PR is merged and deployed.
The payload for error (
ERR) events is no longer a simple string, but a JSON object. After parsing the payload, the error message will be accessible via thedescriptionkey. Put simply,ERR "errormessage"becomesERR {"description":"errormessage"}.Payloads for incoming mute (
MUTE) events now provide the duration of the mute in seconds, accessible viaduration.mutederror event payloads contain the mute time left in seconds, accessible viamuteTimeLeft.Muted users will receive a
mutederror shortly after they connect to chat.