From 23fc8afc5005ce1826268b75254748c6a6ce3503 Mon Sep 17 00:00:00 2001
From: William Yang <mscame@gmail.com>
Date: Wed, 13 Oct 2021 08:54:50 +0200
Subject: [PATCH] feat(olp): rename olp mgmt API

on -> enable
off -> disable
---
 apps/emqx/src/emqx_olp.erl                 | 12 ++++++------
 apps/emqx/test/emqx_olp_SUITE.erl          |  8 ++++----
 apps/emqx_management/src/emqx_mgmt_cli.erl | 18 +++++++++---------
 3 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/apps/emqx/src/emqx_olp.erl b/apps/emqx/src/emqx_olp.erl
index 101064bb6..df97beb35 100644
--- a/apps/emqx/src/emqx_olp.erl
+++ b/apps/emqx/src/emqx_olp.erl
@@ -27,8 +27,8 @@
 
 %% exports for O&M
 -export([ status/0
-        , on/0
-        , off/0
+        , enable/0
+        , disable/0
         ]).
 
 -type cfg_key() ::
@@ -97,13 +97,13 @@ status() ->
   is_overloaded().
 
 %% @doc turn off backgroud runq check.
--spec off() -> ok | {error, timeout}.
-off() ->
+-spec disable() -> ok | {error, timeout}.
+disable() ->
   load_ctl:stop_runq_flagman(5000).
 
 %% @doc turn on backgroud runq check.
--spec on() -> {ok, pid()} | {error, running | restarting | disabled}.
-on() ->
+-spec enable() -> {ok, pid()} | {error, running | restarting | disabled}.
+enable() ->
  case load_ctl:restart_runq_flagman() of
    {error, disabled} ->
      OldCfg = load_ctl:get_config(),
diff --git a/apps/emqx/test/emqx_olp_SUITE.erl b/apps/emqx/test/emqx_olp_SUITE.erl
index 0096765b9..04a294558 100644
--- a/apps/emqx/test/emqx_olp_SUITE.erl
+++ b/apps/emqx/test/emqx_olp_SUITE.erl
@@ -34,7 +34,7 @@ end_per_suite(_Config) ->
     emqx_ct_helpers:stop_apps([]).
 
 init_per_testcase(_, Config) ->
-    emqx_olp:on(),
+    emqx_olp:enable(),
     case wait_for(fun() -> lc_sup:whereis_runq_flagman() end, 10) of
       true -> ok;
       false ->
@@ -51,11 +51,11 @@ init_per_testcase(_, Config) ->
   Config.
 
 %% Test that olp could be enabled/disabled globally
-t_off_on(_Config) ->
+t_disable_enable(_Config) ->
     Old = load_ctl:whereis_runq_flagman(),
-    ok = emqx_olp:off(),
+    ok = emqx_olp:disable(),
     ?assert(not is_process_alive(Old)),
-    {ok, Pid} = emqx_olp:on(),
+    {ok, Pid} = emqx_olp:enable(),
     timer:sleep(1000),
     ?assert(is_process_alive(Pid)).
 
diff --git a/apps/emqx_management/src/emqx_mgmt_cli.erl b/apps/emqx_management/src/emqx_mgmt_cli.erl
index bc6da3caf..b3b38154b 100644
--- a/apps/emqx_management/src/emqx_mgmt_cli.erl
+++ b/apps/emqx_management/src/emqx_mgmt_cli.erl
@@ -505,16 +505,16 @@ olp(["status"]) ->
             false -> "not overloaded"
         end,
     emqx_ctl:print("~p is ~s ~n", [node(), S]);
-olp(["off"]) ->
-    Res = emqx_olp:off(),
-    emqx_ctl:print("Turn off overload protetion ~p : ~p ~n", [node(), Res]);
-olp(["on"]) ->
-    Res = emqx_olp:on(),
-    emqx_ctl:print("Turn on overload protection ~p : ~p ~n", [node(), Res]);
+olp(["disable"]) ->
+    Res = emqx_olp:disable(),
+    emqx_ctl:print("Disable overload protetion ~p : ~p ~n", [node(), Res]);
+olp(["enable"]) ->
+    Res = emqx_olp:enable(),
+    emqx_ctl:print("Enable overload protection ~p : ~p ~n", [node(), Res]);
 olp(_) ->
-    emqx_ctl:usage([{"olp status", "Return OLP status if system is overloaded"},
-                    {"olp on",     "Turn on overload protection"},
-                    {"olp off",    "Turn off overload protection"}
+    emqx_ctl:usage([{"olp status",  "Return OLP status if system is overloaded"},
+                    {"olp enable",  "Enable overload protection"},
+                    {"olp disable", "Disable overload protection"}
                    ]).
 
 %%--------------------------------------------------------------------