✨ Adds custom project's metadata in the webserver API

[pcrespov]

What do these changes do?

Implements get/update_project_metadata operations on web-server side for this exchange with the public-api to manage custom metadata (i.e. user-defined) on a project

sequenceDiagram
        participant API
        participant AS as api-server
        participant WS as web-server
        link API: OAS @ https://editor.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/master/services/api-server/openapi.json
        link WS: OAS @ https://editor.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/master/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml
    
        API->>+AS: get/update_job_metadata(JobMetadataReplace)
        AS->>+WS: get/update_project_metadata(ProjectMetadataReplace)
        WS-->>-AS: ProjectMetadataGet
        AS-->>-API: JobMetadata

Loading

The connection with the api-server will be done in a separate PR for clarity.

The project metadata is then stored in the database in a new table projects_metadata. This table should keep "third-party" metadata attached to a project. This info SHOULD NOT be actual properties of the project (e.g. uuid, name etc) but rather extra information attached by third-parties that "decorate" or qualify a project resource. e.g. things like 'stars', 'quality', 'classifiers', 'dev', etc (or any kind of stats) should be moved here. This is an ERD with some of the tables associated to the projects table

Highlights

• Adds projects/{project_id}/metadata/custom project's sub-resource webserver API (v0.24.0)
  • implemented as a singleton sub-resource of projects
  • splits controller-service-repository, i.e. _handlers, _api, _db
  • Added api for "project's access rights"
• 🗃️ Adds "joinable" projects_metadata to include (for now) user custom metadata.
  • Limited to key-value map

Related issue/s

• Implementing PublicAPI: Allow to list all created jobs (support paging) #4110
• Implementing Jobs API custom and client-context metadata #4313

How to test

• Driving test for database/repository
  • packages/postgres-database/tests/test_utils_projects_metadata.py
• Driving test for web-server:
  • services/web/server/tests/unit/with_dbs/02/test_projects_metadata_handlers.py

DevOps

• 🗃️ New projects_metadata table

NOTE: copy & paste diagrams in https://mermaid.live/

[codecov]

Codecov Report

Merging #4421 (9d263d8) into master (afc1eb0) will decrease coverage by 0.4%.
The diff coverage is 90.5%.

@@           Coverage Diff            @@
##           master   #4421     +/-   ##
========================================
- Coverage    82.8%   82.5%   -0.4%     
========================================
  Files         944     898     -46     
  Lines       40385   39595    -790     
  Branches      972     584    -388     
========================================
- Hits        33452   32671    -781     
- Misses       6723    6787     +64     
+ Partials      210     137     -73     

Flag	Coverage Δ
integrationtests	61.3% <66.4%> (+21.6%)	⬆️
unittests	80.8% <90.5%> (-1.8%)	⬇️

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

Impacted Files	Coverage Δ
...library/api_schemas_webserver/projects_metadata.py	0.0% <0.0%> (ø)
...c/simcore_service_api_server/api/routes/solvers.py	51.2% <ø> (ø)
...core_service_webserver/exporter/_formatter/_sds.py	56.9% <50.0%> (+29.1%)	⬆️
...mcore_service_webserver/projects/_handlers_crud.py	80.9% <50.0%> (+12.8%)	⬆️
...e_service_webserver/projects/_access_rights_api.py	88.8% <88.8%> (ø)
...simcore_service_webserver/projects/_metadata_db.py	92.0% <92.0%> (ø)
...e_service_webserver/projects/_metadata_handlers.py	95.2% <95.2%> (ø)
...core_postgres_database/models/projects_metadata.py	100.0% <100.0%> (ø)
...mcore_postgres_database/utils_projects_metadata.py	100.0% <100.0%> (ø)
...re_service_webserver/projects/_access_rights_db.py	100.0% <100.0%> (ø)
... and 9 more

... and 260 files with indirect coverage changes

[matusdrobuliak66]

looking good 👍

[GitHK]

please ask for a review again when this is done.

[sanderegg]

very nice, please consider my comments

[bisgaard-itis]

LGTM

[codeclimate]

Code Climate has analyzed commit 9d263d8 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