✨ Announcements entrypoint at the web-api (⚠️ devops)

[pcrespov]

What do these changes do?

New plugin to handle public announcements:

• exposes GET /announcements entrypoint to list public announcements
  • View new openapi v0.25.0
• public announcements are stored in redis new database announcements (5). Currently added manually!
• NOTE: this is a first iteration on Publish and broadcast announcements to users osparc-issues#1006 so we can connect the front-end

Related issue/s

• counterpart of WIP ✨ Announcements #4423
• related to https://git.speag.com/oSparc/ti-solutions/-/issues/21
• implementing Publish and broadcast announcements to users osparc-issues#1006

How to test

• driving test

cd services/web/server
pytest tests/unit/with_dbs/02/test_announcements.py

DevOps

• ⚠️ web-server (i.e. not wb-db-event-listener or.env-wb-db-event-listener) must be configured with WEBSERVER_ANNOUNCEMENTS=1
• ⚠️ Activate in redis commander new db: announcements:${REDIS_HOST}:${REDIS_PORT}:5
• Request for ideas: GET /announcements entrypoint is opened
  • plugin can be enabled/disabled with envvar WEBSERVER_ANNOUNCEMENTS: bool
  • limit rate to this entrypoint (traeffik!) ?
  • Any extra suggestion?

[codecov]

Codecov Report

Merging #4487 (256434b) into master (eb5e00b) will increase coverage by 0.0%.
The diff coverage is 97.9%.

@@          Coverage Diff           @@
##           master   #4487   +/-   ##
======================================
  Coverage    86.4%   86.4%           
======================================
  Files        1013    1018    +5     
  Lines       43218   43305   +87     
  Branches     1006    1006           
======================================
+ Hits        37370   37455   +85     
- Misses       5616    5618    +2     
  Partials      232     232           

Flag	Coverage Δ
integrationtests	67.9% <63.2%> (-0.1%)	⬇️
unittests	84.1% <97.9%> (+<0.1%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ges/settings-library/src/settings_library/redis.py	0.0% <0.0%> (ø)
.../web/server/src/simcore_service_webserver/redis.py	95.6% <92.8%> (+0.1%)	⬆️
...rc/simcore_service_webserver/announcements/_api.py	100.0% <100.0%> (ø)
...mcore_service_webserver/announcements/_handlers.py	100.0% <100.0%> (ø)
...simcore_service_webserver/announcements/_models.py	100.0% <100.0%> (ø)
.../simcore_service_webserver/announcements/_redis.py	100.0% <100.0%> (ø)
.../simcore_service_webserver/announcements/plugin.py	100.0% <100.0%> (ø)
...erver/src/simcore_service_webserver/application.py	98.0% <100.0%> (+<0.1%)	⬆️
.../simcore_service_webserver/application_settings.py	98.2% <100.0%> (+<0.1%)	⬆️

... and 1 file with indirect coverage changes

[mrnicegyu11]

Thanks a lot very nice, just some thoughts from my side for this one :)

DevOps tasks are acknowledged, Currently the webserver gets almost all routing and it would be more than just some minutes work to implement a special rate-limit for this specific route. The announcements will be rate-limited just as all other API of the webserver, which was raised for the TIP deployment but is still set at some reasonable values.

[odeimaiz]

Thanks a lot!

I believe you miss increasing the --databases to 6 in services/docker-compose.yml

[mrnicegyu11]

@pcrespov your PR should propagate together with ITISFoundation/osparc-ops-environments#272 that includes the devops changes for the redis-commander

[matusdrobuliak66]

green from me 👍

[odeimaiz]

Tested and working as expected. Thanks!!

[codeclimate]

Code Climate has analyzed commit 256434b and detected 0 issues on this pull request.

View more on Code Climate.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication