Define more granular overriding between inbox form and rms #3974
Conversation
It happens that, if a user wants to paginate through inbox but only through what
has changed since a given timestamp, once the second page is requested using the
given `<after>` returned on the first page, the pagination would overrun any
limit timestamp given and would therefore continue returning the entire inbox set.
Example:
```xml
<!-- We ask for all changes since the given `start` date -->
<iq type="set" id="8D07E14F-9A2D-442A-A996-81F4E47E6CC6">
<inbox xmlns="erlang-solutions.com:xmpp:inbox:0">
<x xmlns="jabber:x:data" type="form">
<field var="box" type="list-single"><value>inbox</value></field>
<field var="start"><value>2023-02-28T15:27:31.481Z</value></field>
</x>
<set xmlns="http://jabber.org/protocol/rsm">
<max>30</max>
</set>
</inbox>
</iq>
<!-- we get all the 30 entries, and then the iq-result with the given page details -->
<iq xmlns="jabber:client" from="alice@localhost" to="alice@localhost/res1" id="8D07E14F-9A2D-442A-A996-81F4E47E6CC6" type="result">
<fin xmlns="erlang-solutions.com:xmpp:inbox:0">
<set xmlns="http://jabber.org/protocol/rsm">
<first>1673349807109070/oaeusnth</first>
<last>1673349791932211/qjkzlvwm</last>
</set>
<active-conversations>0</active-conversations>
<count>30</count>
<unread-messages>0</unread-messages>
</fin>
</iq>
<!-- We decide to continue fetching from the previously given end of page, -->
<!-- but we still want to end on the same timestamp -->
<iq type="set" id="F2DF7FCE-4802-43E9-9C0B-6D0A333D7E8A">
<inbox xmlns="erlang-solutions.com:xmpp:inbox:0">
<x xmlns="jabber:x:data" type="form">
<field var="box" type="list-single"><value>inbox</value></field>
<field var="start"><value>2023-02-28T15:27:31.481Z</value></field>
</x>
<set xmlns="http://jabber.org/protocol/rsm">
<max>30</max>
<after>1673349791932211/qjkzlvwm</after>
</set>
</inbox>
</iq>
```
The old implementation would overrun the `start` part of the form and not limit
the page size. The new implementation takes care of that, by instead of having
RSM overriding the entire form, having `after` override _only_ `end`, and
`before` override _only_ `start`.
|
small_tests_24 / small_tests / 69a1753 small_tests_25 / small_tests / 69a1753 ldap_mnesia_24 / ldap_mnesia / 69a1753 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 69a1753 ldap_mnesia_25 / ldap_mnesia / 69a1753 dynamic_domains_mysql_redis_25 / mysql_redis / 69a1753 muc_SUITE:hibernation:hibernated_room_can_be_queried_for_archive{error,{{assertion_failed,assert,is_groupchat_message,
[<<"Restorable message">>],
undefined,"undefined"},
[{escalus_new_assert,assert_true,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
{line,84}]},
{muc_SUITE,wait_for_mam_result,3,
[{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
{line,4394}]},
{muc_SUITE,'-hibernated_room_can_be_queried_for_archive/1-fun-0-',3,
[{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
{line,4130}]},
{escalus_story,story,4,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{muc_SUITE,hibernated_room_can_be_queried_for_archive,1,
[{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
{line,4126}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1291}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1223}]}]}}pgsql_mnesia_24 / pgsql_mnesia / 69a1753 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 69a1753 internal_mnesia_25 / internal_mnesia / 69a1753 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 69a1753 inbox_extensions_SUITE:async_pools:one_to_one:mute_muted_conv_restarts_timestamp{error,
{{assert,
[{module,inbox_extensions_SUITE},
{line,899},
{expression,"escalus_pred : is_message ( Message )"},
{expected,true},
{value,false}]},
[{inbox_extensions_SUITE,check_message_with_properties,4,
[{file,
"/home/circleci/project/big_tests/tests/inbox_extensions_SUITE.erl"},
{line,899}]},
{inbox_extensions_SUITE,set_inbox_properties,4,
[{file,
"/home/circleci/project/big_tests/tests/inbox_extensions_SUITE.erl"},
{line,893}]},
{inbox_extensions_SUITE,'-mute_muted_conv_restarts_timestamp/1-fun-2-',
2,
[{file,
"/home/circleci/project/big_tests/tests/inbox_extensions_SUITE.erl"},
{line,616}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1291}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1223}]}]}}riak_mnesia_24 / riak_mnesia / 69a1753 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 69a1753 pgsql_mnesia_25 / pgsql_mnesia / 69a1753 mssql_mnesia_25 / odbc_mssql_mnesia / 69a1753 mysql_redis_25 / mysql_redis / 69a1753 dynamic_domains_mysql_redis_25 / mysql_redis / 69a1753 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 69a1753 mam_SUITE:rdbms_async_cache_prefs_cases:messages_filtered_when_prefs_default_policy_is_always{error,
{{assertion_failed,assert,is_iq_result,
[{xmlel,<<"iq">>,
[{<<"type">>,<<"set">>},
{<<"id">>,<<"d0a8cfe9eb56e3a55195e1b0b64e3657">>}],
[{xmlel,<<"prefs">>,
[{<<"xmlns">>,<<"urn:xmpp:mam:1">>},
{<<"default">>,<<"always">>}],
[{xmlel,<<"always">>,[],[]},{xmlel,<<"never">>,[],[]}]}]}],
{xmlel,<<"iq">>,
[{<<"from">>,
<<"alice_messages_filtered_when_prefs_default_policy_is_always_2092@domain.example.com">>},
{<<"to">>,
<<"alice_messages_filtered_when_prefs_default_policy_is_always_2092@domain.example.com/res1">>},
{<<"id">>,<<"pushc993e81a92fbe499">>},
{<<"type">>,<<"set">>}],
[{xmlel,<<"query">>,
[{<<"xmlns">>,<<"jabber:iq:roster">>}],
[{xmlel,<<"item">>,
[{<<"subscription">>,<<"both">>},
{<<"jid">>,
<<"bob_messages_filtered_when_prefs_default_policy_is_always_2092@domain.example.com">>}],
[]}]}]},
"<iq from='alice_messages_filtered_when_prefs_default_policy_is_always_2092@domain.example.com' to='alice_messages_filtered_when_prefs_default_policy_is_always_2092@domain.example.com/res1' id='pushc993e81a92fbe499' type='set'><query xmlns='jabber:iq:roster'><item subscription='both' jid='bob_messages_filtered_when_prefs_default_policy_is_always_2092@domain.example.com'/></query></iq>"},
[{escalus_new_assert,assert_true,2,
[{file,
"/home/circleci/project/big_test...dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 69a1753 |
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #3974 +/- ##
==========================================
+ Coverage 81.08% 83.62% +2.53%
==========================================
Files 538 538
Lines 34031 34030 -1
==========================================
+ Hits 27594 28457 +863
+ Misses 6437 5573 -864
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
It happens that, if a user wants to paginate through inbox but only through what has changed since a given timestamp, once the second page is requested using the given
<after>returned on the first page, the pagination would overrun any limit timestamp given and would therefore continue returning the entire inbox set.Example:
The old implementation would overrun the
startpart of the form and not limit the page size. The new implementation takes care of that, by instead of having RSM overriding the entire form, havingafteroverride onlyend, andbeforeoverride onlystart.