./ct_report/coverage/mongoose_user_cache.COVER.html

1 -module(mongoose_user_cache).
2
3 -include("mongoose_config_spec.hrl").
4
5 -export([start_new_cache/3, stop_cache/2, handle_telemetry_event/4,
6 config_spec/0, process_cache_config/1]).
7
8 -export([is_member/3, get_entry/3, merge_entry/4, delete_user/3, delete_domain/3]).
9
10 -spec is_member(mongooseim:host_type(), module(), jid:jid()) -> boolean().
11 is_member(HostType, Module, Jid) ->
12 9434 CacheName = cache_name(HostType, Module),
13 9434 segmented_cache:is_member(CacheName, key(Jid)).
14
15 -spec get_entry(mongooseim:host_type(), module(), jid:jid()) -> term() | not_found.
16 get_entry(HostType, Module, Jid) ->
17 3518 CacheName = cache_name(HostType, Module),
18 3518 segmented_cache:get_entry(CacheName, key(Jid)).
19
20 -spec merge_entry(mongooseim:host_type(), module(), jid:jid(), map()) -> boolean().
21 merge_entry(HostType, Module, Jid, Entry) ->
22 2176 CacheName = cache_name(HostType, Module),
23 2176 segmented_cache:merge_entry(CacheName, key(Jid), Entry).
24
25 -spec delete_user(mongooseim:host_type(), module(), jid:jid()) -> true.
26 delete_user(HostType, Module, Jid) ->
27 3877 CacheName = cache_name(HostType, Module),
28 3877 segmented_cache:delete_entry(CacheName, key(Jid)).
29
30 -spec delete_domain(mongooseim:host_type(), module(), jid:lserver()) -> true.
31 delete_domain(HostType, Module, Domain) ->
32 15 CacheName = cache_name(HostType, Module),
33 15 segmented_cache:delete_pattern(CacheName, {{'_', Domain}, '_'}).
34
35
36 %% path: (host_config[].)modules.*.cache
37 config_spec() ->
38 438 #section{
39 items = #{<<"module">> => #option{type = atom, validate = {enum, [internal, mod_cache_users]}},
40 <<"strategy">> => #option{type = atom, validate = {enum, [fifo, lru]}},
41 <<"time_to_live">> => #option{type = int_or_infinity, validate = positive},
42 <<"number_of_segments">> => #option{type = integer, validate = positive}
43 },
44 process = fun ?MODULE:process_cache_config/1
45 }.
46
47 %% If an external module is provided, disallow any other configuration key
48 process_cache_config(KVs) ->
49 31 case lists:keyfind(module, 1, KVs) of
50 
:-(
 {module, Module} when Module =/= internal -> [{module, _}] = KVs;
51 31 _ -> ok
52 end,
53 31 KVs.
54
55 -spec start_new_cache(mongooseim:host_type(), module(), gen_mod:module_opts()) -> any().
56 start_new_cache(HostType, Module, Opts) ->
57 168 case gen_mod:get_opt(module, Opts, internal) of
58 168 internal -> do_start_new_cache(HostType, Module, Opts);
59 
:-(
 _ -> ok
60 end.
61
62 do_start_new_cache(HostType, Module, Opts) ->
63 168 CacheName = gen_mod:get_module_proc(HostType, Module),
64 168 CacheOpts = #{merger_fun => gen_mod:get_opt(merger_fun, Opts, fun maps:merge/2),
65 segment_num => gen_mod:get_opt(number_of_segments, Opts, 3),
66 strategy => gen_mod:get_opt(strategy, Opts, fifo),
67 ttl => gen_mod:get_opt(time_to_live, Opts, {hours, 8})},
68 168 Spec = #{id => CacheName, start => {segmented_cache, start_link, [CacheName, CacheOpts]},
69 restart => permanent, shutdown => 5000,
70 type => worker, modules => [segmented_cache]},
71 168 {ok, _} = ejabberd_sup:start_child(Spec),
72 168 create_metrics(HostType, Module, CacheName),
73 168 ok.
74
75 create_metrics(HostType, Module, CacheName) ->
76 168 telemetry:attach(CacheName,
77 [segmented_cache, request],
78 fun ?MODULE:handle_telemetry_event/4,
79 #{host_type => HostType, module => Module}),
80 168 mongoose_metrics:ensure_metric(HostType, [Module, hit], counter),
81 168 mongoose_metrics:ensure_metric(HostType, [Module, miss], counter),
82 168 mongoose_metrics:ensure_metric(HostType, [Module, latency], histogram).
83
84 handle_telemetry_event([segmented_cache, request], #{hit := Hit, time := Latency},
85 _, #{host_type := HostType, module := Module}) ->
86 65251 case Hit of
87 52457 true -> mongoose_metrics:update(HostType, [Module, hit], 1);
88 12794 false -> mongoose_metrics:update(HostType, [Module, miss], 1)
89 end,
90 65251 mongoose_metrics:update(HostType, [Module, latency], Latency),
91 65251 ok.
92
93 -spec stop_cache(mongooseim:host_type(), module()) -> ok.
94 stop_cache(HostType, Module) ->
95 168 case gen_mod:get_module_opt(HostType, Module, module, internal) of
96 168 internal -> ok = ejabberd_sup:stop_child(cache_name(HostType, Module));
97 
:-(
 _ConfiguredModule -> ok
98 end.
99
100 -spec cache_name(mongooseim:host_type(), module()) -> atom().
101 cache_name(HostType, Module) ->
102 19188 case gen_mod:get_module_opt(HostType, Module, module, internal) of
103 19188 internal -> gen_mod:get_module_proc(HostType, Module);
104 
:-(
 ConfiguredModule -> gen_mod:get_module_proc(HostType, ConfiguredModule)
105 end.
106
107 -compile({inline, [key/1]}).
108 -spec key(jid:jid()) -> jid:simple_bare_jid().
109 key(Jid) ->
110 19005 jid:to_lus(Jid).
Line Hits Source