vim-denops / denops.vim

🐜 An ecosystem of Vim/Neovim which allows developers to write cross-platform plugins in Deno
https://vim-denops.github.io/denops-documentation/
MIT License
666 stars 33 forks source link

:+1: Gracefully terminate worker #363

Closed Milly closed 2 months ago

Milly commented 2 months ago

When the cli process traps SIGINT, it will do the following:

When the connection is disconnected, it will do the following:

This PR alone does not include any new features. This is because the termination processing of the worker has not been implemented. This will allow we to implement the termination processing of the worker.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The updates focus on refactoring how connections and worker processes are handled, enhanced error and signal management, and improved testing. Key improvements include renaming functions, using new utilities for async signal handling, managing connections and processes more efficiently, and refining test logic. These changes collectively enhance the robustness and maintainability of the system.

Changes

File Summary
denops/.../cli.ts Refactored connection handling, introduced processWorker, improved error handling, and added signal management.
denops/.../cli_test.ts Updated imports and test logic to align with new connection and signal handling mechanisms.
denops/.../testutil/shared_server.ts Refactored stdout handling, added an abort function for cancellations, and improved disposal error handling.
denops/.../worker.ts Added signal handling for SIGINT and modified worker process flow.
denops/.../worker_test.ts Updated imports, added stubs, and adjusted tests for new signal and worker handling.
tests/denops/server_test.ts Removed verbose: true setting from a test to adjust verbosity levels.

Sequence Diagram

sequenceDiagram
    participant CLI as cli.ts
    participant Worker as worker.ts
    participant Listener as TCP Listener
    participant Signal as SIGINT

    CLI->>Listener: Start listening for connections
    Listener-->>CLI: New connection

    CLI->>Worker: processWorker(conn)
    Note over Worker: Worker processes the connection<br>and manages termination

    Signal-->>Worker: SIGINT triggered
    Worker->>CLI: Handle SIGINT, close connection
    CLI->>Listener: Continue listening

    Signal-->>Worker: Wait for signal
    Worker-->>Signal: Handle signal
    Worker->>CLI: Ensure all connections are terminated

Poem

In fields of code where bytes do leap, A rabbit hops, refactors deep. Connections managed with great care, Signals handled in the air. Tests renewed, robustness found, In this warren, code's profound. 🐇✨


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

Attention: Patch coverage is 96.20253% with 3 lines in your changes missing coverage. Please review.

Project coverage is 92.37%. Comparing base (e8e6d8c) to head (38980d9).

Files Patch % Lines
denops/@denops-private/testutil/shared_server.ts 92.85% 2 Missing :warning:
denops/@denops-private/cli.ts 97.72% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## v7-pre #363 +/- ## ========================================== - Coverage 92.54% 92.37% -0.18% ========================================== Files 20 20 Lines 1154 1206 +52 Branches 125 134 +9 ========================================== + Hits 1068 1114 +46 - Misses 83 89 +6 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.