valkey-search/src/module_loader.cc at main · valkey-io/valkey-search · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * Copyright (c) 2025, valkey-search contributors
 * All rights reserved.
 * SPDX-License-Identifier: BSD 3-Clause
 *
 */

#include <memory>

#include "src/commands/commands.h"
#include "src/keyspace_event_manager.h"
#include "src/valkey_search.h"
#include "src/version.h"
#include "vmsdk/src/module.h"
#include "vmsdk/src/utils.h"
#include "vmsdk/src/valkey_module_api/valkey_module.h"

namespace {

// Strip the '@' prefix from command categories (e.g., @read)
// to format them for Valkey Search's prefix ACL rules (e.g., read).
inline std::list<absl::string_view> ACLPermissionFormatter(
    const absl::flat_hash_set<absl::string_view> &cmd_permissions) {
  std::list<absl::string_view> permissions;
  for (auto permission : cmd_permissions) {
    CHECK(permission[0] == '@');
    permissions.push_back(permission.substr(1));
  }
  return permissions;
}
}  // namespace

vmsdk::module::Options options = {
    .name = "search",
    .acl_categories = ACLPermissionFormatter({
        valkey_search::kSearchCategory,
    }),
    .version = kModuleVersion,
    .minimum_valkey_server_version = kMinimumServerVersion,
    .info = valkey_search::ModuleInfo,
    .commands =
        {
            {
                .cmd_name = valkey_search::kCreateCommand,
                .permissions = ACLPermissionFormatter(
                    valkey_search::kCreateCmdPermissions),
                .flags = {vmsdk::module::kWriteFlag, vmsdk::module::kFastFlag,
                          vmsdk::module::kDenyOOMFlag},
                .cmd_func = &vmsdk::CreateCommand<valkey_search::FTCreateCmd>,
            },
            {
                .cmd_name = valkey_search::kDropIndexCommand,
                .permissions = ACLPermissionFormatter(
                    valkey_search::kDropIndexCmdPermissions),
                .flags = {vmsdk::module::kWriteFlag, vmsdk::module::kFastFlag},
                .cmd_func =
                    &vmsdk::CreateCommand<valkey_search::FTDropIndexCmd>,
            },
            {
                .cmd_name = valkey_search::kInfoCommand,
                .permissions =
                    ACLPermissionFormatter(valkey_search::kInfoCmdPermissions),
                .flags = {vmsdk::module::kReadOnlyFlag,
                          vmsdk::module::kFastFlag},
                .cmd_func = &vmsdk::CreateCommand<valkey_search::FTInfoCmd>,
            },
            {
                .cmd_name = valkey_search::kListCommand,
                .permissions =
                    ACLPermissionFormatter(valkey_search::kListCmdPermissions),
                .flags = {vmsdk::module::kReadOnlyFlag,
                          vmsdk::module::kAdminFlag},
                .cmd_func = &vmsdk::CreateCommand<valkey_search::FTListCmd>,
            },
            {
                .cmd_name = valkey_search::kSearchCommand,
                .permissions = ACLPermissionFormatter(
                    valkey_search::kSearchCmdPermissions),
                .flags = {vmsdk::module::kReadOnlyFlag,
                          vmsdk::module::kDenyOOMFlag},
                .cmd_func = &vmsdk::CreateCommand<valkey_search::FTSearchCmd>,
            },
            {
                .cmd_name = valkey_search::kDebugCommand,
                .permissions =
                    ACLPermissionFormatter(valkey_search::kDebugCmdPermissions),
                .flags = {vmsdk::module::kReadOnlyFlag,
                          vmsdk::module::kAdminFlag},
                .cmd_func = &vmsdk::CreateCommand<valkey_search::FTDebugCmd>,
            },
            {
                .cmd_name = valkey_search::kInternalUpdateCommand,
                .permissions = ACLPermissionFormatter(
                    valkey_search::kInternalUpdateCmdPermissions),
                .flags = {vmsdk::module::kWriteFlag, vmsdk::module::kAdminFlag,
                          vmsdk::module::kFastFlag},
                .cmd_func =
                    &vmsdk::CreateCommand<valkey_search::FTInternalUpdateCmd>,
            },
            {
                .cmd_name = valkey_search::kAggregateCommand,
                .permissions = ACLPermissionFormatter(
                    valkey_search::kSearchCmdPermissions),
                .flags = {vmsdk::module::kReadOnlyFlag,
                          vmsdk::module::kDenyOOMFlag},
                .cmd_func =
                    &vmsdk::CreateCommand<valkey_search::FTAggregateCmd>,
            },
        },
    .on_load =
        [](ValkeyModuleCtx *ctx, ValkeyModuleString **argv, int argc,
           [[maybe_unused]] const vmsdk::module::Options &options) {
          valkey_search::KeyspaceEventManager::InitInstance(
              std::make_unique<valkey_search::KeyspaceEventManager>());
          valkey_search::ValkeySearch::InitInstance(
              std::make_unique<valkey_search::ValkeySearch>());

          return valkey_search::ValkeySearch::Instance().OnLoad(ctx, argv,
                                                                argc);
        },
    .on_unload =
        [](ValkeyModuleCtx *ctx,
           [[maybe_unused]] const vmsdk::module::Options &options) {
          valkey_search::ValkeySearch::Instance().OnUnload(ctx);
        },
};
VALKEY_MODULE(options);