Clean up Event.clearEvent handling to fix a bug where malformed events with falsey content wouldn't be considered decrypted #1807
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
bradtgmurray
commented
Jul 23, 2021
| @@ -486,7 +486,7 @@ export class MatrixEvent extends EventEmitter { | |||
| } | |||
|
|
|||
| public shouldAttemptDecryption() { | |||
| return this.isEncrypted() && !this.isBeingDecrypted() && this.getClearContent() === null; | |||
| return this.isEncrypted() && !this.isBeingDecrypted() && !this.clearEvent; | |||
There was a problem hiding this comment.
This is the "fix" here.
t3chguy
reviewed
Jul 23, 2021
t3chguy
reviewed
Jul 23, 2021
t3chguy
reviewed
Jul 23, 2021
t3chguy
reviewed
Jul 23, 2021
t3chguy
reviewed
Jul 23, 2021
bradtgmurray
commented
Jul 25, 2021
| }).then((event) => { | ||
| expect(event.getRoomId()).toEqual(ROOM_ID); | ||
| expect(event.getContent()).toEqual({}); | ||
| expect(event.getClearContent()).toBeUndefined(); |
There was a problem hiding this comment.
This test would fail on develop because getClearContent would continue to be null before and now it actually has the correct(?) value.
Also, testUtils.awaitDecryption would have thought that the event wasn't decoded yet because getClearContent would still be null, and therefore would wait for an "Event.decrypted" event that would never come as it was already decrypted.
t3chguy
reviewed
Jul 26, 2021
|
Thanks for the feedback and the speedy review! |
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.
shouldAttemptDecryptionwas checking to see if we had acontentproperty on ourclearEvent, but it's possible that we've already been decrypted and the result still has a falseycontentproperty. Instead, only set theclearEventclass member after we've successfully decrypted, and leave it undefined otherwise.Signed-off-by: Brad Murray [email protected]