Add a supervisor for domain workers

Follow cleaner OTP supervision conventions,
we want these workers supervised.

doc/developers-guide/domain_management.md

@@ -19,7 +19,7 @@ It provides the following interfaces:
   Any of these lists can be empty, initial list of domain/host\_type pairs can
   have some unique host\_types not mentioned in the host\_types list.
   The component is initialised by the main MIM supervisor.
-  Implemented in `mongoose_domain_api:init()`.
+  Implemented in `mongoose_domain_sup:start_link/0`.
 - Insert - adding new domain/host\_type pair.
   This function is idempotent. It returns success on an attempt to insert the existing data,
   but fails if ETS already has the domain name associated with another host type.

src/domain/mongoose_domain_api.erl

@@ -4,9 +4,10 @@
 
 -include("mongoose_logger.hrl").
 
--export([init/0,
-         stop/0,
-         get_host_type/1]).
+-ifdef(TEST).
+-export([init/0, stop/0]).
+-endif.
+-export([get_host_type/1]).
 
 %% external domain API for GraphQL or REST handlers
 -export([insert_domain/2,
@@ -45,7 +46,6 @@
 
 -ignore_xref([get_all_static/0]).
 -ignore_xref([get_all_dynamic/0]).
--ignore_xref([stop/0]).
 
 -type status() :: enabled | disabled | deleting.
 -type domain() :: jid:lserver().
@@ -66,6 +66,7 @@
 
 -export_type([status/0, remove_domain_acc/0]).
 
+-ifdef(TEST).
 -spec init() -> ok | {error, term()}.
 init() ->
     mongoose_domain_core:start(),
@@ -80,6 +81,7 @@ stop() ->
     catch mongoose_subdomain_core:stop(),
     catch mongoose_lazy_routing:stop(),
     ok.
+-endif.
 
 -spec insert_domain(domain(), host_type()) -> insert_result().
 insert_domain(Domain, HostType) ->

src/domain/mongoose_domain_core.erl

@@ -9,7 +9,7 @@
 -include_lib("stdlib/include/ms_transform.hrl").
 
 -export([start/0, start/2, stop/0]).
--export([start_link/2]).
+-export([start_link/0, start_link/2]).
 -export([get_host_type/1]).
 -export([is_static/1]).
 
@@ -34,7 +34,7 @@
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2,
          terminate/2, code_change/3]).
 
--ignore_xref([get_start_args/0, start_link/2, start/2, stop/0]).
+-ignore_xref([get_start_args/0, start_link/0, start_link/2, start/0, start/2, stop/0]).
 
 -define(TABLE, ?MODULE).
 -define(HOST_TYPE_TABLE, mongoose_domain_core_host_types).
@@ -46,7 +46,11 @@
 start() ->
     Pairs = get_static_pairs(),
     AllowedHostTypes = mongoose_config:get_opt(host_types),
-    start(Pairs, AllowedHostTypes).
+    ChildSpec =
+        {?MODULE,
+         {?MODULE, start_link, [Pairs, AllowedHostTypes]},
+         permanent, infinity, worker, [?MODULE]},
+    just_ok(supervisor:start_child(mongoose_domain_sup, ChildSpec)).
 
 -ifdef(TEST).
 
@@ -64,16 +68,21 @@ start(Pairs, AllowedHostTypes) ->
         {?MODULE,
          {?MODULE, start_link, [Pairs, AllowedHostTypes]},
          permanent, infinity, worker, [?MODULE]},
-    just_ok(supervisor:start_child(ejabberd_sup, ChildSpec)).
+    just_ok(supervisor:start_child(mongoose_domain_sup, ChildSpec)).
 
 %% required for integration tests
 stop() ->
-    supervisor:terminate_child(ejabberd_sup, ?MODULE),
-    supervisor:delete_child(ejabberd_sup, ?MODULE),
+    supervisor:terminate_child(mongoose_domain_sup, ?MODULE),
+    supervisor:delete_child(mongoose_domain_sup, ?MODULE),
     ok.
 
 -endif.
 
+start_link() ->
+    Pairs = get_static_pairs(),
+    AllowedHostTypes = mongoose_config:get_opt(host_types),
+    start_link(Pairs, AllowedHostTypes).
+
 start_link(Pairs, AllowedHostTypes) ->
     gen_server:start_link({local, ?MODULE}, ?MODULE, [Pairs, AllowedHostTypes], []).
 

src/domain/mongoose_domain_sup.erl

@@ -0,0 +1,19 @@
+-module(mongoose_domain_sup).
+
+-behaviour(supervisor).
+
+-export([start_link/0, init/1]).
+-ignore_xref([start_link/0]).
+
+start_link() ->
+    supervisor:start_link({local, ?MODULE}, ?MODULE, []).
+
+init([]) ->
+    DomainCore = worker_spec(mongoose_domain_core),
+    SubdomainCore = worker_spec(mongoose_subdomain_core),
+    LazyRouting = worker_spec(mongoose_lazy_routing),
+    {ok, {{one_for_one, 10, 1},
+          [DomainCore, SubdomainCore, LazyRouting]}}.
+
+worker_spec(Mod) ->
+    {Mod, {Mod, start_link, []}, permanent, timer:seconds(5), worker, [Mod]}.

src/domain/mongoose_lazy_routing.erl

@@ -43,7 +43,7 @@
          terminate/2,
          code_change/3]).
 
--ignore_xref([start_link/0, stop/0, sync/0]).
+-ignore_xref([start_link/0, start/0, stop/0, sync/0]).
 
 -define(IQ_TABLE, mongoose_lazy_routing_iqs).
 -define(ROUTING_TABLE, mongoose_lazy_routing).
@@ -80,12 +80,12 @@ stop() ->
 start() ->
     ChildSpec = {?MODULE, {?MODULE, start_link, []},
                  permanent, infinity, worker, [?MODULE]},
-    just_ok(supervisor:start_child(ejabberd_sup, ChildSpec)).
+    just_ok(supervisor:start_child(mongoose_domain_sup, ChildSpec)).
 
 %% required for integration tests
 stop() ->
-    supervisor:terminate_child(ejabberd_sup, ?MODULE),
-    supervisor:delete_child(ejabberd_sup, ?MODULE),
+    supervisor:terminate_child(mongoose_domain_sup, ?MODULE),
+    supervisor:delete_child(mongoose_domain_sup, ?MODULE),
     ok.
 
 -endif.

src/domain/mongoose_subdomain_core.erl

@@ -26,7 +26,7 @@
          code_change/3,
          terminate/2]).
 
--ignore_xref([start_link/0, stop/0, sync/0]).
+-ignore_xref([start_link/0, start/0, stop/0, sync/0]).
 
 -ifdef(TEST).
 
@@ -85,12 +85,12 @@ log_error(_Function, _Error) -> ok.
 start() ->
     ChildSpec = {?MODULE, {?MODULE, start_link, []},
                  permanent, infinity, worker, [?MODULE]},
-    just_ok(supervisor:start_child(ejabberd_sup, ChildSpec)).
+    just_ok(supervisor:start_child(mongoose_domain_sup, ChildSpec)).
 
 %% required for integration tests
 stop() ->
-    supervisor:terminate_child(ejabberd_sup, ?MODULE),
-    supervisor:delete_child(ejabberd_sup, ?MODULE),
+    supervisor:terminate_child(mongoose_domain_sup, ?MODULE),
+    supervisor:delete_child(mongoose_domain_sup, ?MODULE),
     ok.
 
 -endif.

src/ejabberd_app.erl

@@ -56,7 +56,6 @@ start(normal, _Args) ->
     mongoose_logs:set_global_loglevel(mongoose_config:get_opt(loglevel)),
     mongoose_deprecations:start(),
     {ok, _} = Sup = ejabberd_sup:start_link(),
-    mongoose_domain_api:init(),
     mongoose_wpool:ensure_started(),
     mongoose_wpool:start_configured_pools(),
     %% ejabberd_sm is started separately because it may use one of the outgoing_pools

src/ejabberd_sup.erl

@@ -149,6 +149,10 @@ init([]) ->
         {mongoose_shaper_sup,
           {mongoose_shaper_sup, start_link, []},
           permanent, infinity, supervisor, [mongoose_shaper_sup]},
+    DomainSup =
+        {mongoose_domain_sup,
+          {mongoose_domain_sup, start_link, []},
+          permanent, infinity, supervisor, [mongoose_domain_sup]},
     PG =
         {pg,
           {pg, start_link, [mim_scope]},
@@ -170,7 +174,8 @@ init([]) ->
            IQSupervisor,
            Listener,
            MucIQ,
-           ShaperSup]}}.
+           ShaperSup,
+           DomainSup]}}.
 
 start_child(ChildSpec) ->
     case supervisor:start_child(ejabberd_sup, ChildSpec) of

test/mongoose_cleanup_SUITE.erl

@@ -36,7 +36,13 @@ init_per_suite(Config) ->
     ok = mnesia:create_schema([node()]),
     ok = mnesia:start(),
     [mongoose_config:set_opt(Key, Value) || {Key, Value} <- opts()],
-    mongoose_domain_api:init(),
+    Self = self(),
+    spawn(fun() ->
+                  supervisor:start_link({local, mongoose_domain_sup}, mongoose_domain_sup, []),
+                  Self ! ready,
+                  receive stop -> ok end
+          end),
+    receive ready -> ok after timer:seconds(30) -> ct:fail(mongoose_domain_sup_not_ready) end,
     Config.
 
 end_per_suite(Config) ->