:+1: Gracefully close service

Milly commented 2 months ago

The Service is closed when The worker is terminated.
The worker is teminated when The Service is closed.
denops.dispatch() (but service.dispatch()) rejects with a service closed error if the service is closed before the plugin loaded.

Summary by CodeRabbit

New Features
- Enhanced Service class with new asynchronous disposal capabilities.
- Introduced new methods for service closure management.
Tests
- Added test cases for new close() and waitClosed() methods.
- Updated tests to cover asynchronous disposal and service closure scenarios.
Bug Fixes
- Improved reliability of service state management and error handling.

coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

Walkthrough

These changes revise the Service class to implement AsyncDisposable instead of Disposable, introducing new async closure functionalities and states. Test cases are updated to reflect these changes, focusing on service closure and promise handling. Additionally, modifications in the worker demonstrate how services now handle async disposal.

Changes

Files	Change Summaries
denops/@denops-private/service.ts	Updated `Service` class to implement `AsyncDisposable`, added `#closed` flag and associated methods (`close`, `waitClosed`).
denops/@denops-private/service_test.ts	Removed outdated test case for `reload()`, added tests for new closure and promise handling methods in `Service`.
denops/@denops-private/worker.ts	Added `await` for service initialization and included `service.waitClosed()` in control flow.
denops/@denops-private/worker_test.ts	Added new imports, spies, and test validations for async disposal of services and hosts.

Sequence Diagram(s)

sequenceDiagram
    participant Host
    participant Service
    participant Worker

    Note over Worker,Service: Service initialization with async disposal
    Worker->>+Service: new Service(meta) (await initialization)
    Worker->>Service: Promise.race([... , service.waitClosed()])
    Host->>Worker: Trigger event
    Worker->>Service: Close service (trigger close())

    Note over Service: Service closure sequence
    Service->>Worker: Resolve waitClosed()
    Worker->>Host: Resolve Promise.race()

Poem

In code's vast fields, new paths unfold, Async closures, stories told. Service waits in silent grace, Until the end, it holds its place. Tests arise, new dawn’s light, With closure’s promise, futures bright. 🌟✨

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](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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 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 as 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. 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. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.53%. Comparing base (6155f40) to head (cf2473f).

:exclamation: Current head cf2473f differs from pull request most recent head 1f861cf

Please upload reports for the commit 1f861cf to get more accurate results.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## v7-pre #368 +/- ## ========================================== + Coverage 92.35% 92.53% +0.17% ========================================== Files 20 20 Lines 1204 1232 +28 Branches 136 138 +2 ========================================== + Hits 1112 1140 +28 Misses 89 89 Partials 3 3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Milly commented 2 months ago

@coderabbitai review

coderabbitai[bot] commented 2 months ago

Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

vim-denops / denops.vim