Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for MustObeyClient Module API #1582

Open
wants to merge 8 commits into
base: unstable
Choose a base branch
from

Conversation

KarthikSubbarao
Copy link
Member

@KarthikSubbarao KarthikSubbarao commented Jan 18, 2025

This PR adds support for MustObeyClient Module API.

The purpose of this API is for Modules to handle commands / callbacks knowing whether commands are arriving from the primary client or AOF client and should never be rejected.

A use case is that Modules can have validation logic in command handlers which only should be executed on primary nodes. Replica nodes must obey commands replicated.

Signed-off-by: KarthikSubbarao <[email protected]>
Copy link

codecov bot commented Jan 18, 2025

Codecov Report

Attention: Patch coverage is 25.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 71.00%. Comparing base (2d0b8e3) to head (93acad9).
Report is 23 commits behind head on unstable.

Files with missing lines Patch % Lines
src/module.c 25.00% 3 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##           unstable    #1582      +/-   ##
============================================
+ Coverage     70.94%   71.00%   +0.05%     
============================================
  Files           121      121              
  Lines         65132    65181      +49     
============================================
+ Hits          46207    46279      +72     
+ Misses        18925    18902      -23     
Files with missing lines Coverage Δ
src/module.c 9.61% <25.00%> (+<0.01%) ⬆️

... and 22 files with indirect coverage changes

src/module.c Show resolved Hide resolved
src/module.c Outdated Show resolved Hide resolved
@madolson madolson added the major-decision-pending Major decision pending by TSC team label Jan 22, 2025
Signed-off-by: KarthikSubbarao <[email protected]>
Signed-off-by: KarthikSubbarao <[email protected]>
Signed-off-by: KarthikSubbarao <[email protected]>
Signed-off-by: Karthik Subbarao <[email protected]>
Signed-off-by: Karthik Subbarao <[email protected]>
tests/modules/propagate.c Outdated Show resolved Hide resolved
Signed-off-by: Karthik Subbarao <[email protected]>
@madolson
Copy link
Member

madolson commented Feb 3, 2025

@valkey-io/core-team Please vote. This is a pretty straight forward API to give modules the ability to quickly check if they should apply the command and ignore checks because it's coming from a primary or AOF. Worth mentioning that this is more performant than ValkeyModule_GetContextFlags, since that command also checks for memory bounds.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major-decision-pending Major decision pending by TSC team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants