MOD-6058: Circular Buffer by raz-mon · Pull Request #5297 · RediSearch/RediSearch

raz-mon · 2024-12-03T06:36:14Z

Adds a Circular Buffer to RediSearch, see the header file for more specification of the exposed API.

Mark if applicable

This PR introduces API changes
This PR introduces serialization changes

codecov · 2024-12-03T06:58:12Z

Codecov Report

Attention: Patch coverage is 98.75000% with 1 line in your changes missing coverage. Please review.

Project coverage is 87.09%. Comparing base (05d0287) to head (274baa0).
Report is 11 commits behind head on master.

Files with missing lines	Patch %	Lines
src/util/circular_buffer.c	98.75%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5297      +/-   ##
==========================================
+ Coverage   86.63%   87.09%   +0.46%     
==========================================
  Files         193      196       +3     
  Lines       34717    34882     +165     
==========================================
+ Hits        30077    30382     +305     
+ Misses       4640     4500     -140

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

src/util/circular_buffer.c

src/util/circular_buffer.h

tests/cpptests/test_cpp_circularBuffer.cpp

src/util/circular_buffer.c

* wip * WIP * Add unit-tests for the Circular Buffer * Formatting * Add coverage to itemSize * Add spaces * Add coverage for ResetReader * Address review * Fix item_count update to be atomic * Add multi-threaded cpp tests for add, reserve functions * Touchup * Format test file * Add comments and some thread-safe modifications * Fix indentation * Remove new-line * Touchup * Fix multi-threading test * Modify test * Remove comment * Add assertion for item-size and item-cap * Modify assertion * Add wasFull output variable to the reserve api * Initialize wasFull to false * Set wasFull in false case (cherry picked from commit dae453b)

redisearch-backport-pull-request · 2024-12-19T13:44:22Z

Successfully created backport PR for 2.8:

[2.8] MOD-6058: Circular Buffer #5381

* wip * WIP * Add unit-tests for the Circular Buffer * Formatting * Add coverage to itemSize * Add spaces * Add coverage for ResetReader * Address review * Fix item_count update to be atomic * Add multi-threaded cpp tests for add, reserve functions * Touchup * Format test file * Add comments and some thread-safe modifications * Fix indentation * Remove new-line * Touchup * Fix multi-threading test * Modify test * Remove comment * Add assertion for item-size and item-cap * Modify assertion * Add wasFull output variable to the reserve api * Initialize wasFull to false * Set wasFull in false case (cherry picked from commit dae453b)

redisearch-backport-pull-request · 2024-12-19T13:44:25Z

Successfully created backport PR for 2.6:

[2.6] MOD-6058: Circular Buffer #5382

* wip * WIP * Add unit-tests for the Circular Buffer * Formatting * Add coverage to itemSize * Add spaces * Add coverage for ResetReader * Address review * Fix item_count update to be atomic * Add multi-threaded cpp tests for add, reserve functions * Touchup * Format test file * Add comments and some thread-safe modifications * Fix indentation * Remove new-line * Touchup * Fix multi-threading test * Modify test * Remove comment * Add assertion for item-size and item-cap * Modify assertion * Add wasFull output variable to the reserve api * Initialize wasFull to false * Set wasFull in false case (cherry picked from commit dae453b)

redisearch-backport-pull-request · 2024-12-19T13:44:30Z

Successfully created backport PR for 2.10:

[2.10] MOD-6058: Circular Buffer #5383

* wip * WIP * Add unit-tests for the Circular Buffer * Formatting * Add coverage to itemSize * Add spaces * Add coverage for ResetReader * Address review * Fix item_count update to be atomic * Add multi-threaded cpp tests for add, reserve functions * Touchup * Format test file * Add comments and some thread-safe modifications * Fix indentation * Remove new-line * Touchup * Fix multi-threading test * Modify test * Remove comment * Add assertion for item-size and item-cap * Modify assertion * Add wasFull output variable to the reserve api * Initialize wasFull to false * Set wasFull in false case (cherry picked from commit dae453b)

redisearch-backport-pull-request · 2024-12-19T13:44:34Z

Successfully created backport PR for 8.0:

[8.0] MOD-6058: Circular Buffer #5384

MOD-6058: Circular Buffer (#5297) * wip * WIP * Add unit-tests for the Circular Buffer * Formatting * Add coverage to itemSize * Add spaces * Add coverage for ResetReader * Address review * Fix item_count update to be atomic * Add multi-threaded cpp tests for add, reserve functions * Touchup * Format test file * Add comments and some thread-safe modifications * Fix indentation * Remove new-line * Touchup * Fix multi-threading test * Modify test * Remove comment * Add assertion for item-size and item-cap * Modify assertion * Add wasFull output variable to the reserve api * Initialize wasFull to false * Set wasFull in false case (cherry picked from commit dae453b) Co-authored-by: Raz Monsonego <[email protected]>

raz-mon added 3 commits November 30, 2024 16:45

wip

08fde2b

WIP

8676399

Add unit-tests for the Circular Buffer

137e356

raz-mon added backport 2.8 backport 2.6 backport 2.10 backport 8.0 labels Dec 3, 2024

raz-mon added 2 commits December 3, 2024 10:13

Formatting

7166a97

Merge branch 'master' into razmon-circular_buffer

680c20b

raz-mon requested review from kei-nan and oshadmi December 9, 2024 09:46