-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
[ECO-5013] feat: Implement room lifecycle monitoring #94
Draft
sacOO7
wants to merge
5
commits into
main
Choose a base branch
from
feature/CHA-RL4-room-monitoring
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a7323c1
[ECO-5013][RTE1] Implemented emitter as per spec RTE1
sacOO7 4275f88
[ECO-5013][CHA-RL4] Updated RoomLifecycleManager
sacOO7 cd73b44
[ECO-5013][CHA-RL4] Updated RoomLifecycleManager operationInProgress …
sacOO7 95f0ff9
[ECO-5013][CHA-RL4] Updated RoomLifecycleManager
sacOO7 64159a0
[ECO-5013][CHA-RL4] Updated RoomLifecycleManager, annotated implement…
sacOO7 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| package com.ably.chat | ||
|
|
||
| import java.util.TreeSet | ||
| import java.util.concurrent.LinkedBlockingQueue | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.launch | ||
|
|
||
| /** | ||
| * Kotlin Emitter interface for supplied value | ||
| * Spec: RTE1 | ||
| */ | ||
| internal interface Emitter<V> { | ||
| fun emit(value: V) | ||
| fun on(block: suspend CoroutineScope.(V) -> Unit): Subscription | ||
| fun once(block: suspend CoroutineScope.(V) -> Unit): Subscription | ||
| fun offAll() | ||
| } | ||
|
|
||
| /** | ||
| * ScopedEmitter is a thread-safe, non-blocking emitter implementation for Kotlin. | ||
| * It ensures that all subscribers receive events asynchronously in the same order under given scope. | ||
| * | ||
| * @param V The type of value to be emitted. | ||
| * @param subscriberScope The CoroutineScope in which the subscribers will run. Defaults to Dispatchers.Default. | ||
| * @param logger An optional logger for logging errors during event processing. | ||
| */ | ||
| internal class ScopedEmitter<V> ( | ||
| private val subscriberScope: CoroutineScope = CoroutineScope(Dispatchers.Default), | ||
| private val logger: Logger? = null, | ||
| ) : Emitter<V> { | ||
|
|
||
| // Sorted list of unique subscribers based on supplied block | ||
| private val subscribers = TreeSet<AsyncSubscriber<V>>() | ||
|
|
||
| // Emitter scope to make sure all subscribers receive events in same order. | ||
| // Will be automatically garbage collected once all jobs are performed. | ||
| private val sequentialScope = CoroutineScope(Dispatchers.Default.limitedParallelism(1)) | ||
|
|
||
| val finishedProcessing: Boolean | ||
| get() = subscribers.all { it.values.isEmpty() && !it.isSubscriberRunning } | ||
|
|
||
| @get:Synchronized | ||
| val subscribersCount: Int | ||
| get() = subscribers.size | ||
|
|
||
| @Synchronized | ||
| override fun emit(value: V) { | ||
| for (subscriber in subscribers.toList()) { | ||
| subscriber.inform(value) | ||
| if (subscriber.once) { | ||
| off(subscriber) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun register(subscriber: AsyncSubscriber<V>): Subscription { | ||
| subscribers.add(subscriber) | ||
| return Subscription { | ||
| off(subscriber) | ||
| } | ||
| } | ||
|
|
||
| @Synchronized | ||
| override fun on(block: suspend CoroutineScope.(V) -> Unit): Subscription { | ||
| val subscriber = AsyncSubscriber(sequentialScope, subscriberScope, block, false, logger) | ||
| return register(subscriber) | ||
| } | ||
|
|
||
| @Synchronized | ||
| override fun once(block: suspend CoroutineScope.(V) -> Unit): Subscription { | ||
| val subscriber = AsyncSubscriber(sequentialScope, subscriberScope, block, true, logger) | ||
| return register(subscriber) | ||
| } | ||
|
|
||
| @Synchronized | ||
| override fun offAll() { | ||
| subscribers.clear() | ||
| } | ||
|
|
||
| @Synchronized | ||
| private fun off(subscriber: AsyncSubscriber<V>) { | ||
| subscribers.remove(subscriber) | ||
| } | ||
| } | ||
|
|
||
| private class AsyncSubscriber<V>( | ||
| private val emitterSequentialScope: CoroutineScope, | ||
| private val subscriberScope: CoroutineScope, | ||
| private val subscriberBlock: (suspend CoroutineScope.(V) -> Unit), | ||
| val once: Boolean, | ||
| private val logger: Logger? = null, | ||
| ) : Comparable<V> { | ||
| val values = LinkedBlockingQueue<V>() // Accessed by both Emitter#emit and emitterSequentialScope | ||
| var isSubscriberRunning = false // Only accessed as a part of emitterSequentialScope | ||
|
|
||
| fun inform(value: V) { | ||
| values.add(value) | ||
| emitterSequentialScope.launch { | ||
| if (!isSubscriberRunning) { | ||
| isSubscriberRunning = true | ||
| while (values.isNotEmpty()) { | ||
| val valueTobeEmitted = values.poll() | ||
| safelyPublish(valueTobeEmitted as V) // Process sequentially, similar to core ably eventEmitter | ||
| } | ||
| isSubscriberRunning = false | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private suspend fun safelyPublish(value: V) { | ||
| runCatching { | ||
| subscriberScope.launch { | ||
| try { | ||
| subscriberBlock(value) | ||
| } catch (t: Throwable) { | ||
| // Catching exception to avoid error propagation to parent | ||
| logger?.warn("Error processing value $value", t) | ||
| } | ||
| }.join() | ||
| } | ||
| } | ||
|
|
||
| override fun compareTo(other: V): Int { | ||
| // Avoid registering duplicate anonymous subscriber block with same instance id | ||
| // Common scenario when Android activity is refreshed or some app components refresh | ||
| if (other is AsyncSubscriber<*>) { | ||
| return this.subscriberBlock.hashCode().compareTo(other.subscriberBlock.hashCode()) | ||
| } | ||
| return this.hashCode().compareTo(other.hashCode()) | ||
| } | ||
| } | ||
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
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.
I don’t think we need this, as we’re essentially reinventing Flow here. Additionally, we’re missing some crucial points in the
ScopedEmitterimplementation. In its current form, listeners will be invoked non-sequentially, which can be misleading.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.
I was hoping we could have a discussion about this eventually. I don't think we're trying to reinvent the wheel here, though the implementation might resemble shared or hot flows.
Unlike cold flows, hot flows continue emitting values even if no one is actively collecting them. This can lead to situations where the flow keeps emitting values even when the component is in the background, which could potentially cause memory leaks.
Additionally, the flow API is well-suited for use in coroutine-based functions, as both emit and collect are suspending functions. On the other hand, tryEmit can be used in non-suspending functions (like the channel.on method here), although it's generally not recommended.
Since tryEmit() is not a suspending function, it requires a buffer to store the emitted values until they are processed by subscribers. To make this work, we need to set the buffer size to unlimited, but this can affect performance and slow down other subscribers.
Another challenge is canceling flows, as there’s no guarantee that queued events will be delivered when cancellation occurs.
I'll create a separate thread to dive deeper into this and explore how the Emitter implementation can be leveraged for the existing public API to handle messages and presence events asynchronously on the Dispatchers.Default scope, as opposed to relying on the current blocking subscribers.