Add aggregation for DSL API

SuLG-ik commented 8 months ago

To extend behaviour of store executor dsl api, you should to use something like

onIntentSkipping<AccountProfileSettingStore.Intent, _, _, _, _, _> {

}

and extension fun somewhere with implement necessary behaviour. With aggregation with ExecutionHandler you can add your own implementation for intent/action execution like filter by type TypeCheckExecutionHander, just call intent DirectExecutionHandler and aggregate one above another. For example, I add useful ExecutionHandler such as CoroutineSkippingExecutionHandler which skip intents while previous is in execution. This aggregation extract to common mvikotlin module with ExecutorBuilder and abstract DslExecutorImpl, which implements common logic of process ExecutionHandlers.

For users, they will be able to create custom ExecutionHandlers and use it as

onIntent(customExecutionHandler<Intent> {
/* some logic with Coroutine/ReactiveExecutorScope */
})

with usage of typedExecutionHander under the hood and own ExecutionHandler.

Other abilities with ExecutionHandlers as simple and extendable api are execute with debounce, execute after cancel previous intents, intents queue, which is able to become part of mvikotlin

Summary by CodeRabbit

New Features
- Introduced coroutine and reactive execution handling in MVI architecture, enhancing support for coroutine and reactive programming patterns.
- Added new classes and functions for managing coroutine and reactive execution within MVI components.
- Implemented new testing capabilities to verify coroutine execution scenarios.
Refactor
- Updated and renamed classes to align with coroutine and reactive execution paradigms.
- Improved method signatures and refactored handler registration methods for better clarity and functionality.
Documentation
- Enhanced documentation to clearly describe the purpose and usage of new execution handling features.

coderabbitai[bot] commented 8 months ago

Walkthrough

The recent updates introduce comprehensive support for coroutine and reactive programming within the MVI Kotlin framework. These changes streamline the execution of intents and actions through the addition of specialized execution handlers and DSLs for both coroutines and reactive programming. The modifications enhance the framework's flexibility and efficiency in handling asynchronous operations, making it more adaptable to various programming paradigms.

Changes

Files	Summary
`mvikotlin-extensions-coroutines/.../CoroutineExecutionHandler.kt`, `mvikotlin-extensions-coroutines/.../CoroutineExecutorDsl.kt`, `mvikotlin-extensions-coroutines/.../CoroutineExecutorDslTest.kt`	Introduced functions, classes, and tests for managing coroutine execution in MVI components.
`mvikotlin-extensions-reaktive/.../ReactiveExecutionHandler.kt`, `mvikotlin-extensions-reaktive/.../ReaktiveExecutorDsl.kt`	Added support for reactive programming with the introduction of `reactiveExecutionHandler` and updates to the executor DSL.
`mvikotlin/.../ExecutionHandler.kt`, `mvikotlin/.../ExecutorBuilder.kt`, `mvikotlin/.../ExecutorImpl.kt`	Implemented an `ExecutionHandler` interface, an abstract `ExecutorBuilder` class, and an abstract `DslExecutorImpl` class for handling execution within the MVI architecture.

🐰✨

In the land of MVI, where coroutines play,
A rabbit hopped in, with updates to convey.
"With reactive streams, and coroutines' might,
Handle intents and actions, both day and night."
So here's to the changes, both big and small,
May your code run smoothly, bugs none at all!
🌟🐇

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

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 .` - `Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

arkivanov commented 7 months ago

Sorry, but it's not clear what this PR does and what problems it solves. Also the PR description is very confusing. Please file an issue with a clear description of your use cases and code snippets. Please describe how do you write your code with current API and what exactly you don't like.

arkivanov / MVIKotlin