Skip to content

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

TypeScript fluxerfluxerapp

refactor(gateway): flatten thread store/permissions, drop tests

Hampusfa65deacac7f
diff --git a/fluxer_gateway/src/guild/guild_thread_permissions.erl b/fluxer_gateway/src/guild/guild_thread_permissions.erl
index 3cd1392f3..04f41294e 100644
--- a/fluxer_gateway/src/guild/guild_thread_permissions.erl
+++ b/fluxer_gateway/src/guild/guild_thread_permissions.erl
@@ -17,6 +17,8 @@
-type permission() :: non_neg_integer().
-type guild_state() :: map().
+-export_type([permission/0, guild_state/0]).
+
-spec resolve(integer(), map(), map() | undefined, guild_state()) -> permission().
resolve(UserId, Thread, Member, State) ->
case parent_channel(Thread, State) of
@@ -24,14 +26,17 @@ resolve(UserId, Thread, Member, State) ->
note_unknown_parent(),
0;
ParentId ->
- ParentPerms = guild_permissions:compute_member_permissions(
- UserId, ParentId, Member, State
- ),
- Perms = alias_permissions(ParentPerms),
- case can_view_thread_from_parent(UserId, Thread, Perms, Member, State) of
- true -> Perms;
- false -> Perms band bnot constants:view_channel_permission()
- end
+ parent_permissions(UserId, ParentId, Thread, Member, State)
+ end.
+
+-spec parent_permissions(integer(), integer(), map(), map() | undefined, guild_state()) ->
+ permission().
+parent_permissions(UserId, ParentId, Thread, Member, State) ->
+ ParentPerms = guild_permissions:compute_member_permissions(UserId, ParentId, Member, State),
+ Perms = alias_permissions(ParentPerms),
+ case can_view_thread_from_parent(UserId, Thread, Perms, Member, State) of
+ true -> Perms;
+ false -> Perms band bnot constants:view_channel_permission()
end.
-spec alias_permissions(permission()) -> permission().
@@ -72,14 +77,18 @@ parent_id(Thread) ->
parent_channel(Thread, State) ->
case parent_id(Thread) of
ParentId when is_integer(ParentId) ->
- case guild_permissions_check:find_channel_by_id(ParentId, State) of
- undefined -> undefined;
- _Channel -> ParentId
- end;
+ existing_channel(ParentId, State);
_ ->
undefined
end.
+-spec existing_channel(integer(), guild_state()) -> integer() | undefined.
+existing_channel(ChannelId, State) ->
+ case guild_permissions_check:find_channel_by_id(ChannelId, State) of
+ undefined -> undefined;
+ _Channel -> ChannelId
+ end.
+
-spec is_thread_member(integer(), map(), guild_state()) -> boolean().
is_thread_member(UserId, Thread, State) ->
case
@@ -89,14 +98,19 @@ is_thread_member(UserId, Thread, State) ->
}
of
{Tab, ThreadId} when Tab =/= undefined, is_integer(ThreadId) ->
- case guild_thread_store:get_thread(Tab, ThreadId) of
- undefined -> listed_member(UserId, Thread);
- _ -> guild_thread_store:is_member(Tab, ThreadId, UserId)
- end;
+ stored_or_listed_member(Tab, ThreadId, UserId, Thread);
_ ->
listed_member(UserId, Thread)
end.
+-spec stored_or_listed_member(guild_thread_store:tab(), integer(), integer(), map()) ->
+ boolean().
+stored_or_listed_member(Tab, ThreadId, UserId, Thread) ->
+ case guild_thread_store:get_thread(Tab, ThreadId) of
+ undefined -> listed_member(UserId, Thread);
+ _ -> guild_thread_store:is_member(Tab, ThreadId, UserId)
+ end.
+
-spec listed_member(integer(), map()) -> boolean().
listed_member(UserId, Thread) ->
lists:member(
@@ -127,83 +141,3 @@ unknown_parent_count() ->
undefined -> 0;
Counter -> counters:get(Counter, 1)
end.
-
--ifdef(TEST).
--include_lib("eunit/include/eunit.hrl").
-
-alias_maps_send_messages_to_threads_bit_test() ->
- InThreads = constants:send_messages_in_threads_permission(),
- ?assertEqual(InThreads bor ?SEND_MESSAGES, alias_permissions(InThreads)),
- ?assertEqual(1024, alias_permissions(1024 bor ?SEND_MESSAGES)),
- ?assertEqual(?ALL_PERMISSIONS, alias_permissions(?ALL_PERMISSIONS)).
-
-moderator_rules_test() ->
- Manage = constants:manage_threads_permission(),
- ?assert(is_moderator(Manage, #{})),
- ?assert(is_moderator(constants:administrator_permission(), #{})),
- ?assertNot(is_moderator(1024, #{})),
- ?assertNot(
- is_moderator(Manage, #{<<"communication_disabled_until">> => <<"2999-01-01T00:00:00Z">>})
- ),
- ?assert(
- is_moderator(Manage, #{<<"communication_disabled_until">> => <<"2000-01-01T00:00:00Z">>})
- ).
-
-shared_case_table_test() ->
- {ok, Contents} = file:read_file("../packages/constants/src/ThreadPermissionCases.json"),
- Cases = [
- Case
- || #{<<"fn">> := Fn} = Case <- json:decode(Contents),
- Fn =:= <<"isThreadModerator">> orelse Fn =:= <<"canViewThread">>
- ],
- ?assertEqual(16, length(Cases)),
- lists:foreach(fun run_case/1, Cases).
-
-run_case(
- #{<<"name">> := Name, <<"fn">> := Fn, <<"actor">> := Actor, <<"expect">> := Expect} = Case
-) ->
- Perms = case_perms(Actor),
- Member = case_member(Actor),
- Thread = case_thread(Actor, maps:get(<<"thread">>, Case, #{})),
- Actual =
- case Fn of
- <<"isThreadModerator">> -> is_moderator(Perms, Member);
- <<"canViewThread">> -> can_view_thread_from_parent(1, Thread, Perms, Member, #{})
- end,
- ?assertEqual({Name, case_expect(Expect)}, {Name, Actual}).
-
-case_perms(#{<<"isOwner">> := true}) ->
- ?ALL_PERMISSIONS;
-case_perms(#{<<"perms">> := Names}) ->
- case lists:member(<<"ADMINISTRATOR">>, Names) of
- true -> ?ALL_PERMISSIONS;
- false -> lists:foldl(fun(N, Acc) -> Acc bor case_bit(N) end, 0, Names)
- end.
-
-case_bit(<<"VIEW_CHANNEL">>) -> constants:view_channel_permission();
-case_bit(<<"READ_MESSAGE_HISTORY">>) -> 65536;
-case_bit(<<"MANAGE_THREADS">>) -> constants:manage_threads_permission();
-case_bit(<<"SEND_MESSAGES_IN_THREADS">>) -> constants:send_messages_in_threads_permission().
-
-case_member(#{<<"timedOut">> := true}) ->
- #{<<"communication_disabled_until">> => <<"2999-01-01T00:00:00Z">>};
-case_member(_) ->
- #{}.
-
-case_thread(Actor, Thread) ->
- MemberIds =
- case maps:get(<<"isMember">>, Actor, false) of
- true -> [<<"1">>];
- false -> []
- end,
- #{
- <<"id">> => <<"2">>,
- <<"type">> => maps:get(<<"type">>, Thread, 11),
- <<"_fluxer_member_ids">> => MemberIds
- }.
-
-case_expect(Bool) when is_boolean(Bool) -> Bool;
-case_expect(null) -> true;
-case_expect(<<"MISSING_ACCESS">>) -> false.
-
--endif.
diff --git a/fluxer_gateway/src/guild/guild_thread_store.erl b/fluxer_gateway/src/guild/guild_thread_store.erl
index a3e451b2a..178044b30 100644
--- a/fluxer_gateway/src/guild/guild_thread_store.erl
+++ b/fluxer_gateway/src/guild/guild_thread_store.erl
@@ -23,7 +23,6 @@
user_thread_ids/2,
parent_thread_ids/2,
threads/1,
- thread_count/1,
total_threads/0,
row_count/1,
remove_user/2,
@@ -31,7 +30,7 @@
import/1
]).
--export_type([tab/0, thread_id/0, user_id/0]).
+-export_type([tab/0, thread_id/0, user_id/0, row/0]).
-define(REGISTRY, guild_thread_store_registry).
-define(RETIRE_DELAY_MS, 60000).
@@ -123,10 +122,10 @@ put_member_row(Tab, Member) ->
}
of
{ThreadId, UserId} when is_integer(ThreadId), is_integer(UserId) ->
- case ets:member(Tab, {t, ThreadId}) of
- true -> put_member(Tab, ThreadId, UserId, Member);
- false -> ok
- end;
+ _ =
+ ets:member(Tab, {t, ThreadId}) andalso
+ put_member(Tab, ThreadId, UserId, Member),
+ ok;
_ ->
ok
end.
@@ -142,22 +141,26 @@ put_thread(Tab, Thread) ->
insert_thread(Tab, Thread) ->
case snowflake_id:parse_optional(maps:get(<<"id">>, Thread, undefined)) of
ThreadId when is_integer(ThreadId) ->
- Known = ets:member(Tab, {t, ThreadId}),
- true = ets:insert(Tab, {{t, ThreadId}, Thread}),
- case snowflake_id:parse_optional(maps:get(<<"parent_id">>, Thread, undefined)) of
- ParentId when is_integer(ParentId) ->
- true = ets:insert(Tab, {{p, ParentId, ThreadId}, true});
- _ ->
- true
- end,
- case Known of
- true -> known;
- false -> new
- end;
+ store_thread(Tab, ThreadId, Thread);
_ ->
invalid
end.
+-spec store_thread(tab(), thread_id(), map()) -> new | known.
+store_thread(Tab, ThreadId, Thread) ->
+ Known = ets:member(Tab, {t, ThreadId}),
+ true = ets:insert(Tab, {{t, ThreadId}, Thread}),
+ case snowflake_id:parse_optional(maps:get(<<"parent_id">>, Thread, undefined)) of
+ ParentId when is_integer(ParentId) ->
+ true = ets:insert(Tab, {{p, ParentId, ThreadId}, true});
+ _ ->
+ true
+ end,
+ case Known of
+ true -> known;
+ false -> new
+ end.
+
-spec enforce_cap(tab()) -> ok.
enforce_cap(Tab) ->
case row_count(Tab) > ?MAX_THREADS of
@@ -171,11 +174,15 @@ trim(_Tab, Excess) when Excess =< 0 ->
trim(Tab, Excess) ->
case ets:select(Tab, [{{{t, '$1'}, '_'}, [], ['$1']}], Excess) of
{Oldest, _Continuation} ->
- lists:foreach(fun(ThreadId) -> remove_thread(Tab, ThreadId) end, Oldest);
+ remove_threads(Tab, Oldest);
'$end_of_table' ->
ok
end.
+-spec remove_threads(tab(), [thread_id()]) -> ok.
+remove_threads(Tab, ThreadIds) ->
+ lists:foreach(fun(ThreadId) -> remove_thread(Tab, ThreadId) end, ThreadIds).
+
-spec get_thread(tab(), thread_id()) -> map() | undefined.
get_thread(Tab, ThreadId) ->
case ets:lookup(Tab, {t, ThreadId}) of
@@ -189,18 +196,21 @@ remove_thread(Tab, ThreadId) ->
undefined ->
ok;
Thread ->
- lists:foreach(
- fun(UserId) -> remove_member(Tab, ThreadId, UserId) end,
- member_ids(Tab, ThreadId)
- ),
- case snowflake_id:parse_optional(maps:get(<<"parent_id">>, Thread, undefined)) of
- ParentId when is_integer(ParentId) -> ets:delete(Tab, {p, ParentId, ThreadId});
- _ -> true
- end,
- true = ets:delete(Tab, {t, ThreadId}),
- ok
+ remove_stored_thread(Tab, ThreadId, Thread)
end.
+-spec remove_stored_thread(tab(), thread_id(), map()) -> ok.
+remove_stored_thread(Tab, ThreadId, Thread) ->
+ lists:foreach(
+ fun(UserId) -> remove_member(Tab, ThreadId, UserId) end, member_ids(Tab, ThreadId)
+ ),
+ case snowflake_id:parse_optional(maps:get(<<"parent_id">>, Thread, undefined)) of
+ ParentId when is_integer(ParentId) -> ets:delete(Tab, {p, ParentId, ThreadId});
+ _ -> true
+ end,
+ true = ets:delete(Tab, {t, ThreadId}),
+ ok.
+
-spec put_member(tab(), thread_id(), user_id(), map()) -> ok.
put_member(Tab, ThreadId, UserId, Member) ->
true = ets:insert(Tab, [{{m, ThreadId, UserId}, Member}, {{u, UserId, ThreadId}, true}]),
@@ -269,10 +279,14 @@ live_thread_count(Tab) ->
thread_count(Tab)
catch
error:badarg ->
- ok = registry(fun() -> ets:delete(?REGISTRY, Tab) end),
+ ok = unregister_table(Tab),
0
end.
+-spec unregister_table(tab()) -> ok.
+unregister_table(Tab) ->
+ registry(fun() -> ets:delete(?REGISTRY, Tab) end).
+
-spec row_count(tab()) -> non_neg_integer().
row_count(Tab) ->
case ets:info(Tab, size) of
@@ -293,7 +307,7 @@ export(Tab) ->
-spec import([term()]) -> tab().
import(Rows) ->
Tab = new(),
- true = ets:insert(Tab, [Row || Row <- Rows, is_valid_row(Row)]),
+ true = ets:insert(Tab, [Row || Row = {_, _} <- Rows, is_valid_row(Row)]),
Tab.
-spec is_valid_row(term()) -> boolean().
@@ -302,129 +316,3 @@ is_valid_row({{m, T, U}, Member}) when is_integer(T), is_integer(U), is_map(Memb
is_valid_row({{u, U, T}, true}) when is_integer(T), is_integer(U) -> true;
is_valid_row({{p, P, T}, true}) when is_integer(T), is_integer(P) -> true;
is_valid_row(_) -> false.
-
--ifdef(TEST).
--include_lib("eunit/include/eunit.hrl").
-
-thread(Id, Parent) ->
- #{<<"id">> => Id, <<"parent_id">> => Parent, <<"type">> => 11}.
-
-member(Thread, User) ->
- #{<<"id">> => integer_to_binary(Thread), <<"user_id">> => integer_to_binary(User)}.
-
-store_round_trip_test() ->
- Tab = new(),
- try
- ok = load(Tab, [thread(10, 1), thread(11, 1), thread(20, 2)], [
- member(10, 100), member(10, 101), member(20, 100), member(99, 100)
- ]),
- ?assertEqual(3, thread_count(Tab)),
- ?assertEqual([100, 101], member_ids(Tab, 10)),
- ?assertEqual([10, 20], user_thread_ids(Tab, 100)),
- ?assertEqual([10, 11], parent_thread_ids(Tab, 1)),
- ?assert(is_member(Tab, 20, 100)),
- ?assertNot(is_member(Tab, 99, 100)),
- ok = remove_thread(Tab, 10),
- ?assertEqual(undefined, get_thread(Tab, 10)),
- ?assertEqual([20], user_thread_ids(Tab, 100)),
- ?assertEqual([], user_thread_ids(Tab, 101)),
- ?assertEqual([11], parent_thread_ids(Tab, 1)),
- ?assertEqual([20], remove_user(Tab, 100)),
- ?assertEqual([], member_ids(Tab, 20))
- after
- destroy(Tab)
- end.
-
-export_import_test() ->
- Tab = new(),
- ok = load(Tab, [thread(10, 1)], [member(10, 5)]),
- Rows = export(Tab),
- destroy(Tab),
- Tab2 = import([junk | Rows]),
- try
- ?assertEqual(length(Rows), row_count(Tab2)),
- ?assert(is_member(Tab2, 10, 5)),
- ?assertEqual([10], parent_thread_ids(Tab2, 1))
- after
- destroy(Tab2)
- end.
-
-total_threads_counts_registered_stores_only_test() ->
- ok = init(),
- Before = total_threads(),
- Tab = new(),
- ok = load(Tab, [thread(10, 1), thread(11, 1)], []),
- ?assertEqual(Before + 2, total_threads()),
- Owner = spawn(fun() ->
- Orphan = new(),
- ok = load(Orphan, [thread(12, 1)], []),
- receive
- stop -> ok
- end
- end),
- wait_for_total(Before + 3),
- Owner ! stop,
- wait_for_total(Before + 2),
- destroy(Tab),
- ?assertEqual(Before, total_threads()).
-
-wait_for_total(Expected) ->
- wait_for_total(Expected, 50).
-
-wait_for_total(Expected, 0) ->
- ?assertEqual(Expected, total_threads());
-wait_for_total(Expected, Attempts) ->
- case total_threads() of
- Expected ->
- ok;
- _ ->
- timer:sleep(10),
- wait_for_total(Expected, Attempts - 1)
- end.
-
-retire_unregisters_at_once_and_schedules_destroy_test() ->
- ok = init(),
- Tab = new(),
- ok = load(Tab, [thread(20, 1)], []),
- Before = total_threads(),
- ok = retire(Tab),
- ?assertEqual(Before - 1, total_threads()),
- ?assertNotEqual(undefined, ets:info(Tab)),
- destroy(Tab).
-
-cap_keeps_newest_threads_test() ->
- Tab = new(),
- try
- ok = load(Tab, [thread(Id, 1) || Id <- lists:seq(10, ?MAX_THREADS + 9)], [
- member(10, 7), member(11, 7)
- ]),
- ?assertEqual(?MAX_THREADS, thread_count(Tab)),
- ok = put_thread(Tab, thread(10, 1)),
- ?assertEqual(?MAX_THREADS, thread_count(Tab)),
- ok = put_thread(Tab, thread(?MAX_THREADS + 10, 1)),
- ?assertEqual(?MAX_THREADS, thread_count(Tab)),
- ?assertEqual(undefined, get_thread(Tab, 10)),
- ?assertEqual([11], user_thread_ids(Tab, 7)),
- ?assertNot(lists:member(10, parent_thread_ids(Tab, 1))),
- ok = put_thread(Tab, thread(5, 1)),
- ?assertEqual(undefined, get_thread(Tab, 5)),
- ?assertEqual(?MAX_THREADS, thread_count(Tab)),
- ?assertNotEqual(undefined, get_thread(Tab, ?MAX_THREADS + 10))
- after
- destroy(Tab)
- end.
-
-load_over_cap_keeps_newest_ids_test() ->
- Tab = new(),
- try
- Ids = lists:seq(?MAX_THREADS + 10, 1, -1),
- ok = load(Tab, [thread(Id, 1) || Id <- Ids], [member(5, 9), member(20, 9)]),
- ?assertEqual(?MAX_THREADS, thread_count(Tab)),
- ?assertEqual(undefined, get_thread(Tab, 10)),
- ?assertNotEqual(undefined, get_thread(Tab, 11)),
- ?assertEqual([20], user_thread_ids(Tab, 9))
- after
- destroy(Tab)
- end.
-
--endif.