apps/efka/src/efka_agent.erl

@@ -2,21 +2,21 @@
 %%% @author anlicheng
 %%% @copyright (C) 2025, <COMPANY>
 %%% @doc
-%%%
+%%% 负责和云端服务器的通讯
 %%% @end
-%%% Created : 06. 5月 2025 00:01
+%%% Created : 29. 4月 2025 17:47
 %%%-------------------------------------------------------------------
 -module(efka_agent).
 -author("anlicheng").
 -include("message_pb.hrl").
 
--behaviour(gen_server).
+-behaviour(gen_statem).
 
 %% API
 -export([start_link/0]).
 
-%% gen_server callbacks
--export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]).
+%% gen_statem callbacks
+-export([init/1, format_status/2, handle_event/4, terminate/3, code_change/4, callback_mode/0]).
 
 -define(SERVER, ?MODULE).
 
@@ -30,123 +30,115 @@
 -define(STATE_ACTIVATED, activated).
 
 -record(state, {
-    transport_pid :: undefined | pid(),
-    status = ?STATE_DENIED
+    transport_pid :: undefined | pid()
 }).
 
 %%%===================================================================
 %%% API
 %%%===================================================================
 
-%% @doc Spawns the server and registers the local name (unique)
--spec(start_link() ->
-    {ok, Pid :: pid()} | ignore | {error, Reason :: term()}).
+%% @doc Creates a gen_statem process which calls Module:init/1 to
+%% initialize. To ensure a synchronized start-up procedure, this
+%% function does not return until Module:init/1 has returned.
 start_link() ->
-    gen_server:start_link({local, ?SERVER}, ?MODULE, [], []).
+    gen_statem:start_link({local, ?SERVER}, ?MODULE, [], []).
 
 %%%===================================================================
-%%% gen_server callbacks
+%%% gen_statem callbacks
 %%%===================================================================
 
 %% @private
-%% @doc Initializes the server
--spec(init(Args :: term()) ->
-    {ok, State :: #state{}} | {ok, State :: #state{}, timeout() | hibernate} |
-    {stop, Reason :: term()} | ignore).
+%% @doc Whenever a gen_statem is started using gen_statem:start/[3,4] or
+%% gen_statem:start_link/[3,4], this function is called by the new
+%% process to initialize.
 init([]) ->
     erlang:process_flag(trap_exit, true),
     erlang:start_timer(0, self(), create_transport),
-    {ok, #state{}}.
+    {ok, ?STATE_DENIED, #state{}}.
 
 %% @private
-%% @doc Handling call messages
--spec(handle_call(Request :: term(), From :: {pid(), Tag :: term()},
-    State :: #state{}) ->
-    {reply, Reply :: term(), NewState :: #state{}} |
-    {reply, Reply :: term(), NewState :: #state{}, timeout() | hibernate} |
-    {noreply, NewState :: #state{}} |
-    {noreply, NewState :: #state{}, timeout() | hibernate} |
-    {stop, Reason :: term(), Reply :: term(), NewState :: #state{}} |
-    {stop, Reason :: term(), NewState :: #state{}}).
-handle_call(_Request, _From, State = #state{}) ->
-    {reply, ok, State}.
+%% @doc This function is called by a gen_statem when it needs to find out
+%% the callback mode of the callback module.
+callback_mode() ->
+    handle_event_function.
 
 %% @private
-%% @doc Handling cast messages
--spec(handle_cast(Request :: term(), State :: #state{}) ->
-    {noreply, NewState :: #state{}} |
-    {noreply, NewState :: #state{}, timeout() | hibernate} |
-    {stop, Reason :: term(), NewState :: #state{}}).
-handle_cast(_Request, State = #state{}) ->
-    {noreply, State}.
+%% @doc Called (1) whenever sys:get_status/1,2 is called by gen_statem or
+%% (2) when gen_statem terminates abnormally.
+%% This callback is optional.
+format_status(_Opt, [_PDict, _StateName, _State]) ->
+    Status = some_term,
+    Status.
 
 %% @private
-%% @doc Handling all non call/cast messages
--spec(handle_info(Info :: timeout() | term(), State :: #state{}) ->
-    {noreply, NewState :: #state{}} |
-    {noreply, NewState :: #state{}, timeout() | hibernate} |
-    {stop, Reason :: term(), NewState :: #state{}}).
-handle_info({timeout, _, create_transport}, State = #state{status = ?STATE_DENIED}) ->
+%% @doc If callback_mode is handle_event_function, then whenever a
+%% gen_statem receives an event from call/2, cast/2, or as a normal
+%% process message, this function is called.
+
+%% 异步建立到目标服务器的连接
+handle_event(info, {timeout, _, create_transport}, ?STATE_DENIED, State = #state{}) ->
     {ok, Props} = application:get_env(efka, tls_server),
     Host = proplists:get_value(host, Props),
     Port = proplists:get_value(port, Props),
     {ok, TransportPid} = efka_transport:start_link(self(), Host, Port),
     efka_transport:connect(TransportPid),
 
-    {noreply, State#state{status = ?STATE_CONNECTING, transport_pid = TransportPid}};
+    {next_state, ?STATE_CONNECTING, State#state{transport_pid = TransportPid}};
 
-handle_info({connect_reply, Reply}, State = #state{status = ?STATE_CONNECTING, transport_pid = TransportPid}) ->
+%% 连接的回复
+handle_event(info, {connect_reply, Reply}, ?STATE_CONNECTING, State = #state{transport_pid = TransportPid}) ->
     case Reply of
         ok ->
             efka_transport:auth_request(TransportPid, 5000),
-            {noreply, State#state{status = ?STATE_AUTH}};
+            {next_state, ?STATE_AUTH, State};
         {error, Reason} ->
             efka_logger:debug("[efka_agent] connect failed, error: ~p, pid: ~p", [Reason, TransportPid]),
             efka_transport:stop(TransportPid),
-            {noreply, ?STATE_DENIED, State#state{status = ?STATE_DENIED}}
+            {next_state, ?STATE_DENIED, State}
     end;
 
-handle_info({auth_reply, {ok, #auth_reply{code = 1, message = Message, repository_url = RepositoryUrl}}}, State = #state{status = ?STATE_AUTH}) ->
+%% 权限校验的回复
+handle_event(info, {auth_reply, {ok, #auth_reply{code = 1, message = Message, repository_url = RepositoryUrl}}}, ?STATE_AUTH, State) ->
     efka_logger:debug("[efka_agent] auth failed, message: ~p, repository_url: ~p", [Message, RepositoryUrl]),
-    {noreply, State#state{status = ?STATE_ACTIVATED}};
-handle_info({auth_reply, {ok, #auth_reply{code = -1, message = Message}}}, State = #state{status = ?STATE_AUTH}) ->
+    {next_state, ?STATE_ACTIVATED, State};
+handle_event(info, {auth_reply, {ok, #auth_reply{code = -1, message = Message}}}, ?STATE_AUTH, State) ->
     %% 主机在后台的授权未通过；此时agent不能推送数据给云端服务器，但是云端服务器可以推送命令给agent
     %% socket的连接状态需要维持
     efka_logger:debug("[efka_agent] auth denied, message: ~p", [Message]),
-    {noreply, State#state{status = ?STATE_RESTRICTED}};
-handle_info({auth_reply, {ok, #auth_reply{code = -2, message = Message}}}, State = #state{transport_pid = TransportPid, status = ?STATE_AUTH}) ->
+    {next_state, ?STATE_RESTRICTED, State};
+handle_event(info, {auth_reply,  {ok, #auth_reply{code = -2, message = Message}}}, ?STATE_AUTH, State = #state{transport_pid = TransportPid}) ->
     %% 其他类型的错误，需要间隔时间重试
     efka_logger:debug("[efka_agent] auth failed, message: ~p", [Message]),
     efka_transport:stop(TransportPid),
-    {noreply, State#state{transport_pid = undefined, status = ?STATE_DENIED}};
-handle_info({auth_reply, {error, Reason}}, State = #state{transport_pid = TransportPid, status = ?STATE_AUTH}) ->
+    {next_state, ?STATE_DENIED, State#state{transport_pid = undefined}};
+handle_event(info, {auth_reply, {error, Reason}}, ?STATE_AUTH, State = #state{transport_pid = TransportPid}) ->
     efka_logger:debug("[efka_agent] auth_request failed, error: ~p", [Reason]),
     efka_transport:stop(TransportPid),
-    {noreply, State#state{transport_pid = undefined, status = ?STATE_DENIED}};
-
+    {next_state, ?STATE_DENIED, State#state{transport_pid = undefined}};
 
 %% 云端服务器推送了消息
 %% 激活消息
 
 %% TODO
-handle_info({server_push_message, <<8:8, ActivatePush>>}, State = #state{transport_pid = TransportPid, status = Status}) ->
+handle_event(info, {server_push_message, <<8:8, ActivatePush>>}, StateName, State = #state{transport_pid = TransportPid}) ->
     #activate_push{auth = Auth} = message_pb:decode_msg(ActivatePush, activate_push),
-    case {Auth, Status} of
+    case {Auth, StateName} of
         {true, ?STATE_ACTIVATED} ->
-            {noreply, State};
+            {keep_state, State};
         {true, ?STATE_DENIED} ->
             %% 重新激活, 需要重新校验
             efka_transport:auth_request(TransportPid, 5000),
-            {noreply, State#state{status = ?STATE_AUTH}};
+            {next_state, ?STATE_AUTH, State};
         {false, _} ->
             %% 这个时候的主机应该是受限制的状态，不允许发送消息；但是能够接受服务器推送的消息
-            {noreply, State#state{status = ?STATE_RESTRICTED}}
+            {next_state, ?STATE_RESTRICTED, State}
     end;
 
 %% 收到需要回复的指令
-handle_info({server_push_message, PacketId, <<16:8, Directive>>}, State = #state{transport_pid = TransportPid, status = ?STATE_ACTIVATED}) ->
+handle_event(info, {server_push_message, PacketId, <<16:8, Directive>>}, ?STATE_ACTIVATED, State = #state{transport_pid = TransportPid}) ->
     #topic_message{topic = Topic, content = Content} = message_pb:decode_msg(Directive, directive),
     efka_logger:debug("[efka_agent] get directive with packet_id: ~p, to device_uuid: ~p, content: ~p", [PacketId, Topic, Content]),
+
     %% 消息发送到订阅系统
     case PacketId > 0 of
         true ->
@@ -156,34 +148,30 @@ handle_info({server_push_message, PacketId, <<16:8, Directive>>}, State = #state
             efka_subscription:publish(Topic, Content)
     end,
 
-    {noreply, State};
+    {keep_state, State};
 
 %% transport进程退出
-handle_info({'EXIT', TransportPid, Reason}, State = #state{transport_pid = TransportPid}) ->
+handle_event(info, {'EXIT', TransportPid, Reason}, _StateName, State = #state{transport_pid = TransportPid}) ->
     efka_logger:debug("[efka_agent] transport pid: ~p, exit with reason: ~p", [TransportPid, Reason]),
     erlang:start_timer(500000, self(), create_transport),
-    {noreply, State#state{transport_pid = undefined, status = ?STATE_DENIED}};
+    {next_state, ?STATE_DENIED, State#state{transport_pid = undefined}};
 
-handle_info(_Info, State = #state{}) ->
-    {noreply, State}.
+handle_event(_EventType, _EventContent, _StateName, State = #state{}) ->
+    NextStateName = the_next_state_name,
+    {next_state, NextStateName, State}.
 
 %% @private
-%% @doc This function is called by a gen_server when it is about to
+%% @doc This function is called by a gen_statem when it is about to
 %% terminate. It should be the opposite of Module:init/1 and do any
-%% necessary cleaning up. When it returns, the gen_server terminates
-%% with Reason. The return value is ignored.
--spec(terminate(Reason :: (normal | shutdown | {shutdown, term()} | term()),
-    State :: #state{}) -> term()).
-terminate(_Reason, _State = #state{}) ->
+%% necessary cleaning up. When it returns, the gen_statem terminates with
+%% Reason. The return value is ignored.
+terminate(_Reason, _StateName, _State = #state{}) ->
     ok.
 
 %% @private
 %% @doc Convert process state when code is changed
--spec(code_change(OldVsn :: term() | {down, term()}, State :: #state{},
-    Extra :: term()) ->
-    {ok, NewState :: #state{}} | {error, Reason :: term()}).
-code_change(_OldVsn, State = #state{}, _Extra) ->
-    {ok, State}.
+code_change(_OldVsn, StateName, State = #state{}, _Extra) ->
+    {ok, StateName, State}.
 
 %%%===================================================================
 %%% Internal functions

apps/efka/src/efka_client.erl

@@ -46,7 +46,7 @@
 %% API
 -export([start_link/3]).
 -export([device_offline/1, device_online/1]).
--export([send_metric_data/2, invoke_service/3, send_log/1, request_metric/0, request_param/0, send_event/2, controller_process/1]).
+-export([send_metric_data/2, invoke_service/3, send_log/1, request_metric/0, request_param/0, send_event/2]).
 
 -export([test/0]).
 
@@ -66,7 +66,6 @@
 test() ->
     start_link(<<"test">>, "localhost", 18080).
 
--spec controller_process(ControllerPid :: pid()) -> ok.
 controller_process(ControllerPid) when is_pid(ControllerPid) ->
     gen_server:call(?MODULE, {controller_process, ControllerPid}).
 
@@ -257,7 +256,7 @@ handle_info({tcp, Socket, <<PacketId:32, ?PACKET_TYPE_RESPONSE:8, Message/binary
     end;
 
 %% 收到efka推送的参数设置
-handle_info({tcp, Socket, <<PacketId:32, ?PACKET_TYPE_PUSH_PARAM:8, Params/binary>>}, State = #state{socket = Socket, controller_process = ControllerPid}) ->
+handle_info({tcp, Socket, <<PacketId:32, ?PACKET_TYPE_PUSH_PARAM:8, Params/binary>>}, State = #state{socket = Socket, controller_process = ControllerPid}) when is_map(Params) ->
     Message = case is_pid(ControllerPid) andalso is_process_alive(ControllerPid) of
                   true ->
                       Ref = make_ref(),
@@ -279,7 +278,7 @@ handle_info({tcp, Socket, <<PacketId:32, ?PACKET_TYPE_PUSH_PARAM:8, Params/binar
     {noreply, State};
 
 %% 收到efka推送的采集项消息
-handle_info({tcp, <<PacketId:32, ?PACKET_TYPE_PUSH_METRIC:8, Metrics/binary>>}, State = #state{socket = Socket, controller_process = ControllerPid}) ->
+handle_info({tcp, <<PacketId:32, ?PACKET_TYPE_PUSH_METRIC:8, Metrics/binary>>}, State = #state{socket = Socket, controller_process = ControllerPid}) when is_list(Metrics) ->
     Message = case is_pid(ControllerPid) andalso is_process_alive(ControllerPid) of
                   true ->
                       Ref = make_ref(),