refactor(auth_mnesia): Export transaction funs

apps/emqx_authn/src/enhanced_authn/emqx_enhanced_authn_scram_mnesia.erl

@@ -52,6 +52,14 @@
     group_match_spec/1
 ]).
 
+%% Internal exports (RPC)
+-export([
+    do_destroy/1,
+    do_add_user/2,
+    do_delete_user/2,
+    do_update_user/3
+]).
+
 -define(TAB, ?MODULE).
 -define(AUTHN_QSCHEMA, [
     {<<"like_user_id">>, binary},
@@ -170,27 +178,27 @@ authenticate(_Credential, _State) ->
     ignore.
 
 destroy(#{user_group := UserGroup}) ->
+    trans(fun ?MODULE:do_destroy/1, [UserGroup]).
+
+do_destroy(UserGroup) ->
     MatchSpec = group_match_spec(UserGroup),
-    trans(
-        fun() ->
     ok = lists:foreach(
         fun(UserInfo) ->
             mnesia:delete_object(?TAB, UserInfo, write)
         end,
         mnesia:select(?TAB, MatchSpec, write)
-            )
-        end
     ).
 
-add_user(
+add_user(UserInfo, State) ->
+    trans(fun ?MODULE:do_add_user/2, [UserInfo, State]).
+
+do_add_user(
     #{
         user_id := UserID,
         password := Password
     } = UserInfo,
     #{user_group := UserGroup} = State
 ) ->
-    trans(
-        fun() ->
     case mnesia:read(?TAB, {UserGroup, UserID}, write) of
         [] ->
             IsSuperuser = maps:get(is_superuser, UserInfo, false),
@@ -198,29 +206,27 @@ add_user(
             {ok, #{user_id => UserID, is_superuser => IsSuperuser}};
         [_] ->
             {error, already_exist}
-            end
+    end.
-        end
-    ).
 
-delete_user(UserID, #{user_group := UserGroup}) ->
+delete_user(UserID, State) ->
-    trans(
+    trans(fun ?MODULE:do_delete_user/2, [UserID, State]).
-        fun() ->
+
+do_delete_user(UserID, #{user_group := UserGroup}) ->
     case mnesia:read(?TAB, {UserGroup, UserID}, write) of
         [] ->
             {error, not_found};
         [_] ->
             mnesia:delete(?TAB, {UserGroup, UserID}, write)
-            end
+    end.
-        end
-    ).
 
-update_user(
+update_user(UserID, User, State) ->
+    trans(fun ?MODULE:do_update_user/3, [UserID, User, State]).
+
+do_update_user(
     UserID,
     User,
     #{user_group := UserGroup} = State
 ) ->
-    trans(
-        fun() ->
     case mnesia:read(?TAB, {UserGroup, UserID}, write) of
         [] ->
             {error, not_found};
@@ -244,9 +250,7 @@ update_user(
                 end,
             mnesia:write(?TAB, UserInfo2, write),
             {ok, format_user_info(UserInfo2)}
-            end
+    end.
-        end
-    ).
 
 lookup_user(UserID, #{user_group := UserGroup}) ->
     case mnesia:dirty_read(?TAB, {UserGroup, UserID}) of
@@ -386,12 +390,10 @@ retrieve(UserID, #{user_group := UserGroup}) ->
     end.
 
 %% TODO: Move to emqx_authn_utils.erl
-trans(Fun) ->
-    trans(Fun, []).
-
 trans(Fun, Args) ->
     case mria:transaction(?AUTH_SHARD, Fun, Args) of
         {atomic, Res} -> Res;
+        {aborted, {function_clause, Stack}} -> erlang:raise(error, function_clause, Stack);
         {aborted, Reason} -> {error, Reason}
     end.
 

apps/emqx_authn/src/simple_authn/emqx_authn_mnesia.erl

@@ -54,6 +54,16 @@
     group_match_spec/1
 ]).
 
+%% Internal exports (RPC)
+-export([
+    do_destroy/1,
+    do_add_user/2,
+    do_delete_user/2,
+    do_update_user/3,
+    import/2,
+    import_csv/3
+]).
+
 -type user_group() :: binary().
 -type user_id() :: binary().
 
@@ -175,15 +185,14 @@ authenticate(
     end.
 
 destroy(#{user_group := UserGroup}) ->
-    trans(
+    trans(fun ?MODULE:do_destroy/1, [UserGroup]).
-        fun() ->
+
+do_destroy(UserGroup) ->
     ok = lists:foreach(
         fun(User) ->
             mnesia:delete_object(?TAB, User, write)
         end,
         mnesia:select(?TAB, group_match_spec(UserGroup), write)
-            )
-        end
     ).
 
 import_users({Filename0, FileData}, State) ->
@@ -200,7 +209,10 @@ import_users({Filename0, FileData}, State) ->
             {error, {unsupported_file_format, Extension}}
     end.
 
-add_user(
+add_user(UserInfo, State) ->
+    trans(fun ?MODULE:do_add_user/2, [UserInfo, State]).
+
+do_add_user(
     #{
         user_id := UserID,
         password := Password
@@ -210,8 +222,6 @@ add_user(
         password_hash_algorithm := Algorithm
     }
 ) ->
-    trans(
-        fun() ->
     case mnesia:read(?TAB, {UserGroup, UserID}, write) of
         [] ->
             {PasswordHash, Salt} = emqx_authn_password_hashing:hash(Algorithm, Password),
@@ -220,23 +230,23 @@ add_user(
             {ok, #{user_id => UserID, is_superuser => IsSuperuser}};
         [_] ->
             {error, already_exist}
-            end
+    end.
-        end
-    ).
 
-delete_user(UserID, #{user_group := UserGroup}) ->
+delete_user(UserID, State) ->
-    trans(
+    trans(fun ?MODULE:do_delete_user/2, [UserID, State]).
-        fun() ->
+
+do_delete_user(UserID, #{user_group := UserGroup}) ->
     case mnesia:read(?TAB, {UserGroup, UserID}, write) of
         [] ->
             {error, not_found};
         [_] ->
             mnesia:delete(?TAB, {UserGroup, UserID}, write)
-            end
+    end.
-        end
-    ).
 
-update_user(
+update_user(UserID, UserInfo, State) ->
+    trans(fun ?MODULE:do_update_user/3, [UserID, UserInfo, State]).
+
+do_update_user(
     UserID,
     UserInfo,
     #{
@@ -244,8 +254,6 @@ update_user(
         password_hash_algorithm := Algorithm
     }
 ) ->
-    trans(
-        fun() ->
     case mnesia:read(?TAB, {UserGroup, UserID}, write) of
         [] ->
             {error, not_found};
@@ -268,9 +276,7 @@ update_user(
                 end,
             insert_user(UserGroup, UserID, NPasswordHash, NSalt, NSuperuser),
             {ok, #{user_id => UserID, is_superuser => NSuperuser}}
-            end
+    end.
-        end
-    ).
 
 lookup_user(UserID, #{user_group := UserGroup}) ->
     case mnesia:dirty_read(?TAB, {UserGroup, UserID}) of
@@ -335,7 +341,7 @@ run_fuzzy_filter(
 import_users_from_json(Bin, #{user_group := UserGroup}) ->
     case emqx_json:safe_decode(Bin, [return_maps]) of
         {ok, List} ->
-            trans(fun import/2, [UserGroup, List]);
+            trans(fun ?MODULE:import/2, [UserGroup, List]);
         {error, Reason} ->
             {error, Reason}
     end.
@@ -344,7 +350,7 @@ import_users_from_json(Bin, #{user_group := UserGroup}) ->
 import_users_from_csv(CSV, #{user_group := UserGroup}) ->
     case get_csv_header(CSV) of
         {ok, Seq, NewCSV} ->
-            trans(fun import_csv/3, [UserGroup, NewCSV, Seq]);
+            trans(fun ?MODULE:import_csv/3, [UserGroup, NewCSV, Seq]);
         {error, Reason} ->
             {error, Reason}
     end.
@@ -435,9 +441,6 @@ get_user_identity(#{clientid := ClientID}, clientid) ->
 get_user_identity(_, Type) ->
     {error, {bad_user_identity_type, Type}}.
 
-trans(Fun) ->
-    trans(Fun, []).
-
 trans(Fun, Args) ->
     case mria:transaction(?AUTH_SHARD, Fun, Args) of
         {atomic, Res} -> Res;