Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Process m.room.encryption events before emitting RoomMember events #2914

Merged
merged 8 commits into from
Nov 30, 2022
Merged

Process m.room.encryption events before emitting RoomMember events #2914

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e2aefa2
Pass a `room` parameter into `Crypto.onCryptoEvent`
richvdh Nov 29, 2022
dc0d751
Factor out `setRoomEncryptionImpl` which takes a `Room`
richvdh Nov 29, 2022
248d244
Factor out `trackRoomDevicesImpl` which takes a `Room`
richvdh Nov 29, 2022
5656b22
Inline a call to `trackRoomDevices`
richvdh Nov 29, 2022
4928d33
Call onCryptoEvent before processing state events
richvdh Nov 25, 2022
7c41145
Add a new test
richvdh Nov 29, 2022
9d20db1
lint
richvdh Nov 29, 2022
f660a6f
Add a test for `setRoomEncryption`
richvdh Nov 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/crypto/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2972,10 +2972,11 @@ export class Crypto extends TypedEventEmitter<CryptoEvent, CryptoEventHandlerMap
/**
* handle an m.room.encryption event
*
* @param {module:models/event.MatrixEvent} event encryption event
* @param room in which the event was received
* @param event encryption event to be processed
*/
public async onCryptoEvent(event: MatrixEvent): Promise<void> {
const roomId = event.getRoomId()!;
public async onCryptoEvent(room: Room, event: MatrixEvent): Promise<void> {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

strictly speaking, this is a breaking change, because this method is accessible outside the js-sdk. But it's really not intended to be called anywhere except internally.

If we really want I could add a new onCryptoEventWithARealRoom method, use that from sync.ts etc, and deprecate the existing method. But it feels to me like that would be adding a bunch of dead code for very little gain.

const roomId = room.roomId;
const content = event.getContent<IRoomEncryption>();

try {
Expand Down
2 changes: 1 addition & 1 deletion src/sliding-sync-sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -703,7 +703,7 @@ export class SlidingSyncSdk {
const processRoomEvent = async (e: MatrixEvent): Promise<void> => {
client.emit(ClientEvent.Event, e);
if (e.isState() && e.getType() == EventType.RoomEncryption && this.opts.crypto) {
await this.opts.crypto.onCryptoEvent(e);
await this.opts.crypto.onCryptoEvent(room, e);
}
};

Expand Down
2 changes: 1 addition & 1 deletion src/sync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1392,7 +1392,7 @@ export class SyncApi {
const processRoomEvent = async (e): Promise<void> => {
client.emit(ClientEvent.Event, e);
if (e.isState() && e.getType() == "m.room.encryption" && this.opts.crypto) {
await this.opts.crypto.onCryptoEvent(e);
await this.opts.crypto.onCryptoEvent(room, e);
}
};

Expand Down