Extra insurance that we don't mix events in the wrong timelines #2848

MadLittleMods · 2022-11-04T00:04:30Z

Add checks to addEventToTimeline as extra insurance that we don't mix events in the wrong timelines (main timeline vs thread timeline).

Split out from #2521

Previously, we just relied on the callers to make sure they're doing the right thing and since it's easy to get it wrong, we mixed and bugs happened.

Dev notes

TimelineSet.addEventsToTimeline -> TimelineSet.addEventToTimeline -> Timeline.addEvent
TimelineSet.addEventToTimeline -> Timeline.addEvent
TimelineSet.addLiveEvent -> TimelineSet.addEventToTimeline -> Timeline.addEvent

yarn jest spec/unit/event-timeline-set.spec.ts

Checklist

Tests written for new code (and old code if feasible)
Linter and other CI checks pass
~~Sign-off given on the changes (see CONTRIBUTING.md)~~

Here's what your changelog entry will look like:

🐛 Bug Fixes

Extra insurance that we don't mix events in the wrong timelines (#2848). Contributed by @MadLittleMods.

Split out from #2521

…rding to the signature

MadLittleMods · 2022-11-04T00:22:55Z

src/models/room.ts

@@ -1862,7 +1862,7 @@ export class Room extends ReadReceipt<RoomEmittedEvents, RoomEventHandlerMap> {
        shouldLiveInThread: boolean;
        threadId?: string;
    } {
-        if (!this.client.supportsExperimentalThreads()) {
+        if (!this.client?.supportsExperimentalThreads()) {


Same crutch used elsewhere in the file,

matrix-js-sdk/src/models/room.ts

Line 382 in 4a33e58

if (this.client?.supportsExperimentalThreads()) {

The alternative is to fix the tests to not pass in null for the client but since we already made the decision to cut corners, I'm doing it here too.

Maybe we should also show that the client is optional in the attribute definition. We kind of straddling between two waters here.

Yeah, honestly I'm surprised Sonar isn't flagging this like it does with extraneous !

client isn't optional and there is plenty of logic in room.ts isn't prepared for that yet. The real fix we can do is with the tests to not pass null for the client.

Perhaps I misunderstood but I'll leave this follow-up change to someone else.

MadLittleMods · 2022-11-04T10:54:57Z

Thanks for the review @florianduros and @t3chguy 🐿

…es (#2848)" This reverts commit 433b7af.

…2856) Add checks to `addEventToTimeline` as extra insurance that we don't mix events in the wrong timelines (main timeline vs thread timeline). Split out from #2521 This PR is a v2 of #2848 since it was reverted in #2853 Previously, we just relied on the callers to make sure they're doing the right thing and since it's easy to get it wrong, we mixed and bugs happened. Call stacks for how events get added to a timeline: - `TimelineSet.addEventsToTimeline` -> `TimelineSet.addEventToTimeline` -> `Timeline.addEvent` - `TimelineSet.addEventToTimeline` -> `Timeline.addEvent` - `TimelineSet.addLiveEvent` -> `TimelineSet.addEventToTimeline` -> `Timeline.addEvent`

@MrAnno

* Make calls go back to 'connecting' state when media lost ([\matrix-org#2880](matrix-org#2880)). * Add ability to send unthreaded receipt ([\matrix-org#2878](matrix-org#2878)). * Add way to abort search requests ([\matrix-org#2877](matrix-org#2877)). * sliding sync: add custom room subscriptions support ([\matrix-org#2834](matrix-org#2834)). * webrtc: add advanced audio settings ([\matrix-org#2434](matrix-org#2434)). Contributed by @MrAnno. * Add support for group calls using MSC3401 ([\matrix-org#2553](matrix-org#2553)). * Make the js-sdk conform to tsc --strict ([\matrix-org#2835](matrix-org#2835)). Fixes matrix-org#2112 matrix-org#2116 and matrix-org#2124. * Let leave requests outlive the window ([\matrix-org#2815](matrix-org#2815)). Fixes element-hq/element-call#639. * Add event and message capabilities to RoomWidgetClient ([\matrix-org#2797](matrix-org#2797)). * Misc fixes for group call widgets ([\matrix-org#2657](matrix-org#2657)). * Support nested Matrix clients via the widget API ([\matrix-org#2473](matrix-org#2473)). * Set max average bitrate on PTT calls ([\matrix-org#2499](matrix-org#2499)). Fixes element-hq/element-call#440. * Add config option for e2e group call signalling ([\matrix-org#2492](matrix-org#2492)). * Enable DTX on audio tracks in calls ([\matrix-org#2482](matrix-org#2482)). * Don't ignore call member events with a distant future expiration date ([\matrix-org#2466](matrix-org#2466)). * Expire call member state events after 1 hour ([\matrix-org#2446](matrix-org#2446)). * Emit unknown device errors for group call participants without e2e ([\matrix-org#2447](matrix-org#2447)). * Mute disconnected peers in PTT mode ([\matrix-org#2421](matrix-org#2421)). * Add support for sending encrypted to-device events with OLM ([\matrix-org#2322](matrix-org#2322)). Contributed by @robertlong. * Support for PTT group call mode ([\matrix-org#2338](matrix-org#2338)). * Fix registration add phone number not working ([\matrix-org#2876](matrix-org#2876)). Contributed by @bagvand. * Use an underride rule for Element Call notifications ([\matrix-org#2873](matrix-org#2873)). Fixes element-hq/element-web#23691. * Fixes unwanted highlight notifications with encrypted threads ([\matrix-org#2862](matrix-org#2862)). * Extra insurance that we don't mix events in the wrong timelines - v2 ([\matrix-org#2856](matrix-org#2856)). Contributed by @MadLittleMods. * Hide pending events in thread timelines ([\matrix-org#2843](matrix-org#2843)). Fixes element-hq/element-web#23684. * Fix pagination token tracking for mixed room timelines ([\matrix-org#2855](matrix-org#2855)). Fixes element-hq/element-web#23695. * Extra insurance that we don't mix events in the wrong timelines ([\matrix-org#2848](matrix-org#2848)). Contributed by @MadLittleMods. * Do not freeze state in `initialiseState()` ([\matrix-org#2846](matrix-org#2846)). * Don't remove our own member for a split second when entering a call ([\matrix-org#2844](matrix-org#2844)). * Resolve races between `initLocalCallFeed` and `leave` ([\matrix-org#2826](matrix-org#2826)). * Add throwOnFail to groupCall.setScreensharingEnabled ([\matrix-org#2787](matrix-org#2787)). * Fix connectivity regressions ([\matrix-org#2780](matrix-org#2780)). * Fix screenshare failing after several attempts ([\matrix-org#2771](matrix-org#2771)). Fixes element-hq/element-call#625. * Don't block muting/unmuting on network requests ([\matrix-org#2754](matrix-org#2754)). Fixes element-hq/element-call#592. * Fix ICE restarts ([\matrix-org#2702](matrix-org#2702)). * Target widget actions at a specific room ([\matrix-org#2670](matrix-org#2670)). * Add tests for ice candidate sending ([\matrix-org#2674](matrix-org#2674)). * Prevent exception when muting ([\matrix-org#2667](matrix-org#2667)). Fixes element-hq/element-call#578. * Fix race in creating calls ([\matrix-org#2662](matrix-org#2662)). * Add client.waitUntilRoomReadyForGroupCalls() ([\matrix-org#2641](matrix-org#2641)). * Wait for client to start syncing before making group calls ([\matrix-org#2632](matrix-org#2632)). Fixes matrix-org#2589. * Add GroupCallEventHandlerEvent.Room ([\matrix-org#2631](matrix-org#2631)). * Add missing events from reemitter to GroupCall ([\matrix-org#2527](matrix-org#2527)). Contributed by @toger5. * Prevent double mute status changed events ([\matrix-org#2502](matrix-org#2502)). * Don't mute the remote side immediately in PTT calls ([\matrix-org#2487](matrix-org#2487)). Fixes element-hq/element-call#425. * Fix some MatrixCall leaks and use a shared AudioContext ([\matrix-org#2484](matrix-org#2484)). Fixes element-hq/element-call#412. * Don't block muting on determining whether the device exists ([\matrix-org#2461](matrix-org#2461)). * Only clone streams on Safari ([\matrix-org#2450](matrix-org#2450)). Fixes element-hq/element-call#267. * Set PTT mode on call correctly ([\matrix-org#2445](matrix-org#2445)). Fixes element-hq/element-call#382. * Wait for mute event to send in PTT mode ([\matrix-org#2401](matrix-org#2401)). * Handle other members having no e2e keys ([\matrix-org#2383](matrix-org#2383)). Fixes element-hq/element-call#338. * Fix races when muting/unmuting ([\matrix-org#2370](matrix-org#2370)).

Extra insurance that we don't mix events in the wrong timelines

0f0e8f9

Split out from #2521

MadLittleMods added the T-Defect label Nov 4, 2022

Fix null client error in tests even though it should not be null acco…

58ed2f3

…rding to the signature

MadLittleMods commented Nov 4, 2022

View reviewed changes

Content is not required

b91b03b

MadLittleMods mentioned this pull request Nov 4, 2022

Fix getLatestTimeline not working when the latest event in the room is a threaded message #2521

Closed

3 tasks

MadLittleMods marked this pull request as ready for review November 4, 2022 00:33

MadLittleMods requested a review from a team as a code owner November 4, 2022 00:33

MadLittleMods requested review from t3chguy, florianduros and justjanne November 4, 2022 00:33

florianduros approved these changes Nov 4, 2022

View reviewed changes

MadLittleMods merged commit 433b7af into develop Nov 4, 2022

MadLittleMods deleted the madlittlemods/no-addEventToTimeline-mixing branch November 4, 2022 10:54

MadLittleMods mentioned this pull request Nov 4, 2022

Ignore random macOS crap (.DS_Store) #2851

Merged

3 tasks

t3chguy added a commit that referenced this pull request Nov 4, 2022

Revert "Extra insurance that we don't mix events in the wrong timelin…

d33d0ae

…es (#2848)" This reverts commit 433b7af.

t3chguy mentioned this pull request Nov 4, 2022

Revert "Extra insurance that we don't mix events in the wrong timelines" #2853

Merged

MadLittleMods restored the madlittlemods/no-addEventToTimeline-mixing branch November 4, 2022 17:32

MadLittleMods mentioned this pull request Nov 4, 2022

Extra insurance that we don't mix events in the wrong timelines - v2 #2856

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extra insurance that we don't mix events in the wrong timelines #2848

Extra insurance that we don't mix events in the wrong timelines #2848

MadLittleMods commented Nov 4, 2022 •

edited by github-actions bot

Loading

MadLittleMods Nov 4, 2022 •

edited

Loading

florianduros Nov 4, 2022

t3chguy Nov 4, 2022

MadLittleMods Nov 4, 2022

MadLittleMods commented Nov 4, 2022

Extra insurance that we don't mix events in the wrong timelines #2848

Extra insurance that we don't mix events in the wrong timelines #2848

Conversation

MadLittleMods commented Nov 4, 2022 • edited by github-actions bot Loading

Dev notes

Checklist

🐛 Bug Fixes

MadLittleMods Nov 4, 2022 • edited Loading

Choose a reason for hiding this comment

florianduros Nov 4, 2022

Choose a reason for hiding this comment

t3chguy Nov 4, 2022

Choose a reason for hiding this comment

MadLittleMods Nov 4, 2022

Choose a reason for hiding this comment

MadLittleMods commented Nov 4, 2022

MadLittleMods commented Nov 4, 2022 •

edited by github-actions bot

Loading

MadLittleMods Nov 4, 2022 •

edited

Loading