Make rabbitmqctl rename_cluster_node's friend, update_cluster_nodes, a no-op

michaelklishin · michaelklishin · commit 7aae9874e9d3 · 2024-01-31T14:30:57.000-05:00
diff --git a/deps/rabbit/src/rabbit_db_cluster.erl b/deps/rabbit/src/rabbit_db_cluster.erl
@@ -23,11 +23,6 @@
          check_consistency/0,
          cli_cluster_status/0]).
 
-%% These two functions are not supported by Khepri and probably
-%% shouldn't be part of this API in the future, but currently
-%% they're needed here so they can fail when invoked using Khepri.
--export([update_cluster_nodes/1]).
-
 -type node_type() :: disc_node_type() | ram_node_type().
 -type disc_node_type() :: disc.
 -type ram_node_type() :: ram.
@@ -389,9 +384,3 @@ cli_cluster_status_using_mnesia() ->
 
 cli_cluster_status_using_khepri() ->
     rabbit_khepri:cli_cluster_status().
-
-update_cluster_nodes(DiscoveryNode) ->
-    case rabbit_khepri:is_enabled() of
-        true  -> {error, not_supported};
-        false -> rabbit_mnesia:update_cluster_nodes(DiscoveryNode)
-    end.
diff --git a/deps/rabbit/src/rabbit_mnesia.erl b/deps/rabbit/src/rabbit_mnesia.erl
@@ -17,7 +17,6 @@
          join_cluster/2,
          reset/0,
          force_reset/0,
-         update_cluster_nodes/1,
          change_cluster_node_type/1,
          forget_cluster_node/2,
          force_load_next_boot/0,
@@ -285,27 +284,6 @@ change_cluster_node_type(Type) ->
     ok = reset(),
     ok = join_cluster(Node, Type).
 
--spec update_cluster_nodes(node()) -> 'ok'.
-
-update_cluster_nodes(DiscoveryNode) ->
-    ensure_mnesia_not_running(),
-    ensure_mnesia_dir(),
-    Status = {AllNodes, _, _} = discover_cluster([DiscoveryNode]),
-    case rabbit_nodes:me_in_nodes(AllNodes) of
-        true ->
-            %% As in `check_consistency/0', we can safely delete the
-            %% schema here, since it'll be replicated from the other
-            %% nodes
-            _ = mnesia:delete_schema([node()]),
-            rabbit_node_monitor:write_cluster_status(Status),
-            rabbit_log:info("Updating cluster nodes from ~tp",
-                            [DiscoveryNode]),
-            init_db_with_mnesia(AllNodes, node_type(), true, true, _Retry = false);
-        false ->
-            e(inconsistent_cluster)
-    end,
-    ok.
-
 %% We proceed like this: try to remove the node locally. If the node
 %% is offline, we remove the node if:
 %%   * This node is a disc node
@@ -1088,16 +1066,14 @@ e(Tag) -> throw({error, {Tag, error_description(Tag)}}).
 
 error_description(clustering_only_disc_node) ->
     "You cannot cluster a node if it is the only disc node in its existing "
-        " cluster. If new nodes joined while this node was offline, use "
-        "'update_cluster_nodes' to add them manually.";
+        " cluster.";
 error_description(resetting_only_disc_node) ->
     "You cannot reset a node when it is the only disc node in a cluster. "
         "Please convert another node of the cluster to a disc node first.";
 error_description(not_clustered) ->
     "Non-clustered nodes can only be disc nodes.";
 error_description(no_online_cluster_nodes) ->
-    "Could not find any online cluster nodes. If the cluster has changed, "
-        "you can use the 'update_cluster_nodes' command.";
+    "Could not find any online cluster nodes.";
 error_description(inconsistent_cluster) ->
     "The nodes provided do not have this node as part of the cluster.";
 error_description(not_a_cluster_node) ->
diff --git a/deps/rabbit/test/clustering_management_SUITE.erl b/deps/rabbit/test/clustering_management_SUITE.erl
@@ -43,9 +43,7 @@ groups() ->
                                                  join_to_start_interval,
                                                  forget_cluster_node,
                                                  change_cluster_node_type,
-                                                 change_cluster_when_node_offline,
-                                                 update_cluster_nodes,
-                                                 force_reset_node
+                                                 change_cluster_when_node_offline
                                                 ]}
                           ]},
                          {clustered_2_nodes, [],
@@ -83,8 +81,7 @@ groups() ->
                                                  persistent_cluster_id,
                                                  stop_start_cluster_node,
                                                  restart_cluster_node,
-                                                 unsupported_forget_cluster_node_offline,
-                                                 unsupported_update_cluster_nodes
+                                                 unsupported_forget_cluster_node_offline
 
                                                 ]}
                           ]},
@@ -926,39 +923,6 @@ change_cluster_when_node_offline(Config) ->
     assert_not_clustered(Bunny),
     ok.
 
-
-update_cluster_nodes(Config) ->
-    [Rabbit, Hare, Bunny] = cluster_members(Config),
-
-    %% Mnesia is running...
-    assert_failure(fun () -> update_cluster_nodes(Config, Rabbit, Hare) end),
-
-    ok = stop_app(Config, Rabbit),
-    ok = join_cluster(Config, Rabbit, Hare),
-    ok = stop_app(Config, Bunny),
-    ok = join_cluster(Config, Bunny, Hare),
-    ok = start_app(Config, Bunny),
-    stop_reset_start(Config, Hare),
-    assert_failure(fun () -> start_app(Config, Rabbit) end),
-    %% Bogus node
-    assert_failure(fun () -> update_cluster_nodes(Config, Rabbit, non@existent) end),
-    %% Inconsistent node
-    assert_failure(fun () -> update_cluster_nodes(Config, Rabbit, Hare) end),
-    ok = update_cluster_nodes(Config, Rabbit, Bunny),
-    ok = start_app(Config, Rabbit),
-    assert_not_clustered(Hare),
-    assert_clustered([Rabbit, Bunny]).
-
-unsupported_update_cluster_nodes(Config) ->
-    [Rabbit, Hare] = cluster_members(Config),
-
-    %% Mnesia is running...
-    assert_failure(fun () -> update_cluster_nodes(Config, Rabbit, Hare) end),
-
-    ok = stop_app(Config, Rabbit),
-    Ret = update_cluster_nodes(Config, Rabbit, Hare),
-    is_not_supported(Ret).
-
 is_not_supported(Ret) ->
     ?assertMatch({error, _, _}, Ret),
     {error, _, Msg} = Ret,
@@ -1012,22 +976,6 @@ classic_config_discovery_node_list(Config) ->
     assert_failure(fun () -> start_app(Config, Hare) end),
     assert_not_clustered(Rabbit).
 
-force_reset_node(Config) ->
-    [Rabbit, Hare, _Bunny] = cluster_members(Config),
-
-    stop_join_start(Config, Rabbit, Hare),
-    stop_app(Config, Rabbit),
-    force_reset(Config, Rabbit),
-    %% Hare thinks that Rabbit is still clustered
-    assert_cluster_status({[Rabbit, Hare], [Rabbit, Hare], [Hare]},
-                          [Hare]),
-    %% %% ...but it isn't
-    assert_cluster_status({[Rabbit], [Rabbit], []}, [Rabbit]),
-    %% We can rejoin Rabbit and Hare
-    update_cluster_nodes(Config, Rabbit, Hare),
-    start_app(Config, Rabbit),
-    assert_clustered([Rabbit, Hare]).
-
 force_reset_node_in_khepri(Config) ->
     [Rabbit, Hare, _Bunny] = cluster_members(Config),
 
@@ -1412,15 +1360,6 @@ change_cluster_node_type(Config, Node, Type) ->
         Error   -> Error
     end.
 
-update_cluster_nodes(Config, Node, DiscoveryNode) ->
-    Ret = rabbit_ct_broker_helpers:rabbitmqctl(
-            Config, Node,
-            ["update_cluster_nodes", atom_to_list(DiscoveryNode)]),
-    case Ret of
-        {ok, _} -> ok;
-        Error   -> Error
-    end.
-
 stop_join_start(Config, Node, ClusterTo, Ram) ->
     ok = stop_app(Config, Node),
     ok = join_cluster(Config, Node, ClusterTo, Ram),
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/node_health_check_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/node_health_check_command.ex
@@ -2,7 +2,7 @@
 ## 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-2023 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.  All rights reserved.
+## Copyright (c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
 
 defmodule RabbitMQ.CLI.Ctl.Commands.NodeHealthCheckCommand do
   alias RabbitMQ.CLI.Core.DocGuide
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/rename_cluster_node_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/rename_cluster_node_command.ex
@@ -2,7 +2,7 @@
 ## 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) 2016-2023 VMware, Inc. or its affiliates.  All rights reserved.
+## Copyright (c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
 
 defmodule RabbitMQ.CLI.Ctl.Commands.RenameClusterNodeCommand do
   require Integer
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/update_cluster_nodes_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/update_cluster_nodes_command.ex
@@ -2,7 +2,7 @@
 ## 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) 2016-2023 VMware, Inc. or its affiliates.  All rights reserved.
+## Copyright (c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
 
 defmodule RabbitMQ.CLI.Ctl.Commands.UpdateClusterNodesCommand do
   alias RabbitMQ.CLI.Core.{Config, DocGuide, Helpers}
@@ -13,21 +13,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.UpdateClusterNodesCommand do
   use RabbitMQ.CLI.Core.AcceptsOnePositionalArgument
   use RabbitMQ.CLI.Core.RequiresRabbitAppStopped
 
-  def run([seed_node], options = %{node: node_name}) do
-    long_or_short_names = Config.get_option(:longnames, options)
-    seed_node_normalised = Helpers.normalise_node(seed_node, long_or_short_names)
-
-    case :rabbit_misc.rpc_call(node_name, :rabbit_db_cluster, :update_cluster_nodes, [
-           seed_node_normalised
-         ]) do
-      {:badrpc, {:EXIT, {:undef, _}}} ->
-        :rabbit_misc.rpc_call(node_name, :rabbit_mnesia, :update_cluster_nodes, [
-          seed_node_normalised
-        ])
-
-      ret0 ->
-        ret0
-    end
+  def run([_seed_node], _opts) do
+    :ok
   end
 
   def usage() do
@@ -46,25 +33,15 @@ defmodule RabbitMQ.CLI.Ctl.Commands.UpdateClusterNodesCommand do
     ]
   end
 
-  def help_section(), do: :cluster_management
-
-  def description(),
-    do:
-      "Instructs a cluster member node to sync the list of known cluster members from <seed_node>"
-
-  def banner([seed_node], %{node: node_name}) do
-    "Will seed #{node_name} from #{seed_node} on next start"
-  end
+  def help_section(), do: :deprecated
 
-  def output({:error, :mnesia_unexpectedly_running}, %{node: node_name}) do
-    {:error, RabbitMQ.CLI.Core.ExitCodes.exit_software(),
-     RabbitMQ.CLI.DefaultOutput.mnesia_running_error(node_name)}
+  def description() do
+    "DEPRECATED. This command is a no-op. Node renaming is incompatible with Raft-based features such as quorum queues, streams, Khepri. "
   end
 
-  def output({:error, :cannot_cluster_node_with_itself}, %{node: node_name}) do
-    {:error, RabbitMQ.CLI.Core.ExitCodes.exit_software(),
-     "Error: cannot cluster node with itself: #{node_name}"}
+  def banner(_, _opts) do
+    [
+      "DEPRECATED. This command is a no-op. Node renaming is incompatible with Raft-based features such as quorum queues, streams, Khepri. "
+    ]
   end
-
-  use RabbitMQ.CLI.DefaultOutput
-end
+end
