root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

rabbit_plugins: Add `list/0` to get the list of plugins 

... without having to pass a plugins path.

[Why]
It's painful to have to get the plugins path, then pass it to `list/1`
every time. It's also more difficult to discover how to use
`rabbit_plugins` to get that list of plugins.
This commit is contained in:
Jean-Sébastien Pédron 2025-08-11 11:24:43 +02:00
parent 87c6615ba6
commit 6d3d297598
No known key found for this signature in database
GPG Key ID: 39E99761A5FD94CC
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
deps/rabbit/src/rabbit_plugins.erl vendored
View File

@ -8,7 +8,7 @@
-module(rabbit_plugins). -module(rabbit_plugins).
-include_lib("rabbit_common/include/rabbit.hrl"). -include_lib("rabbit_common/include/rabbit.hrl").
-include_lib("kernel/include/logger.hrl"). -include_lib("kernel/include/logger.hrl").
-export([setup/0, active/0, read_enabled/1, list/1, list/2, dependencies/3, running_plugins/0]). -export([setup/0, active/0, read_enabled/1, list/0, list/1, list/2, dependencies/3, running_plugins/0]).
-export([ensure/1]). -export([ensure/1]).
-export([validate_plugins/1, format_invalid_plugins/1]). -export([validate_plugins/1, format_invalid_plugins/1]).
-export([is_strictly_plugin/1, strictly_plugins/2, strictly_plugins/1]). -export([is_strictly_plugin/1, strictly_plugins/2, strictly_plugins/1]).
@ -130,7 +130,7 @@ setup() ->
-spec active() -> [plugin_name()]. -spec active() -> [plugin_name()].
active() -> active() ->
InstalledPlugins = plugin_names(list(plugins_dir())), InstalledPlugins = plugin_names(list()),
[App || {App, _, _} <- rabbit_misc:which_applications(), [App || {App, _, _} <- rabbit_misc:which_applications(),
lists:member(App, InstalledPlugins)]. lists:member(App, InstalledPlugins)].
@ -157,6 +157,13 @@ is_enabled_on_node(Name, Node) ->
_Class:_Reason:_Stacktrace -> false _Class:_Reason:_Stacktrace -> false
end. end.
-spec list() -> [#plugin{}].
%% @doc Get the list of plugins from the configured plugin path.
list() ->
PluginsPath = plugins_dir(),
list(PluginsPath).
%% @doc Get the list of plugins which are ready to be enabled. %% @doc Get the list of plugins which are ready to be enabled.
-spec list(string()) -> [#plugin{}]. -spec list(string()) -> [#plugin{}].
@ -228,7 +235,7 @@ strictly_plugins(Plugins, AllPlugins) ->
-spec strictly_plugins([plugin_name()]) -> [plugin_name()]. -spec strictly_plugins([plugin_name()]) -> [plugin_name()].
strictly_plugins(Plugins) -> strictly_plugins(Plugins) ->
AllPlugins = list(plugins_dir()), AllPlugins = list(),
lists:filter( lists:filter(
fun(Name) -> fun(Name) ->
is_strictly_plugin(lists:keyfind(Name, #plugin.name, AllPlugins)) is_strictly_plugin(lists:keyfind(Name, #plugin.name, AllPlugins))
@ -283,7 +290,7 @@ running_plugins() ->
prepare_plugins(Enabled) -> prepare_plugins(Enabled) ->
ExpandDir = plugins_expand_dir(), ExpandDir = plugins_expand_dir(),
AllPlugins = list(plugins_dir()), AllPlugins = list(),
Wanted = dependencies(false, Enabled, AllPlugins), Wanted = dependencies(false, Enabled, AllPlugins),
WantedPlugins = lookup_plugins(Wanted, AllPlugins), WantedPlugins = lookup_plugins(Wanted, AllPlugins),
{ValidPlugins, Problems} = validate_plugins(WantedPlugins), {ValidPlugins, Problems} = validate_plugins(WantedPlugins),