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: change restart reconnect behavior #379

Closed Milly closed 2 months ago

Milly commented 2 months ago

Problem

The behavior of restart and reconnection is inconsistent with the documentation. There are g:denops#server#retry_*, g:denops#server#restart_* and g:denops#server#reconnect_* variables which can be confusing.

Fixes

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The update enhances the Denops plugin by refining server connection logic, adding error handling and reconnection capabilities, and improving test utilities for server behavior. A new connect_or_start function initiates server connections, while failure callbacks manage reconnections. These changes ensure robust server management, streamlined initialization, and improved test coverage.

Changes

File or Directory Summary
autoload/denops/_internal/server/chan.vim Improved connection logic, error handling, and reconnection management by adding new functions and parameters.
autoload/denops/_internal/server/proc.vim Refined process handling with debug outputs, restart delayer, and clear restart logic.
autoload/denops/server.vim Added connect_or_start function to manage server connection and refactored status function.
denops/@denops-private/testutil/host.ts Introduced mode property and updated function calls to pass this property.
denops/@denops-private/testutil/shared_server.ts Added port parameter for server initialization and refactored address handling.
denops/@denops-private/testutil/shared_server_test.ts Enhanced tests to assert addr, host, port, and toString() values for server address.
doc/denops.txt Updated descriptions of server-related variables for clearer understanding of restart and reconnect behavior.
plugin/denops.vim Refactored initialization logic to use connect_or_start function during Vim startup.
tests/denops/server_test.ts Expanded tests for server shutdown, status handling, process events, and reconnect scenarios with improved coverage.

Sequence Diagram(s)

sequenceDiagram
    participant Vim as Vim
    participant Denops as Denops Plugin
    participant Server as Server

    Note over Vim: Server Initialization on Vim Start
    Vim->>Denops: Call connect_or_start()
    Denops->>Server: Attempt to Connect
    alt Connection Success
        Server-->>Denops: Successful Connection
        Denops-->>Vim: Server Ready
    else Connection Failure
        Server-->>Denops: Connection Failed
        Denops->>Server: Schedule Reconnect
    end

    Note over Denops: Reconnect Logic on Failure
    Denops->>Server: Reconnect Attempt
    Server-->>Denops: Connection Status

    Note over Tests: Test Scenarios
    Tests->>Vim: Simulate Server Events
    Vim->>Denops: Handle Events (Ready, Closed, etc.)
    Denops-->>Tests: Verify Correct Behavior

Poem

🐇 In the lands of code, where servers connect, Debugs and retries, no bug can deflect. With callbacks and guards, reconnections start, Denops now sings a more resilient part. Through tests and tweaks, our journey thus, A server strong, built robust by us! 🌐💻✨


[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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 72.72727% with 3 lines in your changes missing coverage. Please review.

Project coverage is 92.25%. Comparing base (97ed0ff) to head (c36cc9c).

Files Patch % Lines
denops/@denops-private/testutil/host.ts 33.33% 2 Missing :warning:
denops/@denops-private/testutil/shared_server.ts 87.50% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## v7-pre #379 +/- ## ========================================== - Coverage 92.30% 92.25% -0.05% ========================================== Files 21 21 Lines 1286 1291 +5 Branches 142 143 +1 ========================================== + Hits 1187 1191 +4 - Misses 96 97 +1 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.