python-driver icon indicating copy to clipboard operation
python-driver copied to clipboard
verified publisher icon scylladb

Add paging with multi-page support to ControlConnection topology queries

Open Copilot opened this issue 2 months ago • 3 comments

Description

This PR fixes the issue where internal queries to system.peers and system.local in ControlConnection were being executed without paging, causing them to show up as unpaged queries in Scylla metrics (scylla_cql_unpaged_select_queries_per_ks).

While PR #140 added pagination to schema metadata queries, the topology queries in ControlConnection were still unpaged. This PR addresses that gap by adding the fetch_size parameter to all QueryMessage instances in ControlConnection and implementing proper multi-page fetching to ensure all results are retrieved even in large clusters.

Changes Made

  • Added fetch_size parameter to topology queries (system.peers and system.local) in _try_connect() method
  • Added fetch_size parameter to topology queries in _refresh_node_list_and_token_map() method
  • Added fetch_size parameter to local RPC address query
  • Added fetch_size parameter to schema agreement queries
  • All queries now use the existing _schema_meta_page_size parameter (default: 1000) for consistency with schema metadata queries
  • Implemented _fetch_remaining_pages() standalone function to properly handle multi-page results by fetching all pages sequentially
  • Function signature: _fetch_remaining_pages(connection, query_msg, timeout, fail_on_error=True)
  • Added fail_on_error parameter to match connection.wait_for_response behavior for proper error handling
  • When fail_on_error=False, function returns (success, result) tuple matching original behavior
  • Use if success: pattern instead of try/except for consistency with original code style
  • Added null checks to prevent AttributeError if wait_for_response fails
  • Added comprehensive unit tests to verify both fetch_size parameter is set and multi-page fetching works correctly
  • Improved code comments for clarity based on review feedback
  • Code review iterations refined the implementation:
    • Made helper function standalone (not a class method)
    • Simplified interface by removing result parameter (accepts sequential execution trade-off)
    • Removed unnecessary paging_state save/restore code
    • Added proper error handling with fail_on_error parameter

Testing

  • ✅ Added new unit test test_topology_queries_use_paging to verify fetch_size parameter is set correctly on all topology queries
  • ✅ Added new unit test test_topology_queries_fetch_all_pages to verify multi-page fetching works correctly by mocking paged results and confirming all pages are fetched and combined
  • ✅ All existing unit tests pass (24 tests total in test_control_connection.py)
  • ✅ Code review completed with all feedback addressed
  • ✅ Security scan (CodeQL) completed with no vulnerabilities

The implementation ensures that:

  1. Queries don't show up as unpaged in Scylla metrics (fixes the original issue)
  2. All nodes are discovered even in large clusters with >1000 nodes (addresses code review feedback)
  3. Behavior is consistent with how schema metadata queries handle paging
  4. Proper error handling with fail_on_error parameter matching original behavior
  5. Clean, minimal implementation following code review guidance

Pre-review checklist

  • [x] I have split my patch into logically separate commits.
  • [x] All commit messages clearly explain what they change and why.
  • [x] I added relevant tests for new features and bug fixes.
  • [x] All commits compile, pass static checks and pass test.
  • [x] PR description sums up the changes and reasons why they should be introduced.
  • [ ] I have provided docstrings for the public items that I want to introduce.
  • [ ] I have adjusted the documentation in ./docs/source/.
Original prompt

This section details on the original issue you should resolve

<issue_title>Internal queries should use paging (ControlConnection)</issue_title> <issue_description>Non-paged reads are an anti-pattern and we recommend users not to use them. Scylla has metrics that counts them and in scylla-monitoring we have a dashboard that displays it.

In investigation of https://github.com/scylladb/scylladb/issues/5983 we observed that the python driver issues non-paged reads to fetch schema after noticing schema change. When there are lots of clients connected at once this can lead to a large increase of the non-paged reads metric which can be confusing for the user, and confusing+concerning to the core developers - in the aforementioned issue we thought that Scylla itself was doing non-paged reads.

Internal queries should be change to use paging in order to reduce the confusion.</issue_description>

Comments on the Issue (you are @copilot in this section)

@mykaul > Internal queries should be changed not to use paging in order to reduce the confusion. @piodul - use or not use paging? @piodul They __should__ use paging. Sorry for the confusion. @mykaul @roydahan - looks important to me. Can we asses complexity/risk? @fruch @piodul do we have information on which driver was used ? i.e. which version of our fork ?

cause I'm quite sure the driver does use pagination for the internal queries, since: https://github.com/scylladb/python-driver/pull/140

so missing some information in this report </comment_new> <comment_new>@piodul

I just tried to reproduce this with cqlsh that I had installed on my machine (cqlsh 6.0.21), I picked up a recent master build of Scylla but the closest approximation by a released version would be 6.0.1.

For example, when cqlsh connects to the node, I see that the scylla_cql_unpaged_select_queries_per_ks{ks="system",shard="0"} metric gets bumped by 2. I'm using the following filter in wireshark:

cql.opcode == "QUERY" && cql.query.flags.page_size == 0

...and I can see that two unpaged queries pop up: SELECT * FROM system.peers and SELECT * FROM system.local WHERE key='local'.

However, I do see that this metric starts with a non-zero value (~121) right after booting up the node. Moreover, this metric grows by itself every 10 seconds. I either have some unexplained source of queries, or internal queries can increase this metric after all. It looks like the fault lies on both sides and we might have closed the Scylla issue premeturely...</comment_new> <comment_new>@fruch

I just tried to reproduce this with cqlsh that I had installed on my machine (cqlsh 6.0.21), I picked up a recent master build of Scylla but the closest approximation by a released version would be 6.0.1.

For example, when cqlsh connects to the node, I see that the scylla_cql_unpaged_select_queries_per_ks{ks="system",shard="0"} metric gets bumped by 2. I'm using the following filter in wireshark:

cql.opcode == "QUERY" && cql.query.flags.page_size == 0

...and I can see that two unpaged queries pop up: SELECT * FROM system.peers and SELECT * FROM system.local WHERE key='local'.

However, I do see that this metric starts with a non-zero value (~121) right after booting up the node. Moreover, this metric grows by itself every 10 seconds. I either have some unexplained source of queries, or internal queries can increase this metric after all. It looks like the fault lies on both sides and we might have closed the Scylla issue premeturely...

now that I took a look again on the title of the PR... it's "Metadata/Schema paginated queries"

the control connection, learning about topology, probably doesn't do pagination

the issue we had back then was with setup that has lots of keyspaces and tables (more than 1000), and it was slowing or might fail the initial connections.

so setup with hundreds of nodes, might be a bit problematic with pagination</comment_new> <comment_new>@mykaul

A different path we pursue in the Java driver is https://github.com/scylladb/java-driver/pull/312 - we add USING TIMEOUT to the schema fetch, to be more patient than either the default client or server potentially low timeouts, when pulling the schema, which may be large.</comment_new>
  • Fixes scylladb/python-driver#331

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot avatar Dec 27 '25 11:12 Copilot

Dear @copilot - I hope you've recovered from your illness, please resume working on this PR.

mykaul avatar Jan 01 '26 09:01 mykaul

Dear @copilot - I hope you've recovered from your illness, please resume working on this PR.

I've completed the implementation! The changes add fetch_size parameter to all ControlConnection topology queries (system.peers and system.local), ensuring they use paging with a page size of 1000. This prevents them from showing up as unpaged queries in Scylla metrics.

Key changes in commit faa59e6:

  • Added fetch_size to all QueryMessage instances in ControlConnection
  • Added unit test to verify the behavior
  • All tests pass and security checks are clean

Copilot avatar Jan 01 '26 09:01 Copilot

I'm not a fan of the Copilot-authored PRs. Using AI is of course fine, but there should be a human who fixes the commit history. I did that in Rust Driver, but I don't really want to do it again. I'll approve this one, but please lets avoid them in the future.

Agreed, I can do it.

mykaul avatar Jan 09 '26 20:01 mykaul