Skip to content

Maintenance/cleanup api server #1578

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

Merged

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented Jun 22, 2020

What do these changes do?

During the design of this first version, there were many variants of the design that remained in the code. This PR cleans up all the deprecated code before extending it with new features. Some relevant changes:

  • Pruned and upgraded requirements
  • Removed trials sandbox folder
  • Removed unused models, db repos and routes
  • Left only basic authentication
  • Added client wrapper for webserver sessions (see osparc-simcore/services/api-server/src/simcore_service_api_server/services/webserver.py)
  • Reverted logger from loguru to default python logger
  • documented dev: services/api-server/README.md

Some of the code that was removed will probably be reintegrated when actually needed (e.g. other authentication schemes)

How to test

unit testing in

make devenv
cd services/api-tests
make install-dev tests

and read README.md for manual tests of the API

Checklist

  • Did you change any service's API? Then make sure to bundle document and upgrade version (make openapi-specs, git commit ... and then make version-*)
  • Unit tests for the changes exist (partially)
  • Runs in the swarm
  • Documentation reflects the changes
  • New module? Add your github username to .github/CODEOWNERS

@pcrespov pcrespov added the a:api framework api, data schemas, label Jun 22, 2020
@pcrespov pcrespov added this to the Huo Guo milestone Jun 22, 2020
@pcrespov pcrespov self-assigned this Jun 22, 2020
@codecov
Copy link

codecov bot commented Jun 22, 2020

Codecov Report

Merging #1578 into master will increase coverage by 1.0%.
The diff coverage is 53.2%.

Impacted file tree graph

@@           Coverage Diff            @@
##           master   #1578     +/-   ##
========================================
+ Coverage    72.4%   73.4%   +1.0%     
========================================
  Files         282     271     -11     
  Lines       10908   10721    -187     
  Branches     1191    1172     -19     
========================================
- Hits         7900    7873     -27     
+ Misses       2662    2504    -158     
+ Partials      346     344      -2     
Flag Coverage Δ
#integrationtests 56.7% <ø> (ø)
#unittests 67.0% <53.2%> (+0.9%) ⬆️
Impacted Files Coverage Δ
...imcore_service_api_server/db/repositories/_base.py 71.4% <ø> (ø)
...mcore_service_api_server/services/serialization.py 0.0% <ø> (ø)
...src/simcore_service_api_server/api/routes/users.py 48.0% <25.0%> (+10.8%) ⬆️
...c/simcore_service_api_server/services/webserver.py 52.6% <40.8%> (-23.2%) ⬇️
...vice_api_server/api/dependencies/authentication.py 50.0% <50.0%> (-50.0%) ⬇️
...rver/src/simcore_service_api_server/core/events.py 78.5% <60.0%> (-5.5%) ⬇️
...e_service_api_server/api/dependencies/webserver.py 57.6% <66.6%> (+5.8%) ⬆️
...ver/src/simcore_service_api_server/core/openapi.py 59.3% <66.6%> (+1.3%) ⬆️
...ore_service_api_server/db/repositories/api_keys.py 52.6% <75.0%> (+2.6%) ⬆️
...imcore_service_api_server/services/remote_debug.py 50.0% <75.0%> (+3.3%) ⬆️
... and 8 more

@pcrespov pcrespov force-pushed the maintenance/cleanup-api-server branch from 26edffc to 1e1e00b Compare June 23, 2020 22:46
@pcrespov pcrespov marked this pull request as ready for review June 23, 2020 22:46
@pcrespov pcrespov requested review from sanderegg and GitHK June 23, 2020 22:46
Copy link
Contributor

@GitHK GitHK left a comment

Choose a reason for hiding this comment

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

OK, had a comment for one of your comments.
As far as authentication goes we'd might want to migrate to something more microservice oriented.

Copy link
Member

@sanderegg sanderegg left a comment

Choose a reason for hiding this comment

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

deleting stuff is always good!
2 questions in the comments.
👍

@pcrespov pcrespov merged commit a329aea into ITISFoundation:master Jun 24, 2020
@pcrespov pcrespov deleted the maintenance/cleanup-api-server branch June 24, 2020 10:52
@odeimaiz odeimaiz mentioned this pull request Aug 4, 2020
odeimaiz added a commit that referenced this pull request Aug 4, 2020
- UI/UX improvements (#1657)
- Bump yarl from 1.4.2 to 1.5.1 in /packages/postgres-database (#1665)
- Bump ujson from 3.0.0 to 3.1.0 in /packages/service-library (#1664)
- Bump pytest-docker from 0.7.2 to 0.8.0 in /packages/service-library (#1647)
- Improving storage performance (#1659)
- Bump aiozipkin from 0.6.0 to 0.7.0 in /packages/service-library (#1642)
- Theming (#1656)
- Platform stability:  (#1645)
- is1594 fix and re-activate e2e testing (#1620)
- 2 bugs fixed + Some improvements (#1634)
- Fixes default (#1640)
- Bump lodash from 4.17.15 to 4.17.19 (#1639)
- Is1585/cleanup storage (#1586)
- Fixes on publish studies handling (#1632)
- Some enhancements and bug fixes (#1608)
- Improve e2e  (#1631)
- filter studies by name before deleting them (#1629)
- Maintenance/upgrades test tools (#1628)
- Bugfix/concurent opening projects (#1598)
- Bugfix/allow reading groups anonymous user (#1615)
- Bump docker from 4.2.1 to 4.2.2 in /packages/postgres-database (#1605)
- fix testing if node has gpu support (#1604)
- [bugfix] Invalidate cache before starting a study (#1602)
- Feature/fix e2e 2 (#1600)
- fix deploy not needing e2e testing since it is disabled
- reduce cardinality of metrics (#1593)
- Excudes e2e stage from include until fixed (#1595)
- Shared project concurrency (frontend) (#1591)
- Homogenize studies and services (#1569)
- [feature] UI Fine grained access - project locking and notification
- Bugfix/apiserver does not need sslheaders (#1564)
- Cleanup catalog service (#1582)
- Maintenance/cleanup api server (#1578)
- Adds support for GPU scheduling of computational services (#1553)
- Maintenance/upgrades and tooling (#1546)
- Is1570/study fails 500 (#1572)
- Bump faker from 4.1.0 to 4.1.1 in /packages/postgres-database (#1573)
- maintenance fix codecov reports (#1568)
- Manage groups, Share studies (#1512)
- Is/add notebook migration script (#1565)
- Is1269/api-server upgrade (#1475)
- added simcore_webserver_service in pytest simcore package (#1563)
- add traefik endpoint to api-gateway (#1555)
@sanderegg sanderegg mentioned this pull request Aug 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:api framework api, data schemas,
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants