Fix: error when closing the result buffer and trying to reopen it

[javoscript]

WHAT

Steps to reproduce bug without fix:

• have plugin configured to show results in split mode
• execute a request
• close the output buffer with :q
• try to execute another request
• error is triggered

...javo/.local/share/nvim/lazy/hurl.nvim/lua/hurl/split.lua:27: Failed to rename buffer
stack traceback:
	[C]: in function 'nvim_buf_set_name'
	...javo/.local/share/nvim/lazy/hurl.nvim/lua/hurl/split.lua:27: in function 'show'
	.../javo/.local/share/nvim/lazy/hurl.nvim/lua/hurl/main.lua:248: in function <.../javo/.local/share/nvim/lazy/hurl.nvim/lua/hurl/main.lua:200>

WHY

Annoying bug 🐛

HOW

Call the quit() function, which has some extra functionality, instead of split:unmount() directly on the BufLeave event handler.

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• Linter
• Tests
• Review comments
• Security

Summary by CodeRabbit

• New Features

  • Improved buffer management when exiting components, enhancing user experience during navigation.

• Bug Fixes

  • Ensured that buffers are properly cleaned up and closed to prevent conflicts upon reopening.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[ellipsis-dev]

Your free trial has expired. To keep using Ellipsis, sign up at https://app.ellipsis.dev for $20/seat/month or reach us at help@ellipsis.dev

[changeset-bot]

⚠️ No Changeset found

Latest commit: 03e4c74

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The changes enhance the M.show method in split.lua by introducing a new quit() function that centralizes the logic for closing and cleaning up buffers. This function is triggered when exiting a buffer and via a key mapping, improving maintainability and control flow in buffer management.

Changes

Files	Change Summary
lua/hurl/split.lua	Introduced a quit() function to manage buffer closure and cleanup, replacing direct calls to split:unmount(). This centralization improves code maintainability and control flow.

Poem

🐰 In the land of code so bright,
A quit() function brings delight.
Buffers close, no fuss, no fight,
Clean and clear, a joyful sight!
Hopping through the lines we weave,
Maintainability, we believe! 🌟

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e498c32 and 6700427.

Files selected for processing (1)

• lua/hurl/split.lua (3 hunks)

Additional comments not posted (2)

lua/hurl/split.lua (2)

20-25: LGTM! Centralized buffer cleanup logic.

The quit function centralizes buffer cleanup logic, ensuring a cleaner and more maintainable approach.

---

38-39: LGTM! Ensure the quit function is correctly invoked.

The BufLeave event handler now calls the quit function instead of directly invoking split:unmount().

Verification successful

---

The quit function is correctly invoked in place of split:unmount().

The BufLeave event handler now calls the quit function, which includes the split:unmount() call, ensuring the intended functionality is preserved.

• lua/hurl/split.lua: The quit function is defined and invoked correctly.
• lua/hurl/popup.lua: The quit function is defined and invoked correctly.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the `quit` function is correctly invoked in the codebase.

# Test: Search for the `quit` function usage. Expect: Only occurrences of the new implementation.
rg --type lua -A 5 $'quit'

Length of output: 1906

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6700427 and 03e4c74.

Files selected for processing (1)

• lua/hurl/split.lua (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• lua/hurl/split.lua

[jellydn]

Thanks. LGTM!

[jellydn]

@all-contributors add @javoscript for code.

[allcontributors]

@jellydn

@javoscript already contributed before to code