[8.4] [MOD-11817] FT.AGGREGATE show Background Indexing OOM warning by redisearch-backport-pull-request[bot] · Pull Request #7153 · RediSearch/RediSearch

redisearch-backport-pull-request · 2025-10-26T13:28:13Z

Description

Backport of #7141 to 8.4.

Note

Shows background indexing OOM warnings in FT.AGGREGATE RESP3 replies and propagates them through the coordinator, with tests and minor infra tweaks.

Aggregate (RESP3):
- Adds warning entries to FT.AGGREGATE replies for background indexing OOM: checks qctx->bgScanOOM (coordinator) or sctx->spec->scan_failed_OOM (shards).
Coordinator:
- In rpnet, parses shard warning and sets AREQ_QueryProcessingCtx(...)->bgScanOOM on QUERY_WINDEXING_FAILURE to propagate OOM status to the client.
Core API:
- Extends QueryProcessingCtx with bool bgScanOOM.
Tests:
- Update OOM tests to assert RESP3 warnings for FT.SEARCH, FT.PROFILE, and FT.AGGREGATE.
- Add TimeLimit guards to wait helpers and use shared info_modules_oom_count_str key.
- Adjust cluster tests to self-init env and verify warnings across shards.

^{Written by Cursor Bugbot for commit 40b7030. This will update automatically on new commits. Configure here.}

* Check aggregate in verbosity test * check verbosity in tests * Check bg scan warning and raise accordingly * Refractor tests * Add comment * fix comment (cherry picked from commit 49a986c)

cursor

Bug: Inconsistent OOM Handling Across Response Types

In sendChunk_Resp2, the ProfilePrinterCtx is initialized with bgScanOOM from sctx->spec->scan_failed_OOM, but qctx->bgScanOOM is not checked. This is inconsistent with sendChunk_Resp3 (line 589) which checks both qctx->bgScanOOM (for coordinator) and sctx->spec->scan_failed_OOM (for shards). In a coordinator scenario using RESP2, the background indexing OOM warning will not be propagated even if qctx->bgScanOOM is true.

src/aggregate/aggregate_exec.c#L455-L476

RediSearch/src/aggregate/aggregate_exec.c

Lines 455 to 476 in 40b7030

    
               } 
        
           done_2: 
        
               RedisModule_Reply_ArrayEnd(reply);    // </results> 
        
               cursor_done = (rc != RS_RESULT_OK 
        
                              && !(rc == RS_RESULT_TIMEDOUT 
        
                                   && req->reqConfig.timeoutPolicy == TimeoutPolicy_Return)); 
        
               bool has_timedout = (rc == RS_RESULT_TIMEDOUT) || hasTimeoutError(qctx->err); 
        
               // Prepare profile printer context 
        
               RedisSearchCtx *sctx = AREQ_SearchCtx(req); 
        
               ProfilePrinterCtx profileCtx = { 
        
                 .req = req, 
        
                 .timedout = has_timedout, 
        
                 .reachedMaxPrefixExpansions = QueryError_HasReachedMaxPrefixExpansionsWarning(qctx->err), 
        
                 .bgScanOOM = sctx->spec && sctx->spec->scan_failed_OOM, 
        
                 .queryOOM = QueryError_HasQueryOOMWarning(qctx->err), 
        
               }; 
        
               if (AREQ_RequestFlags(req) & QEXEC_F_IS_CURSOR) {

codecov · 2025-10-26T14:04:03Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.62%. Comparing base (48ee400) to head (40b7030).
⚠️ Report is 10 commits behind head on 8.4.

Additional details and impacted files

@@            Coverage Diff             @@
##              8.4    #7153      +/-   ##
==========================================
- Coverage   85.67%   85.62%   -0.05%     
==========================================
  Files         327      326       -1     
  Lines       51945    50902    -1043     
  Branches    10921    10921              
==========================================
- Hits        44503    43585     -918     
+ Misses       7276     7151     -125     
  Partials      166      166

Flag	Coverage Δ
flow	`84.24% <100.00%> (-0.08%)`	⬇️
unit	`51.72% <0.00%> (+0.13%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[MOD-11817] FT.AGGREGATE show Background Indexing OOM warning (#7141)

40b7030

* Check aggregate in verbosity test * check verbosity in tests * Check bg scan warning and raise accordingly * Refractor tests * Add comment * fix comment (cherry picked from commit 49a986c)

redisearch-backport-pull-request bot added the size:S label Oct 26, 2025

redisearch-backport-pull-request bot mentioned this pull request Oct 26, 2025

[MOD-11817] FT.AGGREGATE show Background Indexing OOM warning #7141

Merged

redisearch-backport-pull-request bot enabled auto-merge October 26, 2025 13:28

redisearch-backport-pull-request bot requested a review from lerman25 October 26, 2025 13:28

cursor bot reviewed Oct 26, 2025

View reviewed changes

lerman25 approved these changes Oct 26, 2025

View reviewed changes

redisearch-backport-pull-request bot added this pull request to the merge queue Oct 27, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 27, 2025

lerman25 added this pull request to the merge queue Oct 27, 2025

Merged via the queue into 8.4 with commit edf2d2a Oct 27, 2025
22 checks passed

lerman25 deleted the backport-7141-to-8.4 branch October 27, 2025 13:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[8.4] [MOD-11817] FT.AGGREGATE show Background Indexing OOM warning#7153

[8.4] [MOD-11817] FT.AGGREGATE show Background Indexing OOM warning#7153
lerman25 merged 1 commit into8.4from
backport-7141-to-8.4

redisearch-backport-pull-request bot commented Oct 26, 2025 •

edited by cursor bot

Loading

Uh oh!

cursor bot left a comment

Uh oh!

codecov bot commented Oct 26, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	}

	done_2:
	RedisModule_Reply_ArrayEnd(reply); // </results>

	cursor_done = (rc != RS_RESULT_OK
	&& !(rc == RS_RESULT_TIMEDOUT
	&& req->reqConfig.timeoutPolicy == TimeoutPolicy_Return));

	bool has_timedout = (rc == RS_RESULT_TIMEDOUT) \|\| hasTimeoutError(qctx->err);

	// Prepare profile printer context
	RedisSearchCtx *sctx = AREQ_SearchCtx(req);
	ProfilePrinterCtx profileCtx = {
	.req = req,
	.timedout = has_timedout,
	.reachedMaxPrefixExpansions = QueryError_HasReachedMaxPrefixExpansionsWarning(qctx->err),
	.bgScanOOM = sctx->spec && sctx->spec->scan_failed_OOM,
	.queryOOM = QueryError_HasQueryOOMWarning(qctx->err),
	};

	if (AREQ_RequestFlags(req) & QEXEC_F_IS_CURSOR) {

Conversation

redisearch-backport-pull-request bot commented Oct 26, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Inconsistent OOM Handling Across Response Types

Uh oh!

codecov bot commented Oct 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

redisearch-backport-pull-request bot commented Oct 26, 2025 •

edited by cursor bot

Loading

codecov bot commented Oct 26, 2025 •

edited

Loading