Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C2S docs #3962

Merged
merged 11 commits into from
Feb 17, 2023
Merged

C2S docs #3962

merged 11 commits into from
Feb 17, 2023

Conversation

chrzaszcz
Copy link
Member

@chrzaszcz chrzaszcz commented Feb 13, 2023

Update documentation after introducing mongose_c2s.
The migration guide will be updated in a separate PR.

Main changes:

  • New routing docs and diagrams, since the old ones were outdated. It was difficult to get any good-looking output from plantuml, so it was replaced with Google docs. The docs were looking bad in night mode, so a separate dark-mode version is used.
  • Hook description is updated and unified. There were multiple updates since this doc was out of date.
  • Missing configuration options are described.
  • Hook API modules moved to src/hooks to make them easier to find and automatically grep. Another reason was naming - we had confusing modules like mongoose_metric_hooks, which contains handlers, not hooks. The rename is the simplest change, and I wanted to avoid code changes in this PR.

@mongoose-im

This comment was marked as outdated.

@codecov
Copy link

codecov bot commented Feb 13, 2023

Codecov Report

Base: 83.57% // Head: 83.53% // Decreases project coverage by -0.04% ⚠️

Coverage data is based on head (8716857) compared to base (0c23f34).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3962      +/-   ##
==========================================
- Coverage   83.57%   83.53%   -0.04%     
==========================================
  Files         538      538              
  Lines       34003    34003              
==========================================
- Hits        28418    28405      -13     
- Misses       5585     5598      +13     
Impacted Files Coverage Δ
src/config/mongoose_config_spec.erl 100.00% <ø> (ø)
src/hooks/mongoose_c2s_hooks.erl 95.45% <ø> (ø)
src/hooks/mongoose_hooks.erl 95.84% <ø> (ø)
src/pubsub/mod_pubsub_db.erl 57.14% <0.00%> (-28.58%) ⬇️
src/ejabberd.erl 35.00% <0.00%> (-10.00%) ⬇️
src/async_pools/mongoose_aggregator_worker.erl 63.33% <0.00%> (-6.67%) ⬇️
src/pubsub/node_pep.erl 77.77% <0.00%> (-1.86%) ⬇️
src/mod_caps.erl 77.15% <0.00%> (-0.87%) ⬇️
src/pubsub/mod_pubsub_db_mnesia.erl 92.40% <0.00%> (-0.85%) ⬇️
src/pubsub/mod_pubsub.erl 73.48% <0.00%> (-0.19%) ⬇️
... and 4 more

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.
📢 Do you have feedback about the report comment? Let us know in this issue.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@chrzaszcz chrzaszcz force-pushed the c2s-docs branch 2 times, most recently from 7939b13 to 045d2ec Compare February 17, 2023 08:30
@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im
Copy link
Collaborator

mongoose-im commented Feb 17, 2023

small_tests_24 / small_tests / 6d2c774
Reports root / small


small_tests_25 / small_tests / 6d2c774
Reports root / small


ldap_mnesia_24 / ldap_mnesia / 6d2c774
Reports root/ big
OK: 2219 / Failed: 0 / User-skipped: 825 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 6d2c774
Reports root/ big
OK: 4169 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0


ldap_mnesia_25 / ldap_mnesia / 6d2c774
Reports root/ big
OK: 2219 / Failed: 0 / User-skipped: 825 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 6d2c774
Reports root/ big
OK: 4169 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0


dynamic_domains_mysql_redis_25 / mysql_redis / 6d2c774
Reports root/ big
OK: 4143 / Failed: 0 / User-skipped: 114 / Auto-skipped: 0


pgsql_mnesia_24 / pgsql_mnesia / 6d2c774
Reports root/ big
OK: 4549 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0


internal_mnesia_25 / internal_mnesia / 6d2c774
Reports root/ big
OK: 2361 / Failed: 0 / User-skipped: 683 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 6d2c774
Reports root/ big
OK: 4166 / Failed: 0 / User-skipped: 91 / Auto-skipped: 0


elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 6d2c774
Reports root/ big
OK: 2721 / Failed: 0 / User-skipped: 662 / Auto-skipped: 0


riak_mnesia_24 / riak_mnesia / 6d2c774
Reports root/ big
OK: 2559 / Failed: 0 / User-skipped: 654 / Auto-skipped: 0


mysql_redis_25 / mysql_redis / 6d2c774
Reports root/ big
OK: 4534 / Failed: 1 / User-skipped: 111 / Auto-skipped: 0

rest_SUITE:admin:session_can_be_kicked
{error,{test_case_failed,[70,97,105,108,58,32,
              [60,60,
               "\"alice_session_can_be_kicked_2825@localhost/res1\"",
               62,62],
              32,105,110,32,
              [91,
               [[60,60,
               "\"alice_messages_are_sent_and_received_2824@localhost/res1\"",
               62,62],
              44,10,
              [32,32,
               [32,
                [32,[32,"   ",32,32,32],32,"   ",32,32,32],
                32,
                [32,"   ",32,32,32],
                32,"   ",32,32,32],
               32,
               [32,[32,"   ",32,32,32],32,"   ",32,32,32],
               32,
               [32,"   ",32,32,32],
               32,"   ",32,32,32],
              [60,60,
               "\"alice_stanzas_are_sent_and_received_2827@localhost/res1\"",
               62,62],
              44,10,
              [32,32,
               [32,
                [32,[32,"   ",32,32,32],32,"   ",32,32,32],
                32,
                [32,"   ",32,32,32],
                32,"   ",32,32,32],
               32,
               [32,[32,"   ",32,32,32],32,"   ",32,32,32],
               32,
               [32,"   ",32,32,32],
               32,"   ",32,32,32],
              [60,60,
               "\"alice_session_can_be_kicked_2825@localhost/res1\"",
               62,62],
              44,10,
              [32,32,
               [32,
                [32,[32,"   ",32,32,32],32,"   ",32,32,32],
                32,
               ...

Report log


mssql_mnesia_25 / odbc_mssql_mnesia / 6d2c774
Reports root/ big
OK: 4546 / Failed: 0 / User-skipped: 100 / Auto-skipped: 0


pgsql_mnesia_25 / pgsql_mnesia / 6d2c774
Reports root/ big
OK: 4549 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0

@mongoose-im
Copy link
Collaborator

mongoose-im commented Feb 17, 2023

small_tests_24 / small_tests / a9dc040
Reports root / small


small_tests_25 / small_tests / a9dc040
Reports root / small


ldap_mnesia_24 / ldap_mnesia / a9dc040
Reports root/ big
OK: 2219 / Failed: 0 / User-skipped: 825 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / a9dc040
Reports root/ big
OK: 4169 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0


ldap_mnesia_25 / ldap_mnesia / a9dc040
Reports root/ big
OK: 2219 / Failed: 0 / User-skipped: 825 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / a9dc040
Reports root/ big
OK: 4169 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / a9dc040
Reports root/ big
OK: 4166 / Failed: 0 / User-skipped: 91 / Auto-skipped: 0


dynamic_domains_mysql_redis_25 / mysql_redis / a9dc040
Reports root/ big
OK: 4143 / Failed: 0 / User-skipped: 114 / Auto-skipped: 0


pgsql_mnesia_24 / pgsql_mnesia / a9dc040
Reports root/ big
OK: 4549 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0


internal_mnesia_25 / internal_mnesia / a9dc040
Reports root/ big
OK: 2361 / Failed: 0 / User-skipped: 683 / Auto-skipped: 0


mysql_redis_25 / mysql_redis / a9dc040
Reports root/ big
OK: 4535 / Failed: 0 / User-skipped: 111 / Auto-skipped: 0


elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / a9dc040
Reports root/ big
OK: 2739 / Failed: 1 / User-skipped: 662 / Auto-skipped: 0

pubsub_SUITE:dag+basic:publish_only_retract_items_scope_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_and_check_response,4,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
            {line,471}]},
     {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


riak_mnesia_24 / riak_mnesia / a9dc040
Reports root/ big
OK: 2559 / Failed: 0 / User-skipped: 654 / Auto-skipped: 0


pgsql_mnesia_25 / pgsql_mnesia / a9dc040
Reports root/ big
OK: 4549 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0


mssql_mnesia_25 / odbc_mssql_mnesia / a9dc040
Reports root/ big
OK: 4546 / Failed: 0 / User-skipped: 100 / Auto-skipped: 0

@chrzaszcz chrzaszcz marked this pull request as ready for review February 17, 2023 09:49
Copy link
Collaborator

@NelsonVides NelsonVides left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor comments, dunno if those are actually useful examples but just throwing in some thought. Otherwise, a wonderful PR 🎉

doc/developers-guide/Stanza-routing.md Outdated Show resolved Hide resolved
doc/developers-guide/Stanza-routing.md Outdated Show resolved Hide resolved
@mongoose-im
Copy link
Collaborator

mongoose-im commented Feb 17, 2023

small_tests_24 / small_tests / 8716857
Reports root / small


small_tests_25 / small_tests / 8716857
Reports root / small


dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 8716857
Reports root/ big
OK: 4169 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0


ldap_mnesia_24 / ldap_mnesia / 8716857
Reports root/ big
OK: 2219 / Failed: 0 / User-skipped: 825 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 8716857
Reports root/ big
OK: 4169 / Failed: 0 / User-skipped: 88 / Auto-skipped: 0


ldap_mnesia_25 / ldap_mnesia / 8716857
Reports root/ big
OK: 2219 / Failed: 0 / User-skipped: 825 / Auto-skipped: 0


dynamic_domains_mysql_redis_25 / mysql_redis / 8716857
Reports root/ big
OK: 4143 / Failed: 0 / User-skipped: 114 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 8716857
Reports root/ big
OK: 4166 / Failed: 0 / User-skipped: 91 / Auto-skipped: 0


pgsql_mnesia_24 / pgsql_mnesia / 8716857
Reports root/ big
OK: 4549 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0


elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 8716857
Reports root/ big
OK: 2721 / Failed: 0 / User-skipped: 662 / Auto-skipped: 0


pgsql_mnesia_25 / pgsql_mnesia / 8716857
Reports root/ big
OK: 4549 / Failed: 0 / User-skipped: 97 / Auto-skipped: 0


internal_mnesia_25 / internal_mnesia / 8716857
Reports root/ big
OK: 2361 / Failed: 0 / User-skipped: 683 / Auto-skipped: 0


riak_mnesia_24 / riak_mnesia / 8716857
Reports root/ big
OK: 2559 / Failed: 0 / User-skipped: 654 / Auto-skipped: 0


mysql_redis_25 / mysql_redis / 8716857
Reports root/ big
OK: 4535 / Failed: 0 / User-skipped: 111 / Auto-skipped: 0


mssql_mnesia_25 / odbc_mssql_mnesia / 8716857
Reports root/ big
OK: 4546 / Failed: 0 / User-skipped: 100 / Auto-skipped: 0

Copy link
Collaborator

@NelsonVides NelsonVides left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@NelsonVides NelsonVides merged commit d816175 into master Feb 17, 2023
@NelsonVides NelsonVides deleted the c2s-docs branch February 17, 2023 12:10
@jacekwegr jacekwegr added this to the 6.1.0 milestone Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants