./ct_report/coverage/mod_event_pusher_http.COVER.html

1 %%%----------------------------------------------------------------------
2 %%% File : mod_event_pusher_http.erl
3 %%% Author : Baibossynv Valery <baibossynov.valery@gmail.com>
4 %%% Purpose : Message passing via http
5 %%% Created : 16 Dec 2015 by Baibossynv Valery <baibossynov.valery@gmail.com>
6 %%%----------------------------------------------------------------------
7
8 -module(mod_event_pusher_http).
9 -author("baibossynov.valery@gmail.com").
10
11 -ignore_xref([behaviour_info/1]).
12
13 -behaviour(gen_mod).
14 -behaviour(mod_event_pusher).
15 -behaviour(mongoose_module_metrics).
16
17 -callback should_make_req(Acc :: mongoose_acc:t(),
18 Dir :: in | out,
19 Packet :: exml:element(),
20 From :: jid:jid(),
21 To :: jid:jid(),
22 Opts :: [{atom(), term()}]) -> boolean().
23 -callback prepare_headers(Acc :: mongoose_acc:t(),
24 Dir :: in | out,
25 Domain :: jid:lserver(),
26 Message :: binary(),
27 Sender :: jid:luser(),
28 Receiver :: jid:luser(),
29 Opts :: [{atom(), term()}]) -> [{binary(), binary()}].
30 -callback prepare_body(Acc :: mongoose_acc:t(),
31 Dir :: in | out,
32 Domain :: jid:lserver(),
33 Message :: binary(),
34 Sender :: jid:luser(),
35 Receiver :: jid:luser(),
36 Opts :: [{atom(), term()}]) -> binary().
37
38 -include("mod_event_pusher_events.hrl").
39 -include("jlib.hrl").
40
41 %% API
42 -export([start/2, stop/1, config_spec/0, push_event/2, instrumentation/1]).
43
44 %% config spec callbacks
45 -export([fix_path/1]).
46
47 -include("mongoose.hrl").
48 -include("jlib.hrl").
49 -include("mongoose_config_spec.hrl").
50
51 -define(SENT_METRIC, mod_event_pusher_http_sent).
52
53 -spec start(mongooseim:host_type(), gen_mod:module_opts()) -> ok.
54 start(_HostType, _Opts) ->
55 5 ok.
56
57 -spec stop(mongooseim:host_type()) -> ok.
58 stop(_HostType) ->
59 5 ok.
60
61 -spec config_spec() -> mongoose_config_spec:config_section().
62 config_spec() ->
63 106 #section{items = #{<<"handlers">> => #list{items = handler_config_spec(),
64 validate = unique}},
65 defaults = #{<<"handlers">> => []}}.
66
67 handler_config_spec() ->
68 106 #section{items = #{<<"pool_name">> => #option{type = atom,
69 validate = pool_name},
70 <<"path">> => #option{type = binary,
71 process = fun ?MODULE:fix_path/1},
72 <<"callback_module">> => #option{type = atom,
73 validate = module}
74 },
75 defaults = #{<<"pool_name">> => http_pool,
76 <<"path">> => <<>>,
77 <<"callback_module">> => mod_event_pusher_http_defaults}
78 }.
79
80 instrumentation(HostType) ->
81 11 [{?SENT_METRIC, #{host_type => HostType},
82 #{metrics => #{count => spiral, response_time => histogram, failure_count => spiral}}}].
83
84 push_event(Acc, #chat_event{direction = Dir, from = From, to = To, packet = Packet}) ->
85 58 HostType = mongoose_acc:host_type(Acc),
86 58 lists:map(fun(Opts) -> push_event(Acc, Dir, From, To, Packet, Opts) end,
87 gen_mod:get_module_opt(HostType, ?MODULE, handlers)),
88 58 Acc;
89 push_event(Acc, _Event) ->
90 44 Acc.
91
92 push_event(Acc, Dir, From, To, Packet, Opts = #{callback_module := Mod}) ->
93 64 Body = exml_query:path(Packet, [{element, <<"body">>}, cdata], <<>>),
94 64 case Mod:should_make_req(Acc, Dir, Packet, From, To, Opts) of
95 true ->
96 19 make_req(Acc, Dir, From#jid.lserver, From#jid.luser, To#jid.luser, Body, Opts);
97 _ ->
98 45 ok
99 end,
100 64 Acc.
101
102 %%%===================================================================
103 %%% Internal functions
104 %%%===================================================================
105
106 make_req(Acc, Dir, Domain, Sender, Receiver, Message, Opts) ->
107 19 #{pool_name := PoolName, path := Path, callback_module := Mod} = Opts,
108 19 HostType = mongoose_acc:host_type(Acc),
109 19 Body = Mod:prepare_body(Acc, Dir, Domain, Message, Sender, Receiver, Opts),
110 19 Headers = Mod:prepare_headers(Acc, Dir, Domain, Message, Sender, Receiver, Opts),
111 19 LogMeta = #{what => event_pusher_http_req,
112 text => <<"mod_event_pusher_http makes an external HTTP call">>,
113 path => Path, body => Body, headers => Headers,
114 sender => Sender, receiver => Receiver, direction => Dir,
115 server => Domain, pool_name => PoolName, acc => Acc},
116 19 ?LOG_INFO(LogMeta),
117 19 mongoose_instrument:span(?SENT_METRIC, #{host_type => HostType},
118 fun mongoose_http_client:post/5, [HostType, PoolName, Path, Headers, Body],
119 19 fun(Time, Result) -> handle_post_result(Time, Result, LogMeta) end).
120
121 handle_post_result(Time, {ok, {Code, _Body}}, #{sender := Sender}) ->
122 17 #{count => 1, response_time => Time, sender => Sender, response_code => Code};
123 handle_post_result(_Time, {error, Reason}, LogMeta = #{sender := Sender}) ->
124 2 ?LOG_WARNING(LogMeta#{what => event_pusher_http_req_failed,
125 text => <<"mod_event_pusher_http HTTP call failed">>,
126 
:-(
 reason => Reason}),
127 2 #{failure_count => 1, sender => Sender}.
128
129 %% @doc Strip initial slash (it is added by mongoose_http_client)
130 fix_path(<<"/", R/binary>>) ->
131 
:-(
 R;
132 fix_path(R) ->
133 
:-(
 R.
Line Hits Source