./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 2826 CacheName = cache_name(HostType, Module),
13 2826 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 55 CacheName = cache_name(HostType, Module),
18 55 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 544 CacheName = cache_name(HostType, Module),
23 544 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 3049 CacheName = cache_name(HostType, Module),
28 3049 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 
:-(
 CacheName = cache_name(HostType, Module),
33 
:-(
 segmented_cache:delete_pattern(CacheName, {{'_', Domain}, '_'}).
34
35
36 %% path: (host_config[].)modules.*.cache
37 config_spec() ->
38 498 #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 defaults = #{<<"module">> => internal,
46 <<"strategy">> => fifo,
47 <<"time_to_live">> => 480,
48 <<"number_of_segments">> => 3}
49 }.
50
51 %% If an external module is provided, disallow any other configuration key
52 process_cache_config(#{module := internal} = Config) ->
53 
:-(
 Config;
54 process_cache_config(#{module := Module}) ->
55 
:-(
 #{module => Module};
56 process_cache_config(Config) ->
57 34 Config.
58
59 -spec start_new_cache(mongooseim:host_type(), module(), gen_mod:module_opts()) -> any().
60 start_new_cache(HostType, Module, Opts) ->
61 132 case gen_mod:get_opt(module, Opts, internal) of
62 132 internal -> do_start_new_cache(HostType, Module, Opts);
63 
:-(
 _ -> ok
64 end.
65
66 do_start_new_cache(HostType, Module, Opts) ->
67 132 CacheName = gen_mod:get_module_proc(HostType, Module),
68 132 CacheOpts = #{merger_fun => fun maps:merge/2,
69 segment_num => gen_mod:get_opt(number_of_segments, Opts),
70 strategy => gen_mod:get_opt(strategy, Opts),
71 ttl => gen_mod:get_opt(time_to_live, Opts)},
72 132 Spec = #{id => CacheName, start => {segmented_cache, start_link, [CacheName, CacheOpts]},
73 restart => permanent, shutdown => 5000,
74 type => worker, modules => [segmented_cache]},
75 132 {ok, _} = ejabberd_sup:start_child(Spec),
76 132 create_metrics(HostType, Module, CacheName),
77 132 ok.
78
79 create_metrics(HostType, Module, CacheName) ->
80 132 telemetry:attach(CacheName,
81 [segmented_cache, request],
82 fun ?MODULE:handle_telemetry_event/4,
83 #{host_type => HostType, module => Module}),
84 132 mongoose_metrics:ensure_metric(HostType, [Module, hit], counter),
85 132 mongoose_metrics:ensure_metric(HostType, [Module, miss], counter),
86 132 mongoose_metrics:ensure_metric(HostType, [Module, latency], histogram).
87
88 handle_telemetry_event([segmented_cache, request], #{hit := Hit, time := Latency},
89 _, #{host_type := HostType, module := Module}) ->
90 14788 case Hit of
91 11318 true -> mongoose_metrics:update(HostType, [Module, hit], 1);
92 3470 false -> mongoose_metrics:update(HostType, [Module, miss], 1)
93 end,
94 14788 mongoose_metrics:update(HostType, [Module, latency], Latency),
95 14788 ok.
96
97 -spec stop_cache(mongooseim:host_type(), module()) -> ok.
98 stop_cache(HostType, Module) ->
99 130 case gen_mod:get_module_opt(HostType, Module, module, internal) of
100 130 internal -> ok = ejabberd_sup:stop_child(cache_name(HostType, Module));
101 
:-(
 _ConfiguredModule -> ok
102 end.
103
104 -spec cache_name(mongooseim:host_type(), module()) -> atom().
105 cache_name(HostType, Module) ->
106 6604 case gen_mod:get_module_opt(HostType, Module, module, internal) of
107 6604 internal -> gen_mod:get_module_proc(HostType, Module);
108 
:-(
 ConfiguredModule -> gen_mod:get_module_proc(HostType, ConfiguredModule)
109 end.
110
111 -compile({inline, [key/1]}).
112 -spec key(jid:jid()) -> jid:simple_bare_jid().
113 key(Jid) ->
114 6474 jid:to_lus(Jid).
Line Hits Source