✨payments service: notification of payments to the front-end via socketio

[pcrespov]

What do these changes do?

This PR implements socketio link between the payments and the webserver services. This link is used to notify payment completion to the front-end.

NOTE: This PR adds the functionality but the two services are still not connected. This will be done in a separate PR !

• payments/gateway:
  • 📝 Adds openapi specs for gateway in gateway/openapi.json
  • 🔨 Includes scripts in an example implementation that can be used for development. NOTE that this is installed with the payments package and therefore available in the $PATH after installation. i.e. this will create a gateway

      cd services/payments
      make install-dev
      example_payment_gateway.py run

• 🎨 webserver's wallets/_payments_handlers.py: Improves notification with a small delay in payment w/ payment-method ack which is directly performed at the web-servers handler (remember that this type of payment is done in one call and not using the init-prompt-ack flow)

Related issue/s

• Last feature of One-time-payment in payment service #4657

How to test

• Driving test services/payments/tests/unit/test_services_socketio.py

Dev Checklist

• No ENV changes or I properly updated ENV (read the instruction)

DevOps

None

[codecov]

Codecov Report

Merging #5057 (453d955) into master (482c544) will increase coverage by 6.9%.
The diff coverage is 51.2%.

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #5057      +/-   ##
=========================================
+ Coverage    79.9%   86.8%    +6.9%     
=========================================
  Files        1226     669     -557     
  Lines       50098   31971   -18127     
  Branches     1124     577     -547     
=========================================
- Hits        40051   27767   -12284     
+ Misses       9807    4072    -5735     
+ Partials      240     132     -108     

Flag	Coverage Δ
integrationtests	60.9% <83.3%> (-4.0%)	⬇️
unittests	86.2% <51.2%> (+7.6%)	⬆️

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

Files	Coverage Δ
packages/service-library/src/servicelib/utils.py	82.3% <100.0%> (ø)
...ice_webserver/notifications/_rabbitmq_consumers.py	90.8% <100.0%> (+0.1%)	⬆️
...rc/simcore_service_webserver/payments/_socketio.py	100.0% <100.0%> (+41.6%)	⬆️
...simcore_service_webserver/projects/projects_api.py	87.0% <100.0%> (+39.5%)	⬆️
...rc/simcore_service_webserver/socketio/_handlers.py	85.1% <100.0%> (+3.9%)	⬆️
...src/simcore_service_webserver/socketio/messages.py	94.2% <100.0%> (-0.6%)	⬇️
...r/src/simcore_service_webserver/socketio/server.py	100.0% <100.0%> (ø)
...re_service_webserver/wallets/_payments_handlers.py	100.0% <100.0%> (+41.6%)	⬆️
...s/service-library/src/servicelib/socketio_utils.py	0.0% <0.0%> (ø)

... and 836 files with indirect coverage changes

[sanderegg]

very nice!

[matusdrobuliak66]

cool! thanks

[codeclimate]

Code Climate has analyzed commit 453d955 and detected 0 issues on this pull request.

View more on Code Climate.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.4% Duplication

[bisgaard-itis]

@pcrespov sorry, I didn't manage to review before the PR got in. But I really like this and I think it would be very useful to have this somewhere in one of the packages. I guess one could do this with any of the test servers we are using, right?