Merge pull request #12072 from rabbitmq/mergify/bp/v3.13.x/pr-12071

Expose quorum queue status at GET /api/queues/quorum/{vhost}/{name}/status by @SimonUnge (backport #12070) (backport #12071)

Author: michaelklishin

deps/rabbitmq_ct_helpers/src/rabbit_mgmt_test_util.erl

@@ -249,10 +249,13 @@ assert_code(CodeExp, CodeAct, Type, Path, Body) ->
     end.
 
 decode(?OK, _Headers,  ResBody) ->
-    JSON = rabbit_data_coercion:to_binary(ResBody),
-    atomize_map_keys(rabbit_json:decode(JSON));
+    decode_body(ResBody);
 decode(_,    Headers, _ResBody) -> Headers.
 
+decode_body(ResBody) ->
+    JSON = rabbit_data_coercion:to_binary(ResBody),
+    atomize_map_keys(rabbit_json:decode(JSON)).
+
 atomize_map_keys(L) when is_list(L) ->
     [atomize_map_keys(I) || I <- L];
 atomize_map_keys(M) when is_map(M) ->

deps/rabbitmq_management/app.bzl

@@ -99,6 +99,7 @@ def all_beam_files(name = "all_beam_files"):
             "src/rabbit_mgmt_wm_quorum_queue_replicas_delete_member.erl",
             "src/rabbit_mgmt_wm_quorum_queue_replicas_grow.erl",
             "src/rabbit_mgmt_wm_quorum_queue_replicas_shrink.erl",
+            "src/rabbit_mgmt_wm_quorum_queue_status.erl",
             "src/rabbit_mgmt_wm_rebalance_queues.erl",
             "src/rabbit_mgmt_wm_redirect.erl",
             "src/rabbit_mgmt_wm_reset.erl",
@@ -232,6 +233,7 @@ def all_test_beam_files(name = "all_test_beam_files"):
             "src/rabbit_mgmt_wm_quorum_queue_replicas_delete_member.erl",
             "src/rabbit_mgmt_wm_quorum_queue_replicas_grow.erl",
             "src/rabbit_mgmt_wm_quorum_queue_replicas_shrink.erl",
+            "src/rabbit_mgmt_wm_quorum_queue_status.erl",
             "src/rabbit_mgmt_wm_rebalance_queues.erl",
             "src/rabbit_mgmt_wm_redirect.erl",
             "src/rabbit_mgmt_wm_reset.erl",
@@ -455,6 +457,7 @@ def all_srcs(name = "all_srcs"):
             "src/rabbit_mgmt_wm_quorum_queue_replicas_delete_member.erl",
             "src/rabbit_mgmt_wm_quorum_queue_replicas_grow.erl",
             "src/rabbit_mgmt_wm_quorum_queue_replicas_shrink.erl",
+            "src/rabbit_mgmt_wm_quorum_queue_status.erl",
             "src/rabbit_mgmt_wm_rebalance_queues.erl",
             "src/rabbit_mgmt_wm_redirect.erl",
             "src/rabbit_mgmt_wm_reset.erl",

deps/rabbitmq_management/src/rabbit_mgmt_dispatcher.erl

@@ -145,6 +145,7 @@ dispatcher() ->
      {"/queues/quorum/:vhost/:queue/replicas/delete",          rabbit_mgmt_wm_quorum_queue_replicas_delete_member, []},
      {"/queues/quorum/replicas/on/:node/grow",                 rabbit_mgmt_wm_quorum_queue_replicas_grow, []},
      {"/queues/quorum/replicas/on/:node/shrink",               rabbit_mgmt_wm_quorum_queue_replicas_shrink, []},
+     {"/queues/quorum/:vhost/:queue/status",                   rabbit_mgmt_wm_quorum_queue_status, []},
      {"/bindings",                                             rabbit_mgmt_wm_bindings, [all]},
      {"/bindings/:vhost",                                      rabbit_mgmt_wm_bindings, [all]},
      {"/bindings/:vhost/e/:source/:dtype/:destination",        rabbit_mgmt_wm_bindings, [source_destination]},

deps/rabbitmq_management/src/rabbit_mgmt_wm_quorum_queue_status.erl

@@ -0,0 +1,66 @@
+%% This Source Code Form is subject to the terms of the Mozilla Public
+%% License, v. 2.0. If a copy of the MPL was not distributed with this
+%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
+%%
+%% Copyright (c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
+%%
+
+%% An HTTP API counterpart of 'rabbitmq-diagnostics check_if_node_is_quorum_critical'
+-module(rabbit_mgmt_wm_quorum_queue_status).
+
+-export([init/2, to_json/2, content_types_provided/2, is_authorized/2, allowed_methods/2]).
+-export([resource_exists/2]).
+-export([variances/2]).
+
+-include_lib("rabbitmq_management_agent/include/rabbit_mgmt_records.hrl").
+
+%%--------------------------------------------------------------------
+
+init(Req, _State) ->
+    {cowboy_rest, rabbit_mgmt_headers:set_common_permission_headers(Req, ?MODULE), #context{}}.
+
+variances(Req, Context) ->
+    {[<<"accept-encoding">>, <<"origin">>], Req, Context}.
+
+allowed_methods(ReqData, Context) ->
+  {[<<"GET">>, <<"OPTIONS">>], ReqData, Context}.
+
+content_types_provided(ReqData, Context) ->
+   {rabbit_mgmt_util:responder_map(to_json), ReqData, Context}.
+
+resource_exists(ReqData, Context) ->
+    {case queue(ReqData) of
+         not_found -> false;
+         _         -> true
+     end, ReqData, Context}.
+
+to_json(ReqData, Context) ->
+    case  queue(ReqData) of
+        {error, Reason} ->
+            failure(Reason, ReqData, Context);
+        Res ->
+            rabbit_mgmt_util:reply(Res, ReqData, Context)
+    end.
+
+queue(ReqData) ->
+    case rabbit_mgmt_util:vhost(ReqData) of
+        not_found -> not_found;
+        VHost     -> queue(VHost, rabbit_mgmt_util:id(queue, ReqData))
+    end.
+
+queue(VHost, QName) ->
+    Name = rabbit_misc:r(VHost, queue, QName),
+    case rabbit_amqqueue:lookup(Name) of
+        {ok, _Q}            -> rabbit_quorum_queue:status(VHost, QName);
+        {error, not_found} -> not_found
+    end.
+
+
+failure(Reason, ReqData, Context) ->
+    {Response, ReqData1, Context1} = rabbit_mgmt_util:reply([{status, failed},
+                                                             {reason, Reason}],
+                                                            ReqData, Context),
+    {stop, cowboy_req:reply(503, #{}, Response, ReqData1), Context1}.
+
+is_authorized(ReqData, Context) ->
+    rabbit_mgmt_util:is_authorized(ReqData, Context).

deps/rabbitmq_management/test/rabbit_mgmt_http_SUITE.erl

@@ -18,6 +18,7 @@
                                    open_unmanaged_connection/3]).
 -import(rabbit_mgmt_test_util, [assert_list/2, assert_item/2, test_item/2,
                                 assert_keys/2, assert_no_keys/2,
+                                decode_body/1,
                                 http_get/2, http_get/3, http_get/5,
                                 http_get_no_auth/3,
                                 http_get_no_decode/5,
@@ -196,6 +197,7 @@ all_tests() -> [
     user_limit_set_test,
     config_environment_test,
     disabled_qq_replica_opers_test,
+    qq_status_test,
     list_deprecated_features_test,
     list_used_deprecated_features_test
 ].
@@ -3730,6 +3732,28 @@ disabled_qq_replica_opers_test(Config) ->
     http_delete(Config, "/queues/quorum/replicas/on/" ++ Nodename ++ "/shrink", ?METHOD_NOT_ALLOWED),
     passed.
 
+qq_status_test(Config) ->
+    QQArgs = [{durable, true}, {arguments, [{'x-queue-type', 'quorum'}]}],
+    http_get(Config, "/queues/%2f/qq_status", ?NOT_FOUND),
+    http_put(Config, "/queues/%2f/qq_status", QQArgs, {group, '2xx'}),
+    [MapRes] = http_get(Config, "/queues/quorum/%2f/qq_status/status", ?OK),
+    Keys = ['Commit Index','Last Applied','Last Log Index',
+            'Last Written','Machine Version','Membership','Node Name',
+            'Raft State','Snapshot Index','Term'],
+    ?assertEqual(lists:sort(Keys), lists:sort(maps:keys(MapRes))),
+    http_delete(Config, "/queues/%2f/qq_status", {group, '2xx'}),
+
+
+    CQArgs = [{durable, true}],
+    http_get(Config, "/queues/%2F/cq_status", ?NOT_FOUND),
+    http_put(Config, "/queues/%2F/cq_status", CQArgs, {group, '2xx'}),
+    ResBody = http_get_no_decode(Config, "/queues/quorum/%2f/cq_status/status", "guest", "guest", 503),
+    ?assertEqual(#{reason => <<"classic_queue_not_supported">>,
+                   status => <<"failed">>}, decode_body(ResBody)),
+    http_delete(Config, "/queues/%2f/cq_status", {group, '2xx'}),
+    passed.
+
+
 list_deprecated_features_test(Config) ->
     Desc = "This is a deprecated feature",
     DocUrl = "https://rabbitmq.com/",

moduleindex.yaml

@@ -1015,6 +1015,7 @@ rabbitmq_management:
 - rabbit_mgmt_wm_quorum_queue_replicas_delete_member
 - rabbit_mgmt_wm_quorum_queue_replicas_grow
 - rabbit_mgmt_wm_quorum_queue_replicas_shrink
+- rabbit_mgmt_wm_quorum_queue_status
 - rabbit_mgmt_wm_rebalance_queues
 - rabbit_mgmt_wm_redirect
 - rabbit_mgmt_wm_reset