Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👍 Remove args from error messages of call/batch #376

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

lambdalisue
Copy link
Member

@lambdalisue lambdalisue commented Jun 24, 2024

args may contains some sensitive information or massive data.

It follows the decision in #374

Summary by CodeRabbit

  • Refactor

    • Improved error message formatting in Neovim and Vim integrations to provide clearer context during function call failures.
  • Tests

    • Updated test error messages for Neovim and Vim to reflect the new error format for better readability and debugging.

`args` may contains some sensitive information or massive data.
Copy link

coderabbitai bot commented Jun 24, 2024

Walkthrough

The changes primarily involve the removal of the formatCall function from the denops/@denops-private package. This removal prompts modifications in various files to adjust how error messages are formatted, making them more descriptive by directly referencing the called functions rather than relying on formatCall for these tasks.

Changes

Files Change Summaries
denops/.../host.ts Removed formatCall function from exports.
denops/.../host/nvim.ts, denops/.../host/vim.ts Updated imports to exclude formatCall, adjusted error messages to directly mention function calls.
denops/.../host/nvim_test.ts, denops/.../host/vim_test.ts Updated error message strings in tests to reflect new formatting approach.

Poem

In the code where functions call,
No more formatCall to stall,
Direct and clear, the error's sound,
Function names will now be found.
Neovim and Vim both cheer,
As tweaks make the path more clear.
🎉🐇 Code refined, with changes near!


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

@lambdalisue lambdalisue merged commit b1a21ac into main Jun 24, 2024
7 checks passed
@lambdalisue lambdalisue deleted the fix-call-batch-error-message branch June 24, 2024 16:29
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
denops/@denops-private/host/vim.ts (1)

Line range hint 110-116: Refactor suggestion: Remove redundant else clause.

The else clause is unnecessary and can be omitted to simplify the code structure.

- else if (isInvokeMessage(expr)) {
+ if (isInvokeMessage(expr)) {
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fec75b9 and 30b47a3.

Files selected for processing (5)
  • denops/@denops-private/host.ts (1 hunks)
  • denops/@denops-private/host/nvim.ts (3 hunks)
  • denops/@denops-private/host/nvim_test.ts (2 hunks)
  • denops/@denops-private/host/vim.ts (3 hunks)
  • denops/@denops-private/host/vim_test.ts (2 hunks)
Files skipped from review due to trivial changes (2)
  • denops/@denops-private/host.ts
  • denops/@denops-private/host/nvim_test.ts
Additional context used
Learnings (1)
denops/@denops-private/host/vim.ts (1)
User: Milly
PR: vim-denops/denops.vim#352
File: denops/@denops-private/testutil/host.ts:3-4
Timestamp: 2024-05-25T06:35:34.785Z
Learning: `Neovim` and `Vim` from `../host/nvim.ts` and `../host/vim.ts` are classes and should be imported normally if they are instantiated in the code.
Biome
denops/@denops-private/host/vim.ts

[error] 110-116: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.

Additional comments not posted (6)
denops/@denops-private/host/vim.ts (2)

56-56: Approved: Updated error message format in call method.

The error message now correctly formats the function name within single quotes, enhancing readability and security by not exposing arguments.


75-78: Approved: Updated error message format in batch method.

The error message now includes the function name in a clear format, aligning with the updated error handling strategy.

denops/@denops-private/host/nvim.ts (2)

66-66: Approved: Updated error message format in call method.

The error message now correctly formats the function name within single quotes, enhancing readability and security by not exposing arguments.


83-86: Approved: Updated error message format in batch method.

The error message now includes the function name in a clear format, aligning with the updated error handling strategy.

denops/@denops-private/host/vim_test.ts (2)

73-73: Approved: Updated error message format in test for call method.

The test now correctly checks for the updated error message format, ensuring consistency with the main codebase.


99-99: Approved: Updated error message format in test for batch method.

The test now correctly checks for the updated error message format, ensuring consistency with the main codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant