fix: remove _trace from helloOp #654
Merged
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
As per discord/discord-api-docs#967, _trace in OP10 HELLO is no longer an array of strings, but rather an undefined glob of data that presently contains a mixed bag of strings and objects. type helloOp does not seem to be exposed outside of the library, so this is not a breaking change; furthermore, the Trace field of helloOp was not used anywhere within the library. It seems like it would be safer to just remove the field outright, rather than accept it as an interface{} and waste cycles unmarshaling data that is never used. This is a critically breaking bug, as if the upstream change is merged, bots using DiscordGo prior to this patch will be unable to connect; an error would occur when trying to unmarshal the new data glob into a []string, causing (*Session).Open() to prematurely return.
|
Due to the potentially breaking nature of the upstream issue, I would recommend deploying this change to If the upstream change is not merged, there will be no repercussions to DiscordGo and its dependents, as the If the upstream change is merged, DiscordGo and its dependents will be broken entirely. |
|
Thanks for catching this and providing the PR. I agree, since we're not using or exposing it, it's perfectly fine to just remove it. |
ErikMcClure
pushed a commit
to ErikMcClure/discordgo
that referenced
this pull request
Aug 4, 2020
fix: remove _trace from helloOp
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.
As per discord/discord-api-docs#967, _trace in OP10 HELLO is no
longer an array of strings, but rather an undefined glob of data that
presently contains a mixed bag of strings and objects.
type helloOp does not seem to be exposed outside of the library, so this
is not a breaking change; furthermore, the Trace field of helloOp was
not used anywhere within the library. It seems like it would be safer to
just remove the field outright, rather than accept it as an interface{}
and waste cycles unmarshaling data that is never used.
This is a critically breaking bug, as if the upstream change is merged,
bots using DiscordGo prior to this patch will be unable to connect; an
error would occur when trying to unmarshal the new data glob into a
[]string, causing (*Session).Open() to prematurely return.