Performance : improve time to open a room. #3186

ganfra · 2024-07-12T16:24:22Z

Content

Currently when getting a room through the client.getRoom(roomId) method, it also initialises a MatrixTimeline and automatically add the timeline listener.
This is not ok for performance as we use the method in different contexts where we don't need to listen to timeline events.

The timeline will now be subscribed only when needed. It's still hidden by the sdk, so it remains transparent for the client .

Also, rust sdk has removed his timeline cache, getting a fullRoom takes some time as we need to initialise the inner timeline. I've now added a small lruCache to keep those in memory.

Last point, the app was triggering some back pagination because of some race condition when building UI items.

Motivation and context

Closes #3179

Screenshots / GIFs

Tests

Open a room
Close the room
Re-open the same room
Repeat and everything should stay quick and memory low.

Tested devices

Physical
Emulator
OS version(s):

Checklist

Changes have been tested on an Android device or Android emulator with API 23
UI change has been tested on both light and dark themes
Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
Pull request is based on the develop branch
Pull request title will be used in the release note, it clearly define what will change for the user
Pull request includes screenshots or videos if containing UI changes
Pull request includes a sign off
You've made a self review of your PR

github-actions · 2024-07-12T16:30:52Z

📱 Scan the QR code below to install the build (arm64 only) for this PR.

If you can't scan the QR code you can install the build via this link: https://i.diawi.com/ZiLvzq

codecov · 2024-07-12T16:36:54Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.12%. Comparing base (61c0216) to head (f08d30b).
Report is 35 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3186   +/-   ##
========================================
  Coverage    76.12%   76.12%           
========================================
  Files         1643     1643           
  Lines        38668    38668           
  Branches      7475     7475           
========================================
  Hits         29437    29437           
  Misses        5341     5341           
  Partials      3890     3890

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

...src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/TimelineItemsSubscriber.kt

bmarty · 2024-07-15T12:27:06Z

@ganfra do you think that merging this PR can close #3179?

frebib · 2024-07-15T13:18:42Z

@ganfra do you think that merging this PR can close #3179?

With this PR, performance seems better, but IMHO still not close to what it should be. I don't know if EX or rust-sdk is to blame. I still see ~1s+ room opening times. For contrast, WhatsApp opens rooms instantly.

This is especially obvious when you compare to EXA builds from ~6 months ago where timeline loading was so fast that it would cause visual stuttering in the animations. Whilst the dropped frames were annoying, it's a lot less annoying than looking at that dreaded spinner

ganfra · 2024-07-15T13:31:31Z

Currently we are in a state where the rust sdk has no cached timeline, so it's creating one each time. It'll be back later, so should be faster again.
We also have some slowness coming from using JNA (though uniffi).
And in the end we might have some overhead from kotlin codebase, like this PR is improving.

jmartinesp

I'm a bit wary about the never called RustRoomFactory.destroy(). Other than that, it seems to have improved the situation a lot!

jmartinesp · 2024-07-17T14:18:22Z

...matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustRoomFactory.kt

    private val mutex = Mutex()
+    private var isDestroyed: Boolean = false
+
+    private data class RustRoomObjects(


RustRoomReferences? Naming is hard, up to you.

jmartinesp · 2024-07-17T14:26:20Z

...matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustRoomFactory.kt

@@ -70,30 +88,41 @@ class RustRoomFactory(
            )
        }

-    suspend fun create(roomId: RoomId): MatrixRoom? = withContext(createRoomDispatcher) {
-        var cachedPairOfRoom: Pair<RoomListItem, Room>?
+    suspend fun destroy() {


Is this ever called? I couldn't find anything calling it.

Oooops, it was, but I reverted some part and forgot about this one, thanks!

jmartinesp · 2024-07-17T14:29:24Z

...matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustRoomFactory.kt

+            oldRoom.roomListItem.close()
+            oldRoom.fullRoom.close()


sonarcloud · 2024-07-17T16:21:03Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

bmarty

LGTM and tested OK, thanks!

Performance : subscribe to timeline items only when necessary

c508c8b

ganfra marked this pull request as ready for review July 15, 2024 10:01

ganfra requested a review from a team as a code owner July 15, 2024 10:01

ganfra requested review from bmarty and removed request for a team July 15, 2024 10:01

bmarty added the PR-Misc For other changes label Jul 15, 2024

bmarty reviewed Jul 15, 2024

View reviewed changes

...src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/TimelineItemsSubscriber.kt Show resolved Hide resolved

ganfra marked this pull request as draft July 16, 2024 14:15

ganfra added 2 commits July 17, 2024 14:45

Performance : add cache on roomListItem and fullRoom

ef12408

Performance : do not trigger back pagination when opening room.

5e6bcbd

ganfra marked this pull request as ready for review July 17, 2024 13:49

ganfra changed the title ~~Performance : subscribe to timeline items only when necessary~~ Performance : improve time to open a room. Jul 17, 2024

ganfra requested review from bmarty and jmartinesp July 17, 2024 13:54

jmartinesp reviewed Jul 17, 2024

View reviewed changes

ganfra added 2 commits July 17, 2024 17:22

Performance : rename RustRoomObjects to RustRoomReferences

7fab94f

Performance : call roomFactory.destroy()

f08d30b

ganfra requested a review from jmartinesp July 17, 2024 15:28

ganfra added the Run-Maestro Starts a Maestro Cloud session to run integration tests label Jul 17, 2024

github-actions bot removed the Run-Maestro Starts a Maestro Cloud session to run integration tests label Jul 17, 2024

bmarty approved these changes Jul 17, 2024

View reviewed changes

ganfra merged commit a198716 into develop Jul 17, 2024
30 checks passed

ganfra deleted the feature/fga/investigate_performance_issue branch July 17, 2024 17:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Performance : improve time to open a room. #3186

Performance : improve time to open a room. #3186

ganfra commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

codecov bot commented Jul 12, 2024 •

edited

Loading

bmarty commented Jul 15, 2024

frebib commented Jul 15, 2024 •

edited

Loading

ganfra commented Jul 15, 2024 •

edited

Loading

jmartinesp left a comment •

edited

Loading

jmartinesp Jul 17, 2024

jmartinesp Jul 17, 2024

ganfra Jul 17, 2024

jmartinesp Jul 17, 2024

sonarcloud bot commented Jul 17, 2024

bmarty left a comment

Performance : improve time to open a room. #3186

Performance : improve time to open a room. #3186

Conversation

ganfra commented Jul 12, 2024 • edited Loading

Content

Motivation and context

Screenshots / GIFs

Tests

Tested devices

Checklist

github-actions bot commented Jul 12, 2024 • edited Loading

codecov bot commented Jul 12, 2024 • edited Loading

Codecov Report

bmarty commented Jul 15, 2024

frebib commented Jul 15, 2024 • edited Loading

ganfra commented Jul 15, 2024 • edited Loading

jmartinesp left a comment • edited Loading

Choose a reason for hiding this comment

jmartinesp Jul 17, 2024

Choose a reason for hiding this comment

jmartinesp Jul 17, 2024

Choose a reason for hiding this comment

ganfra Jul 17, 2024

Choose a reason for hiding this comment

jmartinesp Jul 17, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Jul 17, 2024

Quality Gate passed

bmarty left a comment

Choose a reason for hiding this comment

ganfra commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

codecov bot commented Jul 12, 2024 •

edited

Loading

frebib commented Jul 15, 2024 •

edited

Loading

ganfra commented Jul 15, 2024 •

edited

Loading

jmartinesp left a comment •

edited

Loading