Type specs around virtual host addition

(cherry picked from commit d478fad)

Author: michaelklishin

deps/rabbit/src/rabbit_queue_type.erl

@@ -57,6 +57,8 @@
 -type arguments() :: queue_arguments | consumer_arguments.
 -type queue_type() :: rabbit_classic_queue | rabbit_quorum_queue | rabbit_stream_queue.
 
+-export_type([queue_type/0]).
+
 -define(STATE, ?MODULE).
 
 %% Recoverable mirrors shouldn't really be a generic one, but let's keep it here until

deps/rabbit/src/rabbit_vhost.erl

@@ -287,9 +287,22 @@ delete(VHost, ActingUser) ->
     rabbit_vhost_sup_sup:delete_on_all_nodes(VHost),
     ok.
 
+-spec put_vhost(vhost:name(),
+    binary(),
+    vhost:tags(),
+    boolean(),
+    rabbit_types:username()) ->
+    'ok' | {'error', any()} | {'EXIT', any()}.
 put_vhost(Name, Description, Tags0, Trace, Username) ->
     put_vhost(Name, Description, Tags0, undefined, Trace, Username).
 
+-spec put_vhost(vhost:name(),
+    binary(),
+    vhost:unparsed_tags() | vhost:tags(),
+    rabbit_queue_type:queue_type(),
+    boolean(),
+    rabbit_types:username()) ->
+    'ok' | {'error', any()} | {'EXIT', any()}.
 put_vhost(Name, Description, Tags0, DefaultQueueType, Trace, Username) ->
     Tags = case Tags0 of
       undefined   -> <<"">>;
@@ -334,10 +347,13 @@ put_vhost(Name, Description, Tags0, DefaultQueueType, Trace, Username) ->
     end,
     Result.
 
+-spec is_over_vhost_limit(vhost:name()) -> 'ok' | no_return().
 is_over_vhost_limit(Name) ->
     Limit = rabbit_misc:get_env(rabbit, vhost_max, infinity),
     is_over_vhost_limit(Name, Limit).
 
+-spec is_over_vhost_limit(vhost:name(), 'infinity' | non_neg_integer())
+        -> 'ok' | no_return().
 is_over_vhost_limit(_Name, infinity) ->
     ok;
 is_over_vhost_limit(Name, Limit) when is_integer(Limit) ->

deps/rabbit/src/vhost.erl

@@ -42,6 +42,11 @@
                       tags => [atom()],
                       metadata_key() => any()} | undefined).
 
+-type(description() :: binary()).
+-type(tag() :: atom()).
+-type(tags() :: [tag()]).
+-type(unparsed_tags() :: binary() | string() | atom()).
+
 -type vhost() :: vhost_v2().
 
 -record(vhost, {
@@ -68,6 +73,10 @@
 -export_type([name/0,
               metadata_key/0,
               metadata/0,
+              description/0,
+              tag/0,
+              unparsed_tags/0,
+              tags/0,
               vhost/0,
               vhost_v2/0,
               vhost_pattern/0,

deps/rabbitmq_management/src/rabbit_mgmt_wm_vhost.erl

@@ -10,14 +10,16 @@
 -export([init/2, resource_exists/2, to_json/2,
          content_types_provided/2, content_types_accepted/2,
          is_authorized/2, allowed_methods/2, accept_content/2,
-         delete_resource/2, id/1, put_vhost/6]).
+         delete_resource/2, id/1]).
 -export([variances/2]).
 
 -import(rabbit_misc, [pget/2]).
 
 -include_lib("rabbitmq_management_agent/include/rabbit_mgmt_records.hrl").
 -include_lib("rabbit_common/include/rabbit.hrl").
 
+-dialyzer({nowarn_function, accept_content/2}).
+
 %%--------------------------------------------------------------------
 
 init(Req, _State) ->
@@ -67,20 +69,20 @@ accept_content(ReqData0, Context = #context{user = #user{username = Username}})
               %% so fall back to it. See rabbitmq/rabbitmq-server#7734.
               FallbackQT = maps:get(defaultqueuetype, BodyMap, undefined),
               DefaultQT = maps:get(default_queue_type, BodyMap, FallbackQT),
-              case put_vhost(Name, Description, Tags, DefaultQT, Trace, Username) of
+              case rabbit_vhost:put_vhost(Name, Description, Tags, DefaultQT, Trace, Username) of
                   ok ->
                       {true, ReqData, Context};
-                  {'EXIT', {vhost_limit_exceeded,
-                            Explanation}} ->
-                      rabbit_mgmt_util:bad_request(list_to_binary(Explanation), ReqData, Context);
                   {error, timeout} = E ->
                       rabbit_mgmt_util:internal_server_error(
                         "Timed out while waiting for the vhost to initialise", E,
                         ReqData0, Context);
                   {error, E} ->
                       rabbit_mgmt_util:internal_server_error(
                         "Error occured while adding vhost", E,
-                        ReqData0, Context)
+                        ReqData0, Context);
+                  {'EXIT', {vhost_limit_exceeded,
+                      Explanation}} ->
+                      rabbit_mgmt_util:bad_request(list_to_binary(Explanation), ReqData, Context)
               end
       end).
 
@@ -104,5 +106,3 @@ id(ReqData) ->
       Value   -> Value
     end.
 
-put_vhost(Name, Description, Tags, DefaultQT, Trace, Username) ->
-    rabbit_vhost:put_vhost(Name, Description, Tags, DefaultQT, Trace, Username).