Skip to content

Introduce a configurable directory for 3rd party plugins that's not deleted during the Mnesia => Khepri migration #14622

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

Merged
merged 2 commits into from
Sep 26, 2025
Merged

Introduce a configurable directory for 3rd party plugins that's not deleted during the Mnesia => Khepri migration #14622

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
3442c91
Introduce "plugins_data_dir" which is preserved during khepri migration
gomoripeti Sep 24, 2025
f2131c6
Naming #11304
michaelklishin Sep 26, 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
3 changes: 2 additions & 1 deletion deps/rabbit/src/rabbit_mnesia.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1066,7 +1066,8 @@ mnesia_and_msg_store_files() ->
rabbit_node_monitor:classic_filename(),
rabbit_node_monitor:quorum_filename(),
rabbit_feature_flags:enabled_feature_flags_list_file(),
rabbit_khepri:dir()],
rabbit_khepri:dir(),
rabbit_plugins:user_provided_plugins_data_dir()],
IgnoredFiles = [filename:basename(File) || File <- IgnoredFiles0],
?LOG_DEBUG("Files and directories found in node's data directory: ~ts, of them to be ignored: ~ts",
[string:join(lists:usort(List0), ", "), string:join(lists:usort(IgnoredFiles), ", ")]),
Expand Down
10 changes: 10 additions & 0 deletions deps/rabbit/src/rabbit_plugins.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
-export([validate_plugins/1, format_invalid_plugins/1]).
-export([is_strictly_plugin/1, strictly_plugins/2, strictly_plugins/1]).
-export([plugins_dir/0, plugin_names/1, plugins_expand_dir/0, enabled_plugins_file/0]).
-export([user_provided_plugins_data_dir/0]).
-export([is_enabled/1, is_enabled_on_node/2, enabled_plugins/0]).
-export([which_plugin/1]).

Expand Down Expand Up @@ -93,6 +94,15 @@ plugins_dir() ->
filename:join([rabbit:data_dir(), "plugins_dir_stub"])
end.

user_provided_plugins_data_dir() ->
case application:get_env(rabbit, user_provided_plugins_data_dir) of
{ok, PluginsDataDir} ->
PluginsDataDir;
_ ->
DataDir = rabbit_mnesia:dir(),
filename:join([DataDir, "user_provided_plugins_data_dir"])
end.

-spec enabled_plugins_file() -> file:filename().
enabled_plugins_file() ->
case application:get_env(rabbit, enabled_plugins_file) of
Expand Down
8 changes: 8 additions & 0 deletions deps/rabbit/test/metadata_store_migration_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,11 @@ from_mnesia_to_khepri(Config) ->
Maintenance = rabbit_ct_broker_helpers:rpc(Config, 0, rabbit_db_maintenance, get, [Server]),
?assertNot(undefined == Maintenance),

PluginsDataDir = rabbit_ct_broker_helpers:rpc(Config, 0, rabbit_plugins, user_provided_plugins_data_dir, []),
ok = file:make_dir(PluginsDataDir),
PluginDataFile = filename:join(PluginsDataDir, "test.txt"),
ok = file:write_file(PluginDataFile, "test content"),

%% 2)
Servers = rabbit_ct_broker_helpers:get_node_configs(Config, nodename),
ok = rabbit_ct_broker_helpers:enable_feature_flag(Config, Servers, khepri_db),
Expand Down Expand Up @@ -156,5 +161,8 @@ from_mnesia_to_khepri(Config) ->
MaintenanceK = rabbit_ct_broker_helpers:rpc(Config, 0, rabbit_db_maintenance, get, [Server]),
?assertEqual(MaintenanceK, Maintenance),

%% plugin data file should be preserved
?assertEqual({ok, <<"test content">>}, file:read_file(PluginDataFile)),

ok.

Loading