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

Fix input sanitation for listchaintxns lncli cmd #9558

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kornpow
Copy link
Contributor

@kornpow kornpow commented Feb 26, 2025

Change Description

This PR was based originally on the PR #7496 and issue #7316 .

Upon rebasing and looking at the solutions there, I found the bigger problem with the command was the lack of error messaging when the end_height < start_height rather than the necessity to support a "reverse ordering" feature.

So while in a separate soon so be opened PR I also implemented "reverse ordering" I thought I would open this one first, as it is more straightforward and an improvement necessary, whether or not reverse ordering is needed/wanted.

This is my first code commit to LND, 2nd including a comment update, so I appreciate the help to getting this PR mergable!

Steps to Test

Try using different options for start_height and end_height, including them, not including them, and having integer values in a way which doesn't make sense, and ensure that the proper errors are shown.

Pull Request Checklist

Testing

  • Your PR passes all CI checks.
  • Tests covering the positive and negative (error paths) are included.
  • Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

📝 Please see our Contribution Guidelines for further guidance.

Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

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.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@kornpow kornpow force-pushed the fix-listchaintxns-lncli-inputs branch 2 times, most recently from 4f4641d to fa5d0b4 Compare February 26, 2025 23:06
Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Thanks for the fix. Makes sense, I think the "will be queried in reverse" was probably from an earlier version of the PR that added the offset.

- Added reverse flag to listchaintxns command.
- Listchaintxns command returns error when start_height is
less than end_height if end_height is not -1.
@kornpow kornpow force-pushed the fix-listchaintxns-lncli-inputs branch from fa5d0b4 to 60b4c13 Compare February 27, 2025 16:53
@kornpow
Copy link
Contributor Author

kornpow commented Feb 27, 2025

"will be queried in reverse"

This wording has been there for a long time, and its what inspired the original issue/PR, even before the offset PR. But now we fixed the help text, we don't have to implement it.

@kornpow kornpow requested a review from guggero February 27, 2025 18:33
@kornpow
Copy link
Contributor Author

kornpow commented Feb 27, 2025

@guggero I would like to potentially add a test for this, but I am not really sure where? Maybe there isnt tests for these kinds of things.

@guggero
Copy link
Collaborator

guggero commented Feb 28, 2025

@guggero I would like to potentially add a test for this, but I am not really sure where? Maybe there isnt tests for these kinds of things.

You could extract the argument parsing into a function, then write a unit test for that in cmd/commands/commands_test.go.

The other approach would be an integration test that executes the binary directly. See

func testDebuglevelShow(ht *lntest.HarnessTest) {

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.

2 participants