Skip to content

Fixing ListBatches REST path filter silently returns empty on wrong batch_key encoding#2137

Open
sergey3bv wants to merge 2 commits into
lightninglabs:mainfrom
sergey3bv:fix/rest-empty-return
Open

Fixing ListBatches REST path filter silently returns empty on wrong batch_key encoding#2137
sergey3bv wants to merge 2 commits into
lightninglabs:mainfrom
sergey3bv:fix/rest-empty-return

Conversation

@sergey3bv
Copy link
Copy Markdown
Contributor

Should close #2080

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where the ListBatches REST endpoint would silently return empty results when provided with incorrectly encoded batch keys. By migrating the path parameter to a string-based representation and introducing strict validation logic, the API now provides clear feedback when invalid inputs are received, improving robustness and developer experience.

Highlights

  • REST API Path Update: Updated the ListBatches REST endpoint to use batch_key_str instead of batch_key in the path to ensure proper handling of batch key encoding.
  • Error Handling: Implemented explicit validation for batch_key and batch_key_str filters, ensuring that malformed or empty keys now return an InvalidArgument error instead of silently returning empty results.
  • Testing: Added a new integration test to verify that the REST endpoint correctly rejects malformed batch keys with appropriate status codes.
New Features

🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@sergey3bv sergey3bv force-pushed the fix/rest-empty-return branch from 46aaa41 to 4ad88ea Compare May 15, 2026 11:19
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the ListBatches REST endpoint to use batch_key_str in the path and ensures that malformed or empty batch keys return an InvalidArgument error. It also adds an integration test to verify correct handling of various batch key encodings. Feedback focuses on adhering to the repository style guide, specifically regarding the placement of comments within switch statements and the minimization of lines for error message formatting in rpcserver.go.

Comment thread rpcserver/rpcserver.go Outdated
Comment thread rpcserver/rpcserver.go Outdated
Comment thread rpcserver/rpcserver.go Outdated
Comment thread rpcserver/rpcserver.go Outdated
Comment thread rpcserver/rpcserver.go Outdated
Comment thread rpcserver/rpcserver.go Outdated
Comment thread rpcserver/rpcserver.go Outdated
// parallel tranches, tapd block processing can be slow so we use a
// generous timeout.
ccTransferTimeout = 2 * time.Minute
ccTransferTimeout = 3 * time.Minute
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please remove from PR.

Comment thread itest/backup_test.go
Comment on lines +478 to +480
ctxt, cancel := context.WithTimeout(
ctxb, defaultWaitTimeout*4,
)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please remove from PR.

Comment thread rpcserver/rpcserver.go
"invalid batch_key: %v", err)
}

default:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

either no default here or a generic unsupported filter type with a // should be unreachable comment.

Comment thread itest/assets_test.go
batchKey,
),
statusCode: []int{
http.StatusBadRequest, http.StatusNotFound,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why accept multiple status codes here?

Comment thread itest/assets_test.go
}

for _, testCase := range testCases {
testCase := testCase
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not needed in modern Go 1.22+

Comment thread rpcserver/rpcserver.go
return nil, fmt.Errorf("invalid batch key string: %w",
err)
return nil, status.Errorf(codes.InvalidArgument,
"invalid batch_key: %v", err)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

old error messages seemed alright. Here you are pretending to now what the field name is (happens to also be wrong since it's batch_key_str).

Comment thread rpcserver/rpcserver.go
if err != nil {
return nil, fmt.Errorf("invalid batch key: %w", err)
return nil, status.Errorf(codes.InvalidArgument,
"invalid batch_key: %v", err)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

old error messages seemed alright. Here you are pretending to now what the field name is (happens to also be wrong since it's batch_key_str).

Comment thread rpcserver/rpcserver.go
if err != nil {
return nil, fmt.Errorf("invalid batch key: %w", err)
return nil, status.Errorf(codes.InvalidArgument,
"invalid batch_key: %v", err)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

old error messages seemed alright. Here you are pretending to now what the field name is.

@github-project-automation github-project-automation Bot moved this from 🆕 New to 👀 In review in Taproot-Assets Project Board May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

ListBatches REST path filter silently returns empty on wrong batch_key encoding

2 participants