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

Service cache docs #2347

Merged
merged 4 commits into from
Jun 25, 2019
Merged

Service cache docs #2347

merged 4 commits into from
Jun 25, 2019

Conversation

ludwikbukowski
Copy link
Contributor

No description provided.

Copy link
Member

@fenek fenek left a comment

Choose a reason for hiding this comment

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

Please describe relation to service_admin_extra (dependency) and how it benefits this service.

@mongoose-im
Copy link
Collaborator

mongoose-im commented Jun 25, 2019

6722.1 / Erlang 20.3 / small_tests / 80081a4
Reports root / small


6722.2 / Erlang 20.3 / internal_mnesia / 80081a4
Reports root/ big
OK: 1253 / Failed: 1 / User-skipped: 167 / Auto-skipped: 0

pubsub_SUITE:tree+basic:subscribe_options_test
{error,{{badmatch,{{<<"pubsub#deliver">>,<<"boolean">>,<<"false">>},
           <<"pubsub#deliver">>}},
    [{pubsub_tools,'-verify_form_values/2-fun-0-',2,
             [{file,"pubsub_tools.erl"},{line,627}]},
     {lists,foreach,2,[{file,"lists.erl"},{line,1338}]},
     {pubsub_SUITE,'-subscribe_options_test/1-fun-1-',3,
             [{file,"pubsub_SUITE.erl"},{line,420}]},
     {escalus_story,story,4,
            [{file,"/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,72}]},
     {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1546}]},
     {test_server,run_test_case_eval1,6,
            [{file,"test_server.erl"},{line,1062}]},
     {test_server,run_test_case_eval,9,
            [{file,"test_server.erl"},{line,994}]}]}}

Report log


6722.3 / Erlang 20.3 / odbc_mssql_mnesia / 80081a4
Reports root/ big
OK: 3143 / Failed: 0 / User-skipped: 278 / Auto-skipped: 0

@mongoose-im
Copy link
Collaborator

mongoose-im commented Jun 25, 2019

6723.1 / Erlang 20.3 / small_tests / 6861bf0
Reports root / small


6723.2 / Erlang 20.3 / internal_mnesia / 6861bf0
Reports root/ big
OK: 1260 / Failed: 1 / User-skipped: 167 / Auto-skipped: 0

sm_SUITE:parallel:subscription_requests_are_buffered_properly
{error,{{badmatch,false},
    [{escalus_session,stream_management,2,
              [{file,"/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_session.erl"},
               {line,240}]},
     {escalus_connection,connection_step,2,
               [{file,"/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_connection.erl"},
                {line,154}]},
     {lists,foldl,3,[{file,"lists.erl"},{line,1263}]},
     {escalus_connection,start,2,
               [{file,"/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_connection.erl"},
                {line,138}]},
     {sm_SUITE,'-subscription_requests_are_buffered_properly/1-fun-3-',6,
           [{file,"sm_SUITE.erl"},{line,848}]},
     {escalus_story,story,4,
            [{file,"/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,72}]},
     {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1546}]},
     {test_server,run_test_case_eval1,6,
            [{file,"test_server.erl"},{line,1062}]}]}}

Report log


6723.3 / Erlang 20.3 / odbc_mssql_mnesia / 6861bf0
Reports root/ big
OK: 3143 / Failed: 0 / User-skipped: 278 / Auto-skipped: 0


6723.4 / Erlang 20.3 / ldap_mnesia / 6861bf0
Reports root/ big
OK: 1199 / Failed: 0 / User-skipped: 206 / Auto-skipped: 0


6723.5 / Erlang 20.3 / elasticsearch_and_cassandra_mnesia / 6861bf0
Reports root/ big
OK: 532 / Failed: 0 / User-skipped: 55 / Auto-skipped: 0


6723.8 / Erlang 21.3 / mysql_redis / 6861bf0
Reports root/ big
OK: 3144 / Failed: 1 / User-skipped: 280 / Auto-skipped: 0

pubsub_SUITE:tree+hometree_specific:can_create_node_with_existing_parent_path
{error,
  {timeout_when_waiting_for_stanza,
    [{escalus_client,wait_for_stanza,
       [{client,<<"alicE17.347718@localhost/res1">>,escalus_tcp,
          <0.17263.3>,
          [{event_manager,<0.17250.3>},
           {server,<<"localhost">>},
           {username,<<"alicE17.347718">>},
           {resource,<<"res1">>}],
          [{event_client,
             [{event_manager,<0.17250.3>},
            {server,<<"localhost">>},
            {username,<<"alicE17.347718">>},
            {resource,<<"res1">>}]},
           {resource,<<"res1">>},
           {username,<<"alicE17.347718">>},
           {server,<<"localhost">>},
           {host,<<"localhost">>},
           {port,5222},
           {auth,{escalus_auth,auth_plain}},
           {wspath,undefined},
           {username,<<"alicE17.347718">>},
           {server,<<"localhost">>},
           {password,<<"matygrysa">>},
           {stream_id,<<"50D9891382634C7F">>}]},
        5000],
       [{file,
          "/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_client.erl"},
        {line,136}]},
     {pubsub_tools,receive_response,3,
       [{file,"pubsub_tools.erl"},{line,457}]},
     {pubsub_tools,receive_and_check_response,4,
       [{file,"pubsub_tools.erl"},{line,448}]},
     {pubsub_SUITE,'-can_create_node_with_existing_parent_path/1-fun-0-',
       1,
       [{file,"pubsub_SUITE.erl"},{line,1767}]},
     {escalus_story,story,4,
       [{file,
          "/home/travis/build/esl/MongooseIM/...

Report log


6723.7 / Erlang 21.3 / pgsql_mnesia / 6861bf0
Reports root/ big / small
OK: 3182 / Failed: 1 / User-skipped: 246 / Auto-skipped: 0

sm_SUITE:parallel_manual_ack_freq_1:resume_session_state_stop_c2s
{error,{{assertion_failed,assert_many,true,
              [is_presence,#Fun<sm_SUITE.16.116926647>],
              [{xmlel,<<"presence">>,
                  [{<<"from">>,
                  <<"alicE76.715077@localhost/escalus-default-resource">>},
                   {<<"to">>,
                  <<"alice76.715077@localhost/escalus-default-resource">>},
                   {<<"xml:lang">>,<<"en">>}],
                  []},
               {xmlel,<<"presence">>,
                  [{<<"from">>,
                  <<"alicE76.715077@localhost/escalus-default-resource">>},
                   {<<"to">>,
                  <<"alice76.715077@localhost/escalus-default-resource">>},
                   {<<"xml:lang">>,<<"en">>}],
                  []}],
              "   <presence from='alicE76.715077@localhost/escalus-default-resource' to='alice76.715077@localhost/escalus-default-resource' xml:lang='en'/>   <presence from='alicE76.715077@localhost/escalus-default-resource' to='alice76.715077@localhost/escalus-default-resource' xml:lang='en'/>"},
    [{escalus_new_assert,assert_true,2,
               [{file,"/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
                {line,84}]},
     {sm_SUITE,resume_session_state_stop_c2s,1,
           [{file,"sm_SUITE.erl"},{line,581}]},
     {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1562}]},
     {test_server,run_test_case_eval1,6,
            [{file,"test_server.erl"},{line,1080}]},
     ...

Report log


6723.9 / Erlang 21.3 / riak_mnesia / 6861bf0
Reports root/ big / small
OK: 1489 / Failed: 0 / User-skipped: 149 / Auto-skipped: 0


### service_cache

Implementation of cache storage.

Choose a reason for hiding this comment

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

The implementation

### service_cache

Implementation of cache storage.
Module expose one function `lookup/2` with parameters `Key` and `Fun`.

Choose a reason for hiding this comment

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

module exposes one

@codecov
Copy link

codecov bot commented Jun 25, 2019

Codecov Report

❗ No coverage uploaded for pull request base (master@07a2fb5). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #2347   +/-   ##
=========================================
  Coverage          ?   72.59%           
=========================================
  Files             ?      335           
  Lines             ?    29287           
  Branches          ?        0           
=========================================
  Hits              ?    21262           
  Misses            ?     8025           
  Partials          ?        0

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 07a2fb5...b5b03be. Read the comment docs.


Implementation of cache storage.
Module expose one function `lookup/2` with parameters `Key` and `Fun`.
When called and the key `Key` exists in cache, the related value is returned.

Choose a reason for hiding this comment

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

when the function is called


### Example configuration
` {service_admin_extra, [{submods, [node, accounts, sessions]}]} `

Module `service_admin_extra` depens on `service_cache`(see below) as cache is efficiently used for `gdpr` submodule and GDPR compilant account removal.
Copy link
Member

Choose a reason for hiding this comment

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

depens -> depends

Copy link
Member

Choose a reason for hiding this comment

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

as the cache speeds up GDPR data retrieval and removal.?


### service_cache

The Implementation of cache storage.
Copy link
Member

Choose a reason for hiding this comment

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

Implementation -> implementation

@mongoose-im
Copy link
Collaborator

mongoose-im commented Jun 25, 2019

6728.1 / Erlang 20.3 / small_tests / 3e406bd
Reports root / small


6728.2 / Erlang 20.3 / internal_mnesia / 3e406bd
Reports root/ big
OK: 1238 / Failed: 0 / User-skipped: 167 / Auto-skipped: 0


6728.4 / Erlang 20.3 / ldap_mnesia / 3e406bd
Reports root/ big
OK: 1214 / Failed: 1 / User-skipped: 206 / Auto-skipped: 0

pubsub_SUITE:dag+basic:subscribe_unsubscribe_test
{error,{{badmatch,false},
    [{pubsub_tools,check_response,2,
             [{file,"pubsub_tools.erl"},{line,468}]},
     {pubsub_tools,receive_response,3,
             [{file,"pubsub_tools.erl"},{line,458}]},
     {pubsub_tools,receive_and_check_response,4,
             [{file,"pubsub_tools.erl"},{line,448}]},
     {escalus_story,story,4,
            [{file,"/home/travis/build/esl/MongooseIM/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,72}]},
     {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1546}]},
     {test_server,run_test_case_eval1,6,
            [{file,"test_server.erl"},{line,1062}]},
     {test_server,run_test_case_eval,9,
            [{file,"test_server.erl"},{line,994}]}]}}

Report log


6728.3 / Erlang 20.3 / odbc_mssql_mnesia / 3e406bd
Reports root/ big
OK: 3143 / Failed: 0 / User-skipped: 278 / Auto-skipped: 0


### Example configuration
` {service_admin_extra, [{submods, [node, accounts, sessions]}]} `

Module `service_admin_extra` depends on `service_cache`(see below) as the cache speeds up GDPR data retrieval and removal.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Module `service_admin_extra` depends on `service_cache`(see below) as the cache speeds up GDPR data retrieval and removal.
The `service_admin_extra` module depends on the`service_cache`(see below) as the cache speeds up GDPR data retrieval and removal.


### service_cache

The implementation of cache storage.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The implementation of cache storage.
Implementation of the cache storage.

not sure which one sounds better

### service_cache

The implementation of cache storage.
Module exposes one function `lookup/2` with parameters `Key` and `Fun`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Module exposes one function `lookup/2` with parameters `Key` and `Fun`.
The module exposes a function `lookup/2` with parameters `Key` and `Fun`.

@fenek fenek merged commit b33de16 into master Jun 25, 2019
@fenek fenek deleted the service-cache-docs branch June 25, 2019 14:27
@fenek fenek added this to the 3.4.0 milestone Jun 26, 2019
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.

5 participants