Merge pull request #1891 from rabbitmq/fix-dialyzer-warnings-v3.7.x

Fix dialyzer warnings v3.7.x

Author: michaelklishin

src/lager_exchange_backend.erl

@@ -39,8 +39,8 @@
 -record(state, {level :: {'mask', integer()},
                 formatter :: atom(),
                 format_config :: any(),
-                init_exchange_ts = undefined :: rabbit_types:timestamp(),
-                exchange = undefined :: #resource{}}).
+                init_exchange_ts = undefined :: integer() | undefined,
+                exchange = undefined :: #resource{} | undefined}).
 
 -ifdef(TEST).
 -include_lib("eunit/include/eunit.hrl").
@@ -165,8 +165,8 @@ handle_log_event({log, Message},
                                  headers      = Headers},
             Body = rabbit_data_coercion:to_binary(Formatter:format(Message, FormatConfig)),
             case rabbit_basic:publish(LogExch, RoutingKey, AmqpMsg, Body) of
-                {ok, _DeliveredQPids} -> ok;
-                {error, not_found}    -> ok
+                ok                 -> ok;
+                {error, not_found} -> ok
             end,
             {ok, State};
         false ->

src/rabbit.erl

@@ -333,14 +333,10 @@ ensure_config() ->
             log_boot_error_and_exit(check_config_file, ErrFmt, ErrArgs)
     end,
     case rabbit_config:prepare_and_use_config() of
-        {error, Reason} ->
-            {Format, Arg} = case Reason of
-                {generation_error, Error} -> {"~s", [Error]};
-                Other                     -> {"~p", [Other]}
-            end,
+        {error, {generation_error, Error}} ->
             log_boot_error_and_exit(generate_config_file,
-                                    "~nConfig file generation failed "++Format,
-                                    Arg);
+                                    "~nConfig file generation failed ~s",
+                                    Error);
         ok -> ok
     end.
 
@@ -683,6 +679,7 @@ stop_apps(Apps) ->
     end,
     ok.
 
+-spec handle_app_error(_) -> fun((_, _) -> no_return()).
 handle_app_error(Term) ->
     fun(App, {bad_return, {_MFA, {'EXIT', ExitReason}}}) ->
             throw({Term, App, ExitReason});
@@ -972,6 +969,7 @@ boot_error(Class, Reason) ->
       [lager:pr_stacktrace(erlang:get_stacktrace(), {Class, Reason})] ++
       LogLocations).
 
+-spec log_boot_error_and_exit(_, _, _) -> no_return().
 log_boot_error_and_exit(Reason, Format, Args) ->
     rabbit_log:error(Format, Args),
     io:format(standard_error, "~nBOOT FAILED~n===========~n" ++ Format ++ "~n", Args),

src/rabbit_amqqueue.erl

@@ -80,8 +80,8 @@
 -spec declare
         (name(), boolean(), boolean(), rabbit_framing:amqp_table(),
          rabbit_types:maybe(pid()), rabbit_types:username()) ->
-            {'new' | 'existing' | 'absent' | 'owner_died',
-             rabbit_types:amqqueue()} |
+            {'new' | 'existing' | 'owner_died', rabbit_types:amqqueue()} |
+            {'absent', rabbit_types:amqqueue(), absent_reason()} |
             rabbit_types:channel_exit().
 -spec declare
         (name(), boolean(), boolean(), rabbit_framing:amqp_table(),
@@ -129,7 +129,7 @@
 -spec notify_policy_changed(rabbit_types:amqqueue()) -> 'ok'.
 -spec consumers(rabbit_types:amqqueue()) ->
           [{pid(), rabbit_types:ctag(), boolean(), non_neg_integer(),
-            rabbit_framing:amqp_table()}].
+            rabbit_framing:amqp_table(), binary()}].
 -spec consumer_info_keys() -> rabbit_types:info_keys().
 -spec consumers_all(rabbit_types:vhost()) ->
           [{name(), pid(), rabbit_types:ctag(), boolean(),
@@ -161,7 +161,7 @@
 -spec notify_down_all(qpids(), pid()) -> ok_or_errors().
 -spec notify_down_all(qpids(), pid(), non_neg_integer()) ->
           ok_or_errors().
--spec activate_limit_all(qpids(), pid()) -> ok_or_errors().
+-spec activate_limit_all(qpids(), pid()) -> ok.
 -spec basic_get(rabbit_types:amqqueue(), pid(), boolean(), pid()) ->
           {'ok', non_neg_integer(), qmsg()} | 'empty'.
 -spec credit
@@ -453,6 +453,8 @@ not_found_or_absent(Name) ->
         [Q] -> {absent, Q, nodedown} %% Q exists on stopped node
     end.
 
+-spec not_found_or_absent_dirty(name()) -> not_found_or_absent().
+
 not_found_or_absent_dirty(Name) ->
     %% We should read from both tables inside a tx, to get a
     %% consistent view. But the chances of an inconsistency are small,
@@ -465,7 +467,7 @@ not_found_or_absent_dirty(Name) ->
 with(Name, F, E) ->
     with(Name, F, E, 2000).
 
-with(Name, F, E, RetriesLeft) ->
+with(#resource{} = Name, F, E, RetriesLeft) ->
     case lookup(Name) of
         {ok, Q = #amqqueue{state = live}} when RetriesLeft =:= 0 ->
             %% Something bad happened to that queue, we are bailing out
@@ -527,9 +529,15 @@ retry_wait(Q = #amqqueue{pid = QPid, name = Name, state = QState}, F, E, Retries
 with(Name, F) -> with(Name, F, fun (E) -> {error, E} end).
 
 with_or_die(Name, F) ->
-    with(Name, F, fun (not_found)           -> rabbit_misc:not_found(Name);
-                      ({absent, Q, Reason}) -> rabbit_misc:absent(Q, Reason)
-                  end).
+    with(Name, F, die_fun(Name)).
+
+-spec die_fun(name()) ->
+    fun((not_found_or_absent()) -> no_return()).
+
+die_fun(Name) ->
+    fun (not_found)           -> rabbit_misc:not_found(Name);
+        ({absent, Q, Reason}) -> rabbit_misc:absent(Q, Reason)
+    end.
 
 assert_equivalence(#amqqueue{name        = QName,
                              durable     = DurableQ,

src/rabbit_amqqueue_process.erl

@@ -355,7 +355,7 @@ terminate_shutdown(Fun, #q{status = Status} = State) ->
                      QName = qname(State),
                      notify_decorators(shutdown, State),
                      [emit_consumer_deleted(Ch, CTag, QName, ActingUser) ||
-                         {Ch, CTag, _, _, _} <-
+                         {Ch, CTag, _, _, _, _} <-
                              rabbit_queue_consumers:all(Consumers)],
                      State1#q{backing_queue_state = Fun(BQS)}
     end.

src/rabbit_basic.erl

@@ -29,7 +29,7 @@
 -type properties_input() ::
         rabbit_framing:amqp_property_record() | [{atom(), any()}].
 -type publish_result() ::
-        {ok, [pid()]} | rabbit_types:error('not_found').
+        ok | rabbit_types:error('not_found').
 -type header() :: any().
 -type headers() :: rabbit_framing:amqp_table() | 'undefined'.
 
@@ -107,8 +107,8 @@ publish(Delivery = #delivery{
 
 publish(X, Delivery) ->
     Qs = rabbit_amqqueue:lookup(rabbit_exchange:route(X, Delivery)),
-    DeliveredQPids = rabbit_amqqueue:deliver(Qs, Delivery),
-    {ok, DeliveredQPids}.
+    _QPids = rabbit_amqqueue:deliver(Qs, Delivery),
+    ok.
 
 delivery(Mandatory, Confirm, Message, MsgSeqNo) ->
     #delivery{mandatory = Mandatory, confirm = Confirm, sender = self(),

src/rabbit_channel.erl

@@ -773,9 +773,7 @@ send(Command, #ch{writer_pid = WriterPid}) ->
     ok = rabbit_writer:send_command(WriterPid, Command).
 
 format_soft_error(#amqp_error{name = N, explanation = E, method = M}) ->
-    io_lib:format("operation ~s caused a channel exception ~s: ~ts", [M, N, E]);
-format_soft_error(Reason) ->
-    Reason.
+    io_lib:format("operation ~s caused a channel exception ~s: ~ts", [M, N, E]).
 
 handle_exception(Reason, State = #ch{protocol     = Protocol,
                                      channel      = Channel,

src/rabbit_config.erl

@@ -121,9 +121,7 @@ maybe_set_net_ticktime(KernelConfig) ->
                     io:format(standard_error,
                         "~nCouldn't set net_ticktime to ~p "
                         "as net_kernel is busy changing net_ticktime to ~p seconds ~n",
-                        [NetTickTime, NewNetTicktime]);
-                _ ->
-                    ok
+                        [NetTickTime, NewNetTicktime])
             end
     end.
 

src/rabbit_health_check.erl

@@ -53,11 +53,7 @@ run_checks([C|Cs]) ->
 node_health_check(list_channels) ->
     case rabbit_channel:info_local([pid]) of
         L when is_list(L) ->
-            ok;
-        Other ->
-            ErrorMsg = io_lib:format("list_channels unexpected output: ~p",
-                                     [Other]),
-            {error_string, ErrorMsg}
+            ok
     end;
 
 node_health_check(list_queues) ->
@@ -66,11 +62,7 @@ node_health_check(list_queues) ->
 node_health_check(rabbit_node_monitor) ->
     case rabbit_node_monitor:partitions() of
         L when is_list(L) ->
-            ok;
-        Other ->
-            ErrorMsg = io_lib:format("rabbit_node_monitor reports unexpected partitions value: ~p",
-                                     [Other]),
-            {error_string, ErrorMsg}
+            ok
     end;
 
 node_health_check(alarms) ->
@@ -87,9 +79,5 @@ health_check_queues([]) ->
 health_check_queues([VHost|RestVHosts]) ->
     case rabbit_amqqueue:info_local(VHost) of
         L when is_list(L) ->
-            health_check_queues(RestVHosts);
-        Other ->
-            ErrorMsg = io_lib:format("list_queues unexpected output for vhost ~s: ~p",
-                                     [VHost, Other]),
-            {error_string, ErrorMsg}
+            health_check_queues(RestVHosts)
     end.

src/rabbit_mirror_queue_master.erl

@@ -81,15 +81,18 @@
 %% Backing queue
 %% ---------------------------------------------------------------------------
 
+-spec start(_, _) -> no_return().
 start(_Vhost, _DurableQueues) ->
     %% This will never get called as this module will never be
     %% installed as the default BQ implementation.
     exit({not_valid_for_generic_backing_queue, ?MODULE}).
 
+-spec stop(_) -> no_return().
 stop(_Vhost) ->
     %% Same as start/1.
     exit({not_valid_for_generic_backing_queue, ?MODULE}).
 
+-spec delete_crashed(_) -> no_return().
 delete_crashed(_QName) ->
     exit({not_valid_for_generic_backing_queue, ?MODULE}).
 
@@ -223,6 +226,7 @@ purge(State = #state { gm                  = GM,
     {Count, BQS1} = BQ:purge(BQS),
     {Count, State #state { backing_queue_state = BQS1 }}.
 
+-spec purge_acks(_) -> no_return().
 purge_acks(_State) -> exit({not_implemented, {?MODULE, purge_acks}}).
 
 publish(Msg = #basic_message { id = MsgId }, MsgProps, IsDelivered, ChPid, Flow,

src/rabbit_mirror_queue_misc.erl

@@ -58,7 +58,8 @@
 
 -spec remove_from_queue
         (rabbit_amqqueue:name(), pid(), [pid()]) ->
-            {'ok', pid(), [pid()], [node()]} | {'error', 'not_found'}.
+            {'ok', pid(), [pid()], [node()]} | {'error', 'not_found'} |
+            {'error', {'not_synced', [pid()]}}.
 -spec add_mirrors(rabbit_amqqueue:name(), [node()], 'sync' | 'async') ->
           'ok'.
 -spec store_updated_slaves(rabbit_types:amqqueue()) ->

src/rabbit_mirror_queue_sync.erl

@@ -67,6 +67,7 @@
                       non_neg_integer(),
                       bq(), bqs()) ->
                           {'already_synced', bqs()} | {'ok', bqs()} |
+                          {'cancelled', bqs()} |
                           {'shutdown', any(), bqs()} |
                           {'sync_died', any(), bqs()}.
 -spec slave(non_neg_integer(), reference(), timer:tref(), pid(),

src/rabbit_mnesia.erl

@@ -163,20 +163,14 @@ init_from_config() ->
     {DiscoveredNodes, NodeType} =
         case rabbit_peer_discovery:discover_cluster_nodes() of
             {ok, {Nodes, Type} = Config}
-            when is_list(Nodes) andalso (Type == disc orelse Type == disk orelse Type == ram) ->
+              when is_list(Nodes) andalso
+                   (Type == disc orelse Type == disk orelse Type == ram) ->
                 case lists:foldr(FindBadNodeNames, [], Nodes) of
                     []       -> Config;
                     BadNames -> e({invalid_cluster_node_names, BadNames})
                 end;
             {ok, {_, BadType}} when BadType /= disc andalso BadType /= ram ->
                 e({invalid_cluster_node_type, BadType});
-            {ok, Nodes} when is_list(Nodes) ->
-                %% The legacy syntax (a nodes list without the node
-                %% type) is unsupported.
-                case lists:foldr(FindBadNodeNames, [], Nodes) of
-                    [] -> e(cluster_node_type_mandatory);
-                    _  -> e(invalid_cluster_nodes_conf)
-                end;
             {ok, _} ->
                 e(invalid_cluster_nodes_conf)
         end,
@@ -978,6 +972,8 @@ nodes_incl_me(Nodes) -> lists:usort([node()|Nodes]).
 
 nodes_excl_me(Nodes) -> Nodes -- [node()].
 
+-spec e(any()) -> no_return().
+
 e(Tag) -> throw({error, {Tag, error_description(Tag)}}).
 
 error_description({invalid_cluster_node_names, BadNames}) ->
@@ -987,9 +983,6 @@ error_description({invalid_cluster_node_type, BadType}) ->
     "In the 'cluster_nodes' configuration key, the node type is invalid "
         "(expected 'disc' or 'ram'): " ++
         lists:flatten(io_lib:format("~p", [BadType]));
-error_description(cluster_node_type_mandatory) ->
-    "The 'cluster_nodes' configuration key must indicate the node type: "
-        "either {[...], disc} or {[...], ram}";
 error_description(invalid_cluster_nodes_conf) ->
     "The 'cluster_nodes' configuration key is invalid, it must be of the "
         "form {[Nodes], Type}, where Nodes is a list of node names and "

src/rabbit_networking.erl

@@ -93,7 +93,7 @@
 -spec tcp_listener_addresses(listener_config()) -> [address()].
 -spec tcp_listener_spec
         (name_prefix(), address(), [gen_tcp:listen_option()], module(), module(),
-         protocol(), any(), non_neg_integer(), label()) ->
+         any(), protocol(), non_neg_integer(), label()) ->
             supervisor:child_spec().
 -spec ensure_ssl() -> rabbit_types:infos().
 -spec poodle_check(atom()) -> 'ok' | 'danger'.
@@ -113,6 +113,11 @@
          _) ->
             'ok'.
 
+%% @todo Remove once Dialyzer only runs on Erlang/OTP 21.3 or above.
+-dialyzer({nowarn_function, boot/0}).
+-dialyzer({nowarn_function, boot_listeners/3}).
+-dialyzer({nowarn_function, record_distribution_listener/0}).
+
 %%----------------------------------------------------------------------------
 
 boot() ->
@@ -427,6 +432,7 @@ gethostaddr(Host, Family) ->
         {error, Reason} -> host_lookup_error(Host, Reason)
     end.
 
+-spec host_lookup_error(_, _) -> no_return().
 host_lookup_error(Host, Reason) ->
     rabbit_log:error("invalid host ~p - ~p~n", [Host, Reason]),
     throw({error, {invalid_host, Host, Reason}}).

src/rabbit_node_monitor.erl

@@ -104,10 +104,9 @@ cluster_status_filename() ->
 
 prepare_cluster_status_files() ->
     rabbit_mnesia:ensure_mnesia_dir(),
-    Corrupt = fun(F) -> throw({error, corrupt_cluster_status_files, F}) end,
     RunningNodes1 = case try_read_file(running_nodes_filename()) of
                         {ok, [Nodes]} when is_list(Nodes) -> Nodes;
-                        {ok, Other}                       -> Corrupt(Other);
+                        {ok, Other}                       -> corrupt_cluster_status_files(Other);
                         {error, enoent}                   -> []
                     end,
     ThisNode = [node()],
@@ -121,14 +120,19 @@ prepare_cluster_status_files() ->
             {ok, [AllNodes0]} when is_list(AllNodes0) ->
                 {legacy_cluster_nodes(AllNodes0), legacy_disc_nodes(AllNodes0)};
             {ok, Files} ->
-                Corrupt(Files);
+                corrupt_cluster_status_files(Files);
             {error, enoent} ->
                 LegacyNodes = legacy_cluster_nodes([]),
                 {LegacyNodes, LegacyNodes}
         end,
     AllNodes2 = lists:usort(AllNodes1 ++ RunningNodes2),
     ok = write_cluster_status({AllNodes2, DiscNodes, RunningNodes2}).
 
+-spec corrupt_cluster_status_files(any()) -> no_return().
+
+corrupt_cluster_status_files(F) ->
+    throw({error, corrupt_cluster_status_files, F}).
+
 write_cluster_status({All, Disc, Running}) ->
     ClusterStatusFN = cluster_status_filename(),
     Res = case rabbit_file:write_term_file(ClusterStatusFN, [{All, Disc}]) of