Skip to content

Commit b16aee3

Browse files
committed
Remove deprected APIs in ra module.
1 parent bde7edd commit b16aee3

File tree

4 files changed

+23
-121
lines changed

4 files changed

+23
-121
lines changed

src/ra.erl

Lines changed: 0 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,10 @@
4444
delete_cluster/1,
4545
delete_cluster/2,
4646
% server management
47-
% deprecated
48-
start_server/1,
4947
start_server/2,
5048
start_server/5,
51-
% deprecated
52-
restart_server/1,
5349
restart_server/2,
5450
restart_server/3,
55-
% deprecated
56-
stop_server/1,
5751
stop_server/2,
5852
force_delete_server/2,
5953
trigger_election/1,
@@ -68,8 +62,6 @@
6862
leave_and_delete_server/3,
6963
leave_and_delete_server/4,
7064
%% troubleshooting
71-
% deprecated
72-
overview/0,
7365
overview/1,
7466
%% helpers
7567
new_uid/1,
@@ -78,20 +70,12 @@
7870
%% auxiliary commands
7971
aux_command/2,
8072
cast_aux_command/2,
81-
register_external_log_reader/1,
8273
member_overview/1,
8374
member_overview/2,
8475
key_metrics/1,
8576
key_metrics/2
8677
]).
8778

88-
%% xref should pick these up
89-
-deprecated({start_server, 1}).
90-
-deprecated({restart_server, 1}).
91-
-deprecated({stop_server, 1}).
92-
-deprecated({overview, 0}).
93-
-deprecated({register_external_log_reader, 1}).
94-
9579
-define(START_TIMEOUT, ?DEFAULT_TIMEOUT).
9680

9781
-type ra_cmd_ret() :: ra_server_proc:ra_cmd_ret().
@@ -170,19 +154,6 @@ start(Params) when is_list(Params) ->
170154
start_in(DataDir) ->
171155
start([{data_dir, DataDir}]).
172156

173-
%% @doc Restarts a previously successfully started ra server in the default system
174-
%% @param ServerId the ra_server_id() of the server
175-
%% @returns `{ok | error, Error}' where error can be
176-
%% `not_found', `system_not_started' or `name_not_registered' when the
177-
%% ra server has never before been started on the Erlang node.
178-
%% DEPRECATED: use restart_server/2
179-
%% @end
180-
-spec restart_server(ra_server_id()) ->
181-
ok | {error, term()}.
182-
restart_server(ServerId) ->
183-
%% TODO: this is a bad overload
184-
restart_server(default, ServerId).
185-
186157
%% @doc Restarts a previously successfully started ra server
187158
%% @param System the system identifier
188159
%% @param ServerId the ra_server_id() of the server
@@ -226,16 +197,6 @@ restart_server(System, ServerId, AddConfig)
226197
{'EXIT', Err} -> {error, Err}
227198
end.
228199

229-
%% @doc Stops a ra server in the default system
230-
%% @param ServerId the ra_server_id() of the server
231-
%% @returns `{ok | error, nodedown}'
232-
%% DEPRECATED: use stop_server/2
233-
%% @end
234-
-spec stop_server(ra_server_id()) ->
235-
ok | {error, nodedown | system_not_started}.
236-
stop_server(ServerId) ->
237-
stop_server(default, ServerId).
238-
239200
%% @doc Stops a ra server
240201
%% @param System the system name
241202
%% @param ServerId the ra_server_id() of the server
@@ -508,16 +469,6 @@ start_server(System, ClusterName, #{id := {_, _}} = Conf0, Machine, ServerIds)
508469
machine => Machine},
509470
start_server(System, maps:merge(Conf0, Conf)).
510471

511-
%% @doc Starts a ra server in the default system
512-
%% @param Conf a ra_server_config() configuration map.
513-
%% @returns `{ok | error, Error}'
514-
%% DEPRECATED: use start_server/2
515-
%% @end
516-
-spec start_server(ra_server:ra_server_config()) ->
517-
ok | {error, term()}.
518-
start_server(Conf) ->
519-
start_server(default, Conf).
520-
521472
%% @doc Starts a ra server
522473
%% @param System the system name
523474
%% @param Conf a ra_server_config() configuration map.
@@ -741,14 +692,6 @@ new_uid(Source) when is_binary(Source) ->
741692
Prefix = ra_lib:derive_safe_string(Source, 6),
742693
ra_lib:make_uid(string:uppercase(Prefix)).
743694

744-
%% @doc Returns a map of overview data of the default Ra system on the current Erlang
745-
%% node.
746-
%% DEPRECATED: use overview/1
747-
%% @end
748-
-spec overview() -> map() | system_not_started.
749-
overview() ->
750-
overview(default).
751-
752695
%% @doc Returns a map of overview data of the Ra system on the current Erlang
753696
%% node.
754697
%% @end
@@ -1181,18 +1124,6 @@ aux_command(ServerRef, Cmd) ->
11811124
cast_aux_command(ServerRef, Cmd) ->
11821125
gen_statem:cast(ServerRef, {aux_command, Cmd}).
11831126

1184-
%% @doc Registers an external log reader. ServerId needs to be local to the node.
1185-
%% Returns an initiated ra_log_reader:state() state.
1186-
%% Deprecated. Now only reads log data stored in segments, not log data
1187-
%% in mem tables.
1188-
%% @end
1189-
-spec register_external_log_reader(ra_server_id()) ->
1190-
ra_log_reader:state().
1191-
register_external_log_reader({_, Node} = ServerId)
1192-
when Node =:= node() ->
1193-
{ok, Reader} = gen_statem:call(ServerId, {register_external_log_reader, self()}),
1194-
Reader.
1195-
11961127
%% @doc Returns a overview map of the internal server state
11971128
%%
11981129
%% The keys and values will typically remain stable but may

test/coordination_SUITE.erl

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -942,15 +942,15 @@ segment_writer_or_wal_crash_follower(Config) ->
942942
end || I <- lists:seq(1, 10)],
943943

944944
%% stop and restart the follower
945-
ok = ra:stop_server(Follower),
946-
ok = ra:restart_server(Follower),
945+
ok = ra:stop_server(?SYS, Follower),
946+
ok = ra:restart_server(?SYS, Follower),
947947

948948
await_condition(AwaitReplicated, 100),
949949

950950
_ = ct_rpc:call(FollowerNode, ra_log_wal, force_rollover, [ra_log_wal]),
951951

952-
ok = ra:stop_server(Follower),
953-
ok = ra:restart_server(Follower),
952+
ok = ra:stop_server(?SYS, Follower),
953+
ok = ra:restart_server(?SYS, Follower),
954954

955955
await_condition(AwaitReplicated, 100),
956956

@@ -1052,15 +1052,15 @@ segment_writer_or_wal_crash_leader(Config) ->
10521052
end || I <- lists:seq(1, 10)],
10531053

10541054
%% stop and restart the leader
1055-
ok = ra:stop_server(Leader),
1056-
ok = ra:restart_server(Leader),
1055+
ok = ra:stop_server(?SYS, Leader),
1056+
ok = ra:restart_server(?SYS, Leader),
10571057

10581058
await_condition(AwaitReplicated, 100),
10591059

10601060
_ = ct_rpc:call(LeaderNode, ra_log_wal, force_rollover, [ra_log_wal]),
10611061

1062-
ok = ra:stop_server(Leader),
1063-
ok = ra:restart_server(Leader),
1062+
ok = ra:stop_server(?SYS, Leader),
1063+
ok = ra:restart_server(?SYS, Leader),
10641064

10651065
await_condition(AwaitReplicated, 100),
10661066

test/ra_2_SUITE.erl

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@ all_tests() ->
4343
custom_ra_event_formatter,
4444
config_modification_at_restart,
4545
segment_writer_handles_server_deletion,
46-
%% TODO: mt decide on whether to support this
47-
% external_reader,
4846
add_member_without_quorum,
4947
force_start_follower_as_single_member,
5048
force_start_follower_as_single_member_nonvoter,
@@ -646,33 +644,6 @@ segment_writer_handles_server_deletion(Config) ->
646644
end,
647645
ok.
648646

649-
external_reader(Config) ->
650-
ok = logger:set_primary_config(level, all),
651-
ServerId = ?config(server_id, Config),
652-
ClusterName = ?config(cluster_name, Config),
653-
ok = start_cluster(ClusterName, [ServerId]),
654-
ra:members(ServerId),
655-
ok = enqueue(ServerId, msg1),
656-
[begin
657-
_ = ra:pipeline_command(ServerId, {enq, N}, no_correlation, normal)
658-
end || N <- lists:seq(1, 1023)],
659-
_ = enqueue(ServerId, final),
660-
R0 = ra:register_external_log_reader(ServerId),
661-
ok = force_roll_over(),
662-
receive
663-
{ra_event, _, {machine, {ra_log_update, _, _, _} = E}} ->
664-
R1 = ra_log_reader:handle_log_update(E, R0),
665-
{Entries, _R2} = ra_log_reader:sparse_read(R1, lists:seq(0, 1026), []),
666-
ct:pal("read ~w ~w", [length(Entries), lists:last(Entries)]),
667-
%% read all entries
668-
ok
669-
after 3000 ->
670-
flush(),
671-
exit(ra_log_update_timeout)
672-
end,
673-
ra:delete_cluster([ServerId]),
674-
ok.
675-
676647
add_member_without_quorum(Config) ->
677648
ok = logger:set_primary_config(level, all),
678649
%% ra:start_server should fail if the node already exists

test/ra_SUITE.erl

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -776,8 +776,8 @@ consistent_query_after_restart(Config) ->
776776
{ok, _, _} = ra:process_command(A, N, ?PROCESS_COMMAND_TIMEOUT),
777777
application:stop(ra),
778778
restart_ra(DataDir),
779-
ok = ra:restart_server(A),
780-
ok = ra:restart_server(B),
779+
ok = ra:restart_server(?SYS, A),
780+
ok = ra:restart_server(?SYS, B),
781781
?assertMatch({ok, N, _}, ra:consistent_query(A, fun(S) -> S end))
782782
end || N <- lists:seq(1, 30)],
783783

@@ -790,15 +790,15 @@ consistent_query_minority(Config) ->
790790
{ok, _, Leader} = ra:process_command(A, 9,
791791
?PROCESS_COMMAND_TIMEOUT),
792792
[F1, F2] = Cluster -- [Leader],
793-
ra:stop_server(F1),
794-
ra:stop_server(F2),
793+
ra:stop_server(?SYS, F1),
794+
ra:stop_server(?SYS, F2),
795795

796796
{timeout, _} = ra:consistent_query(Leader, fun(S) -> S end),
797797
%% restart after a short sleep so that quorum is restored whilst the next
798798
%% query is executing
799799
_ = spawn(fun() ->
800800
timer:sleep(1000),
801-
ra:restart_server(F1),
801+
ra:restart_server(?SYS, F1),
802802
ok
803803
end),
804804
{ok, 9, _} = ra:consistent_query(Leader, fun(S) -> S end, 10000),
@@ -817,11 +817,11 @@ consistent_query_leader_change(Config) ->
817817
{ok, _, A} = ra:process_command(A, 9, ?PROCESS_COMMAND_TIMEOUT),
818818
%% do two consistent queries, this will put query_index == 2 everywhere
819819
{ok, 9, A} = ra:consistent_query(A, fun(S) -> S end),
820-
ok = ra:stop_server(E),
820+
ok = ra:stop_server(?SYS, E),
821821
{ok, 9, A} = ra:consistent_query(A, fun(S) -> S end),
822822
%% restart B
823-
ok = ra:stop_server(B),
824-
ok = ra:restart_server(B),
823+
ok = ra:stop_server(?SYS, B),
824+
ok = ra:restart_server(?SYS, B),
825825
%% Wait for B to recover and catch up.
826826
{ok, #{log := #{last_written_index_term := CurrentIdxTerm}}, _} =
827827
ra:member_overview(A),
@@ -839,12 +839,12 @@ consistent_query_leader_change(Config) ->
839839
ra_leaderboard:lookup_leader(ClusterName) =:= B
840840
end, 20),
841841
%% restart E
842-
ok = ra:restart_server(E),
842+
ok = ra:restart_server(?SYS, E),
843843
{ok, 9, B} = ra:consistent_query(B, fun(S) -> S end),
844844

845-
ok = ra:stop_server(A),
846-
ok = ra:stop_server(C),
847-
ok = ra:stop_server(D),
845+
ok = ra:stop_server(?SYS, A),
846+
ok = ra:stop_server(?SYS, C),
847+
ok = ra:stop_server(?SYS, D),
848848

849849
%% there is no quorum now so this should time out
850850
case ra:consistent_query(B, fun(S) -> S end, 500) of
@@ -854,9 +854,9 @@ consistent_query_leader_change(Config) ->
854854
ct:fail("consistent query should time out"),
855855
ok
856856
end,
857-
ok = ra:restart_server(A),
858-
ok = ra:restart_server(C),
859-
ok = ra:restart_server(D),
857+
ok = ra:restart_server(?SYS, A),
858+
ok = ra:restart_server(?SYS, C),
859+
ok = ra:restart_server(?SYS, D),
860860
{ok, 9, _} = ra:consistent_query(A, fun(S) -> S end),
861861
{ok, 9, _} = ra:consistent_query(B, fun(S) -> S end),
862862
{ok, 9, _} = ra:consistent_query(C, fun(S) -> S end),

0 commit comments

Comments
 (0)