[Bug] QueryMessage ignores the request's pagination fields and echoes a scroll_id it never issues

Open
#11,369 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@iloveeyjafjalla is already working on this.

Since Oct 12, 2026.

  • #11370 by @iloveeyjafjalla — open

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
java
Domain
api

Research direction

Read the QueryMessage implementation and the ListMessageRequest and ListMessageResponse proto fields cited in the issue, then check §8 in docs/proxy-admin.md and docs/proxy-admin-zh.md. Reproduce with page_size: 1 and a second-page request. Done means the supported page-size cap is honored, unsupported page numbers and scroll IDs return BAD_REQUEST without echoing a cursor, and both docs describe the boundary.

Written by the indexing model from the issue text.

Description

Before Creating the Bug Report
  • I found a bug, not just asking a question, which should be created in GitHub Discussions.
  • I have searched the GitHub Issues and GitHub Discussions of this repository and believe that this is not a duplicate.
  • I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ.
Runtime platform environment

OS: any (proxy module, admin gRPC surface)

RocketMQ version

branch: develop
Git commit id: 9ea2ccdc2b41445aee5e177e14e501d606f5a1ed (2026-10-08)

JDK Version

Compiler: Temurin 1.8.0_504 (target 1.8, same as CI)

Describe the Bug

QueryMessage accepts the request's pagination fields and then ignores them, while answering OK.

The proto declares page-style pagination and a cursor:

// ListMessageRequest
// Page-style pagination parameters.
optional int32 page_num = 8;
optional int32 page_size = 9;
...
// ListMessageResponse
// Cursor to be passed back to fetch the next page.
optional string scroll_id = 3;

The implementation reads none of them: only max_message_nums is honored (defaulting to 32), and the response echoes the
request's scroll_id back:

int maxNums = request.getMaxMessageNums() > 0 ? request.getMaxMessageNums() : DEFAULT_MAX_MESSAGE_NUMS;
...
ListMessageResponse.Builder builder = ListMessageResponse.newBuilder().setStatus(ok());
if (request.hasScrollId()) {
    builder.setScrollId(request.getScrollId());
}

Consequences:

  • a caller that sets only page_size = 10 receives up to 32 messages (the default cap) instead of its page size;
  • a caller that asks for page_num = 2, or that passes the scroll_id from the previous response back, receives the same
    first page again with OK — there is no ordering or cursor behind it, so a paging client loops on the same data;
  • the echoed scroll_id claims a continuation exists that the proxy never issues.
Steps to Reproduce
  1. Run a proxy with grpcAdminServerEnable=true on a topic with more than one page of messages for a key.
  2. Call QueryMessage{message_key, page_size:1} — more than one message comes back.
  3. Call it again with page_num:2 (or with the scroll_id of the first response) — the same first page comes back with OK.
Expected behavior

The fields that can be honored are honored (a page_size acts as the result cap), and the ones the open-source broker cannot
serve — page_num beyond the first page and scroll_id, which both need a cursor the broker does not provide — are refused
with an explicit status instead of silently returning an unscoped page. scroll_id is not echoed back as if a cursor existed.

This is the rule the same RPC already applies to its unsupported search_key variants (subscription / lite_topic /
SEARCHKEY_NOT_SET → BAD_REQUEST) and the documented surface rule in docs/proxy-admin.md §8.

Actual behavior

OK with an unscoped first page; page_size ignored; a scroll_id that cannot fetch anything echoed back.

Additional context

Fix: cap the result by page_size when it is set, refuse page_num > 1 and any scroll_id with BAD_REQUEST, and document
the boundary in docs/proxy-admin.md / docs/proxy-admin-zh.md §8.

Dominant language
Java
Stars
22.7k
Forks
12k
Avg merge
3d 18h
Merged PRs (30d)
17

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/rocketmq

All issues in apache/rocketmq

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.