Review

Author: NelsonVides

guides/configuration.md

@@ -9,7 +9,7 @@ Amoc supports the following generic configuration parameters:
     * default value - empty list (`[]`)
     * example: `AMOC_NODES="['amoc@amoc-1', 'amoc@amoc-2']"`
 
-* `user_rate` - a rate (in ms, implemented as a `t:amoc_throttle:rate/0`) of user processes per minute:
+* `user_rate` - a rate (implemented as a `t:amoc_throttle:rate/0`) of user processes per minute:
     * default value - 1200.
     * example: `AMOC_USER_RATE="600"`
     * this parameter can be updated at runtime (in the same way as scenario configuration).

src/amoc_controller.erl

@@ -12,7 +12,7 @@
 
 -required_variable(#{name => user_rate, default_value => ?DEFAULT_USER_RATE,
                      verification => {?MODULE, verify_user_rate, 1},
-                     description => "Throttle rate for the Scenario:start/1,2 callback (def: 50ms)",
+                     description => "Throttle rate for the Scenario:start/1,2 callback",
                      update => {?MODULE, update_user_rate, 2}}).
 
 -record(state, {scenario :: amoc:scenario() | undefined,
@@ -130,9 +130,9 @@ disable() ->
 %% @private
 -spec verify_user_rate(any()) -> boolean().
 verify_user_rate(UserRate) ->
-    infinity =:= UserRate
+    (infinity =:= UserRate)
     orelse is_integer(UserRate)
-    andalso 0 =< UserRate.
+    andalso (0 =< UserRate).
 
 %% @private
 -spec update_user_rate(user_rate, user_rate()) -> ok.

src/throttle/amoc_throttle_controller.erl

@@ -11,7 +11,7 @@
          ensure_throttle_processes_started/2,
          pause/1, resume/1, stop/1, get_info/1,
          change_rate/2, change_rate_gradually/2,
-         pg_scope/0, consume_all_messages/1,
+         pg_scope/0, consume_all_timer_ticks/1,
          get_throttle_process/1,
          raise_event_on_slave_node/2, telemetry_event/2]).
 
@@ -260,17 +260,17 @@ continue_plan(Name, State, Info, #change_rate_plan{rates = [Rate]} = Plan) ->
     TRef = Plan#change_rate_plan.timer,
     Info1 = do_change_rate(Name, Rate, Interval, Info),
     {ok, cancel} = timer:cancel(TRef),
-    consume_all_messages({change_plan, Name}),
+    consume_all_timer_ticks({change_plan, Name}),
     State#{Name => Info1#throttle_info{change_plan = undefined}};
 continue_plan(Name, State, Info, #change_rate_plan{rates = [Rate | Rates]} = Plan) ->
     Info1 = do_change_rate(Name, Rate, Info#throttle_info.interval, Info),
     NewPlan = Plan#change_rate_plan{rates = Rates},
     State#{Name => Info1#throttle_info{change_plan = NewPlan}}.
 
--spec consume_all_messages(any()) -> ok.
-consume_all_messages(Msg) ->
+-spec consume_all_timer_ticks(any()) -> ok.
+consume_all_timer_ticks(Msg) ->
     receive
-        Msg -> consume_all_messages(Msg)
+        Msg -> consume_all_timer_ticks(Msg)
     after 0 -> ok
     end.
 

src/throttle/amoc_throttle_process.erl

@@ -143,7 +143,7 @@ maybe_stop_timer(#state{tref = undefined}) ->
     ok;
 maybe_stop_timer(#state{tref = TRef}) ->
     {ok, cancel} = timer:cancel(TRef),
-    amoc_throttle_controller:consume_all_messages(delay_between_executions).
+    amoc_throttle_controller:consume_all_timer_ticks(delay_between_executions).
 
 timeout(#state{delay_between_executions = infinity}) ->
     infinity;