Flow based Event Emitter #35

sacOO7 · 2024-10-24T09:35:42Z

No description provided.

added comments accordingly

…ager

coderabbitai · 2024-10-24T09:35:49Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sacOO7 · 2024-10-24T12:52:01Z

chat-android/src/main/java/com/ably/chat/FlowEmitter.kt

+    fun offAll()
+}
+
+open class FlowEmitter<V>(scope: CoroutineScope = CoroutineScope(Dispatchers.Default)) : Emitter<V> {


Flow is async in nature. It doesn't take a deterministic approach to canceled collectors.
Also, SDK methods are a with a mix of suspending and nonsuspending functions.
So, designing an emitter that works for both using flow kinda feels antipattern : (
Also, while writing few tests, I found, it doesn't work as expected. Especially when you cancel the subscription, because collect is async in nature and can collect values later in time.
In the case of ably-java based emitter, values emitted are triggered by emit itself, so it's deterministic.

Flow doesn't provide any deterministic methods to cancel the collector, rather they ask to cancel the parent coroutine that launched it. This can also cancel active job running inside collector

I can push some failing/flaky tests. So, will keep this on hold.

Also, collectors can cause memory leaks if not properly handled/ closed : (

sacOO7 · 2024-10-25T09:07:47Z

chat-android/src/test/java/com/ably/chat/FlowEmitterTest.kt

+import org.junit.Assert
+import org.junit.Test
+
+class FlowEmitterTest {


This simple emitter test doesn't work : (

I think Flows are meant for specific requirements for broadcasting events and don't fit right into the ably specific emitter pattern.
Kotlin doesn't provide flexible API around collectors, getting active collectors, canceling them, etc. Dangling collectors can also cause memory leaks.
If we want to implement (coroutine/scope-based) emitters in Kotlin, It's better to do it using simple DS like ConcurrentList instead

2f12adb have fixed the test, but had to make on method blocking and add extra workaround (emit null as end of stream) to make flows work as expected

sacOO7 · 2024-10-26T13:03:48Z

Superseded by #38

sacOO7 added 2 commits October 23, 2024 16:39

Implemented doRetry mechanism when room attach fails,

60905b8

added comments accordingly

Implemented flow based emitter/eventemitter, used inside LifeCycleMan…

3b31ec3

…ager

sacOO7 commented Oct 24, 2024

View reviewed changes

Added simple flowemitter test with relevant comments for Emitter

e00ead4

sacOO7 commented Oct 25, 2024

View reviewed changes

Updated Emitter#on to be blocking in order to fix failing test

2f12adb

sacOO7 force-pushed the feature/roomlifecycle-attach-with-retry branch from 60905b8 to f091c71 Compare October 25, 2024 10:49

sacOO7 mentioned this pull request Oct 26, 2024

Simple thread safe event emitter #38

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flow based Event Emitter #35

Flow based Event Emitter #35

sacOO7 commented Oct 24, 2024

coderabbitai bot commented Oct 24, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

sacOO7 Oct 24, 2024 •

edited

Loading

sacOO7 Oct 24, 2024

sacOO7 Oct 24, 2024

sacOO7 Oct 24, 2024 •

edited

Loading

sacOO7 Oct 25, 2024 •

edited

Loading

sacOO7 Oct 25, 2024 •

edited

Loading

sacOO7 commented Oct 26, 2024

Flow based Event Emitter #35

Are you sure you want to change the base?

Flow based Event Emitter #35

Conversation

sacOO7 commented Oct 24, 2024

coderabbitai bot commented Oct 24, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

sacOO7 Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

sacOO7 Oct 24, 2024

Choose a reason for hiding this comment

sacOO7 Oct 24, 2024

Choose a reason for hiding this comment

sacOO7 Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

sacOO7 Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

sacOO7 Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

sacOO7 commented Oct 26, 2024

CodeRabbit Configuration File (`.coderabbit.yaml`)

sacOO7 Oct 24, 2024 •

edited

Loading

sacOO7 Oct 24, 2024 •

edited

Loading

sacOO7 Oct 25, 2024 •

edited

Loading

sacOO7 Oct 25, 2024 •

edited

Loading