Merge branch 'dev/v4.3.14' into export-test-case-v4.3.14

CHANGES-4.3.md

@@ -10,6 +10,13 @@ File format:
 - One list item per change topic
   Change log ends with a list of github PRs
 
+## v4.3.14
+
+### Enhancements
+
+* In order to fix the execution order of exhook, e.g. before/after other plugins/modules,
+  ExHook now supports user customizing emqx_hook execute priority.
+
 ## v4.3.13
 
 ### Important changes

Makefile

@@ -99,6 +99,7 @@ $(PROFILES:%=clean-%):
 .PHONY: clean-all
 clean-all:
 	@rm -rf _build
+	@rm rebar.lock
 
 .PHONY: deps-all
 deps-all: $(REBAR) $(PROFILES:%=deps-%)

apps/emqx_exhook/etc/emqx_exhook.conf

@@ -24,6 +24,17 @@
 ## Value: false | Duration
 #exhook.auto_reconnect = 60s
 
+## The exhook execution priority on the Chain of the emqx hooks.
+##
+## Modify the field to fix the exhook execute order before/after other plugins/modules.
+## By default, most hooks registered by plugins or modules have a priority of 0.
+##
+## With the same priority of 0, the execute order depends on hookpoints mount order.
+## Scilicet is the loaded order of plugins/ modules.
+##
+## Default: 0
+## Value: Integer
+#exhook.hook_priority = 0
 
 ##--------------------------------------------------------------------
 ## The Hook callback servers

apps/emqx_exhook/include/emqx_exhook.hrl

@@ -41,4 +41,6 @@
       , {'message.dropped',     {emqx_exhook_handler, on_message_dropped,      []}}
       ]).
 
+-define(DEFAULT_HOOK_PRIORITY, 0).
+
 -endif.

apps/emqx_exhook/priv/emqx_exhook.schema

@@ -15,6 +15,11 @@
   {datatype, string}
 ]}.
 
+{mapping, "exhook.hook_priority", "emqx_exhook.hook_priority", [
+  {default, 0},
+  {datatype, integer}
+]}.
+
 {translation, "emqx_exhook.auto_reconnect", fun(Conf) ->
   case cuttlefish:conf_get("exhook.auto_reconnect", Conf) of
       "false" -> false;

apps/emqx_exhook/src/emqx_exhook.app.src

@@ -1,6 +1,6 @@
 {application, emqx_exhook,
  [{description, "EMQ X Extension for Hook"},
-  {vsn, "4.3.4"},
+  {vsn, "4.3.5"},
   {modules, []},
   {registered, []},
   {mod, {emqx_exhook_app, []}},

apps/emqx_exhook/src/emqx_exhook.appup.src

@@ -1,13 +1,23 @@
-%% -*-: erlang -*-
+%% -*- mode: erlang -*-
 {VSN,
  [
-    {<<"4.3.[0-3]">>, [
+    {"4.3.4", [
+        {load_module, emqx_exhook_sup, brutal_purge,soft_purge,[]},
+        {load_module, emqx_exhook_server, brutal_purge,soft_purge,[]},
+        {update, emqx_exhook_mngr, {advanced, ["4.3.4"]}}
+    ]},
+    {<<"4\\.3\\.[0-3]">>, [
         {restart_application, emqx_exhook}
     ]},
     {<<".*">>, []}
  ],
  [
-    {<<"4.3.[0-3]">>, [
+    {"4.3.4", [
+        {load_module, emqx_exhook_sup, brutal_purge,soft_purge,[]},
+        {load_module, emqx_exhook_server, brutal_purge,soft_purge,[]},
+        {update, emqx_exhook_mngr, {advanced, ["4.3.4"]}}
+    ]},
+    {<<"4\\.3\\.[0-3]">>, [
          {restart_application, emqx_exhook}
     ]},
     {<<".*">>, []}

apps/emqx_exhook/src/emqx_exhook_mngr.erl

@@ -23,7 +23,7 @@
 -include_lib("emqx/include/logger.hrl").
 
 %% APIs
--export([start_link/3]).
+-export([start_link/4]).
 
 %% Mgmt API
 -export([ enable/2
@@ -59,9 +59,14 @@
           %% Request options
           request_options :: grpc_client:options(),
           %% Timer references
-          trefs :: map()
+          trefs :: map(),
+          %% Hooks execute options
+          hooks_options :: hooks_options()
          }).
 
+-export_type([ server_options/0
+             , hooks_options/0]).
+
 -type servers() :: [{Name :: atom(), server_options()}].
 
 -type server_options() :: [ {scheme, http | https}
@@ -69,6 +74,10 @@
                           | {port, inet:port_number()}
                           ].
 
+-type hooks_options() :: #{hook_priority => integer()}.
+
+-define(DEFAULT_HOOK_OPTS, #{hook_priority => ?DEFAULT_HOOK_PRIORITY}).
+
 -define(DEFAULT_TIMEOUT, 60000).
 
 -define(CNTER, emqx_exhook_counter).
@@ -77,12 +86,12 @@
 %% APIs
 %%--------------------------------------------------------------------
 
--spec start_link(servers(), false | non_neg_integer(), grpc_client:options())
+-spec start_link(servers(), false | non_neg_integer(), grpc_client:options(), hooks_options())
     ->ignore
      | {ok, pid()}
      | {error, any()}.
-start_link(Servers, AutoReconnect, ReqOpts) ->
+start_link(Servers, AutoReconnect, ReqOpts, HooksOpts) ->
-    gen_server:start_link(?MODULE, [Servers, AutoReconnect, ReqOpts], []).
+    gen_server:start_link(?MODULE, [Servers, AutoReconnect, ReqOpts, HooksOpts], []).
 
 -spec enable(pid(), atom()|string()) -> ok | {error, term()}.
 enable(Pid, Name) ->
@@ -102,7 +111,7 @@ call(Pid, Req) ->
 %% gen_server callbacks
 %%--------------------------------------------------------------------
 
-init([Servers, AutoReconnect, ReqOpts0]) ->
+init([Servers, AutoReconnect, ReqOpts0, HooksOpts]) ->
     process_flag(trap_exit, true),
     %% XXX: Due to the ExHook Module in the enterprise,
     %% this process may start multiple times and they will share this table
@@ -120,32 +129,33 @@ init([Servers, AutoReconnect, ReqOpts0]) ->
 
     %% Load the hook servers
     ReqOpts = maps:without([request_failed_action], ReqOpts0),
-    {Waiting, Running} = load_all_servers(Servers, ReqOpts),
+    {Waiting, Running} = load_all_servers(Servers, ReqOpts, HooksOpts),
     {ok, ensure_reload_timer(
            #state{waiting = Waiting,
                   running = Running,
                   stopped = #{},
                   request_options = ReqOpts,
                   auto_reconnect = AutoReconnect,
-                  trefs = #{}
+                  trefs = #{},
+                  hooks_options = HooksOpts
                  }
           )}.
 
 %% @private
-load_all_servers(Servers, ReqOpts) ->
+load_all_servers(Servers, ReqOpts, HooksOpts) ->
-    load_all_servers(Servers, ReqOpts, #{}, #{}).
+    load_all_servers(Servers, ReqOpts, HooksOpts, #{}, #{}).
-load_all_servers([], _Request, Waiting, Running) ->
+load_all_servers([], _Request, _HooksOpts, Waiting, Running) ->
     {Waiting, Running};
-load_all_servers([{Name, Options}|More], ReqOpts, Waiting, Running) ->
+load_all_servers([{Name, Options} | More], ReqOpts, HooksOpts, Waiting, Running) ->
     {NWaiting, NRunning} =
-        case emqx_exhook_server:load(Name, Options, ReqOpts) of
+        case emqx_exhook_server:load(Name, Options, ReqOpts, HooksOpts) of
             {ok, ServerState} ->
                 save(Name, ServerState),
                 {Waiting, Running#{Name => Options}};
             {error, _} ->
                 {Waiting#{Name => Options}, Running}
         end,
-    load_all_servers(More, ReqOpts, NWaiting, NRunning).
+    load_all_servers(More, ReqOpts, HooksOpts, NWaiting, NRunning).
 
 handle_call({load, Name}, _From, State) ->
     {Result, NState} = do_load_server(Name, State),
@@ -199,8 +209,27 @@ terminate(_Reason, State = #state{running = Running}) ->
     _ = unload_exhooks(),
     ok.
 
-code_change(_OldVsn, State, _Extra) ->
+%% in the emqx_exhook:v4.3.5, we have added one new field in the state last:
-    {ok, State}.
+%%  - hooks_options :: map()
+code_change({down, _Vsn}, State, [ToVsn]) ->
+    case re:run(ToVsn, "4\\.3\\.[0-4]") of
+        {match, _} ->
+            NState = list_to_tuple(
+                       lists:droplast(
+                         tuple_to_list(State))),
+            {ok, NState};
+        _ ->
+            {ok, State}
+    end;
+code_change(_Vsn, State, [FromVsn]) ->
+    case re:run(FromVsn, "4\\.3\\.[0-4]") of
+        {match, _} ->
+            NState = list_to_tuple(
+                       tuple_to_list(State) ++ [?DEFAULT_HOOK_OPTS]),
+            {ok, NState};
+        _ ->
+            {ok, State}
+    end.
 
 %%--------------------------------------------------------------------
 %% Internal funcs
@@ -214,7 +243,8 @@ do_load_server(Name, State0 = #state{
                                  waiting = Waiting,
                                  running = Running,
                                  stopped = Stopped,
-                                 request_options = ReqOpts}) ->
+                                 request_options = ReqOpts,
+                                 hooks_options = HooksOpts}) ->
     State = clean_reload_timer(Name, State0),
     case maps:get(Name, Running, undefined) of
         undefined ->
@@ -223,7 +253,7 @@ do_load_server(Name, State0 = #state{
                 undefined ->
                     {{error, not_found}, State};
                 Options ->
-                    case emqx_exhook_server:load(Name, Options, ReqOpts) of
+                    case emqx_exhook_server:load(Name, Options, ReqOpts, HooksOpts) of
                         {ok, ServerState} ->
                             save(Name, ServerState),
                             ?LOG(info, "Load exhook callback server "

apps/emqx_exhook/src/emqx_exhook_server.erl

@@ -25,7 +25,7 @@
 -define(PB_CLIENT_MOD, emqx_exhook_v_1_hook_provider_client).
 
 %% Load/Unload
--export([ load/3
+-export([ load/4
         , unload/1
         ]).
 
@@ -81,8 +81,9 @@
 %% Load/Unload APIs
 %%--------------------------------------------------------------------
 
--spec load(atom(), list(), map()) -> {ok, server()} | {error, term()} .
+-spec load(atom(), emqx_exhook_mngr:server_options(), grpc_client:options(), emqx_exhook_mngr:hooks_options())
-load(Name0, Opts0, ReqOpts) ->
+          -> {ok, server()} | {error, term()} .
+load(Name0, Opts0, ReqOpts, HooksOpts) ->
     Name = to_list(Name0),
     {SvrAddr, ClientOpts} = channel_opts(Opts0),
     case emqx_exhook_sup:start_grpc_client_channel(
@@ -97,7 +98,7 @@ load(Name0, Opts0, ReqOpts) ->
                                io_lib:format("exhook.~s.", [Name])),
                     ensure_metrics(Prefix, HookSpecs),
                     %% Ensure hooks
-                    ensure_hooks(HookSpecs),
+                    ensure_hooks(HookSpecs, maps:get(hook_priority, HooksOpts, ?DEFAULT_HOOK_PRIORITY)),
                     {ok, #server{name = Name,
                                  options = ReqOpts,
                                  channel = _ChannPoolPid,
@@ -193,13 +194,13 @@ ensure_metrics(Prefix, HookSpecs) ->
             || Hookpoint <- maps:keys(HookSpecs)],
     lists:foreach(fun emqx_metrics:ensure/1, Keys).
 
-ensure_hooks(HookSpecs) ->
+ensure_hooks(HookSpecs, Priority) ->
     lists:foreach(fun(Hookpoint) ->
         case lists:keyfind(Hookpoint, 1, ?ENABLED_HOOKS) of
             false ->
                 ?LOG(error, "Unknown name ~s to hook, skip it!", [Hookpoint]);
             {Hookpoint, {M, F, A}} ->
-                emqx_hooks:put(Hookpoint, {M, F, A}),
+                emqx_hooks:put(Hookpoint, {M, F, A}, Priority),
                 ets:update_counter(?CNTER, Hookpoint, {2, 1}, {Hookpoint, 0})
         end
     end, maps:keys(HookSpecs)).

apps/emqx_exhook/src/emqx_exhook_sup.erl

@@ -18,6 +18,8 @@
 
 -behaviour(supervisor).
 
+-include("emqx_exhook.hrl").
+
 -export([ start_link/0
         , init/1
         ]).
@@ -43,7 +45,7 @@ start_link() ->
 
 init([]) ->
     Mngr = ?CHILD(emqx_exhook_mngr, worker,
-                  [servers(), auto_reconnect(), request_options()]),
+                  [servers(), auto_reconnect(), request_options(), hooks_options()]),
     {ok, {{one_for_one, 10, 100}, [Mngr]}}.
 
 servers() ->
@@ -57,6 +59,10 @@ request_options() ->
       request_failed_action => env(request_failed_action, deny)
      }.
 
+hooks_options() ->
+    #{hook_priority => env(hook_priority, ?DEFAULT_HOOK_PRIORITY)
+     }.
+
 env(Key, Def) ->
     application:get_env(emqx_exhook, Key, Def).
 

apps/emqx_exhook/test/emqx_exhook_SUITE.erl

@@ -98,10 +98,31 @@ t_cli_stats(_) ->
     _ = emqx_exhook_cli:cli(x),
     unmeck_print().
 
+t_priority(_) ->
+    restart_exhook_with_envs([{emqx_exhook, hook_priority, 1}]),
+
+    emqx_exhook:disable(default),
+    ok = emqx_exhook:enable(default),
+    [Callback | _] = emqx_hooks:lookup('client.connected'),
+    1 = emqx_hooks:callback_priority(Callback).
+
 %%--------------------------------------------------------------------
 %% Utils
 %%--------------------------------------------------------------------
 
+%% TODO: make it more general and move to `emqx_ct_helpers`
+restart_exhook_with_envs(Envs) ->
+    emqx_ct_helpers:stop_apps([emqx_exhook]),
+    SetPriorityFun
+        = fun(emqx) ->
+                  set_special_cfgs(emqx);
+             (emqx_exhook) ->
+                  lists:foreach(fun({App, Key, Val}) ->
+                                        application:set_env(App, Key, Val)
+                                end, Envs)
+          end,
+    emqx_ct_helpers:start_apps([emqx_exhook], SetPriorityFun).
+
 meck_print() ->
     meck:new(emqx_ctl, [passthrough, no_history, no_link]),
     meck:expect(emqx_ctl, print, fun(_) -> ok end),

apps/emqx_rule_engine/src/emqx_rule_engine.app.src

@@ -1,6 +1,6 @@
 {application, emqx_rule_engine,
  [{description, "EMQ X Rule Engine"},
-  {vsn, "4.3.8"}, % strict semver, bump manually!
+  {vsn, "4.3.9"}, % strict semver, bump manually!
   {modules, []},
   {registered, [emqx_rule_engine_sup, emqx_rule_registry]},
   {applications, [kernel,stdlib,rulesql,getopt]},

apps/emqx_rule_engine/src/emqx_rule_engine.appup.src

@@ -1,7 +1,9 @@
 %% -*- mode: erlang -*-
 %% Unless you know what you are doing, DO NOT edit manually!!
 {VSN,
-  [{"4.3.7",
+  [{"4.3.8",
+    [{load_module,emqx_rule_funcs,brutal_purge,soft_purge,[]}]},
+   {"4.3.7",
     [{load_module,emqx_rule_funcs,brutal_purge,soft_purge,[]},
      {load_module,emqx_rule_engine_api,brutal_purge,soft_purge,[]},
      {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]},
@@ -78,7 +80,9 @@
      {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
      {load_module,emqx_rule_engine_api,brutal_purge,soft_purge,[]}]},
    {<<".*">>,[]}],
-  [{"4.3.7",
+  [{"4.3.8",
+    [{load_module,emqx_rule_funcs,brutal_purge,soft_purge,[]}]},
+   {"4.3.7",
     [{load_module,emqx_rule_funcs,brutal_purge,soft_purge,[]},
      {load_module,emqx_rule_engine_api,brutal_purge,soft_purge,[]},
      {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]},

apps/emqx_rule_engine/src/emqx_rule_funcs.erl

@@ -197,6 +197,9 @@
         , rfc3339_to_unix_ts/2
         , now_timestamp/0
         , now_timestamp/1
+        , mongo_date/0
+        , mongo_date/1
+        , mongo_date/2
         ]).
 
 %% Proc Dict Func
@@ -900,6 +903,24 @@ time_unit(<<"millisecond">>) -> millisecond;
 time_unit(<<"microsecond">>) -> microsecond;
 time_unit(<<"nanosecond">>) -> nanosecond.
 
+mongo_date() ->
+    erlang:timestamp().
+
+mongo_date(MillisecondsTimestamp) ->
+    convert_timestamp(MillisecondsTimestamp).
+
+mongo_date(Timestamp, Unit) ->
+    InsertedTimeUnit = time_unit(Unit),
+    ScaledEpoch = erlang:convert_time_unit(Timestamp, InsertedTimeUnit, millisecond),
+    convert_timestamp(ScaledEpoch).
+
+convert_timestamp(MillisecondsTimestamp) ->
+    MicroTimestamp = MillisecondsTimestamp * 1000,
+    MegaSecs = MicroTimestamp div 1000_000_000_000,
+    Secs = MicroTimestamp div 1000_000 - MegaSecs*1000_000,
+    MicroSecs = MicroTimestamp rem 1000_000,
+    {MegaSecs, Secs, MicroSecs}.
+
 %% @doc This is for sql funcs that should be handled in the specific modules.
 %% Here the emqx_rule_funcs module acts as a proxy, forwarding
 %% the function handling to the worker module.

src/emqx.app.src

@@ -6,7 +6,7 @@
   %% the emqx `release' version, which in turn is comprised of several
   %% apps, one of which is this.  See `emqx_release.hrl' for more
   %% info.
-  {vsn, "4.3.14"}, % strict semver, bump manually!
+  {vsn, "4.3.15"}, % strict semver, bump manually!
   {modules, []},
   {registered, []},
   {applications, [ kernel

src/emqx.appup.src

@@ -1,7 +1,14 @@
 %% -*- mode: erlang -*-
 %% Unless you know what you are doing, DO NOT edit manually!!
 {VSN,
-  [{"4.3.13",
+  [{"4.3.14",
+    [{load_module,emqx_hooks,brutal_purge,soft_purge,[]},
+     {load_module,emqx_flapping,brutal_purge,soft_purge,[]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
+     {load_module,emqx_shared_sub,brutal_purge,soft_purge,[]}
+    ]},
+   {"4.3.13",
     [{load_module,emqx_plugins,brutal_purge,soft_purge,[]},
      {load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
@@ -18,7 +25,9 @@
      {load_module,emqx_ctl,brutal_purge,soft_purge,[]},
      {load_module,emqx_cm,brutal_purge,soft_purge,[]},
      {load_module,emqx_misc,brutal_purge,soft_purge,[]},
-     {load_module,emqx_connection,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_connection,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.12",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -44,7 +53,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.11",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -72,7 +83,9 @@
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_http_lib,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.10",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -100,7 +113,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_connection,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.9",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -132,7 +147,9 @@
      {load_module,emqx_os_mon,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.8",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -164,7 +181,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.7",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -197,7 +216,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.6",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -230,7 +251,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.5",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -264,7 +287,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.4",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -298,7 +323,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.3",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -333,7 +360,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.2",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -368,7 +397,9 @@
      {load_module,emqx_os_mon,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.1",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -406,7 +437,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.0",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -447,13 +480,23 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {<<".*">>,[]}],
-   {"4.3.13",
+  [{"4.3.14",
-    [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_hooks,brutal_purge,soft_purge,[]},
+     {load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
      {load_module,emqx_shared_sub,brutal_purge,soft_purge,[]},
-     {load_module,emqx_plugins,brutal_purge,soft_purge,[]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}
+    ]},
+   {"4.3.13",
+    [{load_module,emqx_plugins,brutal_purge,soft_purge,[]},
+     {load_module,emqx_flapping,brutal_purge,soft_purge,[]},
+     {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
+     {load_module,emqx_shared_sub,brutal_purge,soft_purge,[]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
      {load_module,emqx_frame,brutal_purge,soft_purge,[]},
      {load_module,emqx_sys_mon,brutal_purge,soft_purge,[]},
      {load_module,emqx_pmon,brutal_purge,soft_purge,[]},
@@ -465,7 +508,9 @@
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_ctl,brutal_purge,soft_purge,[]},
      {load_module,emqx_cm,brutal_purge,soft_purge,[]},
-     {load_module,emqx_connection,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_connection,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.12",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -490,7 +535,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.11",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -517,7 +564,9 @@
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_http_lib,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.10",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -544,7 +593,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_connection,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.9",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -575,7 +626,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.8",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -606,7 +659,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.7",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -638,7 +693,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.6",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -670,7 +727,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.5",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -703,7 +762,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.4",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -736,7 +797,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.3",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -770,7 +833,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.2",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -804,7 +869,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.1",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -841,7 +908,9 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {"4.3.0",
     [{load_module,emqx_flapping,brutal_purge,soft_purge,[]},
      {load_module,emqx_listeners,brutal_purge,soft_purge,[]},
@@ -880,5 +949,7 @@
      {load_module,emqx,brutal_purge,soft_purge,[]},
      {load_module,emqx_app,brutal_purge,soft_purge,[]},
      {load_module,emqx_message,brutal_purge,soft_purge,[]},
-     {load_module,emqx_limiter,brutal_purge,soft_purge,[]}]},
+     {load_module,emqx_limiter,brutal_purge,soft_purge,[]},
+     {load_module,emqx_hooks,brutal_purge,soft_purge,[]}
+    ]},
    {<<".*">>,[]}]}.

src/emqx_hooks.erl

@@ -32,6 +32,8 @@
         , add/3
         , add/4
         , put/2
+        , put/3
+        , put/4
         , del/2
         , run/2
         , run_fold/3
@@ -75,6 +77,8 @@
           priority :: integer()
          }).
 
+-type callback() :: #callback{}.
+
 -record(hook, {
           name :: hookpoint(),
           callbacks :: list(#callback{})
@@ -110,7 +114,7 @@ callback_priority(#callback{priority= P}) -> P.
 %%--------------------------------------------------------------------
 
 %% @doc Register a callback
--spec(add(hookpoint(), action() | #callback{}) -> ok_or_error(already_exists)).
+-spec(add(hookpoint(), action() | callback()) -> ok_or_error(already_exists)).
 add(HookPoint, Callback) when is_record(Callback, callback) ->
     gen_server:call(?SERVER, {add, HookPoint, Callback}, infinity);
 add(HookPoint, Action) when is_function(Action); is_tuple(Action) ->
@@ -131,12 +135,24 @@ add(HookPoint, Action, Filter, Priority) when is_integer(Priority) ->
     add(HookPoint, #callback{action = Action, filter = Filter, priority = Priority}).
 
 %% @doc Like add/2, it register a callback, discard 'already_exists' error.
--spec(put(hookpoint(), action() | #callback{}) -> ok).
+-spec put(hookpoint(), action() | callback()) -> ok.
-put(HookPoint, Callback) ->
+put(HookPoint, Callback) when is_record(Callback, callback) ->
     case add(HookPoint, Callback) of
         ok -> ok;
         {error, already_exists} -> ok
-    end.
+    end;
+put(HookPoint, Action) when is_function(Action); is_tuple(Action) ->
+    ?MODULE:put(HookPoint, #callback{action = Action, priority = 0}).
+
+-spec put(hookpoint(), action(), filter() | integer() | list()) -> ok.
+put(HookPoint, Action, {_M, _F, _A} = Filter) ->
+    ?MODULE:put(HookPoint, #callback{action = Action, filter = Filter, priority = 0});
+put(HookPoint, Action, Priority) when is_integer(Priority) ->
+    ?MODULE:put(HookPoint, #callback{action = Action, priority = Priority}).
+
+-spec put(hookpoint(), action(), filter(), integer()) -> ok.
+put(HookPoint, Action, Filter, Priority) when is_integer(Priority) ->
+    ?MODULE:put(HookPoint, #callback{action = Action, filter = Filter, priority = Priority}).
 
 %% @doc Unregister a callback.
 -spec(del(hookpoint(), action() | {module(), atom()}) -> ok).
@@ -205,7 +221,7 @@ execute({M, F, A}, Args) ->
     erlang:apply(M, F, Args ++ A).
 
 %% @doc Lookup callbacks.
--spec(lookup(hookpoint()) -> [#callback{}]).
+-spec(lookup(hookpoint()) -> [callback()]).
 lookup(HookPoint) ->
     case ets:lookup(?TAB, HookPoint) of
         [#hook{callbacks = Callbacks}] ->
@@ -288,4 +304,3 @@ del_callback(Func, [#callback{action = {Func, _A}} | Callbacks], Acc) ->
     del_callback(Func, Callbacks, Acc);
 del_callback(Action, [Callback | Callbacks], Acc) ->
     del_callback(Action, Callbacks, [Callback | Acc]).
-