Skip to content

PISTON-292: support for pause aliases #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danielfinke wants to merge 1 commit into
base: master
Choose a base branch
from
Open

PISTON-292: support for pause aliases #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 26 additions & 22 deletions src/acdc_agent_fsm.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
,originate_resp/2, originate_started/2, originate_uuid/2
,originate_failed/2
,sync_req/2, sync_resp/2
,pause/2
,pause/3
,resume/1
,end_wrapup/1

Expand Down Expand Up @@ -108,6 +108,7 @@

,sync_ref :: kz_term:api_reference()
,pause_ref :: kz_term:api_reference() | 'infinity'
,pause_alias :: kz_term:api_binary()

,member_call :: kapps_call:call() | 'undefined'
,member_call_id :: kz_term:api_binary()
Expand Down Expand Up @@ -279,9 +280,9 @@ sync_resp(ServerRef, JObj) ->
%% @doc
%% @end
%%------------------------------------------------------------------------------
-spec pause(kz_types:server_ref(), timeout()) -> 'ok'.
pause(ServerRef, Timeout) ->
gen_statem:cast(ServerRef, {'pause', Timeout}).
-spec pause(kz_types:server_ref(), timeout(), kz_term:api_binary()) -> 'ok'.
pause(ServerRef, Timeout, Alias) ->
gen_statem:cast(ServerRef, {'pause', Timeout, Alias}).

%%------------------------------------------------------------------------------
%% @doc
Expand Down Expand Up @@ -1415,26 +1416,26 @@ handle_event({'resume'}=Event, StateName, #state{agent_state_updates=Queue}=Stat
lager:debug("recv resume during ~p, delaying", [StateName]),
NewQueue = [Event | Queue],
{'next_state', StateName, State#state{agent_state_updates=NewQueue}};
handle_event({'pause', Timeout}, 'ringing', #state{agent_listener=AgentListener
,account_id=AccountId
,agent_id=AgentId
,member_call_id=CallId
,member_call_queue_id=QueueId
}=State) ->
handle_event({'pause', Timeout, Alias}, 'ringing', #state{agent_listener=AgentListener
,account_id=AccountId
,agent_id=AgentId
,member_call_id=CallId
,member_call_queue_id=QueueId
}=State) ->
%% Give up the current ringing call
acdc_agent_listener:hangup_call(AgentListener),
lager:debug("stopping ringing agent in order to move to pause"),
acdc_stats:call_missed(AccountId, QueueId, AgentId, CallId, <<"agent pausing">>),
NewFSMState = clear_call(State, 'failed'),
%% After clearing we are basically 'ready' state, pause from that state
handle_event({'pause', Timeout}, 'ready', NewFSMState);
handle_event({'pause', Timeout}=Event, 'ready', #state{agent_state_updates=Queue}=State) ->
lager:debug("recv status update: pausing for up to ~b s", [Timeout]),
handle_event({'pause', Timeout, Alias}, 'ready', NewFSMState);
handle_event({'pause', Timeout, _}=Event, 'ready', #state{agent_state_updates=Queue}=State) ->
lager:debug("recv status update: pausing for up to ~p s", [Timeout]),
NewQueue = [Event | Queue],
apply_state_updates(State#state{agent_state_updates=NewQueue});
handle_event({'pause', Timeout}, 'paused', State) ->
handle_event({'pause', Timeout}, 'ready', State);
handle_event({'pause', _}=Event, StateName, #state{agent_state_updates=Queue}=State) ->
handle_event({'pause', Timeout, Alias}, 'paused', State) ->
handle_event({'pause', Timeout, Alias}, 'ready', State);
handle_event({'pause', _, _}=Event, StateName, #state{agent_state_updates=Queue}=State) ->
lager:debug("recv pause during ~p, delaying", [StateName]),
NewQueue = [Event | Queue],
{'next_state', StateName, State#state{agent_state_updates=NewQueue}};
Expand Down Expand Up @@ -2020,6 +2021,7 @@ apply_state_updates_fold({_, StateName, #state{account_id=AccountId
,agent_listener=AgentListener
,wrapup_ref=WRef
,pause_ref=PRef
,pause_alias=Alias
}}=Acc, []) ->
lager:debug("resulting agent state ~s", [StateName]),
case StateName of
Expand All @@ -2029,11 +2031,11 @@ apply_state_updates_fold({_, StateName, #state{account_id=AccountId
'wrapup' -> acdc_agent_stats:agent_wrapup(AccountId, AgentId, time_left(WRef));
'paused' ->
acdc_agent_listener:send_agent_busy(AgentListener),
acdc_agent_stats:agent_paused(AccountId, AgentId, time_left(PRef))
acdc_agent_stats:agent_paused(AccountId, AgentId, time_left(PRef), Alias)
end,
Acc;
apply_state_updates_fold({_, _, State}, [{'pause', Timeout}|Updates]) ->
apply_state_updates_fold(handle_pause(Timeout, State), Updates);
apply_state_updates_fold({_, _, State}, [{'pause', Timeout, Alias}|Updates]) ->
apply_state_updates_fold(handle_pause(Timeout, Alias, State), Updates);
apply_state_updates_fold({_, _, State}, [{'resume'}|Updates]) ->
apply_state_updates_fold(handle_resume(State), Updates);
apply_state_updates_fold({_, 'wrapup', State}, [{'end_wrapup'}|Updates]) ->
Expand Down Expand Up @@ -2083,15 +2085,17 @@ handle_resume(#state{agent_listener=AgentListener
acdc_agent_listener:presence_update(AgentListener, ?PRESENCE_GREEN),
{'next_state', 'ready', State#state{pause_ref='undefined'}}.

-spec handle_pause(timeout(), state()) -> kz_types:handle_fsm_ret(state()).
handle_pause(Timeout, #state{agent_listener=AgentListener}=State) ->
-spec handle_pause(timeout(), kz_term:api_binary(), state()) -> kz_types:handle_fsm_ret(state()).
handle_pause(Timeout, Alias, #state{agent_listener=AgentListener}=State) ->
acdc_agent_listener:presence_update(AgentListener, ?PRESENCE_RED_FLASH),
State1 = case Timeout of
'infinity' ->
State#state{pause_ref='infinity'};
_ ->
Ref = start_pause_timer(Timeout),
State#state{pause_ref=Ref}
State#state{pause_ref=Ref
,pause_alias=Alias
}
end,
{'next_state', 'paused', State1}.

Expand Down
13 changes: 7 additions & 6 deletions src/acdc_agent_handler.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ handle_status_update(JObj, _Props) ->
<<"pause">> ->
'true' = kapi_acdc_agent:pause_v(JObj),
Timeout = kz_json:get_value(<<"Time-Limit">>, JObj, ?DEFAULT_PAUSE),
maybe_pause_agent(AccountId, AgentId, Timeout, JObj);
Alias = kz_json:get_value(<<"Alias">>, JObj),
maybe_pause_agent(AccountId, AgentId, Timeout, Alias, JObj);
<<"resume">> ->
'true' = kapi_acdc_agent:resume_v(JObj),
maybe_resume_agent(AccountId, AgentId, JObj);
Expand Down Expand Up @@ -170,16 +171,16 @@ maybe_stop_agent(AccountId, AgentId, JObj) ->

end.

maybe_pause_agent(AccountId, AgentId, <<"infinity">>, JObj) ->
maybe_pause_agent(AccountId, AgentId, 'infinity', JObj);
maybe_pause_agent(AccountId, AgentId, Timeout, JObj) ->
maybe_pause_agent(AccountId, AgentId, <<"infinity">>, Alias, JObj) ->
maybe_pause_agent(AccountId, AgentId, 'infinity', Alias, JObj);
maybe_pause_agent(AccountId, AgentId, Timeout, Alias, JObj) ->
case acdc_agents_sup:find_agent_supervisor(AccountId, AgentId) of
'undefined' -> lager:debug("agent ~s (~s) not found, nothing to do", [AgentId, AccountId]);
Sup when is_pid(Sup) ->
lager:debug("agent ~s(~s) is pausing for ~p", [AccountId, AgentId, Timeout]),
lager:debug("agent ~s(~s) is pausing (~p) for ~p", [AccountId, AgentId, Alias, Timeout]),
FSM = acdc_agent_sup:fsm(Sup),
acdc_agent_fsm:update_presence(FSM, presence_id(JObj), presence_state(JObj, 'undefined')),
acdc_agent_fsm:pause(FSM, Timeout)
acdc_agent_fsm:pause(FSM, Timeout, Alias)
end.

maybe_resume_agent(AccountId, AgentId, JObj) ->
Expand Down
14 changes: 10 additions & 4 deletions src/acdc_agent_stats.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
,agent_connecting/3, agent_connecting/6
,agent_connected/3, agent_connected/6
,agent_wrapup/3
,agent_paused/3
,agent_paused/4
,agent_outbound/3

,handle_status_stat/2
Expand Down Expand Up @@ -172,16 +172,17 @@ agent_wrapup(AccountId, AgentId, WaitTime) ->
,fun kapi_acdc_stats:publish_status_wrapup/1
).

-spec agent_paused(kz_term:ne_binary(), kz_term:ne_binary(), timeout() | 'undefined') -> 'ok'.
agent_paused(AccountId, AgentId, 'undefined') ->
-spec agent_paused(kz_term:ne_binary(), kz_term:ne_binary(), timeout() | 'undefined', kz_term:api_binary()) -> 'ok'.
agent_paused(AccountId, AgentId, 'undefined', _) ->
lager:debug("undefined pause time for ~s(~s)", [AgentId, AccountId]);
agent_paused(AccountId, AgentId, PauseTime) ->
agent_paused(AccountId, AgentId, PauseTime, Alias) ->
Prop = props:filter_undefined(
[{<<"Account-ID">>, AccountId}
,{<<"Agent-ID">>, AgentId}
,{<<"Timestamp">>, kz_time:now_s()}
,{<<"Status">>, <<"paused">>}
,{<<"Pause-Time">>, PauseTime}
,{<<"Pause-Alias">>, Alias}
| kz_api:default_headers(?APP_NAME, ?APP_VERSION)
]),
log_status_change(AccountId, Prop),
Expand Down Expand Up @@ -233,6 +234,7 @@ handle_status_stat(JObj, Props) ->
,callid=kz_json:get_value(<<"Call-ID">>, JObj)
,wait_time=acdc_stats_util:wait_time(EventName, JObj)
,pause_time=acdc_stats_util:pause_time(EventName, JObj)
,pause_alias=kz_json:get_value(<<"Pause-Alias">>, JObj)
,caller_id_name=acdc_stats_util:caller_id_name(EventName, JObj)
,caller_id_number=acdc_stats_util:caller_id_number(EventName, JObj)
,queue_id=acdc_stats_util:queue_id(EventName, JObj)
Expand Down Expand Up @@ -426,6 +428,7 @@ status_stat_to_map(#status_stat{key=#status_stat_key{agent_id=AgentId
,status=Status
,wait_time=WT
,pause_time=PT
,pause_alias=Alias
,callid=CallId
,caller_id_name=CIDName
,caller_id_number=CIDNum
Expand All @@ -437,6 +440,7 @@ status_stat_to_map(#status_stat{key=#status_stat_key{agent_id=AgentId
,'status' => Status
,'wait_time' => WT
,'pause_time' => PT
,'pause_alias' => Alias
,'call_id' => CallId
,'caller_id_name' => CIDName
,'caller_id_number' => CIDNum
Expand All @@ -452,6 +456,7 @@ status_stat_to_doc(#status_stat{key=#status_stat_key{account_id=AccountId
,status=Status
,wait_time=WT
,pause_time=PT
,pause_alias=Alias
,callid=CallId
,caller_id_name=CIDName
,caller_id_number=CIDNum
Expand All @@ -464,6 +469,7 @@ status_stat_to_doc(#status_stat{key=#status_stat_key{account_id=AccountId
,{<<"status">>, Status}
,{<<"wait_time">>, WT}
,{<<"pause_time">>, PT}
,{<<"pause_alias">>, Alias}
,{<<"caller_id_name">>, CIDName}
,{<<"caller_id_number">>, CIDNum}
,{<<"queue_id">>, QueueId}
Expand Down
1 change: 1 addition & 0 deletions src/acdc_stats.hrl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@

,wait_time :: kz_term:api_integer() | '_'
,pause_time :: timeout() | 'undefined' | '_'
,pause_alias :: kz_term:api_binary() | '_'
,callid :: kz_term:api_binary() | '_'
,caller_id_name :: kz_term:api_binary() | '_'
,caller_id_number :: kz_term:api_binary() | '_'
Expand Down
1 change: 1 addition & 0 deletions src/cb_agents.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ publish_update(Context, AgentId, PubFun) ->
[{<<"Account-ID">>, cb_context:account_id(Context)}
,{<<"Agent-ID">>, AgentId}
,{<<"Time-Limit">>, cb_context:req_value(Context, <<"timeout">>)}
,{<<"Alias">>, cb_context:req_value(Context, <<"alias">>)}
,{<<"Presence-ID">>, cb_context:req_value(Context, <<"presence_id">>)}
,{<<"Presence-State">>, cb_context:req_value(Context, <<"presence_state">>)}
| kz_api:default_headers(?APP_NAME, ?APP_VERSION)
Expand Down
4 changes: 3 additions & 1 deletion src/kapi_acdc_agent.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,8 @@ stats_resp_v(JObj) ->
]).
-define(AGENT_TYPES, []).

-define(OPTIONAL_PAUSE_HEADERS, [<<"Alias">>]).

-define(LOGIN_VALUES, [{<<"Event-Name">>, <<"login">>} | ?AGENT_VALUES]).
-define(LOGOUT_VALUES, [{<<"Event-Name">>, <<"logout">>} | ?AGENT_VALUES]).
-define(PAUSE_VALUES, [{<<"Event-Name">>, <<"pause">>} | ?AGENT_VALUES]).
Expand Down Expand Up @@ -322,7 +324,7 @@ logout_queue_v(JObj) ->
{'error', string()}.
pause(Props) when is_list(Props) ->
case pause_v(Props) of
'true' -> kz_api:build_message(Props, ?AGENT_HEADERS, ?OPTIONAL_AGENT_HEADERS);
'true' -> kz_api:build_message(Props, ?AGENT_HEADERS, ?OPTIONAL_AGENT_HEADERS ++ ?OPTIONAL_PAUSE_HEADERS);
'false' -> {'error', "Proplist failed validation for agent_pause"}
end;
pause(JObj) ->
Expand Down
2 changes: 1 addition & 1 deletion src/kapi_acdc_stats.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ status_resp_v(JObj) ->
status_resp_v(kz_json:to_proplist(JObj)).

-define(STATUS_HEADERS, [<<"Account-ID">>, <<"Agent-ID">>, <<"Timestamp">>]).
-define(STATUS_OPTIONAL_HEADERS, [<<"Wait-Time">>, <<"Pause-Time">>, <<"Call-ID">>
-define(STATUS_OPTIONAL_HEADERS, [<<"Wait-Time">>, <<"Pause-Time">>, <<"Pause-Alias">>, <<"Call-ID">>
,<<"Caller-ID-Name">>, <<"Caller-ID-Number">>
,<<"Queue-ID">>
]).
Expand Down