Add metadata for vhosts in global definitions exported via UI #11454
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The limit code part remains untouched.
The behaviours of @michaelklishin Please confirm if limits and |
michaelklishin
force-pushed
the
rabbitmq-server-10515
branch
from
a2f6d70
to
29de365
Compare
|
The forced push was a rebase. |
|
@anhanhnguyen I will have to take a look at what the behavior of the virtual host-specific exporting endpoint is, and how it compares to CLI tools. I will get back to you next week. |
michaelklishin
force-pushed
the
rabbitmq-server-10515
branch
from
29de365
to
2dbb90f
Compare
michaelklishin
requested changes
Jun 23, 2024
in the definition import test immediately reveals an exception. Looks like this is the relevant part: |
michaelklishin
requested changes
Jun 23, 2024
| binary_to_list(Filename), ReqData) | ||
| end, | ||
| Context). | ||
| rabbit_definitions:all_definitions(), |
There was a problem hiding this comment.
This function can return keys that the HTTP API cannot serialize to JSON as is.
Which is why this filtering exists in the same module:
rw_state() ->
[{users, [name, password_hash, hashing_algorithm, tags, limits]},
{vhosts, [name]},
{permissions, [user, vhost, configure, write, read]},
{topic_permissions, [user, vhost, exchange, write, read]},
{parameters, [vhost, component, name, value]},
{global_parameters, [name, value]},
{policies, [vhost, name, pattern, definition, priority, 'apply-to']},
{queues, [name, vhost, durable, auto_delete, arguments]},
{exchanges, [name, vhost, type, durable, auto_delete, internal,
arguments]},
{bindings, [source, vhost, destination, destination_type, routing_key,
arguments]}].
filter(Items) ->
[filter_items(N, V, proplists:get_value(N, rw_state())) || {N, V} <- Items].
|
I'm afraid I cannot accept this pull request as is. It breaks the HTTP API by removing the filtering and assuming that anything returned by It hijacks an existing test to test something different then uses dummy values such as an empty list of tags and an empty description string. Using an empty list of tags specifically won't test much. The implementation part should have been diff --git a/deps/rabbitmq_management/src/rabbit_mgmt_wm_definitions.erl b/deps/rabbitmq_management/src/rabbit_mgmt_wm_definitions.erl
index 06f98b1408..65c833450f 100644
--- a/deps/rabbitmq_management/src/rabbit_mgmt_wm_definitions.erl
+++ b/deps/rabbitmq_management/src/rabbit_mgmt_wm_definitions.erl
@@ -254,7 +254,7 @@ export_name(_Name) -> true.
rw_state() ->
[{users, [name, password_hash, hashing_algorithm, tags, limits]},
- {vhosts, [name]},
+ {vhosts, [name, description, tags, default_queue_type, metadata]},
{permissions, [user, vhost, configure, write, read]},
{topic_permissions, [user, vhost, exchange, write, read]},
{parameters, [vhost, component, name, value]},
diff --git a/deps/rabbitmq_management/src/rabbit_mgmt_wm_vhosts.erl b/deps/rabbitmq_management/src/rabbit_mgmt_wm_vhosts.erl
index 2decdfc9ed..a0779a2af3 100644
--- a/deps/rabbitmq_management/src/rabbit_mgmt_wm_vhosts.erl
+++ b/deps/rabbitmq_management/src/rabbit_mgmt_wm_vhosts.erl
@@ -55,7 +55,7 @@ augment(Basic, ReqData) ->
augmented(ReqData, #context{user = User}) ->
case rabbit_mgmt_util:disable_stats(ReqData) of
- false ->
+ false ->
rabbit_mgmt_db:augment_vhosts(
[rabbit_vhost:info(V) || V <- rabbit_mgmt_util:list_visible_vhosts(User)],
rabbit_mgmt_util:range(ReqData));
@@ -64,4 +64,4 @@ augmented(ReqData, #context{user = User}) ->
end.
basic() ->
- rabbit_vhost:info_all([name]).
+ rabbit_vhost:info_all([name, description, tags, default_queue_type, metadata]).and a new test should have been added to test the metadata specifically. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
Fix the issue reported at #10515.
Types of Changes
What types of changes does your code introduce to this project?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply.You can also fill these out after creating the PR.
If you're unsure about any of them, don't hesitate to ask on the mailing list.
We're here to help!
This is simply a reminder of what we are going to look for before merging your code.
CONTRIBUTING.mddocumentFurther Comments
The change aims to synchronise the output of
GET /api/definitionsandrabbitmqctl export_definitionsrabbit_definitions:all_definitions()asrabbitmqctl export_definitionsdefinition_import_SUITEand its input cases are covered