fix(server): make query result batch boundaries explicit - #3193
fix(server): make query result batch boundaries explicit#3193contrueCT wants to merge 5 commits into
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #3193 +/- ##
============================================
+ Coverage 37.77% 37.90% +0.12%
- Complexity 6560 6601 +41
============================================
Files 800 802 +2
Lines 68960 69092 +132
Branches 9166 9186 +20
============================================
+ Hits 26052 26191 +139
- Misses 39841 39844 +3
+ Partials 3067 3057 -10 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
bitflicker64
left a comment
There was a problem hiding this comment.
Blocking: yes. Summary: The batching design holds up. BatchIterator close and exception semantics, the shared cursor across mapBatches/flatMap, the raw-empty-page versus filtered-empty-batch distinction, and rebuilding the batch context on an edge-cache hit all check out. One blocker: moving the QueryList fetcher up from super::query to fetchVertexBatch puts the vertex cache inside the paging machinery, and the joined cache-plus-backend result it returns carries no page metadata, so a paged primary-key vertex query dies in PageInfo.pageState. Please add the paging() bypass plus a VertexCoreTest case for that shape; the other four comments are optional.
Evidence: the chain is traced through unmodified code and spelled out inline on CachedGraphTransaction.java:322, including why the existing green paging tests do not reach it. Static analysis only, not executed against a page-capable backend. CI at c694bb0 is green on all 24 checks.
Purpose of the PR
Closes #3190.
QueryResultscurrently detects a query boundary by probinghasNext()and then checking whether the active query changed. That probe can activate the next index query or backend page before the current batch finishes processing. Ordering is also selected from the first active segment, so an unsorted batch[1]followed by a batch with input IDs[3, 2]can incorrectly produce[1, 2, 3].This change gives each batch its own results and captured processing context. Parsing, TTL checks, residual filtering and input-order restoration finish within that batch before the caller consumes a flattened stream.
Main Changes
QueryBatchandQueryResultContextto carry the input IDs, ordering decision, visibility flags and effective results filter with the results that produced them.QueryResults,QueryListandPageEntryIteratorcompose explicit batches. RemovequeryVersion/currentQueriesboundary inference and shared results-filter propagation.queries()diagnostics bounded to the current batch and clear them on close.PageState. Give each empty page an independent batch cursor, preventing one consumer from exhausting another consumer's cursor.The flattened consumer can advance after A is exhausted; an iterator operating inside A never probes B to discover A's boundary. HStore partition merging,
ORDER_BY_KEYand physical-key cursors are outside this change.Verifying these changes
VertexCoreTest,EdgeCoreTestand cache regressions.Three focused tests first failed on the old implementation: mixed ordering returned
[1, 2, 3]instead of[1, 3, 2], and the next-query and next-page fetch counters reached 2 when only 1 batch should have been activated. All now pass. Additional regressions fail on the previous PR head for materialization/mapping afterhasNext()and duplicate/accumulating query diagnostics; they pass with the shared cursor. The paging regression traverses 10,000 realPageEntryIteratorpages and checks that only the current query is retained.Verification on JDK 17 and Maven 3.9.16:
05186a0eQueryListTest17788a4a17788a4aVertexCoreTest,EdgeCoreTestc694bb0aVertexCoreTest,EdgeCoreTestc694bb0ac694bb0aBoth new review regressions failed on
c694bb0a: primary-key paging raisedInvalid PageState 'null', and interleaved empty-page consumption exposed the shared cursor. They pass with this follow-up. The primary-key test covers cold and warm caches, residual filtering to an empty result, a missing primary key, and terminal page metadata.The latest supplement adds 10 tests. Seven isolated fault-injection variants are rejected by the new tests: omitted holder/source closing, a changed cache capacity boundary, a discarded oversized-batch tail, and incorrect cleanup decisions for invisible, mismatching, or matching-with-stale-index records. The unchanged implementation passes all selected diagnostic tests. Reflection-filter entries were checked against 15 actual declared methods across the transaction and cache classes.
Coverage includes raw-empty backend pages versus filtered-empty batches, missing and expired vertices through cache materialization, empty batches/holders, null and expanded mapper results, mixed ordering in both directions, real page-fetch counters and cursor metadata, limits, cross-batch materialization capacity, materialization after partial consumption, page metadata after closing the source, early close and suppressed exceptions, residual filtering on warm vertex caches, and an off-heap edge-cache hit with zero backend reads. The HStore selection also passed on the pre-change baseline using the same isolated PD/Store setup.
At
c694bb0a, a separate four-method HStore reproduction exercises schema cleanup after creating 10,000 edges per label. Before the empty-page fix, three subsequent tests timed out in setup. With the fix, cleanup completes and the sequence matches baseline36811483: three tests pass, whiletestQueryOutEdgesOfVertexBySortkeyWithMoreFieldsInPagefails in its body withCardinality from code 0. This existing HStore serialization error remains unresolved; the 26-test selection above is not a full HStore-suite pass.Reproduction commands
Formatting and full reactor compilation passed. Verification used
-Drat.skip=true; the complete UnitTestSuite, API and TinkerPop suites were not run. The latest unit verification used Java files matching05186a0ebyte-for-byte. The backend suites remain labeled with the snapshots actually tested and were not rerun for this test/auth-registration supplement.Does this PR potentially affect the following parts?
Documentation Status
Doc - TODODoc - DoneDoc - No Need