Skip to content

A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.

TypeScript fluxerfluxerapp

refactor(gateway): remove unused assignable role rpcs and tests

Hampus2c5645abbd0c
diff --git a/fluxer_gateway/src/gateway/gateway_rpc_guild_permissions.erl b/fluxer_gateway/src/gateway/gateway_rpc_guild_permissions.erl
index 3ad098bd8..88082c22d 100644
--- a/fluxer_gateway/src/gateway/gateway_rpc_guild_permissions.erl
+++ b/fluxer_gateway/src/gateway/gateway_rpc_guild_permissions.erl
@@ -2,10 +2,6 @@
-module(gateway_rpc_guild_permissions).
--ifdef(TEST).
--include_lib("eunit/include/eunit.hrl").
--endif.
-
-typing([eqwalizer]).
-export([handle/2, get_permissions_cached_or_rpc/3]).
@@ -17,9 +13,7 @@ handle(<<"guild.get_user_permissions">>, P) -> handle_get_user_permissions(P);
handle(<<"guild.get_user_permissions_batch">>, P) -> handle_get_user_permissions_batch(P);
handle(<<"guild.check_permission">>, P) -> handle_check_permission(P);
handle(<<"guild.can_manage_roles">>, P) -> handle_can_manage_roles(P);
-handle(<<"guild.can_manage_role">>, P) -> handle_can_manage_role(P);
-handle(<<"guild.get_assignable_roles">>, P) -> handle_get_assignable_roles(P);
-handle(<<"guild.get_user_max_role_position">>, P) -> handle_get_max_role_position(P).
+handle(<<"guild.can_manage_role">>, P) -> handle_can_manage_role(P).
-spec handle_get_user_permissions(map()) -> map().
handle_get_user_permissions(
@@ -133,54 +127,6 @@ guild_call_can_manage(Pid, Msg) ->
gateway_rpc_error:raise(<<"role_management_check_error">>)
end.
--spec handle_get_assignable_roles(map()) -> term().
-handle_get_assignable_roles(
- #{<<"guild_id">> := GIB, <<"user_id">> := UIB}
-) ->
- GuildId = validation:snowflake_or_throw(<<"guild_id">>, GIB),
- UserId = validation:snowflake_or_throw(<<"user_id">>, UIB),
- do_get_assignable_roles(GuildId, UserId).
-
--spec do_get_assignable_roles(integer(), integer()) -> term().
-do_get_assignable_roles(GuildId, UserId) ->
- gateway_rpc_guild_infra:with_guild(GuildId, fun(Pid) ->
- guild_call_assignable(Pid, UserId)
- end).
-
--spec guild_call_assignable(pid(), integer()) -> map().
-guild_call_assignable(Pid, UserId) ->
- Msg = {get_assignable_roles, #{user_id => UserId}},
- case gen_server:call(Pid, Msg, ?GUILD_CALL_TIMEOUT) of
- #{role_ids := RoleIds} ->
- #{<<"role_ids">> => [integer_to_binary(R) || R <- RoleIds]};
- _ ->
- gateway_rpc_error:raise(<<"assignable_roles_error">>)
- end.
-
--spec handle_get_max_role_position(map()) -> term().
-handle_get_max_role_position(
- #{<<"guild_id">> := GIB, <<"user_id">> := UIB}
-) ->
- GuildId = validation:snowflake_or_throw(<<"guild_id">>, GIB),
- UserId = validation:snowflake_or_throw(<<"user_id">>, UIB),
- do_get_max_role_position(GuildId, UserId).
-
--spec do_get_max_role_position(integer(), integer()) -> term().
-do_get_max_role_position(GuildId, UserId) ->
- gateway_rpc_guild_infra:with_guild(GuildId, fun(Pid) ->
- guild_call_max_pos(Pid, UserId)
- end).
-
--spec guild_call_max_pos(pid(), integer()) -> map().
-guild_call_max_pos(Pid, UserId) ->
- Msg = {get_user_max_role_position, #{user_id => UserId}},
- case gen_server:call(Pid, Msg, ?GUILD_CALL_TIMEOUT) of
- #{position := Pos} ->
- #{<<"position">> => Pos};
- _ ->
- gateway_rpc_error:raise(<<"max_role_position_error">>)
- end.
-
-spec get_permissions_cached_or_rpc(
integer(), integer(), integer() | undefined
) -> {ok, integer()} | {error, guild_not_found} | error.
@@ -202,7 +148,7 @@ get_permissions_via_rpc(GuildId, UserId, ChannelId) ->
{error, guild_not_found}
end.
--spec get_perms_from_guild(integer(), pid(), term()) -> {ok, integer()} | error.
+-spec get_perms_from_guild(integer(), pid(), {atom(), map()}) -> {ok, integer()} | error.
get_perms_from_guild(GuildId, Pid, Msg) ->
case
gateway_rpc_guild_infra:safe_guild_call(
@@ -224,29 +170,3 @@ permission_or_throw(Value) ->
catch
error:{invalid_bitset, _} -> gateway_rpc_error:raise(<<"invalid_params">>)
end.
-
--ifdef(TEST).
-check_permission_unknown_guild_raises_guild_not_found_test() ->
- Payload = #{
- <<"guild_id">> => <<"1">>,
- <<"user_id">> => <<"2">>,
- <<"permission">> => <<"1">>,
- <<"channel_id">> => <<"0">>
- },
- ?assertError(
- {gateway_rpc_error, <<"guild_not_found">>},
- handle(<<"guild.check_permission">>, Payload)
- ).
-
-get_user_permissions_unknown_guild_raises_guild_not_found_test() ->
- Payload = #{
- <<"guild_id">> => <<"1">>,
- <<"user_id">> => <<"2">>,
- <<"channel_id">> => <<"0">>
- },
- ?assertError(
- {gateway_rpc_error, <<"guild_not_found">>},
- handle(<<"guild.get_user_permissions">>, Payload)
- ).
-
--endif.
diff --git a/fluxer_gateway/src/guild/guild_members_common.erl b/fluxer_gateway/src/guild/guild_members_common.erl
index 19ebcef55..4fd275ddb 100644
--- a/fluxer_gateway/src/guild/guild_members_common.erl
+++ b/fluxer_gateway/src/guild/guild_members_common.erl
@@ -5,8 +5,6 @@
-export([
guild_data/1,
- guild_members/1,
- guild_roles/1,
guild_channels/1,
owner_id/1,
member_user_id/1,
@@ -16,11 +14,7 @@
member_can_view_channel/4,
normalize_int_list/1,
unique_preserve/1,
- role_ids_from_roles/1,
- collect_mentions_for_user_ids/5,
- collect_mentions/5,
- build_connected_user_ids/2,
- check_should_mention/3
+ build_connected_user_ids/2
]).
-export_type([guild_state/0, member/0, user_id/0, role_id/0, channel_id/0]).
@@ -34,12 +28,6 @@
-spec guild_data(guild_state()) -> map().
guild_data(State) -> map_utils:ensure_map(map_utils:get_safe(State, data, #{})).
--spec guild_members(guild_state()) -> [member()].
-guild_members(State) -> guild_data_index_members:member_values(guild_data(State)).
-
--spec guild_roles(guild_state()) -> [map()].
-guild_roles(State) -> guild_data_index_roles:role_list(guild_data(State)).
-
-spec guild_channels(guild_state()) -> [map()].
guild_channels(State) -> guild_data_index_channels:channel_list(guild_data(State)).
@@ -95,90 +83,6 @@ unique_value(Value, {Acc, Seen}) ->
false -> {[Value | Acc], Seen#{Value => true}}
end.
--spec role_ids_from_roles([map()]) -> [role_id()].
-role_ids_from_roles(Roles) ->
- lists:filtermap(fun role_id_from_role/1, Roles).
-
--spec role_id_from_role(map()) -> {true, role_id()} | false.
-role_id_from_role(Role) ->
- SafeRole = map_utils:ensure_map(Role),
- case snowflake_id:parse_maybe(maps:get(<<"id">>, SafeRole, undefined)) of
- undefined -> false;
- RoleId -> {true, RoleId}
- end.
-
--spec collect_mentions_for_user_ids(
- [user_id()], user_id(), channel_id(), guild_state(), fun((user_id(), member()) -> boolean())
-) -> [user_id()].
-collect_mentions_for_user_ids(UserIds, AuthorId, ChannelId, State, Predicate) ->
- MemberMap = guild_data_index_members:member_map(guild_data(State)),
- lists:filtermap(
- fun(UserId) ->
- collect_mention_for_user_id(
- UserId, AuthorId, ChannelId, State, Predicate, MemberMap
- )
- end,
- lists:usort(UserIds)
- ).
-
--spec collect_mention_for_user_id(
- user_id(),
- user_id(),
- channel_id(),
- guild_state(),
- fun((user_id(), member()) -> boolean()),
- map()
-) -> {true, user_id()} | false.
-collect_mention_for_user_id(UserId, UserId, _ChannelId, _State, _Predicate, _MemberMap) ->
- false;
-collect_mention_for_user_id(UserId, _AuthorId, ChannelId, State, Predicate, MemberMap) ->
- case maps:get(UserId, MemberMap, undefined) of
- undefined -> false;
- Member -> maybe_collect_user_mention(UserId, Member, ChannelId, State, Predicate)
- end.
-
--spec maybe_collect_user_mention(
- user_id(), member(), channel_id(), guild_state(), fun((user_id(), member()) -> boolean())
-) -> {true, user_id()} | false.
-maybe_collect_user_mention(UserId, Member, ChannelId, State, Predicate) ->
- case
- Predicate(UserId, Member) andalso
- member_can_view_channel(UserId, ChannelId, Member, State)
- of
- true -> {true, UserId};
- false -> false
- end.
-
--spec collect_mentions(
- [member()], user_id(), channel_id(), guild_state(), fun((member()) -> boolean())
-) -> [user_id()].
-collect_mentions(Members, AuthorId, ChannelId, State, Predicate) ->
- lists:filtermap(
- fun(Member) ->
- collect_mention(Member, AuthorId, ChannelId, State, Predicate)
- end,
- Members
- ).
-
--spec collect_mention(
- member(), user_id(), channel_id(), guild_state(), fun((member()) -> boolean())
-) -> {true, user_id()} | false.
-collect_mention(Member, AuthorId, ChannelId, State, Predicate) ->
- case member_user_id(Member) of
- undefined -> false;
- AuthorId -> false;
- UserId -> maybe_collect_member_mention(UserId, Member, ChannelId, State, Predicate)
- end.
-
--spec maybe_collect_member_mention(
- user_id(), member(), channel_id(), guild_state(), fun((member()) -> boolean())
-) -> {true, user_id()} | false.
-maybe_collect_member_mention(UserId, Member, ChannelId, State, Predicate) ->
- case Predicate(Member) andalso member_can_view_channel(UserId, ChannelId, Member, State) of
- true -> {true, UserId};
- false -> false
- end.
-
-spec build_connected_user_ids(boolean(), map()) -> gb_sets:set(user_id()).
build_connected_user_ids(false, _Sessions) ->
gb_sets:empty();
@@ -192,22 +96,6 @@ add_connected_user_id(_SessionId, SessionData, Acc) ->
_ -> Acc
end.
--spec check_should_mention(user_id(), member(), map()) -> boolean().
-check_should_mention(UserId, Member, Context) ->
- #{
- mention_everyone := MentionEveryone,
- mention_here := MentionHere,
- has_role_mentions := HasRoleMentions,
- has_direct_mentions := HasDirectMentions,
- role_id_set := RoleIdSet,
- direct_user_id_set := DirectUserIdSet,
- connected_user_ids := ConnectedUserIds
- } = Context,
- MentionEveryone orelse
- (MentionHere andalso gb_sets:is_member(UserId, ConnectedUserIds)) orelse
- (HasRoleMentions andalso member_has_any_role_set(Member, RoleIdSet)) orelse
- (HasDirectMentions andalso gb_sets:is_member(UserId, DirectUserIdSet)).
-
-spec truthy(term()) -> boolean().
truthy(true) -> true;
truthy(_) -> false.
diff --git a/fluxer_gateway/src/guild/guild_members_roles.erl b/fluxer_gateway/src/guild/guild_members_roles.erl
index 635a56574..80ffe4969 100644
--- a/fluxer_gateway/src/guild/guild_members_roles.erl
+++ b/fluxer_gateway/src/guild/guild_members_roles.erl
@@ -6,7 +6,6 @@
-export([
can_manage_roles/2,
can_manage_role/2,
- get_assignable_roles/2,
check_target_member/2,
user_ids_for_any_role/2
]).
@@ -70,36 +69,6 @@ can_manage_role(#{user_id := UserId, role_id := RoleId}, State) ->
end,
{reply, #{can_manage => Reply}, State}.
--spec get_assignable_roles(map(), guild_state()) -> guild_reply(map()).
-get_assignable_roles(#{user_id := UserId}, State) ->
- Roles = guild_members_common:guild_roles(State),
- OwnerId = guild_members_common:owner_id(State),
- RoleIds =
- case UserId =:= OwnerId of
- true ->
- guild_members_common:role_ids_from_roles(Roles);
- false ->
- UserRoleRank = get_member_role_rank(UserId, State),
- assignable_role_ids(Roles, UserRoleRank)
- end,
- {reply, #{role_ids => RoleIds}, State}.
-
--spec assignable_role_ids([role()], {integer(), integer()}) -> [role_id()].
-assignable_role_ids(Roles, UserRoleRank) ->
- lists:filtermap(
- fun(Role) ->
- assignable_role_id(Role, UserRoleRank)
- end,
- Roles
- ).
-
--spec assignable_role_id(role(), {integer(), integer()}) -> {true, role_id()} | false.
-assignable_role_id(Role, UserRoleRank) ->
- case {role_rank(Role) < UserRoleRank, role_id(Role)} of
- {true, Id} when is_integer(Id) -> {true, Id};
- _ -> false
- end.
-
-spec check_target_member(map(), guild_state()) -> guild_reply(map()).
check_target_member(#{user_id := UserId, target_user_id := TargetUserId}, State) ->
OwnerId = guild_members_common:owner_id(State),
diff --git a/fluxer_gateway/src/guild/guild_query_handler.erl b/fluxer_gateway/src/guild/guild_query_handler.erl
index 1c6713e02..249140996 100644
--- a/fluxer_gateway/src/guild/guild_query_handler.erl
+++ b/fluxer_gateway/src/guild/guild_query_handler.erl
@@ -69,7 +69,10 @@ waited_longer_than(Ms) ->
-spec inferred_deadlines_enabled() -> boolean().
inferred_deadlines_enabled() ->
- application:get_env(fluxer_gateway, guild_query_inferred_deadlines, true) =/= false.
+ case application:get_env(fluxer_gateway, guild_query_inferred_deadlines, true) of
+ false -> false;
+ _ -> true
+ end.
-spec caller_timeout_ms(term()) -> pos_integer() | undefined.
caller_timeout_ms(get_large_guild_metadata) -> 200;
@@ -87,8 +90,6 @@ rpc_caller_timeout_ms(resolve_mention_sources_page) -> 4000;
rpc_caller_timeout_ms(get_user_permissions) -> 4000;
rpc_caller_timeout_ms(can_manage_roles) -> 4000;
rpc_caller_timeout_ms(can_manage_role) -> 4000;
-rpc_caller_timeout_ms(get_assignable_roles) -> 4000;
-rpc_caller_timeout_ms(get_user_max_role_position) -> 4000;
rpc_caller_timeout_ms(get_guild_data) -> 4000;
rpc_caller_timeout_ms(get_guild_auth_context) -> 4000;
rpc_caller_timeout_ms(get_guild_member) -> 4000;
@@ -273,11 +274,15 @@ bounded_member_query(_Tag, _Request) ->
-spec direct_mentions_only(map()) -> boolean().
direct_mentions_only(Request) ->
- maps:get(mention_everyone, Request, undefined) =:= false andalso
- maps:get(mention_here, Request, undefined) =:= false andalso
+ is_false(maps:get(mention_everyone, Request, undefined)) andalso
+ is_false(maps:get(mention_here, Request, undefined)) andalso
maps:get(role_ids, Request, undefined) =:= [] andalso
few_ids(maps:get(user_ids, Request, undefined)).
+-spec is_false(term()) -> boolean().
+is_false(false) -> true;
+is_false(_) -> false.
+
-spec few_ids(term()) -> boolean().
few_ids(Ids) when is_list(Ids) ->
length(Ids) =< ?INLINE_MEMBER_QUERY_MAX_IDS;
@@ -350,20 +355,11 @@ handle_call_sync({can_manage_roles, Req}, State) ->
guild_members_roles:can_manage_roles(request_map(Req), State);
handle_call_sync({can_manage_role, Req}, State) ->
guild_members_roles:can_manage_role(request_map(Req), State);
-handle_call_sync({get_assignable_roles, Req}, State) ->
- guild_members_roles:get_assignable_roles(request_map(Req), State);
-handle_call_sync({get_user_max_role_position, Req}, State) ->
- handle_max_role_position(request_map(Req), State);
handle_call_sync({check_target_member, Req}, State) ->
guild_members_roles:check_target_member(request_map(Req), State);
handle_call_sync(Msg, State) ->
handle_call_data(Msg, State).
--spec handle_max_role_position(map(), guild_state()) -> {reply, map(), guild_state()}.
-handle_max_role_position(#{user_id := UserId}, State) ->
- Position = guild_permissions_check:get_max_role_position(UserId, State),
- {reply, #{position => Position}, State}.
-
-spec handle_call_data(term(), guild_state()) -> {reply, term(), guild_state()}.
handle_call_data({get_guild_data, Req}, State) ->
guild_data:get_guild_data(request_map(Req), State);
@@ -450,7 +446,7 @@ spawn_async_reply(From, ReplyFun) ->
send_async_reply(From, ReplyFun) ->
gen_server:reply(From, safe_reply(ReplyFun)).
--spec safe_reply(fun(() -> term())) -> term().
+-spec safe_reply(fun(() -> Reply)) -> Reply | #{error := async_handler_failed}.
safe_reply(ReplyFun) ->
try
ReplyFun()
@@ -463,22 +459,6 @@ safe_reply(ReplyFun) ->
build_query_snapshot(State) ->
maps:with([id, data, sessions, virtual_channel_access], State).
--spec maybe_put_guild_count_cache(guild_state(), non_neg_integer(), non_neg_integer()) -> ok.
-maybe_put_guild_count_cache(State, MemberCount, OnlineCount) ->
- case
- {
- maps:get(disable_guild_count_cache_updates, State, false),
- maps:get(id, State, undefined)
- }
- of
- {true, _} ->
- ok;
- {false, GuildId} when is_integer(GuildId) ->
- guild_counts_cache:update(GuildId, MemberCount, OnlineCount);
- _ ->
- ok
- end.
-
-spec owner_id(guild_state()) -> user_id() | undefined.
owner_id(State) ->
case resolve_data_map(State) of
@@ -505,88 +485,3 @@ resolve_data_payload(#{<<"members">> := _} = State) ->
State;
resolve_data_payload(_State) ->
undefined.
-
--ifdef(TEST).
--include_lib("eunit/include/eunit.hrl").
-
-monotonic_deadline_ignores_the_legacy_wall_clock_test() ->
- From = {self(), make_ref()},
- Now = erlang:monotonic_time(millisecond),
- ?assertNot(
- is_expired({get_data, #{deadline => 0, deadline_monotonic => Now + 5000}}, From)
- ),
- ?assert(
- is_expired(
- {get_data, #{deadline => 9999999999999, deadline_monotonic => Now - 1}}, From
- )
- ),
- ?assertNot(is_expired({get_data, #{deadline => 0}}, From)).
-
-expired_forum_unread_scope_is_shed_test() ->
- From = {self(), make_ref()},
- State = #{id => 1},
- Request = #{
- channel_id => 2,
- thread_ids => [3],
- deadline_monotonic => erlang:monotonic_time(millisecond) - 1
- },
- ?assertEqual({noreply, State}, handle_call({get_forum_unread_scope, Request}, From, State)).
-
-deadline_less_queries_expire_once_every_known_caller_has_given_up_test() ->
- Self = self(),
- Ref = make_ref(),
- spawn(fun() ->
- From = {Self, make_ref()},
- self() ! queued_request,
- ok = guild_mailbox_age:note(),
- Fresh = is_expired({get_large_guild_metadata}, From),
- timer:sleep(1300),
- Future = erlang:monotonic_time(millisecond) + 5000,
- Results = #{
- fresh => Fresh,
- metadata => is_expired({get_large_guild_metadata}, From),
- counts => is_expired({get_user_counts, 1}, From),
- forum_unreads => is_expired({get_forum_unread_scope, #{}}, From),
- unknown_tag => is_expired({get_sessions}, From),
- explicit_deadline =>
- is_expired({get_large_guild_metadata, #{deadline_monotonic => Future}}, From)
- },
- ok = application:set_env(fluxer_gateway, guild_query_inferred_deadlines, false),
- Disabled = is_expired({get_large_guild_metadata}, From),
- ok = application:unset_env(fluxer_gateway, guild_query_inferred_deadlines),
- Self ! {Ref, Results#{disabled => Disabled}}
- end),
- Results =
- receive
- {Ref, R} -> R
- after 5000 -> error(timeout)
- end,
- ?assertEqual(
- #{
- fresh => false,
- metadata => true,
- counts => false,
- forum_unreads => false,
- unknown_tag => false,
- explicit_deadline => false,
- disabled => false
- },
- Results
- ).
-
-call_keeps_the_legacy_deadline_and_adds_a_monotonic_deadline_test() ->
- Guild = spawn(fun() ->
- receive
- {'$gen_call', From, {get_data, Request}} -> gen_server:reply(From, Request)
- end
- end),
- WallBefore = os:system_time(millisecond),
- MonotonicBefore = erlang:monotonic_time(millisecond),
- #{deadline := WallDeadline, deadline_monotonic := MonotonicDeadline} =
- call(Guild, {get_data, #{}}, 2000),
- ?assert(WallDeadline >= WallBefore + 2000),
- ?assert(WallDeadline =< os:system_time(millisecond) + 2000),
- ?assert(MonotonicDeadline >= MonotonicBefore + 2000),
- ?assert(MonotonicDeadline =< erlang:monotonic_time(millisecond) + 2000).
-
--endif.