✨ web-api: ProjectGet model adds new permalinks field

[pcrespov]

What do these changes do?

Preamble

A permalink is an url like https://osparc.io/study/{template_project_uuid} that when used in a browser it will copy the target template and open it as a standard project.

NOTE that for an unfortunate design decision (see #1975) https://osparc.io/#/study/{project_uuid} ( see # instead of /) is also defined in the front-end to open (not copy) a study BUT this is not considered in this definition of permalink .

NOTE also that there are some conditions for a study to have a permalink, e.g. it has to be a template.

Feature

In this PR ProjectGet schema in the API ( used in or as part of responses as GET /projects or GET /project/{project_id} ) adds a new optional field with permalink information:

permalink:
  title: ProjectPermalink
  required:
    - url
    - is_public
  type: object
  properties:
    url:
      title: Url
      maxLength: 2083
      minLength: 1
      type: string
      format: uri
    is_public:
      title: Is Public
      type: boolean

and example of data is

{
  {
     # ... 
    "dev": {},
    "permalink": {
      "url": "http://127.0.0.1:9081/study/43365f42-eb64-11ed-a1d1-02420a000016",
      "is_public": true
    }
  }
}

Implementation details

The implementation follows a design that decouples the part that creates the permalink (in the studies_dispatcher plugin) and the part that assigns the value in the ProjectGet model (in the projects plugin): the permalink field is computed using an external callback that is implemented in the studies_dispatcher plugin (who define permalinks) and is registered in the projects plugin (who exposes and defines the project resource) upon startup (see setup_studies_dispatcher).

Highlights

• web-api version: 0.18.0 → 0.19.0
• Note that permalink field in ProjectGet is optional: If for some reason it cannot be created, then it will not be returned. Some reasons could be:
  • the studies_dispatcher plugin is disabled: therefore even having a permalink no study will be dispatched
  • the study does not follow the criteria to be assigned a permalink (see PermalinkNotAllowedError)
    • example: Failed to create permalink: Can only create permalink from a template project. Got project_uuid='ee592535-99ff-515f-be2a-07c0f92c7a35' with project_type=<ProjectType.STANDARD: 'STANDARD'>
  • something else went wrong: better not to provide that provide an incorrect permalink

Related issue/s

• jLab: you need to be logged in osparc-issues#829
• closes Link to share templates osparc-issues#806
• "Anonymous User Experience" Mode osparc-issues#929

How to test

• create a standard project
  • GET /project/uuid should NOT include permalink
• create a template and share with everyone
  • GET /project/uuid should include permalink

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[codecov]

Codecov Report

Merging #4008 (c86b6da) into master (8ebb2e3) will decrease coverage by 5.6%.
The diff coverage is 98.1%.

@@           Coverage Diff            @@
##           master   #4008     +/-   ##
========================================
- Coverage    85.5%   80.0%   -5.6%     
========================================
  Files         961     891     -70     
  Lines       41605   40235   -1370     
  Branches      953     822    -131     
========================================
- Hits        35599   32188   -3411     
- Misses       5789    7857   +2068     
+ Partials      217     190     -27     

Flag	Coverage Δ
integrationtests	77.4% <ø> (+10.0%)	⬆️
unittests	79.0% <98.1%> (-3.4%)	⬇️

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

Impacted Files	Coverage Δ
...c/servicelib/aiohttp/long_running_tasks/_server.py	89.5% <83.3%> (ø)
...c/simcore_service_webserver/projects/_permalink.py	97.5% <97.5%> (ø)
...ackages/models-library/src/models_library/users.py	100.0% <100.0%> (ø)
...imcore_service_webserver/projects/_create_utils.py	96.8% <100.0%> (+0.1%)	⬆️
...imcore_service_webserver/projects/_rest_schemas.py	100.0% <100.0%> (ø)
...rver/src/simcore_service_webserver/projects/api.py	100.0% <100.0%> (ø)
..._service_webserver/projects/projects_exceptions.py	84.3% <100.0%> (-9.4%)	⬇️
...rvice_webserver/projects/projects_handlers_crud.py	87.5% <100.0%> (-0.4%)	⬇️
...bserver/studies_dispatcher/_projects_permalinks.py	100.0% <100.0%> (ø)
...ore_service_webserver/studies_dispatcher/plugin.py	100.0% <100.0%> (ø)

... and 210 files with indirect coverage changes

[sanderegg]

great! a few minor comments.

[sanderegg]

great! a few minor comments.

[GitHK]

👍

[codeclimate]

Code Climate has analyzed commit c86b6da 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.6% Duplication

[pcrespov]

🚨

• test in master (see "How to test" section)