Remove deprected APIs in ra module.

kjnilsson · kjnilsson · commit f9c3c98e38a3 · 2025-01-06T12:20:56.000Z
diff --git a/src/ra.erl b/src/ra.erl
@@ -44,16 +44,10 @@
          delete_cluster/1,
          delete_cluster/2,
          % server management
-         % deprecated
-         start_server/1,
          start_server/2,
          start_server/5,
-         % deprecated
-         restart_server/1,
          restart_server/2,
          restart_server/3,
-         % deprecated
-         stop_server/1,
          stop_server/2,
          force_delete_server/2,
          trigger_election/1,
@@ -68,8 +62,6 @@
          leave_and_delete_server/3,
          leave_and_delete_server/4,
          %% troubleshooting
-         % deprecated
-         overview/0,
          overview/1,
          %% helpers
          new_uid/1,
@@ -78,20 +70,12 @@
          %% auxiliary commands
          aux_command/2,
          cast_aux_command/2,
-         register_external_log_reader/1,
          member_overview/1,
          member_overview/2,
          key_metrics/1,
          key_metrics/2
         ]).
 
-%% xref should pick these up
--deprecated({start_server, 1}).
--deprecated({restart_server, 1}).
--deprecated({stop_server, 1}).
--deprecated({overview, 0}).
--deprecated({register_external_log_reader, 1}).
-
 -define(START_TIMEOUT, ?DEFAULT_TIMEOUT).
 
 -type ra_cmd_ret() :: ra_server_proc:ra_cmd_ret().
@@ -170,19 +154,6 @@ start(Params) when is_list(Params) ->
 start_in(DataDir) ->
     start([{data_dir, DataDir}]).
 
-%% @doc Restarts a previously successfully started ra server in the default system
-%% @param ServerId the ra_server_id() of the server
-%% @returns `{ok | error, Error}' where error can be
-%% `not_found', `system_not_started' or `name_not_registered' when the
-%% ra server has never before been started on the Erlang node.
-%% DEPRECATED: use restart_server/2
-%% @end
--spec restart_server(ra_server_id()) ->
-    ok | {error, term()}.
-restart_server(ServerId) ->
-    %% TODO: this is a bad overload
-    restart_server(default, ServerId).
-
 %% @doc Restarts a previously successfully started ra server
 %% @param System the system identifier
 %% @param ServerId the ra_server_id() of the server
@@ -226,16 +197,6 @@ restart_server(System, ServerId, AddConfig)
         {'EXIT', Err} -> {error, Err}
     end.
 
-%% @doc Stops a ra server in the default system
-%% @param ServerId the ra_server_id() of the server
-%% @returns `{ok | error, nodedown}'
-%% DEPRECATED: use stop_server/2
-%% @end
--spec stop_server(ra_server_id()) ->
-    ok | {error, nodedown | system_not_started}.
-stop_server(ServerId) ->
-    stop_server(default, ServerId).
-
 %% @doc Stops a ra server
 %% @param System the system name
 %% @param ServerId the ra_server_id() of the server
@@ -508,16 +469,6 @@ start_server(System, ClusterName, #{id := {_, _}} = Conf0, Machine, ServerIds)
              machine => Machine},
     start_server(System, maps:merge(Conf0, Conf)).
 
-%% @doc Starts a ra server in the default system
-%% @param Conf a ra_server_config() configuration map.
-%% @returns `{ok | error, Error}'
-%% DEPRECATED: use start_server/2
-%% @end
--spec start_server(ra_server:ra_server_config()) ->
-    ok | {error, term()}.
-start_server(Conf) ->
-    start_server(default, Conf).
-
 %% @doc Starts a ra server
 %% @param System the system name
 %% @param Conf a ra_server_config() configuration map.
@@ -741,14 +692,6 @@ new_uid(Source) when is_binary(Source) ->
     Prefix = ra_lib:derive_safe_string(Source, 6),
     ra_lib:make_uid(string:uppercase(Prefix)).
 
-%% @doc Returns a map of overview data of the default Ra system on the current Erlang
-%% node.
-%% DEPRECATED: use overview/1
-%% @end
--spec overview() -> map() | system_not_started.
-overview() ->
-    overview(default).
-
 %% @doc Returns a map of overview data of the Ra system on the current Erlang
 %% node.
 %% @end
@@ -1181,18 +1124,6 @@ aux_command(ServerRef, Cmd) ->
 cast_aux_command(ServerRef, Cmd) ->
     gen_statem:cast(ServerRef, {aux_command, Cmd}).
 
-%% @doc Registers an external log reader. ServerId needs to be local to the node.
-%% Returns an initiated ra_log_reader:state() state.
-%% Deprecated. Now only reads log data stored in segments, not log data
-%% in mem tables.
-%% @end
--spec register_external_log_reader(ra_server_id()) ->
-    ra_log_reader:state().
-register_external_log_reader({_, Node} = ServerId)
- when Node =:= node() ->
-    {ok, Reader} = gen_statem:call(ServerId, {register_external_log_reader, self()}),
-    Reader.
-
 %% @doc Returns a overview map of the internal server state
 %%
 %% The keys and values will typically remain stable but may
diff --git a/test/coordination_SUITE.erl b/test/coordination_SUITE.erl
@@ -942,15 +942,15 @@ segment_writer_or_wal_crash_follower(Config) ->
      end || I <- lists:seq(1, 10)],
 
     %% stop and restart the follower
-    ok = ra:stop_server(Follower),
-    ok = ra:restart_server(Follower),
+    ok = ra:stop_server(?SYS, Follower),
+    ok = ra:restart_server(?SYS, Follower),
 
     await_condition(AwaitReplicated, 100),
 
     _ = ct_rpc:call(FollowerNode, ra_log_wal, force_rollover, [ra_log_wal]),
 
-    ok = ra:stop_server(Follower),
-    ok = ra:restart_server(Follower),
+    ok = ra:stop_server(?SYS, Follower),
+    ok = ra:restart_server(?SYS, Follower),
 
     await_condition(AwaitReplicated, 100),
 
@@ -1052,15 +1052,15 @@ segment_writer_or_wal_crash_leader(Config) ->
      end || I <- lists:seq(1, 10)],
 
     %% stop and restart the leader
-    ok = ra:stop_server(Leader),
-    ok = ra:restart_server(Leader),
+    ok = ra:stop_server(?SYS, Leader),
+    ok = ra:restart_server(?SYS, Leader),
 
     await_condition(AwaitReplicated, 100),
 
     _ = ct_rpc:call(LeaderNode, ra_log_wal, force_rollover, [ra_log_wal]),
 
-    ok = ra:stop_server(Leader),
-    ok = ra:restart_server(Leader),
+    ok = ra:stop_server(?SYS, Leader),
+    ok = ra:restart_server(?SYS, Leader),
 
     await_condition(AwaitReplicated, 100),
 
diff --git a/test/ra_2_SUITE.erl b/test/ra_2_SUITE.erl
@@ -42,8 +42,6 @@ all_tests() ->
      custom_ra_event_formatter,
      config_modification_at_restart,
      segment_writer_handles_server_deletion,
-     %% TODO: mt decide on whether to support this
-     % external_reader,
      add_member_without_quorum,
      force_start_follower_as_single_member,
      force_start_follower_as_single_member_nonvoter,
@@ -583,33 +581,6 @@ segment_writer_handles_server_deletion(Config) ->
     end,
     ok.
 
-external_reader(Config) ->
-    ok = logger:set_primary_config(level, all),
-    ServerId = ?config(server_id, Config),
-    ClusterName = ?config(cluster_name, Config),
-    ok = start_cluster(ClusterName, [ServerId]),
-    ra:members(ServerId),
-    ok = enqueue(ServerId, msg1),
-    [begin
-         _ = ra:pipeline_command(ServerId, {enq, N}, no_correlation, normal)
-     end || N <- lists:seq(1, 1023)],
-    _ = enqueue(ServerId, final),
-    R0 = ra:register_external_log_reader(ServerId),
-    ok = force_roll_over(),
-    receive
-        {ra_event, _, {machine, {ra_log_update, _, _, _} = E}} ->
-            R1 = ra_log_reader:handle_log_update(E, R0),
-            {Entries, _R2} = ra_log_reader:sparse_read(R1, lists:seq(0, 1026), []),
-            ct:pal("read ~w ~w", [length(Entries), lists:last(Entries)]),
-            %% read all entries
-            ok
-    after 3000 ->
-              flush(),
-              exit(ra_log_update_timeout)
-    end,
-    ra:delete_cluster([ServerId]),
-    ok.
-
 add_member_without_quorum(Config) ->
     ok = logger:set_primary_config(level, all),
     %% ra:start_server should fail if the node already exists
diff --git a/test/ra_SUITE.erl b/test/ra_SUITE.erl
@@ -775,8 +775,8 @@ consistent_query_after_restart(Config) ->
          {ok, _, _} = ra:process_command(A, N, ?PROCESS_COMMAND_TIMEOUT),
          application:stop(ra),
          restart_ra(DataDir),
-         ok = ra:restart_server(A),
-         ok = ra:restart_server(B),
+         ok = ra:restart_server(?SYS, A),
+         ok = ra:restart_server(?SYS, B),
          ?assertMatch({ok, N, _}, ra:consistent_query(A, fun(S) -> S end))
      end || N <- lists:seq(1, 30)],
 
@@ -789,15 +789,15 @@ consistent_query_minority(Config) ->
     {ok, _, Leader} = ra:process_command(A, 9,
                                          ?PROCESS_COMMAND_TIMEOUT),
     [F1, F2] = Cluster -- [Leader],
-    ra:stop_server(F1),
-    ra:stop_server(F2),
+    ra:stop_server(?SYS, F1),
+    ra:stop_server(?SYS, F2),
 
     {timeout, _} = ra:consistent_query(Leader, fun(S) -> S end),
     %% restart after a short sleep so that quorum is restored whilst the next
     %% query is executing
     _ = spawn(fun() ->
                       timer:sleep(1000),
-                      ra:restart_server(F1),
+                      ra:restart_server(?SYS, F1),
                       ok
               end),
     {ok, 9, _} = ra:consistent_query(Leader, fun(S) -> S end, 10000),
@@ -816,11 +816,11 @@ consistent_query_leader_change(Config) ->
     {ok, _, A} = ra:process_command(A, 9, ?PROCESS_COMMAND_TIMEOUT),
     %% do two consistent queries, this will put query_index == 2 everywhere
     {ok, 9, A} = ra:consistent_query(A, fun(S) -> S end),
-    ok = ra:stop_server(E),
+    ok = ra:stop_server(?SYS, E),
     {ok, 9, A} = ra:consistent_query(A, fun(S) -> S end),
     %% restart B
-    ok = ra:stop_server(B),
-    ok = ra:restart_server(B),
+    ok = ra:stop_server(?SYS, B),
+    ok = ra:restart_server(?SYS, B),
     %% Wait for B to recover and catch up.
     {ok, #{log := #{last_written_index_term := CurrentIdxTerm}}, _} =
       ra:member_overview(A),
@@ -838,12 +838,12 @@ consistent_query_leader_change(Config) ->
               ra_leaderboard:lookup_leader(ClusterName) =:= B
       end, 20),
     %% restart E
-    ok = ra:restart_server(E),
+    ok = ra:restart_server(?SYS, E),
     {ok, 9, B} = ra:consistent_query(B, fun(S) -> S end),
 
-    ok = ra:stop_server(A),
-    ok = ra:stop_server(C),
-    ok = ra:stop_server(D),
+    ok = ra:stop_server(?SYS, A),
+    ok = ra:stop_server(?SYS, C),
+    ok = ra:stop_server(?SYS, D),
 
     %% there is no quorum now so this should time out
     case ra:consistent_query(B, fun(S) -> S end, 500) of
@@ -853,9 +853,9 @@ consistent_query_leader_change(Config) ->
             ct:fail("consistent query should time out"),
             ok
     end,
-    ok = ra:restart_server(A),
-    ok = ra:restart_server(C),
-    ok = ra:restart_server(D),
+    ok = ra:restart_server(?SYS, A),
+    ok = ra:restart_server(?SYS, C),
+    ok = ra:restart_server(?SYS, D),
     {ok, 9, _} = ra:consistent_query(A, fun(S) -> S end),
     {ok, 9, _} = ra:consistent_query(B, fun(S) -> S end),
     {ok, 9, _} = ra:consistent_query(C, fun(S) -> S end),
