Rename MAM modules #3684

chrzaszcz · 2022-06-14T13:51:24Z

The goal is to make MAM module naming more intuitive.

mod_mam is renamed to mod_mam_pm, because it is a PM-specific module, just as mod_mam_muc is a MUC-specific one.
mod_mam_meta is renamed to mod_mam, because no other modules have this unexpected suffix, and it is more intuitive when the main module is just named after the functionality.

GitHub does not recognize the renaming because types were left in mod_mam (they affect PM and MUC), but you can look at the individual commits, and see that the changes were quite mechanical - the diff is very straightforward for the first two commits.

There are no functional changes in this PR.

The mod_mam_* backends are not renamed to mod_mam_pm_* in this PR - if needed, we can do it in a separate task.

codecov · 2022-06-14T14:03:31Z

Codecov Report

Merging #3684 (70796b8) into master (cbd9928) will increase coverage by 0.01%.
The diff coverage is 90.90%.

@@            Coverage Diff             @@
##           master    #3684      +/-   ##
==========================================
+ Coverage   81.11%   81.12%   +0.01%     
==========================================
  Files         434      434              
  Lines       31884    31884              
==========================================
+ Hits        25863    25867       +4     
+ Misses       6021     6017       -4

Impacted Files	Coverage Δ
src/config/mongoose_config_spec.erl	`100.00% <ø> (ø)`
src/mam/mod_mam_cassandra_arch.erl	`83.49% <ø> (ø)`
src/mam/mod_mam_muc.erl	`75.23% <ø> (ø)`
src/mam/mod_mam_params.erl	`100.00% <ø> (ø)`
src/mam/mod_mam_rdbms_arch.erl	`49.50% <0.00%> (ø)`
src/mam/mod_mam_rdbms_arch_async.erl	`89.13% <ø> (ø)`
src/mam/mod_mam_utils.erl	`86.60% <ø> (ø)`
src/metrics/mongoose_metrics_mam_hooks.erl	`87.87% <ø> (ø)`
src/mam/mod_mam_pm.erl	`89.11% <89.11%> (ø)`
src/mam/mod_mam.erl	`97.40% <97.29%> (+8.28%)`	⬆️
... and 15 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cbd9928...70796b8. Read the comment docs.

mongoose-im · 2022-06-15T13:31:58Z

small_tests_24 / small_tests / 0b8923a
Reports root / small

small_tests_25 / small_tests / 0b8923a
Reports root / small

dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 0b8923a
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 0b8923a
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

dynamic_domains_mysql_redis_25 / mysql_redis / 0b8923a
Reports root/ big
OK: 2808 / Failed: 0 / User-skipped: 105 / Auto-skipped: 0

ldap_mnesia_24 / ldap_mnesia / 0b8923a
Reports root/ big
OK: 1508 / Failed: 0 / User-skipped: 401 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 0b8923a
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

ldap_mnesia_25 / ldap_mnesia / 0b8923a
Reports root/ big
OK: 1508 / Failed: 0 / User-skipped: 401 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / 0b8923a
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

internal_mnesia_25 / internal_mnesia / 0b8923a
Reports root/ big
OK: 1593 / Failed: 0 / User-skipped: 316 / Auto-skipped: 0

elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 0b8923a
Reports root/ big
OK: 1876 / Failed: 0 / User-skipped: 324 / Auto-skipped: 0

pgsql_mnesia_25 / pgsql_mnesia / 0b8923a
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

mysql_redis_25 / mysql_redis / 0b8923a
Reports root/ big
OK: 3194 / Failed: 0 / User-skipped: 102 / Auto-skipped: 0

riak_mnesia_24 / riak_mnesia / 0b8923a
Reports root/ big
OK: 1731 / Failed: 0 / User-skipped: 323 / Auto-skipped: 0

mssql_mnesia_25 / odbc_mssql_mnesia / 0b8923a
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

mongoose-im · 2022-06-15T14:04:15Z

small_tests_24 / small_tests / e389d71
Reports root / small

small_tests_25 / small_tests / e389d71
Reports root / small

dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / e389d71
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

dynamic_domains_mysql_redis_25 / mysql_redis / e389d71
Reports root/ big
OK: 2808 / Failed: 0 / User-skipped: 105 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / e389d71
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

ldap_mnesia_24 / ldap_mnesia / e389d71
Reports root/ big
OK: 1508 / Failed: 0 / User-skipped: 401 / Auto-skipped: 0

ldap_mnesia_25 / ldap_mnesia / e389d71
Reports root/ big
OK: 1508 / Failed: 0 / User-skipped: 401 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / e389d71
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

internal_mnesia_25 / internal_mnesia / e389d71
Reports root/ big
OK: 1593 / Failed: 0 / User-skipped: 316 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / e389d71
Reports root/ big
OK: 2791 / Failed: 1 / User-skipped: 88 / Auto-skipped: 46

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,4383}]},
     {muc_SUITE,'-hibernated_room_can_be_queried_for_archive/1-fun-0-',3,
          [{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
           {line,4124}]},
     {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,4120}]},
     {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}]}]}}

Report log

rest_SUITE:roster:end_per_group

{error,
  {{badrpc,
     {'EXIT',
       {timeout,
         {gen_server,call,
           ['wpool_pool-mongoose_wpool$rdbms$global$default-3',
            {sql_cmd,
              {sql_execute,auth_delete_user,
                [<<"domain.example.com">>,<<"alice">>]},
              -576460110083},
            60000]}}}},
   [{escalus_rpc,call_with_cookie_match,
      [mongooseim@localhost,ejabberd_admin,unregister,
       [<<"alicE">>,<<"domain.example.com">>],
       30000,ejabberd],
      [{file,
         "/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_rpc.erl"},
       {line,34}]},
    {lists,foreach_1,2,[{file,"lists.erl"},{line,1442}]},
    {escalus_ejabberd,delete_users,2,
      [{file,
         "/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_ejabberd.erl"},
       {line,216}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1379}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1223}]}]}}

Report log

rest_client_SUITE:init_per_suite

{'EXIT',{{badrpc,timeout},
     [{distributed_helper,rpc,
                [#{node => mongooseim@localhost},
                 mongoose_modules,replace_modules,
                 [<<"test type">>,[],
                #{mod_muc_light =>
                    #{all_can_configure => false,
                    all_can_invite => false,
                    backend => mnesia,blocking => true,
                    config_schema =>
                      [{<<"roomname">>,<<"Untitled">>,
                        roomname,binary},
                       {<<"subject">>,<<>>,subject,
                        binary}],
                    equal_occupants => false,
                    host => {prefix,<<"muclight.">>},
                    legacy_mode => false,
                    max_occupants => infinity,
                    rooms_in_rosters => true,
                    rooms_per_page => 10,
                    rooms_per_user => infinity}}]],
                [{file,"/home/circleci/project/big_tests/tests/distributed_helper.erl"},
                 {line,117}]},
      {rest_client_SUITE,init_modules,1,
               [{file,"/home/circleci/project/big_tests/tests/rest_client_SUITE.erl"},
                {line,136}]},
      {rest_client_SUITE,init_per_suite,1,
               [{file,"/home/circleci/project/big_tests/tests/rest_client_SUITE.erl"},
                {line,123}]},
      {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
      {test_server,run_test_case_eval1,6,
             [{file,...

Report log

mysql_redis_25 / mysql_redis / e389d71
Reports root/ big
OK: 3205 / Failed: 1 / User-skipped: 102 / Auto-skipped: 0

pep_SUITE:pep_tests:unsubscribe_after_presence_unsubscription

{error,{{badmatch,[{xmlel,<<"presence">>,
              [{<<"from">>,
              <<"alice_unsubscribe_after_presence_unsubscription_1895@localhost/res1">>},
               {<<"to">>,
              <<"bob_unsubscribe_after_presence_unsubscription_1895@localhost/res1">>},
               {<<"type">>,<<"unavailable">>}],
              []}]},
    [{pep_SUITE,'-unsubscribe_after_presence_unsubscription/1-fun-0-',2,
          [{file,"/home/circleci/project/big_tests/tests/pep_SUITE.erl"},
           {line,384}]},
     {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}]}]}}

Report log

elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / e389d71
Reports root/ big
OK: 1876 / Failed: 0 / User-skipped: 324 / Auto-skipped: 0

pgsql_mnesia_25 / pgsql_mnesia / e389d71
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

riak_mnesia_24 / riak_mnesia / e389d71
Reports root/ big
OK: 1731 / Failed: 0 / User-skipped: 323 / Auto-skipped: 0

mssql_mnesia_25 / odbc_mssql_mnesia / e389d71
Reports root/ big
OK: 3218 / Failed: 2 / User-skipped: 98 / Auto-skipped: 0

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,4383}]},
     {muc_SUITE,'-hibernated_room_can_be_queried_for_archive/1-fun-0-',3,
          [{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
           {line,4124}]},
     {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,4120}]},
     {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}]}]}}

Report log

pubsub_SUITE:dag+node_config:send_last_published_item_test

{error,{{badmatch,false},
    [{pubsub_tools,check_response,2,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
            {line,491}]},
     {pubsub_tools,receive_response,3,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
            {line,481}]},
     {pubsub_tools,receive_subscribe_response,3,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
            {line,334}]},
     {pubsub_SUITE,'-send_last_published_item_test/1-fun-0-',2,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_SUITE.erl"},
            {line,937}]},
     {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}]}]}}

Report log

mongoose-im · 2022-06-15T14:23:17Z

small_tests_24 / small_tests / 70796b8
Reports root / small

small_tests_25 / small_tests / 70796b8
Reports root / small

dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 70796b8
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 70796b8
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

ldap_mnesia_24 / ldap_mnesia / 70796b8
Reports root/ big
OK: 1508 / Failed: 0 / User-skipped: 401 / Auto-skipped: 0

dynamic_domains_mysql_redis_25 / mysql_redis / 70796b8
Reports root/ big
OK: 2808 / Failed: 0 / User-skipped: 105 / Auto-skipped: 0

dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 70796b8
Reports root/ big
OK: 2825 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0

ldap_mnesia_25 / ldap_mnesia / 70796b8
Reports root/ big
OK: 1508 / Failed: 0 / User-skipped: 401 / Auto-skipped: 0

internal_mnesia_25 / internal_mnesia / 70796b8
Reports root/ big
OK: 1593 / Failed: 0 / User-skipped: 316 / Auto-skipped: 0

pgsql_mnesia_24 / pgsql_mnesia / 70796b8
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 70796b8
Reports root/ big
OK: 1876 / Failed: 0 / User-skipped: 324 / Auto-skipped: 0

pgsql_mnesia_25 / pgsql_mnesia / 70796b8
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

riak_mnesia_24 / riak_mnesia / 70796b8
Reports root/ big
OK: 1731 / Failed: 0 / User-skipped: 323 / Auto-skipped: 0

mysql_redis_25 / mysql_redis / 70796b8
Reports root/ big
OK: 3194 / Failed: 0 / User-skipped: 102 / Auto-skipped: 0

mssql_mnesia_25 / odbc_mssql_mnesia / 70796b8
Reports root/ big
OK: 3199 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

Premwoik

Looks good to me :)

chrzaszcz force-pushed the mod_mam_pm branch from 3facead to ae1e880 Compare June 14, 2022 13:53

This comment was marked as outdated.

Sign in to view

chrzaszcz changed the title ~~Rename mod_mam to mod_mam_pm~~ Rename MAM modules Jun 15, 2022

This comment was marked as outdated.

Sign in to view

chrzaszcz force-pushed the mod_mam_pm branch from b441139 to 66efc03 Compare June 15, 2022 12:15

This comment was marked as outdated.

Sign in to view

mongoose-im mentioned this pull request Jun 15, 2022

CI build failures summary - part 2 #3685

Closed

Rename mod_mam to mod_mam_pm

c511cc1

chrzaszcz force-pushed the mod_mam_pm branch from 66efc03 to 91a3ac5 Compare June 15, 2022 12:38

This comment was marked as outdated.

Sign in to view

chrzaszcz force-pushed the mod_mam_pm branch from edae314 to 0b8923a Compare June 15, 2022 13:24

chrzaszcz force-pushed the mod_mam_pm branch from 0b8923a to e389d71 Compare June 15, 2022 13:56

chrzaszcz added 4 commits June 15, 2022 16:15

Rename mod_mam_meta to mod_mam

9b4ef36

Move exported MAM types to mod_mam

d596496

Update MAM docs

0fa917f

Document the migration of mod_mam

70796b8

chrzaszcz force-pushed the mod_mam_pm branch from e389d71 to 70796b8 Compare June 15, 2022 14:15

chrzaszcz marked this pull request as ready for review June 15, 2022 14:58

Premwoik approved these changes Jun 20, 2022

View reviewed changes

Premwoik merged commit c213d44 into master Jun 20, 2022

Premwoik deleted the mod_mam_pm branch June 20, 2022 10:50

chrzaszcz added this to the 6.0.0 milestone Dec 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename MAM modules #3684

Rename MAM modules #3684

chrzaszcz commented Jun 14, 2022 •

edited

This comment was marked as outdated.

This comment was marked as outdated.

codecov bot commented Jun 14, 2022 •

edited

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

mongoose-im commented Jun 15, 2022 •

edited

mongoose-im commented Jun 15, 2022 •

edited

mongoose-im commented Jun 15, 2022 •

edited

Premwoik left a comment

Rename MAM modules #3684

Rename MAM modules #3684

Conversation

chrzaszcz commented Jun 14, 2022 • edited

This comment was marked as outdated.

This comment was marked as outdated.

codecov bot commented Jun 14, 2022 • edited

Codecov Report

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

mongoose-im commented Jun 15, 2022 • edited

mongoose-im commented Jun 15, 2022 • edited

mongoose-im commented Jun 15, 2022 • edited

Premwoik left a comment

Choose a reason for hiding this comment

chrzaszcz commented Jun 14, 2022 •

edited

codecov bot commented Jun 14, 2022 •

edited

mongoose-im commented Jun 15, 2022 •

edited

mongoose-im commented Jun 15, 2022 •

edited

mongoose-im commented Jun 15, 2022 •

edited