Skip to content

Commit

Permalink
Merge pull request #4471 from esl/support-old-exml-format
Browse files Browse the repository at this point in the history 
Support old exml format
  • Loading branch information
@DenysGonchar
DenysGonchar authored Jan 28, 2025
2 parents 1428ceb + 9b21949 commit 685eea7
Show file tree
Hide file tree
Showing 6 changed files with 162 additions and 169 deletions.
97 changes: 73 additions & 24 deletions big_tests/tests/mam_SUITE.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,8 @@ rdbms_configs(_, _) ->
[].

cassandra_configs(true) ->
[cassandra];
[cassandra,
cassandra_eterm];
cassandra_configs(_) ->
[].

Expand Down Expand Up @@ -309,6 +310,7 @@ mam_cases() ->
mam_service_discovery_to_different_client_bare_jid_results_in_error,
archive_is_instrumented,
easy_archive_request,
easy_archive_request_old_xmlel_format,
easy_archive_request_for_the_receiver,
message_sent_to_yourself,
range_archive_request,
Expand Down Expand Up @@ -637,7 +639,7 @@ init_per_group(Group, ConfigIn) ->
C = configuration(Group),
B = basic_group(Group),
{ModulesToStart, Config0} = required_modules_for_group(C, B, ConfigIn),
ct:pal("Init per group ~p; configuration ~p; basic group ~p", [Group, C, B]),
ct:log("Init per group ~p; configuration ~p; basic group ~p", [Group, C, B]),
Config01 = dynamic_modules:save_modules(host_type(), Config0),
dynamic_modules:ensure_modules(host_type(), ModulesToStart),
Config1 = do_init_per_group(C, Config01),
Expand All @@ -648,6 +650,8 @@ do_init_per_group(C, ConfigIn) ->
case C of
cassandra ->
[{archive_wait, 1500} | Config0];
cassandra_eterm ->
[{archive_wait, 1500} | Config0];
elasticsearch ->
[{archive_wait, 2500} | Config0];
_ ->
Expand All @@ -657,7 +661,8 @@ do_init_per_group(C, ConfigIn) ->
setup_meck(_, elasticsearch) ->
ok = rpc(mim(), meck, expect,
[mongoose_elasticsearch, insert_document, 4, {error, simulated}]);
setup_meck(_, cassandra) ->
setup_meck(_, Config) when Config =:= cassandra_eterm;
Config =:= cassandra ->
ok = rpc(mim(), meck, expect,
[mongoose_cassandra, cql_write_async, 5, {error, simulated}]);
setup_meck(drop_msg, Config) when Config =:= rdbms_async_pool;
Expand Down Expand Up @@ -753,21 +758,15 @@ maybe_set_wait(C, Types, Config) when C =:= rdbms_async_pool;
maybe_set_wait(_C, _, Config) ->
Config.

mam_prefs_backend_module(rdbms, rdbms) ->
mod_mam_rdbms_prefs;
mam_prefs_backend_module(cassandra, cassandra) ->
mod_mam_cassandra_prefs;
mam_prefs_backend_module(_, mnesia) ->
mod_mam_mnesia_prefs;
mam_prefs_backend_module(_, _) ->
{error, wrong_db}.

mam_opts_for_conf(elasticsearch) ->
#{backend => elasticsearch,
user_prefs_store => mnesia};
mam_opts_for_conf(cassandra) ->
#{backend => cassandra,
user_prefs_store => cassandra};
mam_opts_for_conf(cassandra_eterm) ->
Opts = mam_opts_for_conf(cassandra),
Opts#{db_message_format => mam_message_eterm};
mam_opts_for_conf(rdbms_easy) ->
EasyOpts = #{db_jid_format => mam_jid_rfc,
db_message_format => mam_message_xml},
Expand Down Expand Up @@ -881,24 +880,37 @@ maybe_skip(C, Config) when C =:= muc_light_failed_to_decode_message_in_database;
"elasticsearch does not support encodings");
maybe_skip(C, Config) when C =:= muc_light_sql_query_failed;
C =:= pm_sql_query_failed ->
skip_if(?config(configuration, Config) =:= elasticsearch orelse
?config(configuration, Config) =:= cassandra,
Configuration = ?config(configuration, Config),
skip_if(lists:member(Configuration, [elasticsearch, cassandra, cassandra_eterm]),
"Not an SQL database");
maybe_skip(C, Config) when C =:= muc_light_include_groupchat_filter;
C =:= muc_light_no_pm_stored_include_groupchat_filter;
C =:= muc_light_include_groupchat_messages_by_default ->
skip_if(?config(configuration, Config) =:= cassandra,
Configuration = ?config(configuration, Config),
skip_if(lists:member(Configuration, [cassandra, cassandra_eterm]),
"include_groupchat field is not supported for cassandra backend");
maybe_skip(C, Config) when C =:= easy_text_search_request;
C =:= long_text_search_request;
C =:= save_unicode_messages;
C =:= muc_text_search_request ->
skip_if(?config(configuration, Config) =:= cassandra,
Configuration = ?config(configuration, Config),
skip_if(lists:member(Configuration, [cassandra, cassandra_eterm]),
"full text search is not implemented for cassandra backend");
maybe_skip(C, Config) when C =:= muc_light_async_pools_batch_flush;
C =:= async_pools_batch_flush ->
skip_if(?config(configuration, Config) =/= rdbms_async_pool,
"only for async pool");
maybe_skip(C, Config) when C =:= easy_archive_request_old_xmlel_format ->
MamOpts = ?config(mam_meta_opts, Config),
MamBackend = maps:get(backend, MamOpts, rdbms),
DefaultFormat = case MamBackend of
rdbms -> mam_message_compressed_eterm;
_ -> mam_message_xml
end,
MessageFormat = maps:get(db_message_format, MamOpts, DefaultFormat),
PmMamOpts = maps:get(pm, MamOpts, #{}),
PmMessageFormat = maps:get(db_message_format, PmMamOpts, MessageFormat),
skip_if(PmMessageFormat =:= mam_message_xml, "run only for eterm PM message format");
maybe_skip(_C, _Config) ->
ok.

Expand Down Expand Up @@ -1238,13 +1250,6 @@ message_dropped(Config) ->
easy_archive_request(Config) ->
P = ?config(props, Config),
F = fun(Alice, Bob) ->
%% Alice sends "OH, HAI!" to Bob
%% {xmlel,<<"message">>,
%% [{<<"from">>,<<"alice@localhost/res1">>},
%% {<<"to">>,<<"bob@localhost/res1">>},
%% {<<"xml:lang">>,<<"en">>},
%% {<<"type">>,<<"chat">>}],
%% [{xmlel,<<"body">>,[],[{xmlcdata,<<"OH, HAI!">>}]}]}
escalus:send(Alice, escalus_stanza:chat_to(Bob, <<"OH, HAI!">>)),
mam_helper:wait_for_archive_size(Alice, 1),
escalus:send(Alice, stanza_archive_request(P, <<"q1">>)),
Expand All @@ -1271,6 +1276,49 @@ easy_archive_request_for_the_receiver(Config) ->
end,
escalus_fresh:story(Config, [{alice, 1}, {bob, 1}], F).

easy_archive_request_old_xmlel_format(Config) ->
P = ?config(props, Config),
F = fun(Alice, Bob) ->
AArcId = rest_helper:make_arc_id(Alice),
{BobJid, _, _} = BArcId = rest_helper:make_arc_id(Bob),
DateTime = calendar:local_time(),
Msg = mam_helper:generate_msg_for_date_user(AArcId, BArcId, DateTime, <<"OH, HAI!">>),
Packet = erlang:element(5, Msg),
OldFormatPacket =
{xmlel,<<"message">>,
[{<<"to">>, BobJid}, {<<"type">>,<<"chat">>}],
[{xmlel,<<"body">>,[],[{xmlcdata,<<"OH, HAI!">>}]}]},

Msg1 = erlang:setelement(5, Msg, OldFormatPacket),
ct:log("Packet: ~p~n", [Packet]),
ct:log("OldFormatPacket: ~p~n", [OldFormatPacket]),
mam_helper:put_msg(Msg1),
mam_helper:wait_for_archive_size(Alice, 1),
escalus:send(Alice, stanza_archive_request(P, <<"q1">>)),
Res = wait_archive_respond(Alice),
assert_lookup_event(mod_mam_pm_lookup, escalus_utils:get_jid(Alice)),
assert_respond_size(1, Res),
assert_respond_query_id(P, <<"q1">>, parse_result_iq(Res)),
[RespMessage] = respond_messages(Res),
ct:log("ResPacket: ~p~n", [RespMessage]),

ArchivedMsg = exml_query:path(RespMessage, [{element, <<"result">>},
{element, <<"forwarded">>},
{element, <<"message">>}]),
ct:log("ArchivedMsg: ~p~n", [ArchivedMsg]),
assert_msg_match(Packet, ArchivedMsg),
ok
end,
escalus_fresh:story(Config, [{alice, 1}, {bob, 1}], F).

assert_msg_match(Pattern, Msg) ->
#xmlel{attrs = PatternAttrs, children = PatternChildren} = Pattern,
#xmlel{attrs = MsgAttrs, children = MsgChildren} = Msg,
[?assertEqual(Value, maps:get(Name, MsgAttrs, undefined),
<<"attribute ", Name/binary>>)
|| Name := Value <- PatternAttrs],
?assertEqual(PatternChildren, MsgChildren).

message_sent_to_yourself(Config) ->
P = ?config(props, Config),
F = fun(Alice) ->
Expand Down Expand Up @@ -4106,7 +4154,8 @@ message_retraction_is_enabled(Config) ->
BasicGroup = ?config(basic_group, Config),
BasicGroup =/= disabled_retraction andalso BasicGroup =/= muc_disabled_retraction.

check_include_groupchat_features(Stanza, cassandra, _BasicGroup) ->
check_include_groupchat_features(Stanza, Config, _BasicGroup) when Config =:= cassandra_eterm;
Config =:= cassandra ->
?assertNot(escalus_pred:has_feature(groupchat_field_ns(), Stanza)),
?assertNot(escalus_pred:has_feature(groupchat_available_ns(), Stanza));
check_include_groupchat_features(Stanza, _Configuration, muc_light) ->
Expand Down
24 changes: 0 additions & 24 deletions big_tests/tests/mam_helper.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -541,30 +541,6 @@ get_received_msgs_ids(Response) ->
Parsed#forwarded_message.result_id
end, Msgs).

%% @doc Result query iq.
%%
%% [{xmlel,<<"iq">>,
%% [{<<"from">>,<<"alice@localhost">>},
%% {<<"to">>,<<"alice@localhost/res1">>},
%% {<<"id">>,<<"387862024ce65379b049e19751e4309e">>},
%% {<<"type">>,<<"result">>}],
%% []}]
%%
%%
%% [{xmlel,<<"iq">>,
%% [{<<"from">>,<<"alice@localhost">>},
%% {<<"to">>,<<"alice@localhost/res1">>},
%% {<<"id">>,<<"c256a18c4b720465e215a81362d41eb7">>},
%% {<<"type">>,<<"result">>}],
%% [{xmlel,<<"query">>,
%% [{<<"xmlns">>,<<"urn:xmpp:mam:tmp">>}],
%% [{xmlel,<<"set">>,
%% [{<<"xmlns">>,<<"http://jabber.org/protocol/rsm">>}],
%% [{xmlel,<<"first">>,
%% [{<<"index">>,<<"10">>}],
%% [{xmlcdata,<<"103439">>}]},
%% {xmlel,<<"last">>,[],[{xmlcdata,<<"103447">>}]},
%% {xmlel,<<"count">>,[],[{xmlcdata,<<"15">>}]}]}]}]}]
parse_result_iq(#mam_archive_respond{respond_iq = IQ, respond_fin = undefined}) ->
Fin = exml_query:subelement(IQ, <<"fin">>),
Set = exml_query:subelement(Fin, <<"set">>),
Expand Down
24 changes: 0 additions & 24 deletions big_tests/tests/muc_SUITE.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5374,30 +5374,6 @@ has_muc(#xmlel{children = [ #xmlel{children = Services} ]}) ->
%% </query>
%% </iq>

%% is like this:
%% {xmlel,<<"iq">>,
%% [{<<"from">>,<<"localhost">>},
%% {<<"to">>,<<"alice@localhost/res1">>},
%% {<<"id">>,<<"a5eb1dc70826598893b15f1936b18a34">>},
%% {<<"type">>,<<"result">>}],
%% [{xmlel,<<"query">>,
%% [{<<"xmlns">>,
%% <<"http://jabber.org/protocol/disco#items">>}],
%% [{xmlel,<<"item">>,
%% [{<<"jid">>,<<"vjud.localhost">>}],
%% []},
%% {xmlel,<<"item">>,
%% [{<<"jid">>,<<"pubsub.localhost">>}],
%% []},
%% {xmlel,<<"item">>,
%% [{<<"jid">>,<<"muc.localhost">>}],
%% []},
%% {xmlel,<<"item">>,
%% [{<<"jid">>,<<"irc.localhost">>}],
%% []}]}]}
%% how to obtaing output like the above? simply put this in the test case:
%% S = escalus:wait_for_stanza(Alice),
%% error_logger:info_msg("~p~n", [S]),
IsMUC = fun(Item) ->
exml_query:attr(Item, <<"jid">>) == muc_host()
end,
Expand Down
2 changes: 1 addition & 1 deletion src/mam/mam_message_compressed_eterm.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ encode(Packet) ->
term_to_binary(Packet, [compressed]).

decode(Bin) ->
binary_to_term(Bin).
mam_message_eterm:decode(Bin).
24 changes: 23 additions & 1 deletion src/mam/mam_message_eterm.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,30 @@

-behaviour(mam_message).

-include_lib("exml/include/exml.hrl").

-type old_xmlcdata_format() :: {xmlcdata, Content :: binary()}.
-type old_xmlel_format() :: {xmlel, Name :: binary(), Attrs :: [{binary(),binary()}],
Children :: [old_xmlel_format() | old_xmlcdata_format()]}.
encode(Packet) ->
term_to_binary(Packet).

decode(Bin) ->
binary_to_term(Bin).
Term = binary_to_term(Bin),
maybe_convert_old_exml_format(Term).

-spec maybe_convert_old_exml_format(exml:element() | old_xmlel_format()) ->
exml:element().
maybe_convert_old_exml_format({xmlel, _, Attrs, _} = XmlEl) when is_list(Attrs) ->
convert_old_exml_format(XmlEl);
maybe_convert_old_exml_format(XmlEl) ->
XmlEl.

-spec convert_old_exml_format(old_xmlcdata_format()) -> exml:cdata();
(old_xmlel_format()) -> exml:element().
convert_old_exml_format({xmlel, Name, Attrs, Children}) ->
NewAttrs = maps:from_list(Attrs),
NewChildren = [convert_old_exml_format(C) || C <- Children],
#xmlel{name = Name, attrs = NewAttrs, children = NewChildren};
convert_old_exml_format({xmlcdata, Content}) ->
#xmlcdata{content = Content}.
Loading

0 comments on commit 685eea7

Please sign in to comment.