Skip to content

Listeners: minor fixes in docs and refactoring - #4516

Merged
jacekwegr merged 9 commits into
feature/listenersfrom
listeners/fixes
Apr 7, 2025
Merged

jacekwegr merged 9 commits into
feature/listenersfrom
listeners/fixes

Conversation

@chrzaszcz

Copy link
Copy Markdown
Member

This PR corrects multiple minor issues found during the review of feature/listeners:

  • Improve documentation.
  • Refactor code.

See the commit messages for more information.

The comment actually refers to the previous clause.
- Don't mention just_tls, because this module doesn't need to be
  exposed to the user any longer (there is no 'module' option).
- Make it clear how to enable/disable TLS (like for the c2s listener).
- Specify the default mode as 'tls' for components.
@mongoose-im

mongoose-im commented Apr 7, 2025 •

Copy link
Copy Markdown
Collaborator

elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / 777ec84
Reports root/ big
OK: 683 / Failed: 0 / User-skipped: 72 / Auto-skipped: 0


small_tests_27 / small_tests / 777ec84
Reports root / small


small_tests_26 / small_tests / 777ec84
Reports root / small


small_tests_27_arm64 / small_tests / 777ec84
Reports root / small


ldap_mnesia_26 / ldap_mnesia / 777ec84
Reports root/ big
OK: 2331 / Failed: 0 / User-skipped: 1187 / Auto-skipped: 0


ldap_mnesia_27 / ldap_mnesia / 777ec84
Reports root/ big
OK: 2331 / Failed: 0 / User-skipped: 1352 / Auto-skipped: 0


internal_mnesia_27 / internal_mnesia / 777ec84
Reports root/ big
OK: 2465 / Failed: 0 / User-skipped: 1218 / Auto-skipped: 0


dynamic_domains_mysql_redis_27 / mysql_redis / 777ec84
Reports root/ big
OK: 5160 / Failed: 0 / User-skipped: 154 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / 777ec84
Reports root/ big
OK: 5195 / Failed: 0 / User-skipped: 119 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / 777ec84
Reports root/ big
OK: 5030 / Failed: 0 / User-skipped: 119 / Auto-skipped: 0


pgsql_cets_27 / pgsql_cets / 777ec84
Reports root/ big
OK: 5280 / Failed: 0 / User-skipped: 188 / Auto-skipped: 0


mysql_redis_27 / mysql_redis / 777ec84
Reports root/ big
OK: 5562 / Failed: 0 / User-skipped: 149 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 777ec84
Reports root/ big
OK: 5190 / Failed: 0 / User-skipped: 124 / Auto-skipped: 0


cockroachdb_cets_27 / cockroachdb_cets / 777ec84
Reports root/ big
OK: 5286 / Failed: 3 / User-skipped: 188 / Auto-skipped: 0

pubsub_SUITE:dag+last_item_cache:send_last_published_item_no_items_test
{error,
  {timeout_when_waiting_for_stanza,
    [{escalus_client,wait_for_stanza,
       [{client,
          <<"alice_send_last_published_item_no_items_test_3824@localhost/res1">>,
          escalus_tcp,<0.118114.0>,
          [{event_manager,<0.118111.0>},
           {server,<<"localhost">>},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3824">>},
           {resource,<<"res1">>}],
          [{event_client,
             [{event_manager,<0.118111.0>},
            {server,<<"localhost">>},
            {username,
              <<"alicE_send_last_published_item_no_items_test_3824">>},
            {resource,<<"res1">>}]},
           {resource,<<"res1">>},
           {username,
             <<"alice_send_last_published_item_no_items_test_3824">>},
           {server,<<"localhost">>},
           {host,<<"localhost">>},
           {port,5222},
           {auth,fun escalus_auth:auth_plain/2},
           {wspath,undefined},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3824">>},
           {server,<<"localhost">>},
           {password,<<"matygrysa">>},
           {stream_id,<<"c9836a8adb842881">>}]},
        5000],
       [{file,
          "/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
        {line,136}]},
     {pubsub_tools,receive_response,3,
       [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
        {line,434}]},
     {pubsub_tools,receive_and_c...

Report log

pubsub_SUITE:dag+last_item_cache:send_last_published_item_no_items_test
{error,
  {timeout_when_waiting_for_stanza,
    [{escalus_client,wait_for_stanza,
       [{client,
          <<"alice_send_last_published_item_no_items_test_3826@localhost/res1">>,
          escalus_tcp,<0.118192.0>,
          [{event_manager,<0.118181.0>},
           {server,<<"localhost">>},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3826">>},
           {resource,<<"res1">>}],
          [{event_client,
             [{event_manager,<0.118181.0>},
            {server,<<"localhost">>},
            {username,
              <<"alicE_send_last_published_item_no_items_test_3826">>},
            {resource,<<"res1">>}]},
           {resource,<<"res1">>},
           {username,
             <<"alice_send_last_published_item_no_items_test_3826">>},
           {server,<<"localhost">>},
           {host,<<"localhost">>},
           {port,5222},
           {auth,fun escalus_auth:auth_plain/2},
           {wspath,undefined},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3826">>},
           {server,<<"localhost">>},
           {password,<<"matygrysa">>},
           {stream_id,<<"e9f8238cec73af63">>}]},
        5000],
       [{file,
          "/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
        {line,136}]},
     {pubsub_tools,receive_response,3,
       [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
        {line,434}]},
     {pubsub_tools,receive_and_c...

Report log

pubsub_SUITE:dag+last_item_cache:send_last_published_item_no_items_test
{error,
  {timeout_when_waiting_for_stanza,
    [{escalus_client,wait_for_stanza,
       [{client,
          <<"alice_send_last_published_item_no_items_test_3830@localhost/res1">>,
          escalus_tcp,<0.118272.0>,
          [{event_manager,<0.118267.0>},
           {server,<<"localhost">>},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3830">>},
           {resource,<<"res1">>}],
          [{event_client,
             [{event_manager,<0.118267.0>},
            {server,<<"localhost">>},
            {username,
              <<"alicE_send_last_published_item_no_items_test_3830">>},
            {resource,<<"res1">>}]},
           {resource,<<"res1">>},
           {username,
             <<"alice_send_last_published_item_no_items_test_3830">>},
           {server,<<"localhost">>},
           {host,<<"localhost">>},
           {port,5222},
           {auth,fun escalus_auth:auth_plain/2},
           {wspath,undefined},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3830">>},
           {server,<<"localhost">>},
           {password,<<"matygrysa">>},
           {stream_id,<<"6db3ca30ab66bfad">>}]},
        5000],
       [{file,
          "/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
        {line,136}]},
     {pubsub_tools,receive_response,3,
       [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
        {line,434}]},
     {pubsub_tools,receive_and_c...

Report log


pgsql_mnesia_26 / pgsql_mnesia / 777ec84
Reports root/ big
OK: 5418 / Failed: 0 / User-skipped: 128 / Auto-skipped: 0


pgsql_mnesia_27 / pgsql_mnesia / 777ec84
Reports root/ big
OK: 5583 / Failed: 0 / User-skipped: 128 / Auto-skipped: 0


mssql_mnesia_27 / odbc_mssql_mnesia / 777ec84
Reports root/ big
OK: 5578 / Failed: 0 / User-skipped: 133 / Auto-skipped: 0

@codecov

codecov Bot commented Apr 7, 2025 •

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.85%. Comparing base (5315e76) to head (e3a603d).
Report is 11 commits behind head on feature/listeners.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           feature/listeners    #4516      +/-   ##
=====================================================
+ Coverage              85.80%   85.85%   +0.05%     
=====================================================
  Files                    564      564              
  Lines                  33842    33838       -4     
=====================================================
+ Hits                   29037    29051      +14     
+ Misses                  4805     4787      -18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Components support dynamic domains now
- Correct typos and minor mistakes
MIM supports stream closing now
- Simplify type specs
- Set listener module to the correct value
  (actually, it would be used only for inspection)
@mongoose-im

mongoose-im commented Apr 7, 2025 •

Copy link
Copy Markdown
Collaborator

elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / e3a603d
Reports root/ big
OK: 683 / Failed: 0 / User-skipped: 72 / Auto-skipped: 0


small_tests_26 / small_tests / e3a603d
Reports root / small


small_tests_27 / small_tests / e3a603d
Reports root / small


small_tests_27_arm64 / small_tests / e3a603d
Reports root / small


ldap_mnesia_27 / ldap_mnesia / e3a603d
Reports root/ big
OK: 2330 / Failed: 1 / User-skipped: 1352 / Auto-skipped: 0

graphql_server_SUITE:admin_cli:clustering_tests:join_successful
{error,{#{what => invalid_response_code,
      response_code => {exit_status,1},
      expected_type => ok},
    [{graphql_helper,assert_response_code,2,
             [{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
              {line,258}]},
     {graphql_helper,get_ok_value,2,
             [{file,"/home/circleci/project/big_tests/tests/graphql_helper.erl"},
              {line,241}]},
     {graphql_server_SUITE,join_successful,1,
                 [{file,"/home/circleci/project/big_tests/tests/graphql_server_SUITE.erl"},
                {line,153}]},
     {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
     {test_server,run_test_case_eval1,6,
            [{file,"test_server.erl"},{line,1303}]},
     {test_server,run_test_case_eval,9,
            [{file,"test_server.erl"},{line,1235}]}]}}

Report log


dynamic_domains_mysql_redis_27 / mysql_redis / e3a603d
Reports root/ big
OK: 5160 / Failed: 0 / User-skipped: 154 / Auto-skipped: 0


ldap_mnesia_26 / ldap_mnesia / e3a603d
Reports root/ big
OK: 2331 / Failed: 0 / User-skipped: 1187 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / e3a603d
Reports root/ big
OK: 5195 / Failed: 0 / User-skipped: 119 / Auto-skipped: 0


pgsql_cets_27 / pgsql_cets / e3a603d
Reports root/ big
OK: 5280 / Failed: 0 / User-skipped: 188 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / e3a603d
Reports root/ big
OK: 5030 / Failed: 0 / User-skipped: 119 / Auto-skipped: 0


internal_mnesia_27 / internal_mnesia / e3a603d
Reports root/ big
OK: 2465 / Failed: 0 / User-skipped: 1218 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / e3a603d
Reports root/ big
OK: 5190 / Failed: 0 / User-skipped: 124 / Auto-skipped: 0


mysql_redis_27 / mysql_redis / e3a603d
Reports root/ big
OK: 5562 / Failed: 0 / User-skipped: 149 / Auto-skipped: 0


pgsql_mnesia_26 / pgsql_mnesia / e3a603d
Reports root/ big
OK: 5418 / Failed: 0 / User-skipped: 128 / Auto-skipped: 0


cockroachdb_cets_27 / cockroachdb_cets / e3a603d
Reports root/ big
OK: 5284 / Failed: 2 / User-skipped: 188 / Auto-skipped: 0

pubsub_SUITE:dag+last_item_cache:send_last_published_item_no_items_test
{error,
  {timeout_when_waiting_for_stanza,
    [{escalus_client,wait_for_stanza,
       [{client,
          <<"alice_send_last_published_item_no_items_test_3795@localhost/res1">>,
          escalus_tcp,<0.118773.0>,
          [{event_manager,<0.118763.0>},
           {server,<<"localhost">>},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3795">>},
           {resource,<<"res1">>}],
          [{event_client,
             [{event_manager,<0.118763.0>},
            {server,<<"localhost">>},
            {username,
              <<"alicE_send_last_published_item_no_items_test_3795">>},
            {resource,<<"res1">>}]},
           {resource,<<"res1">>},
           {username,
             <<"alice_send_last_published_item_no_items_test_3795">>},
           {server,<<"localhost">>},
           {host,<<"localhost">>},
           {port,5222},
           {auth,fun escalus_auth:auth_plain/2},
           {wspath,undefined},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3795">>},
           {server,<<"localhost">>},
           {password,<<"matygrysa">>},
           {stream_id,<<"59fad8509b47b7f5">>}]},
        5000],
       [{file,
          "/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
        {line,136}]},
     {pubsub_tools,receive_response,3,
       [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
        {line,434}]},
     {pubsub_tools,receive_and_c...

Report log

pubsub_SUITE:tree+last_item_cache:send_last_published_item_no_items_test
{error,
  {timeout_when_waiting_for_stanza,
    [{escalus_client,wait_for_stanza,
       [{client,
          <<"alice_send_last_published_item_no_items_test_3850@localhost/res1">>,
          escalus_tcp,<0.120058.0>,
          [{event_manager,<0.120047.0>},
           {server,<<"localhost">>},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3850">>},
           {resource,<<"res1">>}],
          [{event_client,
             [{event_manager,<0.120047.0>},
            {server,<<"localhost">>},
            {username,
              <<"alicE_send_last_published_item_no_items_test_3850">>},
            {resource,<<"res1">>}]},
           {resource,<<"res1">>},
           {username,
             <<"alice_send_last_published_item_no_items_test_3850">>},
           {server,<<"localhost">>},
           {host,<<"localhost">>},
           {port,5222},
           {auth,fun escalus_auth:auth_plain/2},
           {wspath,undefined},
           {username,
             <<"alicE_send_last_published_item_no_items_test_3850">>},
           {server,<<"localhost">>},
           {password,<<"matygrysa">>},
           {stream_id,<<"dde7f30725af113f">>}]},
        5000],
       [{file,
          "/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
        {line,136}]},
     {pubsub_tools,receive_response,3,
       [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
        {line,434}]},
     {pubsub_tools,receive_and_c...

Report log


pgsql_mnesia_27 / pgsql_mnesia / e3a603d
Reports root/ big
OK: 5583 / Failed: 0 / User-skipped: 128 / Auto-skipped: 0


mssql_mnesia_27 / odbc_mssql_mnesia / e3a603d
Reports root/ big
OK: 5578 / Failed: 0 / User-skipped: 133 / Auto-skipped: 0


ldap_mnesia_27 / ldap_mnesia / e3a603d
Reports root/ big
OK: 22 / Failed: 0 / User-skipped: 0 / Auto-skipped: 0

@chrzaszcz
chrzaszcz marked this pull request as ready for review April 7, 2025 10:25

@NelsonVides NelsonVides left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks fantastic to me, very neat, thank you! 😄

Base automatically changed from listeners/organize-config-options to feature/listeners April 7, 2025 13:02

@jacekwegr jacekwegr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me! 👍

@jacekwegr
jacekwegr merged commit 79e8f17 into feature/listeners Apr 7, 2025
@jacekwegr
jacekwegr deleted the listeners/fixes branch April 7, 2025 16:31
@jacekwegr jacekwegr added this to the 6.4.0 milestone May 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants