Skip to content

Adding client flags for module usage (closes 2590) #2868

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.

Sign up for GitHub

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

Open
martinrvisser wants to merge 2 commits into
base: unstable
Choose a base branch
from
+71 −9
Open

Adding client flags for module usage (closes 2590) #2868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db5f26c
Adding client flags for module usage (closes 2590)
martinrvisser Dec 3, 2025
481841c
Adding client flags for module usage (closes 2590)
martinrvisser Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/module.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3826,6 +3826,13 @@ int modulePopulateClientInfoStructure(void *ci, client *client, int structver) {
if (client->flag.blocked) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_BLOCKED;
if (client->conn->type == connectionTypeTls()) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_SSL;
if (client->flag.readonly) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_READONLY;
if (client->flag.primary) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_PRIMARY;
if (client->flag.replica) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_REPLICA;
if (client->flag.monitor) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_MONITOR;
if (client->flag.module) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_MODULE;
if (client->flag.authenticated) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_AUTHENTICATED;
if (client->flag.ever_authenticated) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_EVER_AUTHENTICATED;
if (client->flag.fake) ci1->flags |= VALKEYMODULE_CLIENTINFO_FLAG_FAKE;

int port;
connAddrPeerName(client->conn, ci1->addr, sizeof(ci1->addr), &port);
Expand Down
7 changes: 7 additions & 0 deletions src/valkeymodule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,6 +682,13 @@ static const ValkeyModuleEvent ValkeyModuleEvent_ReplicationRoleChanged = {VALKE
#define VALKEYMODULE_CLIENTINFO_FLAG_UNIXSOCKET (1 << 4)
#define VALKEYMODULE_CLIENTINFO_FLAG_MULTI (1 << 5)
#define VALKEYMODULE_CLIENTINFO_FLAG_READONLY (1 << 6)
#define VALKEYMODULE_CLIENTINFO_FLAG_PRIMARY (1 << 7)
#define VALKEYMODULE_CLIENTINFO_FLAG_REPLICA (1 << 8)
#define VALKEYMODULE_CLIENTINFO_FLAG_MONITOR (1 << 9)
#define VALKEYMODULE_CLIENTINFO_FLAG_MODULE (1 << 10)
#define VALKEYMODULE_CLIENTINFO_FLAG_AUTHENTICATED (1 << 11)
#define VALKEYMODULE_CLIENTINFO_FLAG_EVER_AUTHENTICATED (1 << 12)
#define VALKEYMODULE_CLIENTINFO_FLAG_FAKE (1 << 13)

/* Here we take all the structures that the module pass to the core
* and the other way around. Notably the list here contains the structures
Expand Down
11 changes: 9 additions & 2 deletions tests/modules/misc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,14 +306,21 @@ int test_clientinfo(ValkeyModuleCtx *ctx, ValkeyModuleString **argv, int argc)

ValkeyModule_ReplyWithArray(ctx, 10);
char flags[512];
snprintf(flags, sizeof(flags) - 1, "%s:%s:%s:%s:%s:%s:%s",
snprintf(flags, sizeof(flags) - 1, "%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_SSL ? "ssl" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_PUBSUB ? "pubsub" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_BLOCKED ? "blocked" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_TRACKING ? "tracking" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_UNIXSOCKET ? "unixsocket" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_MULTI ? "multi" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_READONLY ? "readonly" : "");
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_READONLY ? "readonly" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_PRIMARY ? "primary" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_REPLICA ? "replica" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_MONITOR ? "monitor" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_MODULE ? "module" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_AUTHENTICATED ? "authenticated" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_EVER_AUTHENTICATED ? "ever_authenticated" : "",
ci.flags & VALKEYMODULE_CLIENTINFO_FLAG_FAKE ? "fake" : "");

ValkeyModule_ReplyWithCString(ctx, "flags");
ValkeyModule_ReplyWithCString(ctx, flags);
Expand Down
55 changes: 48 additions & 7 deletions tests/unit/moduleapi/misc.tcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,31 +97,72 @@ start_server {overrides {save {900 1}} tags {"modules"}} {
assert { $was_set == 0 }
}

proc parse_client_flags {flags} {
set flag_list [split $flags ":"]
set parsed_flags {}

# Just collect all non-empty flags
foreach flag $flag_list {
if {$flag ne ""} {
lappend parsed_flags $flag
}
}

return $parsed_flags
}

test {test module clientinfo api} {
# Test basic sanity and SSL flag
set info [r test.clientinfo]
set ssl_flag [expr $::tls ? {"ssl:"} : {":"}]

assert { [dict get $info db] == 9 }
assert { [dict get $info flags] == "${ssl_flag}:::::" }

set flags [parse_client_flags [dict get $info flags]]

# Check initial state - should have auth flags, maybe SSL
if {$::tls} {
assert { "ssl" in $flags }
}
assert { "authenticated" in $flags }
assert { "ever_authenticated" in $flags }
assert { "multi" ni $flags }
assert { "tracking" ni $flags }
assert { "readonly" ni $flags }

# Test MULTI flag
r multi
r test.clientinfo
set info [lindex [r exec] 0]
assert { [dict get $info flags] == "${ssl_flag}::::multi:" }
set flags [parse_client_flags [dict get $info flags]]
assert { "multi" in $flags }
assert { "authenticated" in $flags }
assert { "ever_authenticated" in $flags }

# Test TRACKING flag
r client tracking on
set info [r test.clientinfo]
assert { [dict get $info flags] == "${ssl_flag}::tracking:::" }
set flags [parse_client_flags [dict get $info flags]]
assert { "tracking" in $flags }
assert { "multi" ni $flags }
assert { "authenticated" in $flags }
assert { "ever_authenticated" in $flags }
r CLIENT TRACKING off

# Test READONLY flag
r readonly
set info [r test.clientinfo]
assert { [dict get $info flags] == "${ssl_flag}:::::readonly" }
set flags [parse_client_flags [dict get $info flags]]
assert { "readonly" in $flags }
assert { "tracking" ni $flags }
assert { "multi" ni $flags }
assert { "authenticated" in $flags }
assert { "ever_authenticated" in $flags }

r readwrite
set info [r test.clientinfo]
assert { [dict get $info flags] == "${ssl_flag}:::::" }
set flags [parse_client_flags [dict get $info flags]]
assert { "readonly" ni $flags }
assert { "authenticated" in $flags }
assert { "ever_authenticated" in $flags }
}

test {tracking with rm_call sanity} {
Expand Down
Loading