Merge pull request #4597 from esl/tomasz/mim-2527-all-domains

Add allDomains GraphQL query

Author: chrzaszcz

big_tests/tests/graphql_domain_SUITE.erl

@@ -41,8 +41,10 @@ domain_tests() ->
      wrong_host_type_error_formatting,
      invalid_domain_name_error,
      disable_domain,
+     get_all_domains_with_disabled,
      enable_domain,
      get_domains_by_host_type,
+     get_all_domains,
      get_domain_details,
      delete_domain,
      request_delete_domain,
@@ -60,6 +62,7 @@ domain_admin_tests() ->
      domain_admin_disable_domain_no_permission,
      domain_admin_enable_domain_no_permission,
      domain_admin_get_domains_by_host_type_no_permission,
+     domain_admin_get_all_domains_no_permission,
      domain_admin_get_domain_details_no_permission,
      domain_admin_delete_domain_no_permission,
      domain_admin_set_domain_password_no_permission,
@@ -94,9 +97,15 @@ end_per_group(domain_admin_tests, _Config) ->
 end_per_group(_GroupName, _Config) ->
     graphql_helper:clean().
 
+init_per_testcase(get_all_domains_with_disabled, Config) ->
+    disable_domain(?EXAMPLE_DOMAIN, Config),
+    escalus:init_per_testcase(get_all_domains_with_disabled, Config);
 init_per_testcase(CaseName, Config) ->
     escalus:init_per_testcase(CaseName, Config).
 
+end_per_testcase(get_all_domains_with_disabled, Config) ->
+    enable_domain(?EXAMPLE_DOMAIN, Config),
+    escalus:end_per_testcase(get_all_domains_with_disabled, Config);
 end_per_testcase(CaseName, Config) ->
     escalus:end_per_testcase(CaseName, Config).
 
@@ -178,6 +187,15 @@ disable_domain(Config) ->
     {ok, Domain} = rpc(mim(), mongoose_domain_sql, select_domain, [?EXAMPLE_DOMAIN]),
     ?assertEqual(#{host_type => ?HOST_TYPE, status => disabled}, Domain).
 
+get_all_domains_with_disabled(Config) ->
+    Result = execute_command(<<"domain">>, <<"allDomains">>, #{}, Config),
+    ParsedResult = get_ok_value([data, domain, allDomains], Result),
+    Expected = [
+        #{<<"domain">> => ?EXAMPLE_DOMAIN, <<"hostType">> => ?HOST_TYPE, <<"status">> => <<"DISABLED">>},
+        #{<<"domain">> => ?SECOND_EXAMPLE_DOMAIN, <<"hostType">> => ?HOST_TYPE, <<"status">> => <<"ENABLED">>}
+    ],
+    lists:foreach(fun(E) -> ?assert(lists:member(E, ParsedResult)) end, Expected).
+
 enable_domain(Config) ->
     Result = enable_domain(?EXAMPLE_DOMAIN, Config),
     ParsedResult = get_ok_value([data, domain, enableDomain], Result),
@@ -189,6 +207,15 @@ get_domains_by_host_type(Config) ->
     ?assertEqual(lists:sort([?EXAMPLE_DOMAIN, ?SECOND_EXAMPLE_DOMAIN]),
                  lists:sort(ParsedResult)).
 
+get_all_domains(Config) ->
+    Result = execute_command(<<"domain">>, <<"allDomains">>, #{}, Config),
+    ParsedResult = get_ok_value([data, domain, allDomains], Result),
+    Expected = [
+        #{<<"domain">> => ?EXAMPLE_DOMAIN, <<"hostType">> => ?HOST_TYPE, <<"status">> => <<"ENABLED">>},
+        #{<<"domain">> => ?SECOND_EXAMPLE_DOMAIN, <<"hostType">> => ?HOST_TYPE, <<"status">> => <<"ENABLED">>}
+    ],
+    lists:foreach(fun(E) -> ?assert(lists:member(E, ParsedResult)) end, Expected).
+
 get_domain_details(Config) ->
     Result = get_domain_details(?EXAMPLE_DOMAIN, Config),
     ParsedResult = get_ok_value([data, domain, domainDetails], Result),
@@ -276,6 +303,9 @@ domain_admin_get_domains_by_host_type_no_permission(Config) ->
     get_unauthorized(get_domains_by_host_type(?HOST_TYPE, Config)),
     get_unauthorized(get_domains_by_host_type(domain_helper:host_type(), Config)).
 
+domain_admin_get_all_domains_no_permission(Config) ->
+    get_unauthorized(execute_command(<<"domain">>, <<"allDomains">>, #{}, Config)).
+
 domain_admin_get_domain_details_no_permission(Config) ->
     get_unauthorized(get_domain_details(?DOMAIN_ADMIN_EXAMPLE_DOMAIN, Config)),
     get_unauthorized(get_domain_details(?EXAMPLE_DOMAIN, Config)).

big_tests/tests/service_domain_db_SUITE.erl

@@ -96,6 +96,7 @@ db_cases() -> [
     db_can_check_domain_password,
     db_cannot_check_password_for_unknown_domain,
     db_deleting_domain_deletes_domain_admin,
+    db_get_all_domains,
     sql_select_from,
     db_could_sync_between_nodes,
     db_gaps_are_getting_filled_automatically
@@ -391,6 +392,22 @@ db_get_all_static(_) ->
      {<<"example.cfg">>, <<"type1">>}] =
         lists:sort(get_all_static(mim())).
 
+db_get_all_domains(_) ->
+    Domain1 = random_domain_name(),
+    Domain2 = random_domain_name(),
+    {ok, _} = insert_domain(mim(), Domain1, <<"type1">>),
+    {ok, _} = insert_domain(mim(), Domain2, <<"type1">>),
+    disable_domain(mim(), Domain1),
+    sync(),
+
+    AllDomains = get_all_domains(mim()),
+
+    %% Verify Domain1 is disabled and Domain2 is enabled
+    [Domain1Map] = [D || D <- AllDomains, maps:get(domain, D) == Domain1],
+    ?assertMatch(#{domain := Domain1, host_type := <<"type1">>, status := disabled}, Domain1Map),
+    [Domain2Map] = [D || D <- AllDomains, maps:get(domain, D) == Domain2],
+    ?assertMatch(#{domain := Domain2, host_type := <<"type1">>, status := enabled}, Domain2Map).
+
 db_get_all_dynamic(_) ->
     Domain1 = random_domain_name(),
     Domain2 = random_domain_name(),
@@ -1147,6 +1164,9 @@ get_all_static(Node) ->
 get_all_dynamic(Node) ->
     rpc(Node, mongoose_domain_api, get_all_dynamic, []).
 
+get_all_domains(Node) ->
+    rpc(Node, mongoose_domain_api, get_all_domains, []).
+
 disable_domain(Node, Domain) ->
     rpc(Node, mongoose_domain_api, disable_domain, [Domain]).
 

priv/graphql/schemas/admin/domain.gql

@@ -2,6 +2,9 @@ type DomainAdminQuery @use(services: ["service_domain_db"]) @protected{
   "Get all enabled domains by hostType. Only for global admin"
   domainsByHostType(hostType: String!): [DomainName!]
     @protected(type: GLOBAL) @use
+  "Get all domains with details. Returns a list of Domain objects. Only for global admin"
+  allDomains: [Domain!]
+    @protected(type: GLOBAL) @use
   "Get information about the domain"
   domainDetails(domain: DomainName!): Domain
     @protected(type: DOMAIN, args: ["domain"]) @use

src/domain/mongoose_domain_api.erl

@@ -22,7 +22,8 @@
 %% domain API
 -export([get_domain_host_type/1,
          get_all_static/0,
-         get_domains_by_host_type/1]).
+         get_domains_by_host_type/1,
+         get_all_domains/0]).
 
 %% domain admin API
 -export([check_domain_password/2]).
@@ -226,6 +227,10 @@ get_all_dynamic() ->
 get_domains_by_host_type(HostType) ->
     mongoose_domain_core:get_domains_by_host_type(HostType).
 
+-spec get_all_domains() -> [domain_info()].
+get_all_domains() ->
+    mongoose_domain_sql:select_all_domains().
+
 -type password() :: binary().
 
 -spec check_domain_password(domain(), password()) -> ok | {error, wrong_password | not_found}.

src/domain/mongoose_domain_sql.erl

@@ -12,6 +12,7 @@
          delete_domain_admin/1]).
 
 -export([select_domain/1,
+         select_all_domains/0,
          get_minmax_event_id/0,
          count_events_between_ids/2,
          get_event_ids_between/2,
@@ -85,6 +86,8 @@ start(_) ->
                    "domain_settings.status = ", Enabled/binary, ") "
               " WHERE domain_events.id >= ? AND domain_events.id <= ? "
               " ORDER BY domain_events.id ">>),
+    prepare(domain_select_all, domain_settings, [],
+            <<"SELECT domain, host_type, status FROM domain_settings order by domain">>),
     %% Admins
     prepare(domain_insert_admin, domain_admins, [domain, pass_details],
             <<"INSERT INTO domain_admins (domain, pass_details) VALUES (?, ?)">>),
@@ -139,6 +142,13 @@ select_domain(Domain) ->
             {ok, row_to_map(Row)}
     end.
 
+select_all_domains() ->
+    Pool = get_db_pool(),
+    {selected, Rows} = execute_successfully(Pool, domain_select_all, []),
+    [#{domain => Domain,
+       host_type => HostType,
+       status => int_to_status(mongoose_rdbms:result_to_integer(Status))} || {Domain, HostType, Status} <- Rows].
+
 delete_domain(Domain, HostType) ->
     transaction(fun(Pool) ->
             case select_domain(Domain) of

src/graphql/admin/mongoose_graphql_domain_admin_query.erl

@@ -17,5 +17,8 @@ execute(_Ctx, admin, <<"domainsByHostType">>, #{<<"hostType">> := HostType}) ->
         Error ->
             format_result(Error, #{hostType => HostType})
     end;
+execute(_Ctx, admin, <<"allDomains">>, _Args) ->
+    Domains = mongoose_domain_api:get_all_domains(),
+    {ok, [ {ok, D} || D <- Domains ]};
 execute(_Ctx, admin, <<"domainDetails">>, #{<<"domain">> := Domain}) ->
     format_result(mongoose_domain_api:get_domain_details(Domain), #{domain => Domain}).