mirrors/dragonfly
1
0
Fork 0
mirror of https://github.com/dragonflydb/dragonfly.git synced 2025-05-10 18:05:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

chore: update command interface for acl, hll families (#4253)

Browse source
This commit is contained in:
Roman Gershman 2024-12-04 15:15:09 +02:00 • committed by GitHub
parent 7a23ec2aac
commit 892a415201
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 67 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

100
src/server/acl/acl_family.cc
View file

@ -64,14 +64,14 @@ AclFamily::AclFamily(UserRegistry* registry, util::ProactorPool* pool)
: registry_(registry), pool_(pool) { : registry_(registry), pool_(pool) {
} }
void AclFamily::Acl(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::Acl(CmdArgList args, const CommandContext& cmd_cntx) {
builder->SendError("Wrong number of arguments for acl command"); cmd_cntx.rb->SendError("Wrong number of arguments for acl command");
} }
void AclFamily::List(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::List(CmdArgList args, const CommandContext& cmd_cntx) {
const auto registry_with_lock = registry_->GetRegistryWithLock(); const auto registry_with_lock = registry_->GetRegistryWithLock();
const auto& registry = registry_with_lock.registry; const auto& registry = registry_with_lock.registry;
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder); auto* rb = static_cast<facade::RedisReplyBuilder*>(cmd_cntx.rb);
rb->StartArray(registry.size()); rb->StartArray(registry.size());
for (const auto& [username, user] : registry) { for (const auto& [username, user] : registry) {
@ -92,7 +92,7 @@ void AclFamily::List(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder
absl::StrAppend(&buffer, username, " ", user.IsActive() ? "on "sv : "off "sv, password, absl::StrAppend(&buffer, username, " ", user.IsActive() ? "on "sv : "off "sv, password,
acl_keys, maybe_space_com, acl_pub_sub, " ", acl_cat_and_commands); acl_keys, maybe_space_com, acl_pub_sub, " ", acl_cat_and_commands);
builder->SendSimpleString(buffer); rb->SendSimpleString(buffer);
} }
} }
@ -116,12 +116,12 @@ void AclFamily::StreamUpdatesToAllProactorConnections(const std::string& user,
using facade::ErrorReply; using facade::ErrorReply;
void AclFamily::SetUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::SetUser(CmdArgList args, const CommandContext& cmd_cntx) {
string_view username = facade::ToSV(args[0]); string_view username = facade::ToSV(args[0]);
auto reg = registry_->GetRegistryWithWriteLock(); auto reg = registry_->GetRegistryWithWriteLock();
const bool exists = reg.registry.contains(username); const bool exists = reg.registry.contains(username);
const bool has_all_keys = exists ? reg.registry.find(username)->second.Keys().all_keys : false; const bool has_all_keys = exists ? reg.registry.find(username)->second.Keys().all_keys : false;
auto* builder = cmd_cntx.rb;
auto req = ParseAclSetUser(args.subspan(1), false, has_all_keys); auto req = ParseAclSetUser(args.subspan(1), false, has_all_keys);
auto error_case = [builder](ErrorReply&& error) { builder->SendError(error); }; auto error_case = [builder](ErrorReply&& error) { builder->SendError(error); };
@ -184,7 +184,7 @@ void AclFamily::EvictOpenConnectionsOnAllProactorsWithRegistry(
} }
} }
void AclFamily::DelUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::DelUser(CmdArgList args, const CommandContext& cmd_cntx) {
auto& registry = *registry_; auto& registry = *registry_;
absl::flat_hash_set<string_view> users; absl::flat_hash_set<string_view> users;
@ -199,19 +199,18 @@ void AclFamily::DelUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* buil
} }
if (users.empty()) { if (users.empty()) {
builder->SendLong(0); cmd_cntx.rb->SendLong(0);
return; return;
} }
VLOG(1) << "Evicting open acl connections"; VLOG(1) << "Evicting open acl connections";
EvictOpenConnectionsOnAllProactors(users); EvictOpenConnectionsOnAllProactors(users);
VLOG(1) << "Done evicting open acl connections"; VLOG(1) << "Done evicting open acl connections";
builder->SendLong(users.size()); cmd_cntx.rb->SendLong(users.size());
} }
void AclFamily::WhoAmI(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder, void AclFamily::WhoAmI(CmdArgList args, const CommandContext& cmd_cntx) {
ConnectionContext* cntx) { auto* rb = static_cast<facade::RedisReplyBuilder*>(cmd_cntx.rb);
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder); rb->SendBulkString(absl::StrCat("User is ", cmd_cntx.conn_cntx->authed_username));
rb->SendBulkString(absl::StrCat("User is ", cntx->authed_username));
} }
string AclFamily::RegistryToString() const { string AclFamily::RegistryToString() const {
@ -240,8 +239,9 @@ string AclFamily::RegistryToString() const {
return result; return result;
} }
void AclFamily::Save(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::Save(CmdArgList args, const CommandContext& cmd_cntx) {
auto acl_file_path = absl::GetFlag(FLAGS_aclfile); auto acl_file_path = absl::GetFlag(FLAGS_aclfile);
auto* builder = cmd_cntx.rb;
if (acl_file_path.empty()) { if (acl_file_path.empty()) {
builder->SendError("Dragonfly is not configured to use an ACL file."); builder->SendError("Dragonfly is not configured to use an ACL file.");
return; return;
@ -348,23 +348,24 @@ bool AclFamily::Load() {
return !LoadToRegistryFromFile(acl_file, nullptr); return !LoadToRegistryFromFile(acl_file, nullptr);
} }
void AclFamily::Load(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::Load(CmdArgList args, const CommandContext& cmd_cntx) {
auto acl_file = absl::GetFlag(FLAGS_aclfile); auto acl_file = absl::GetFlag(FLAGS_aclfile);
if (acl_file.empty()) { if (acl_file.empty()) {
builder->SendError("Dragonfly is not configured to use an ACL file."); cmd_cntx.rb->SendError("Dragonfly is not configured to use an ACL file.");
return; return;
} }
const auto load_error = LoadToRegistryFromFile(acl_file, builder); const auto load_error = LoadToRegistryFromFile(acl_file, cmd_cntx.rb);
if (load_error) { if (load_error) {
builder->SendError(absl::StrCat("Error loading: ", acl_file, " ", load_error.Format())); cmd_cntx.rb->SendError(absl::StrCat("Error loading: ", acl_file, " ", load_error.Format()));
} }
} }
void AclFamily::Log(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::Log(CmdArgList args, const CommandContext& cmd_cntx) {
auto* rb = static_cast<facade::RedisReplyBuilder*>(cmd_cntx.rb);
if (args.size() > 1) { if (args.size() > 1) {
builder->SendError(facade::OpStatus::OUT_OF_RANGE); rb->SendError(facade::OpStatus::OUT_OF_RANGE);
} }
size_t max_output = 10; size_t max_output = 10;
@ -373,12 +374,12 @@ void AclFamily::Log(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder)
if (absl::EqualsIgnoreCase(option, "RESET")) { if (absl::EqualsIgnoreCase(option, "RESET")) {
pool_->AwaitFiberOnAll( pool_->AwaitFiberOnAll(
[](auto index, auto* context) { ServerState::tlocal()->acl_log.Reset(); }); [](auto index, auto* context) { ServerState::tlocal()->acl_log.Reset(); });
builder->SendOk(); rb->SendOk();
return; return;
} }
if (!absl::SimpleAtoi(facade::ToSV(args[0]), &max_output)) { if (!absl::SimpleAtoi(facade::ToSV(args[0]), &max_output)) {
builder->SendError("Invalid count"); rb->SendError("Invalid count");
return; return;
} }
} }
@ -393,7 +394,6 @@ void AclFamily::Log(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder)
total_entries += log.size(); total_entries += log.size();
} }
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder);
if (total_entries == 0) { if (total_entries == 0) {
rb->SendEmptyArray(); rb->SendEmptyArray();
return; return;
@ -454,19 +454,22 @@ void AclFamily::Log(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder)
} }
} }
void AclFamily::Users(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::Users(CmdArgList args, const CommandContext& cmd_cntx) {
const auto registry_with_lock = registry_->GetRegistryWithLock(); const auto registry_with_lock = registry_->GetRegistryWithLock();
const auto& registry = registry_with_lock.registry; const auto& registry = registry_with_lock.registry;
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder); auto* rb = static_cast<facade::RedisReplyBuilder*>(cmd_cntx.rb);
rb->StartArray(registry.size()); rb->StartArray(registry.size());
for (const auto& [username, _] : registry) { for (const auto& [username, _] : registry) {
rb->SendSimpleString(username); rb->SendSimpleString(username);
} }
} }
void AclFamily::Cat(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::Cat(CmdArgList args, const CommandContext& cmd_cntx) {
auto* rb = static_cast<facade::RedisReplyBuilder*>(cmd_cntx.rb);
if (args.size() > 1) { if (args.size() > 1) {
builder->SendError(facade::OpStatus::SYNTAX_ERR); rb->SendError(facade::OpStatus::SYNTAX_ERR);
return; return;
} }
@ -475,7 +478,7 @@ void AclFamily::Cat(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder)
if (!cat_table_.contains(category)) { if (!cat_table_.contains(category)) {
auto error = absl::StrCat("Unkown category: ", category); auto error = absl::StrCat("Unkown category: ", category);
builder->SendError(error); rb->SendError(error);
return; return;
} }
@ -488,7 +491,6 @@ void AclFamily::Cat(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder)
} }
}; };
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder);
cmd_registry_->Traverse(cb); cmd_registry_->Traverse(cb);
rb->StartArray(results.size()); rb->StartArray(results.size());
for (const auto& command : results) { for (const auto& command : results) {
@ -505,7 +507,6 @@ void AclFamily::Cat(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder)
} }
} }
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder);
rb->StartArray(total_categories); rb->StartArray(total_categories);
for (auto& elem : reverse_cat_table_) { for (auto& elem : reverse_cat_table_) {
if (elem != "_RESERVED") { if (elem != "_RESERVED") {
@ -514,12 +515,13 @@ void AclFamily::Cat(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder)
} }
} }
void AclFamily::GetUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::GetUser(CmdArgList args, const CommandContext& cmd_cntx) {
auto username = facade::ToSV(args[0]); auto username = facade::ToSV(args[0]);
const auto registry_with_lock = registry_->GetRegistryWithLock(); const auto registry_with_lock = registry_->GetRegistryWithLock();
const auto& registry = registry_with_lock.registry; const auto& registry = registry_with_lock.registry;
auto* rb = static_cast<facade::RedisReplyBuilder*>(cmd_cntx.rb);
if (!registry.contains(username)) { if (!registry.contains(username)) {
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder);
rb->SendNull(); rb->SendNull();
return; return;
} }
@ -530,7 +532,6 @@ void AclFamily::GetUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* buil
pass.pop_back(); pass.pop_back();
} }
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder);
rb->StartArray(10); rb->StartArray(10);
rb->SendSimpleString("flags"); rb->SendSimpleString("flags");
@ -567,7 +568,8 @@ void AclFamily::GetUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* buil
rb->SendSimpleString(pub_sub); rb->SendSimpleString(pub_sub);
} }
void AclFamily::GenPass(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::GenPass(CmdArgList args, const CommandContext& cmd_cntx) {
auto* builder = cmd_cntx.rb;
if (args.length() > 1) { if (args.length() > 1) {
builder->SendError(facade::UnknownSubCmd("GENPASS", "ACL")); builder->SendError(facade::UnknownSubCmd("GENPASS", "ACL"));
return; return;
@ -595,13 +597,14 @@ void AclFamily::GenPass(CmdArgList args, Transaction* tx, SinkReplyBuilder* buil
builder->SendSimpleString(response); builder->SendSimpleString(response);
} }
void AclFamily::DryRun(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void AclFamily::DryRun(CmdArgList args, const CommandContext& cmd_cntx) {
auto* rb = static_cast<facade::RedisReplyBuilder*>(cmd_cntx.rb);
auto username = facade::ArgS(args, 0); auto username = facade::ArgS(args, 0);
const auto registry_with_lock = registry_->GetRegistryWithLock(); const auto registry_with_lock = registry_->GetRegistryWithLock();
const auto& registry = registry_with_lock.registry; const auto& registry = registry_with_lock.registry;
if (!registry.contains(username)) { if (!registry.contains(username)) {
auto error = absl::StrCat("User '", username, "' not found"); auto error = absl::StrCat("User '", username, "' not found");
builder->SendError(error); rb->SendError(error);
return; return;
} }
@ -609,7 +612,7 @@ void AclFamily::DryRun(CmdArgList args, Transaction* tx, SinkReplyBuilder* build
auto* cid = cmd_registry_->Find(command); auto* cid = cmd_registry_->Find(command);
if (!cid) { if (!cid) {
auto error = absl::StrCat("Command '", command, "' not found"); auto error = absl::StrCat("Command '", command, "' not found");
builder->SendError(error); rb->SendError(error);
return; return;
} }
@ -617,30 +620,19 @@ void AclFamily::DryRun(CmdArgList args, Transaction* tx, SinkReplyBuilder* build
const bool is_allowed = const bool is_allowed =
IsUserAllowedToInvokeCommandGeneric(user.AclCommandsRef(), {{}, true}, {}, *cid).first; IsUserAllowedToInvokeCommandGeneric(user.AclCommandsRef(), {{}, true}, {}, *cid).first;
if (is_allowed) { if (is_allowed) {
builder->SendOk(); rb->SendOk();
return; return;
} }
auto msg = absl::StrCat("This user has no permissions to run the '", command, "' command"); auto msg = absl::StrCat("This user has no permissions to run the '", command, "' command");
auto* rb = static_cast<facade::RedisReplyBuilder*>(builder);
rb->SendBulkString(msg); rb->SendBulkString(msg);
} }
using MemberFunc2 = void (AclFamily::*)(CmdArgList args, Transaction* tx, using MemberFunc = void (AclFamily::*)(CmdArgList args, const CommandContext& cmd_cntx);
facade::SinkReplyBuilder* builder);
using MemberFunc = void (AclFamily::*)(CmdArgList args, Transaction* tx, CommandId::Handler3 HandlerFunc(AclFamily* acl, MemberFunc f) {
facade::SinkReplyBuilder* builder, ConnectionContext* cntx); return [=](CmdArgList args, const CommandContext& cmd_cntx) { return (acl->*f)(args, cmd_cntx); };
CommandId::Handler2 HandlerFunc(AclFamily* acl, MemberFunc2 f) {
return [=](CmdArgList args, Transaction* tx, facade::SinkReplyBuilder* builder) {
return (acl->*f)(args, tx, builder);
};
}
CommandId::Handler HandlerFunc(AclFamily* acl, MemberFunc f) {
return [=](CmdArgList args, Transaction* tx, facade::SinkReplyBuilder* builder,
ConnectionContext* cntx) { return (acl->*f)(args, tx, builder, cntx); };
} }
#define HFUNC(x) SetHandler(HandlerFunc(this, &AclFamily::x)) #define HFUNC(x) SetHandler(HandlerFunc(this, &AclFamily::x))

26
src/server/acl/acl_family.h
View file

@ -37,21 +37,21 @@ class AclFamily final {
private: private:
using SinkReplyBuilder = facade::SinkReplyBuilder; using SinkReplyBuilder = facade::SinkReplyBuilder;
void Acl(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void Acl(CmdArgList args, const CommandContext& cmd_cntx);
void List(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void List(CmdArgList args, const CommandContext& cmd_cntx);
void SetUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void SetUser(CmdArgList args, const CommandContext& cmd_cntx);
void DelUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void DelUser(CmdArgList args, const CommandContext& cmd_cntx);
void WhoAmI(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder, ConnectionContext* cntx); void WhoAmI(CmdArgList args, const CommandContext& cmd_cntx);
void Save(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void Save(CmdArgList args, const CommandContext& cmd_cntx);
void Load(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void Load(CmdArgList args, const CommandContext& cmd_cntx);
// Helper function for bootstrap // Helper function for bootstrap
bool Load(); bool Load();
void Log(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void Log(CmdArgList args, const CommandContext& cmd_cntx);
void Users(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void Users(CmdArgList args, const CommandContext& cmd_cntx);
void Cat(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void Cat(CmdArgList args, const CommandContext& cmd_cntx);
void GetUser(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void GetUser(CmdArgList args, const CommandContext& cmd_cntx);
void DryRun(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void DryRun(CmdArgList args, const CommandContext& cmd_cntx);
void GenPass(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder); void GenPass(CmdArgList args, const CommandContext& cmd_cntx);
// Helper function that updates all open connections and their // Helper function that updates all open connections and their
// respective ACL fields on all the available proactor threads // respective ACL fields on all the available proactor threads

10
src/server/hll_family.cc
View file

@ -294,16 +294,16 @@ OpResult<int> PFMergeInternal(CmdArgList args, Transaction* tx, SinkReplyBuilder
return result; return result;
} }
void PFMerge(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void PFMerge(CmdArgList args, const CommandContext& cmd_cntx) {
OpResult<int> result = PFMergeInternal(args, tx, builder); OpResult<int> result = PFMergeInternal(args, cmd_cntx.tx, cmd_cntx.rb);
if (result.ok()) { if (result.ok()) {
if (result.value() == 0) { if (result.value() == 0) {
builder->SendOk(); cmd_cntx.rb->SendOk();
} else { } else {
builder->SendError(HllFamily::kInvalidHllErr); cmd_cntx.rb->SendError(HllFamily::kInvalidHllErr);
} }
} else { } else {
HandleOpValueResult(result, builder); HandleOpValueResult(result, cmd_cntx.rb);
} }
} }

6
src/server/stream_family.cc
View file

@ -1909,7 +1909,7 @@ void SetId(facade::CmdArgParser* parser, Transaction* tx, SinkReplyBuilder* buil
} }
} }
void XGroupHelp(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) { void XGroupHelp(CmdArgList args, const CommandContext& cmd_cntx) {
string_view help_arr[] = {"XGROUP <subcommand> [<arg> [value] [opt] ...]. Subcommands are:", string_view help_arr[] = {"XGROUP <subcommand> [<arg> [value] [opt] ...]. Subcommands are:",
"CREATE <key> <groupname> <id|$> [option]", "CREATE <key> <groupname> <id|$> [option]",
" Create a new consumer group. Options are:", " Create a new consumer group. Options are:",
@ -1927,7 +1927,7 @@ void XGroupHelp(CmdArgList args, Transaction* tx, SinkReplyBuilder* builder) {
" Set the current group ID and entries_read counter.", " Set the current group ID and entries_read counter.",
"HELP", "HELP",
" Print this help."}; " Print this help."};
auto* rb = static_cast<RedisReplyBuilder*>(builder); auto* rb = static_cast<RedisReplyBuilder*>(cmd_cntx.rb);
return rb->SendSimpleStrArr(help_arr); return rb->SendSimpleStrArr(help_arr);
} }
@ -2474,7 +2474,7 @@ void XReadGeneric2(CmdArgList args, bool read_group, Transaction* tx, SinkReplyB
} }
void HelpSubCmd(facade::CmdArgParser* parser, Transaction* tx, SinkReplyBuilder* builder) { void HelpSubCmd(facade::CmdArgParser* parser, Transaction* tx, SinkReplyBuilder* builder) {
XGroupHelp(parser->Tail(), tx, builder); XGroupHelp(parser->Tail(), CommandContext{tx, builder, nullptr});
} }
bool ParseXpendingOptions(CmdArgList& args, PendingOpts& opts, SinkReplyBuilder* builder) { bool ParseXpendingOptions(CmdArgList& args, PendingOpts& opts, SinkReplyBuilder* builder) {