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 member list engine, drop inline tests

Hampusbd433135b399
diff --git a/fluxer_gateway/src/guild/guild_mailbox_age.erl b/fluxer_gateway/src/guild/guild_mailbox_age.erl
index 8b555dbd8..11ec4b409 100644
--- a/fluxer_gateway/src/guild/guild_mailbox_age.erl
+++ b/fluxer_gateway/src/guild/guild_mailbox_age.erl
@@ -4,6 +4,7 @@
-typing([eqwalizer]).
-export([note/0, handle_mark/1, min_age_ms/0]).
+-export_type([seq/0]).
-define(KEY, {?MODULE, marks}).
-define(MARK_INTERVAL_MS, 50).
@@ -66,103 +67,3 @@ marks() ->
put_marks(Marks) ->
_ = erlang:put(?KEY, Marks),
ok.
-
--ifdef(TEST).
--include_lib("eunit/include/eunit.hrl").
-
-in_fresh_process(Fun) ->
- Self = self(),
- Ref = make_ref(),
- {Pid, MRef} = spawn_monitor(fun() -> Self ! {Ref, Fun()} end),
- receive
- {Ref, Result} ->
- erlang:demonitor(MRef, [flush]),
- Result;
- {'DOWN', MRef, process, Pid, Reason} ->
- erlang:error(Reason)
- after 5000 ->
- erlang:error(timeout)
- end.
-
-next_mark() ->
- receive
- {?MODULE, Seq} -> Seq
- after 0 -> none
- end.
-
-no_age_without_a_backlog_test() ->
- ?assertEqual(
- {undefined, none},
- in_fresh_process(fun() ->
- ok = note(),
- {min_age_ms(), next_mark()}
- end)
- ).
-
-a_message_queued_before_a_mark_is_at_least_as_old_as_the_mark_test() ->
- {Age, Seq} = in_fresh_process(fun() ->
- self() ! queued_request,
- ok = note(),
- timer:sleep(120),
- receive
- queued_request -> ok
- end,
- {min_age_ms(), next_mark()}
- end),
- ?assertEqual(0, Seq),
- ?assert(Age >= 119),
- ?assert(Age =< 1000).
-
-handled_marks_stop_bounding_later_messages_test() ->
- ?assertEqual(
- undefined,
- in_fresh_process(fun() ->
- self() ! queued_request,
- ok = note(),
- receive
- queued_request -> ok
- end,
- ok = handle_mark(next_mark()),
- min_age_ms()
- end)
- ).
-
-marks_are_rate_limited_while_busy_test() ->
- Seqs = in_fresh_process(fun() ->
- self() ! queued_request,
- ok = note(),
- ok = note(),
- timer:sleep(60),
- ok = note(),
- [next_mark(), next_mark(), next_mark()]
- end),
- ?assertEqual([0, 1, none], Seqs).
-
-the_oldest_unhandled_mark_bounds_the_age_test() ->
- {Age, Seqs} = in_fresh_process(fun() ->
- self() ! queued_request,
- ok = note(),
- timer:sleep(200),
- ok = note(),
- receive
- queued_request -> ok
- end,
- First = next_mark(),
- Second = next_mark(),
- {min_age_ms(), [First, Second]}
- end),
- ?assertEqual([0, 1], Seqs),
- ?assert(Age >= 199).
-
-a_forged_mark_only_loosens_the_bound_test() ->
- ?assertEqual(
- undefined,
- in_fresh_process(fun() ->
- self() ! queued_request,
- ok = note(),
- ok = handle_mark(1000),
- min_age_ms()
- end)
- ).
-
--endif.
diff --git a/fluxer_gateway/src/guild/guild_member_list_channel_engine.erl b/fluxer_gateway/src/guild/guild_member_list_channel_engine.erl
index 44965cfa2..9f6b24cd7 100644
--- a/fluxer_gateway/src/guild/guild_member_list_channel_engine.erl
+++ b/fluxer_gateway/src/guild/guild_member_list_channel_engine.erl
@@ -337,18 +337,24 @@ new_visibility_memo(ChannelId, Data, State) ->
memoised_can_view(UserId, ChannelId, Member, _SortedRoleIds, State, disabled) ->
{can_view(UserId, ChannelId, Member, State), disabled};
memoised_can_view(UserId, ChannelId, Member, SortedRoleIds, State, Memo) ->
- #{exceptions := Exceptions, cache := Cache} = Memo,
+ #{exceptions := Exceptions} = Memo,
case sets:is_element(UserId, Exceptions) of
true ->
{can_view(UserId, ChannelId, Member, State), Memo};
false ->
- case maps:find(SortedRoleIds, Cache) of
- {ok, Visible} ->
- {Visible, Memo};
- error ->
- Visible = can_view(UserId, ChannelId, Member, State),
- {Visible, Memo#{cache := Cache#{SortedRoleIds => Visible}}}
- end
+ cached_can_view(UserId, ChannelId, Member, SortedRoleIds, State, Memo)
+ end.
+
+-spec cached_can_view(
+ integer(), pos_integer(), map(), [integer()], guild_state(), visibility_memo()
+) -> {boolean(), visibility_memo()}.
+cached_can_view(UserId, ChannelId, Member, SortedRoleIds, State, #{cache := Cache} = Memo) ->
+ case maps:find(SortedRoleIds, Cache) of
+ {ok, Visible} ->
+ {Visible, Memo};
+ error ->
+ Visible = can_view(UserId, ChannelId, Member, State),
+ {Visible, Memo#{cache := Cache#{SortedRoleIds => Visible}}}
end.
%% Category visibility recurses into child channels, each with its own
@@ -388,7 +394,7 @@ channel_overwrite_target_ids(ChannelId, Data) ->
case maps:get(ChannelId, guild_data_index_channels:channel_index(Data), undefined) of
Channel when is_map(Channel) ->
lists:filtermap(
- fun(Overwrite) -> overwrite_target_id(Overwrite) end,
+ fun overwrite_target_id/1,
map_utils:ensure_list(maps:get(<<"permission_overwrites">>, Channel, []))
);
_ ->
@@ -465,70 +471,3 @@ channel_id(ListId) ->
-spec guild_id(guild_state()) -> integer() | undefined.
guild_id(State) ->
snowflake_id:parse_maybe(maps:get(id, State, undefined)).
-
--ifdef(TEST).
--include_lib("eunit/include/eunit.hrl").
-
-memo_channel_state() ->
- #{
- data => #{
- <<"guild">> => #{<<"features">> => [], <<"owner_id">> => <<"7">>},
- <<"channel_index">> => #{
- 500 => #{
- <<"id">> => <<"500">>,
- <<"type">> => 0,
- <<"permission_overwrites">> => [#{<<"id">> => <<"42">>, <<"type">> => 1}]
- },
- 600 => #{<<"id">> => <<"600">>, <<"type">> => 4}
- }
- },
- virtual_channel_access => #{99 => sets:from_list([500])}
- }.
-
-memoisable_channel_skips_categories_test() ->
- Data = maps:get(data, memo_channel_state()),
- ?assert(memoisable_channel(500, Data)),
- ?assertNot(memoisable_channel(600, Data)),
- ?assertNot(memoisable_channel(777, Data)).
-
-visibility_exceptions_cover_owner_virtual_and_overwrites_test() ->
- State = memo_channel_state(),
- Exceptions = visibility_exceptions(500, maps:get(data, State), State),
- ?assert(sets:is_element(7, Exceptions)),
- ?assert(sets:is_element(99, Exceptions)),
- ?assert(sets:is_element(42, Exceptions)),
- ?assertNot(sets:is_element(1234, Exceptions)).
-
-new_visibility_memo_is_disabled_for_categories_test() ->
- State = memo_channel_state(),
- ?assertEqual(disabled, new_visibility_memo(600, maps:get(data, State), State)),
- ?assertNotEqual(disabled, new_visibility_memo(500, maps:get(data, State), State)).
-
-memoised_can_view_bypasses_exception_users_test() ->
- State = memo_channel_state(),
- Memo0 = new_visibility_memo(500, maps:get(data, State), State),
- {_, Memo1} = memoised_can_view(7, 500, #{<<"roles">> => []}, [], State, Memo0),
- ?assertEqual(0, map_size(maps:get(cache, Memo1))),
- {_, Memo2} = memoised_can_view(42, 500, #{<<"roles">> => []}, [], State, Memo1),
- ?assertEqual(0, map_size(maps:get(cache, Memo2))).
-
-memoised_can_view_disabled_never_caches_test() ->
- State = memo_channel_state(),
- ?assertMatch(
- {_, disabled},
- memoised_can_view(1000, 600, #{<<"roles">> => [1]}, [1], State, disabled)
- ).
-
-offline_member_skips_the_presence_lookup_test() ->
- Presences = #{7 => #{<<"status">> => <<"online">>}},
- Connected = sets:from_list([7]),
- ?assert(member_is_online(7, Presences, Connected)),
- ?assertNot(member_is_online(8, Presences, Connected)),
- ?assertNot(member_is_online(7, Presences, sets:new())).
-
-invisible_member_is_not_online_test() ->
- Connected = sets:from_list([7]),
- ?assertNot(member_is_online(7, #{7 => #{<<"status">> => <<"invisible">>}}, Connected)),
- ?assertNot(member_is_online(7, #{7 => #{<<"status">> => <<"offline">>}}, Connected)).
-
--endif.
diff --git a/fluxer_gateway/src/guild/guild_member_list_common.erl b/fluxer_gateway/src/guild/guild_member_list_common.erl
index af57d582c..1136d6d2a 100644
--- a/fluxer_gateway/src/guild/guild_member_list_common.erl
+++ b/fluxer_gateway/src/guild/guild_member_list_common.erl
@@ -4,7 +4,6 @@
-typing([eqwalizer]).
-export([
- get_member_user_id/1,
get_member_display_name/1,
normalize_name/1,
casefold_binary/1,
@@ -13,14 +12,6 @@
unicode_chardata_to_binary/1
]).
--spec get_member_user_id(map()) -> integer() | undefined.
-get_member_user_id(Member) ->
- User = maps:get(<<"user">>, Member, #{}),
- case snowflake_id:parse_maybe(maps:get(<<"id">>, User, undefined)) of
- UserId when is_integer(UserId), UserId > 0 -> UserId;
- _ -> undefined
- end.
-
-spec normalize_name(term()) -> binary().
normalize_name(undefined) ->
<<>>;
@@ -61,10 +52,14 @@ casefold_binary(Value) ->
{ok, Folded} ->
Folded;
not_ascii ->
- case unicode_chardata_to_binary(string:casefold(Bin)) of
- {ok, Folded} -> Folded;
- error -> Bin
- end
+ unicode_casefold(Bin)
+ end.
+
+-spec unicode_casefold(binary()) -> binary().
+unicode_casefold(Bin) ->
+ case unicode_chardata_to_binary(string:casefold(Bin)) of
+ {ok, Folded} -> Folded;
+ error -> Bin
end.
%% Case folding a pure-ASCII binary is exactly A-Z -> a-z, so a byte pass is
diff --git a/fluxer_gateway/src/guild/guild_member_list_engine_inputs.erl b/fluxer_gateway/src/guild/guild_member_list_engine_inputs.erl
index 7e04cca3d..294495704 100644
--- a/fluxer_gateway/src/guild/guild_member_list_engine_inputs.erl
+++ b/fluxer_gateway/src/guild/guild_member_list_engine_inputs.erl
@@ -18,7 +18,7 @@
-type channel_id() :: pos_integer().
-type inputs() :: {term(), [term()]}.
--export_type([guild_state/0, list_id/0]).
+-export_type([guild_state/0, list_id/0, channel_id/0]).
-define(INPUTS_KEY, channel_member_list_engine_inputs).
@@ -49,14 +49,24 @@ find_current_twin(_Inputs, [], _Recorded, _AccessByChannel, _State) ->
find_current_twin(Inputs, [ListId | Rest], Recorded, AccessByChannel, State) ->
case {maps:find(ListId, Recorded), channel_id(ListId)} of
{{ok, Inputs}, TwinChannelId} when is_integer(TwinChannelId) ->
- case inputs(TwinChannelId, State, AccessByChannel) of
- Inputs -> {ok, ListId};
- _ -> find_current_twin(Inputs, Rest, Recorded, AccessByChannel, State)
- end;
+ current_twin_or_next(
+ inputs(TwinChannelId, State, AccessByChannel),
+ ListId,
+ Inputs,
+ {Rest, Recorded, AccessByChannel, State}
+ );
_ ->
find_current_twin(Inputs, Rest, Recorded, AccessByChannel, State)
end.
+-spec current_twin_or_next(
+ inputs(), list_id(), inputs(), {[list_id()], map(), #{term() => [term()]}, guild_state()}
+) -> {ok, list_id()} | none.
+current_twin_or_next(Inputs, ListId, Inputs, _Rest) ->
+ {ok, ListId};
+current_twin_or_next(_Current, _ListId, Inputs, {Rest, Recorded, AccessByChannel, State}) ->
+ find_current_twin(Inputs, Rest, Recorded, AccessByChannel, State).
+
-spec record(list_id(), channel_id(), guild_state(), guild_state()) -> guild_state().
record(ListId, ChannelId, BuiltFrom, State) ->
put_recorded(maps:put(ListId, inputs(ChannelId, BuiltFrom), recorded(State)), State).
@@ -79,16 +89,20 @@ latch_stale(State) ->
put_recorded(
maps:filter(
fun(ListId, Recorded) ->
- case channel_id(ListId) of
- undefined -> false;
- ChannelId -> Recorded =:= inputs(ChannelId, State, AccessByChannel)
- end
+ still_current(ListId, Recorded, State, AccessByChannel)
end,
recorded(State)
),
State
).
+-spec still_current(list_id(), inputs(), guild_state(), #{term() => [term()]}) -> boolean().
+still_current(ListId, Recorded, State, AccessByChannel) ->
+ case channel_id(ListId) of
+ undefined -> false;
+ ChannelId -> Recorded =:= inputs(ChannelId, State, AccessByChannel)
+ end.
+
-spec inputs(channel_id(), guild_state()) -> inputs().
inputs(ChannelId, State) ->
inputs(ChannelId, State, virtual_access_by_channel(State)).
@@ -103,22 +117,23 @@ inputs(ChannelId, State, AccessByChannel) ->
-spec virtual_access_by_channel(guild_state()) -> #{term() => [term()]}.
virtual_access_by_channel(State) ->
ByChannel = maps:fold(
- fun(UserId, Channels, Acc) ->
- sets:fold(
- fun(ChannelId, Inner) ->
- maps:update_with(
- ChannelId, fun(Users) -> [UserId | Users] end, [UserId], Inner
- )
- end,
- Acc,
- Channels
- )
- end,
+ fun add_user_channels/3,
#{},
map_utils:ensure_map(maps:get(virtual_channel_access, State, #{}))
),
maps:map(fun(_ChannelId, Users) -> lists:sort(Users) end, ByChannel).
+-spec add_user_channels(term(), sets:set(term()), #{term() => [term()]}) ->
+ #{term() => [term()]}.
+add_user_channels(UserId, Channels, Acc) ->
+ sets:fold(
+ fun(ChannelId, Inner) -> add_channel_user(ChannelId, UserId, Inner) end, Acc, Channels
+ ).
+
+-spec add_channel_user(term(), term(), #{term() => [term()]}) -> #{term() => [term()]}.
+add_channel_user(ChannelId, UserId, ByChannel) ->
+ maps:update_with(ChannelId, fun(Users) -> [UserId | Users] end, [UserId], ByChannel).
+
-spec recorded(guild_state()) -> #{list_id() => inputs()}.
recorded(State) ->
case maps:get(?INPUTS_KEY, State, #{}) of
diff --git a/fluxer_gateway/src/guild/guild_member_list_groups.erl b/fluxer_gateway/src/guild/guild_member_list_groups.erl
index b27c5249d..34d0df22f 100644
--- a/fluxer_gateway/src/guild/guild_member_list_groups.erl
+++ b/fluxer_gateway/src/guild/guild_member_list_groups.erl
@@ -5,8 +5,7 @@
-export([
get_hoisted_roles_sorted/2,
- get_effective_hoist_position/1,
- find_top_hoisted_role/2
+ get_effective_hoist_position/1
]).
-spec get_hoisted_roles_sorted([map()], integer() | undefined) -> [map()].
@@ -37,18 +36,6 @@ get_effective_hoist_position(Role) ->
_ -> maps:get(<<"position">>, Role, 0)
end.
--spec find_top_hoisted_role([integer()], [integer()]) -> integer() | undefined.
-find_top_hoisted_role(MemberRoleIds, HoistedRoleIds) ->
- Shared = [RId || RId <- HoistedRoleIds, role_is_member(RId, MemberRoleIds)],
- case Shared of
- [] -> undefined;
- [Top | _] -> Top
- end.
-
--spec role_is_member(integer(), [integer()]) -> boolean().
-role_is_member(RoleId, MemberRoleIds) ->
- lists:member(RoleId, MemberRoleIds).
-
-spec role_id(map()) -> integer() | undefined.
role_id(Role) ->
case snowflake_id:parse_maybe(maps:get(<<"id">>, Role, undefined)) of
diff --git a/fluxer_gateway/src/guild/guild_member_list_subscribe.erl b/fluxer_gateway/src/guild/guild_member_list_subscribe.erl
index dcff29c1a..54cbfa8d2 100644
--- a/fluxer_gateway/src/guild/guild_member_list_subscribe.erl
+++ b/fluxer_gateway/src/guild/guild_member_list_subscribe.erl
@@ -251,10 +251,11 @@ previous_or_encoded_fragment(Id, Item, Previous) ->
#{Id := {Item, Fragment}} ->
Fragment;
_ ->
- {json_fragment, iolist_to_binary(json:encode(guild_data_wire:payload(Item)))}
+ Payload = eqwalizer:dynamic_cast(guild_data_wire:payload(Item)),
+ {json_fragment, iolist_to_binary(json:encode(Payload))}
end.
--spec cache_fragment(term(), {term(), term()}, {map(), map()}) -> {map(), map()}.
+-spec cache_fragment(term(), term(), {map(), map()}) -> {map(), map()}.
cache_fragment(Id, Entry, {Current, _Previous}) when
map_size(Current) >= ?SYNC_ITEM_CACHE_MAX_ENTRIES
->
@@ -365,339 +366,3 @@ valid_list_id(ListId) when is_binary(ListId) ->
end;
valid_list_id(_) ->
false.
-
--ifdef(TEST).
--include_lib("eunit/include/eunit.hrl").
-
-sync_payload_matches_uncached_encoding_test() ->
- with_clean_cache(fun() ->
- Members = [test_member(N) || N <- lists:seq(1, 60)],
- Payloads = [
- sync_payload(<<"500">>, [{0, 99}], Members),
- sync_payload(<<"600">>, [{0, 99}], lists:reverse(Members)),
- sync_payload(<<"600">>, [{0, 99}, {100, 199}], Members ++ Members),
- sync_payload(<<"0">>, [{0, 99}], lists:sublist(Members, 7, 30))
- ],
- [assert_matches_uncached(P) || P <- Payloads ++ Payloads],
- ?assertEqual(60, map_size(current_entries()))
- end).
-
-sync_payload_reencodes_changed_member_test() ->
- with_clean_cache(fun() ->
- Members = [test_member(N) || N <- lists:seq(1, 10)],
- assert_matches_uncached(sync_payload(<<"500">>, [{0, 99}], Members)),
- [First | Rest] = Members,
- Renamed = put_in(First, [<<"member">>, <<"nick">>], <<"renamed \"x\"">>),
- Idle = put_in(
- hd(Rest), [<<"member">>, <<"presence">>, <<"status">>], <<"idle">>
- ),
- Changed = [Renamed, Idle | tl(Rest)],
- Old = encode_sync_payload(sync_payload(<<"500">>, [{0, 99}], Members)),
- New = assert_matches_uncached(sync_payload(<<"500">>, [{0, 99}], Changed)),
- ?assertNotEqual(Old, New)
- end).
-
-sync_payload_keeps_non_member_items_inline_test() ->
- with_clean_cache(fun() ->
- Items = [
- #{<<"group">> => #{<<"id">> => <<"online">>, <<"count">> => 3}},
- #{<<"member">> => #{<<"nick">> => <<"no user">>}},
- #{<<"member">> => #{<<"user">> => #{<<"username">> => <<"no id">>}}},
- test_member(1)
- ],
- assert_matches_uncached(payload_with_ops([sync_op_items({0, 99}, Items)])),
- ?assertEqual([<<"1427764882469228557">>], maps:keys(current_entries()))
- end).
-
-sync_payload_without_ops_matches_uncached_test() ->
- with_clean_cache(fun() ->
- assert_matches_uncached(#{<<"id">> => <<"500">>, <<"guild_id">> => 7}),
- ?assertEqual(undefined, erlang:get(?SYNC_ITEM_CACHE_KEY)),
- assert_matches_uncached(payload_with_ops([#{<<"op">> => <<"INVALIDATE">>}])),
- ?assertEqual(#{}, current_entries())
- end).
-
-sync_item_cache_is_bounded_test() ->
- with_clean_cache(fun() ->
- Count = ?SYNC_ITEM_CACHE_MAX_ENTRIES + 5,
- Members = [test_member(N) || N <- lists:seq(1, Count)],
- Payload = sync_payload(<<"500">>, [{0, Count - 1}], Members),
- assert_matches_uncached(Payload),
- ?assertEqual(5, map_size(current_entries())),
- ?assertEqual(?SYNC_ITEM_CACHE_MAX_ENTRIES, map_size(previous_entries())),
- assert_matches_uncached(Payload),
- ?assert(
- map_size(current_entries()) + map_size(previous_entries()) =<
- 2 * ?SYNC_ITEM_CACHE_MAX_ENTRIES
- )
- end).
-
-sync_item_cache_flag_off_encodes_uncached_and_clears_test() ->
- with_clean_cache(fun() ->
- Payload = sync_payload(<<"500">>, [{0, 99}], [test_member(N) || N <- lists:seq(1, 5)]),
- assert_matches_uncached(Payload),
- ?assertEqual(5, map_size(current_entries())),
- with_cache_flag(false, fun() ->
- assert_matches_uncached(Payload),
- ?assertEqual(undefined, erlang:get(?SYNC_ITEM_CACHE_KEY))
- end)
- end).
-
-sync_item_cache_released_after_two_idle_generations_test() ->
- with_clean_cache(fun() ->
- with_generation_ms(5, fun() ->
- Members = [test_member(N) || N <- lists:seq(1, 5)],
- Payload = sync_payload(<<"500">>, [{0, 99}], Members),
- assert_matches_uncached(Payload),
- ?assertNotEqual(undefined, erlang:get(?SYNC_ITEM_CACHE_KEY)),
- ?assertEqual(2, deliver_rotation_timers_until_released(10)),
- ?assertEqual(undefined, erlang:get(?SYNC_ITEM_CACHE_KEY))
- end)
- end).
-
-sync_item_cache_previous_generation_changed_member_reencodes_test() ->
- with_clean_cache(fun() ->
- Members = [test_member(N) || N <- lists:seq(1, 4)],
- assert_matches_uncached(sync_payload(<<"500">>, [{0, 99}], Members)),
- rotate_now(),
- [First | Rest] = Members,
- Renamed = put_in(First, [<<"member">>, <<"nick">>], <<"renamed">>),
- assert_matches_uncached(sync_payload(<<"500">>, [{0, 99}], [Renamed | Rest])),
- #{<<"member">> := #{<<"user">> := #{<<"id">> := Id}}} = Renamed,
- ?assertMatch(#{Id := {Renamed, _}}, current_entries())
- end).
-
-sync_item_cache_ignores_stale_timer_test() ->
- with_clean_cache(fun() ->
- Payload = sync_payload(<<"500">>, [{0, 99}], [test_member(N) || N <- lists:seq(1, 5)]),
- assert_matches_uncached(Payload),
- {StaleRef, _, _} = erlang:get(?SYNC_ITEM_CACHE_KEY),
- with_cache_flag(false, fun() -> assert_matches_uncached(Payload) end),
- assert_matches_uncached(Payload),
- ?assertMatch({noreply, #{}}, guild:handle_info(rotation_msg(StaleRef), #{})),
- ?assertEqual(5, map_size(current_entries())),
- ?assertNotMatch({StaleRef, _, _}, erlang:get(?SYNC_ITEM_CACHE_KEY))
- end).
-
-dispatch_sync_group_sends_uncached_bytes_test() ->
- with_clean_cache(fun() ->
- Members = [test_member(N) || N <- lists:seq(1, 20)],
- SyncFun = fun(Ranges) -> sync_payload(<<"500">>, Ranges, Members) end,
- Expected = uncached(SyncFun([{0, 99}])),
- ok = dispatch_sync_group([{0, 99}], [self()], 7, SyncFun),
- ok = dispatch_sync_group([{0, 99}], [self()], 7, SyncFun),
- ?assertEqual([Expected, Expected], received_dispatches())
- end).
-
-sync_payload_cache_is_keyed_by_list_and_ranges_test() ->
- with_clean_cache(fun() ->
- Members = [test_member(N) || N <- lists:seq(1, 40)],
- Payloads = [
- sync_payload(<<"500">>, [{0, 99}], Members),
- sync_payload(<<"600">>, [{0, 99}], Members),
- sync_payload(<<"500">>, [{0, 19}], Members),
- sync_payload(<<"500">>, [{0, 19}, {20, 39}], Members)
- ],
- [assert_matches_uncached(P) || P <- Payloads ++ lists:reverse(Payloads)],
- ?assertEqual(4, map_size(payload_entries())),
- Header = (hd(Payloads))#{<<"online_count">> => 1},
- assert_matches_uncached(Header),
- ?assertEqual(4, map_size(payload_entries()))
- end).
-
-sync_payload_flag_off_ignores_cached_payload_test() ->
- with_clean_cache(fun() ->
- Payload = sync_payload(<<"500">>, [{0, 99}], [test_member(N) || N <- lists:seq(1, 5)]),
- assert_matches_uncached(Payload),
- ?assertEqual(1, map_size(payload_entries())),
- with_cache_flag(false, fun() ->
- assert_matches_uncached(Payload),
- ?assertEqual(#{}, payload_entries())
- end)
- end).
-
-assert_matches_uncached(Payload) ->
- Expected = uncached(Payload),
- Actual = encode_sync_payload(Payload),
- ?assertEqual(Expected, Actual),
- ?assertEqual(
- json:decode(element(2, Expected)), json:decode(element(2, Actual))
- ),
- Actual.
-
-uncached(Payload) ->
- {pre_encoded, iolist_to_binary(json:encode(guild_data_wire:payload(Payload)))}.
-
-received_dispatches() ->
- receive
- {'$gen_cast', {dispatch, guild_member_list_update, Encoded}} ->
- [Encoded | received_dispatches()];
- {dispatch, guild_member_list_update, Encoded} ->
- [Encoded | received_dispatches()]
- after 200 ->
- []
- end.
-
-sync_payload(ListId, Ranges, Items) ->
- Ops = [
- sync_op_items(Range, lists:sublist(Items, Start + 1, End - Start + 1))
- || {Start, End} = Range <- Ranges
- ],
- (payload_with_ops(Ops))#{<<"id">> => ListId}.
-
-payload_with_ops(Ops) ->
- #{
- <<"guild_id">> => <<"1427764882469228556">>,
- <<"id">> => <<"500">>,
- <<"channel_id">> => <<"500">>,
- <<"member_count">> => 55278,
- <<"online_count">> => 1365,
- <<"groups">> => [
- #{<<"id">> => <<"1427764882469228600">>, <<"count">> => 12},
- #{<<"id">> => <<"online">>, <<"count">> => 1353}
- ],
- <<"ops">> => Ops
- }.
-
-sync_op_items({Start, End}, Items) ->
- #{<<"op">> => <<"SYNC">>, <<"range">> => [Start, End], <<"items">> => Items}.
-
-test_member(N) ->
- Id = integer_to_binary(1427764882469228556 + N),
- User = #{
- <<"id">> => Id,
- <<"username">> => <<"user_", (integer_to_binary(N))/binary>>,
- <<"global_name">> => pick(N, [
- null, <<"Ünïcødé \\ \"q\" "/utf8, 240, 159, 152, 128>>, <<"g">>
- ]),
- <<"avatar">> => pick(N, [null, <<"a_0123456789abcdef">>]),
- <<"discriminator">> => <<"0000">>,
- <<"flags">> => N * 4096,
- <<"bot">> => N rem 11 =:= 0,
- <<"avatar_decoration_data">> => pick(N, [
- null, #{<<"sku_id">> => 99, <<"asset">> => <<"x">>}
- ])
- },
- Member = #{
- <<"user">> => User,
- <<"nick">> => pick(N, [null, <<"nick\n\t", 1, " ", (integer_to_binary(N))/binary>>]),
- <<"roles">> => pick(N, [
- [], [<<"1427764882469228600">>, <<"1427764882469228601">>], [42]
- ]),
- <<"joined_at">> => <<"2026-01-01T00:00:00.000Z">>,
- <<"communication_disabled_until">> => null,
- <<"deaf">> => false,
- <<"mute">> => N rem 5 =:= 0,
- <<"premium_since">> => pick(N, [null, <<"2026-02-02T00:00:00Z">>]),
- <<"guild_id">> => 1427764882469228556,
- voice_channel_id => pick(N, [null, 1427764882469228777]),
- <<"presence">> => #{
- <<"user">> => #{<<"id">> => Id},
- <<"status">> => pick(N, [<<"online">>, <<"idle">>, <<"dnd">>]),
- <<"mobile">> => N rem 2 =:= 0,
- <<"afk">> => false,
- <<"custom_status">> => pick(N, [
- null, #{<<"text">> => <<"hi">>, <<"emoji_id">> => 5, <<"emoji_name">> => null}
- ])
- }
- },
- #{<<"member">> => Member}.
-
-pick(N, Options) ->
- lists:nth(N rem length(Options) + 1, Options).
-
-put_in(Map, [Key], Value) ->
- Map#{Key => Value};
-put_in(Map, [Key | Rest], Value) ->
- Map#{Key => put_in(maps:get(Key, Map), Rest, Value)}.
-
-with_clean_cache(Fun) ->
- clear_cache(),
- try
- Fun()
- after
- clear_cache()
- end.
-
-clear_cache() ->
- ok = erase_sync_item_cache(),
- flush_rotation_timers().
-
-flush_rotation_timers() ->
- receive
- {timeout, _, ?SYNC_ITEM_CACHE_TIMEOUT_MSG} -> flush_rotation_timers()
- after 0 ->
- ok
- end.
-
-current_entries() ->
- case erlang:get(?SYNC_ITEM_CACHE_KEY) of
- {_, Current, _} -> fragment_entries(Current);
- _ -> #{}
- end.
-
-previous_entries() ->
- case erlang:get(?SYNC_ITEM_CACHE_KEY) of
- {_, _, Previous} -> fragment_entries(Previous);
- _ -> #{}
- end.
-
-fragment_entries(Generation) ->
- maps:filter(fun(Key, _) -> is_binary(Key) end, Generation).
-
-payload_entries() ->
- case erlang:get(?SYNC_ITEM_CACHE_KEY) of
- {_, Current, _} -> maps:filter(fun(Key, _) -> not is_binary(Key) end, Current);
- _ -> #{}
- end.
-
-rotation_msg(TimerRef) ->
- {timeout, TimerRef, ?SYNC_ITEM_CACHE_TIMEOUT_MSG}.
-
-rotate_now() ->
- {TimerRef, _, _} = erlang:get(?SYNC_ITEM_CACHE_KEY),
- _ = erlang:cancel_timer(TimerRef),
- ?assertMatch({noreply, #{}}, guild:handle_info(rotation_msg(TimerRef), #{})).
-
-deliver_rotation_timers_until_released(0) ->
- erlang:error(sync_item_cache_not_released);
-deliver_rotation_timers_until_released(Remaining) ->
- receive
- {timeout, _, ?SYNC_ITEM_CACHE_TIMEOUT_MSG} = Msg ->
- {noreply, _} = guild:handle_info(Msg, #{}),
- case erlang:get(?SYNC_ITEM_CACHE_KEY) of
- undefined -> 1;
- _ -> 1 + deliver_rotation_timers_until_released(Remaining - 1)
- end
- after 1000 ->
- erlang:error(sync_item_cache_timer_not_armed)
- end.
-
-with_generation_ms(Ms, Fun) ->
- Key = member_list_sync_item_cache_generation_ms,
- Previous = application:get_env(fluxer_gateway, Key),
- application:set_env(fluxer_gateway, Key, Ms),
- try
- Fun()
- after
- case Previous of
- {ok, Old} -> application:set_env(fluxer_gateway, Key, Old);
- undefined -> application:unset_env(fluxer_gateway, Key)
- end
- end.
-
-with_cache_flag(Value, Fun) ->
- Previous = application:get_env(fluxer_gateway, member_list_sync_item_cache_enabled),
- application:set_env(fluxer_gateway, member_list_sync_item_cache_enabled, Value),
- try
- Fun()
- after
- case Previous of
- {ok, Old} ->
- application:set_env(fluxer_gateway, member_list_sync_item_cache_enabled, Old);
- undefined ->
- application:unset_env(fluxer_gateway, member_list_sync_item_cache_enabled)
- end
- end.
-
--endif.