Notification events resolving and rendering in batches #4722
+881
−512
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright 2025 New Vector Ltd. | ||
| * | ||
| * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial | ||
| * Please see LICENSE files in the repository root for full details. | ||
| */ | ||
|
|
||
| package io.element.android.libraries.push.impl.notifications | ||
|
|
||
| import io.element.android.libraries.di.AppScope | ||
| import io.element.android.libraries.di.SingleIn | ||
| import io.element.android.libraries.matrix.api.core.EventId | ||
| import io.element.android.libraries.matrix.api.core.RoomId | ||
| import io.element.android.libraries.matrix.api.core.SessionId | ||
| import io.element.android.libraries.push.impl.notifications.model.ResolvedPushEvent | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.ExperimentalCoroutinesApi | ||
| import kotlinx.coroutines.channels.Channel | ||
| import kotlinx.coroutines.delay | ||
| import kotlinx.coroutines.flow.MutableSharedFlow | ||
| import kotlinx.coroutines.flow.SharedFlow | ||
| import kotlinx.coroutines.isActive | ||
| import kotlinx.coroutines.launch | ||
| import timber.log.Timber | ||
| import javax.inject.Inject | ||
| import kotlin.time.Duration.Companion.milliseconds | ||
|
|
||
| @OptIn(ExperimentalCoroutinesApi::class) | ||
| @SingleIn(AppScope::class) | ||
| class NotificationResolverQueue @Inject constructor( | ||
| private val notifiableEventResolver: NotifiableEventResolver, | ||
| private val coroutineScope: CoroutineScope, | ||
| ) { | ||
| companion object { | ||
| private const val BATCH_WINDOW_MS = 250L | ||
| } | ||
| private val requestQueue = Channel<NotificationEventRequest>(capacity = 100) | ||
|
|
||
| val results: SharedFlow<Pair<List<NotificationEventRequest>, List<ResolvedPushEvent>>> = MutableSharedFlow() | ||
|
|
||
| init { | ||
| coroutineScope.launch { | ||
| while (coroutineScope.isActive) { | ||
| // Wait for a batch of requests to be received in a specified time window | ||
| delay(BATCH_WINDOW_MS.milliseconds) | ||
|
There was a problem hiding this comment. Are you sure this code will behave as a first throttler? There was a problem hiding this comment. It doesn't have to act as a throttle operation, but as a window one, grouping events that happen in an interval in batches. Those batches won't always be optimal, since as you say, if you receive one after one window closes it'll be processed on the next one. If you think it's worth it implementing it more in a throttle/debounce way (without discarding items as those operators usually do) I can try to do that. There is the possibility that this means we chain lots of 'received item, wait for X ms' operations and end up delaying the processing for longer, but it's not really likely to happen in the real world except maybe for when you have several pushes in firebase that couldn't be delivered, the device reconnects and it starts receiving the pending pushes. There was a problem hiding this comment. Done in bd27b50, it seems to work quite well. |
||
|
|
||
| val groupedRequestsById = buildList { | ||
| while (!requestQueue.isEmpty) { | ||
| requestQueue.receiveCatching().getOrNull()?.let(this::add) | ||
| } | ||
| }.groupBy { it.sessionId } | ||
|
|
||
| val sessionIds = groupedRequestsById.keys | ||
| for (sessionId in sessionIds) { | ||
| val requests = groupedRequestsById[sessionId].orEmpty() | ||
| Timber.d("Fetching notifications for $sessionId: $requests. Pending requests: ${!requestQueue.isEmpty}") | ||
|
|
||
| launch { | ||
| // No need for a Mutex since the SDK already has one internally | ||
| val notifications = notifiableEventResolver.resolveEvents(sessionId, requests).getOrNull().orEmpty() | ||
| (results as MutableSharedFlow).emit(requests to notifications.values.filterNotNull()) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| suspend fun enqueue(request: NotificationEventRequest) { | ||
| requestQueue.send(request) | ||
| } | ||
| } | ||
|
|
||
| data class NotificationEventRequest( | ||
| val sessionId: SessionId, | ||
| val roomId: RoomId, | ||
| val eventId: EventId, | ||
| val providerInfo: String, | ||
| ) | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At first sight, it's strange that the return type is not
Result<Map<RoomId, List<NotificationData>>>There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was like that originally, but where it's immediately used later (here) having the notifications grouped by room id doesn't really help, we'd have to first search for the room, then use
notifications.find { it.eventId == eventId }. Using having the id -> data mapping is more optimised.