🎨 Enhances Iicence feature: new vendor phantoms and licensed-resource-data id (🚨)

[pcrespov]

What do these changes do?

Enhancements of the licenses feature:

• web-api: missing id needed by the front-end (requested by @odeimaiz )
• Can register speag phantoms as licensed-items (requested by @mguidon )

Related issue/s

• part of VIP Models: Data Structure osparc-issues#1823
• part of https://github.com/ITISFoundation/private-issues/issues/4

How to test

Manually tested in local deploy setting .env with envs in osparc-config MR

• produced 111 NEWLY_REGISTERED entries including ComputationalPhantoms

web-api

• The web-api GET v0/catalog/licensed-items responds with

{
 # ...
  "data": [
    {
      "licensedItemId": "5a66b856-b116-4309-a2f9-d3224f818326",
      "displayName": "SHO-RC-V1 V1.0",
      "licensedResourceType": "VIP_MODEL",
      "licensedResourceData": {
        "categoryId": "ComputationalPhantom",
        "categoryDisplay": "Phantom of the Opera",
        "source": {
          "id": 78,
          "description": "SPEAG Posable Hand Phantom for Clamshell Phones - Right",
          "thumbnail": "https://speag.swiss/assets/images/Sim4Life/semshorc.png",
          "features": {
            "name": "SHO-RC-V1",
            "version": "V1.0",
            "date": "2024-11-05",
            "functionality": "Posable"
          },
          "doi": null
        },
        "termsOfUseUrl": null
      },
      "pricingPlanId": 1,
      "createdAt": "2025-02-06T12:38:54.079488Z",
      "modifiedAt": "2025-02-06T12:38:54.079488Z"
    }
  ]
}

• @odeimaiz please check and confirm that everything you need is provided in the response above. thx

public-api

GET /licensed-items produces

{
  "items": [
    {
      "licensed_item_id": "5a66b856-b116-4309-a2f9-d3224f818326",
      "display_name": "SHO-RC-V1 V1.0",
      "licensed_resource_type": "VIP_MODEL",
      "licensed_resource_data": {
        "source": {
          "id": 78,
          "doi": null,
          "features": {
            "date": "2024-11-05",
            "name": "SHO-RC-V1",
            "version": "V1.0",
            "functionality": "Posable"
          },
          "thumbnail": "https://speag.swiss/assets/images/Sim4Life/semshorc.png",
          "protection": "Code",
          "description": "SPEAG Posable Hand Phantom for Clamshell Phones - Right",
          "license_key": "MODEL_SEMSHO_RC",
          "license_version": "V1.0",
          "available_from_url": null
        },
        "category_id": "ComputationalPhantom",
        "category_display": "Phantom of the Opera"
      },
      "pricing_plan_id": 1,
      "created_at": "2025-02-06T12:38:54.079488Z",
      "modified_at": "2025-02-06T12:38:54.079488Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0,
  "links": {
    "first": "/v0/licensed-items?limit=20&offset=0",
    "last": "/v0/licensed-items?limit=20&offset=0",
    "self": "/v0/licensed-items?limit=20&offset=0",
    "next": null,
    "prev": null
  }
}

• @mguidon please check and confirm that everything you need is in the response above. thx

Dev-ops

• new env-vars for speag vendor

   LICENSES_SPEAG_PHANTOMS_API_URL
   LICENSES_SPEAG_PHANTOMS_CATEGORIES

• Review changes in osparc-config repo in MR
• 🚨 check that the deploy enables/disables licensed items

[codecov]

Codecov Report

Attention: Patch coverage is 64.28571% with 10 lines in your changes missing coverage. Please review.

Project coverage is 87.24%. Comparing base (a8a8046) to head (3aaea4c).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7179      +/-   ##
==========================================
- Coverage   87.66%   87.24%   -0.43%     
==========================================
  Files        1641     1634       -7     
  Lines       64171    63998     -173     
  Branches     1179     1179              
==========================================
- Hits        56255    55832     -423     
- Misses       7605     7855     +250     
  Partials      311      311              

Flag	Coverage Δ		*Carryforward flag
integrationtests	64.61% <ø> (+<0.01%)	⬆️	Carriedforward from 92046e7
unittests	85.52% <64.28%> (-1.11%)	⬇️

*This pull request uses carry forward flags. Click here to find out more.

Components	Coverage Δ
api	∅ <ø> (∅)
pkg_aws_library	94.02% <ø> (ø)
pkg_dask_task_models_library	97.09% <ø> (ø)
pkg_models_library	91.45% <100.00%> (+<0.01%)	⬆️
pkg_notifications_library	84.57% <ø> (ø)
pkg_postgres_database	88.39% <ø> (ø)
pkg_service_integration	70.03% <ø> (ø)
pkg_service_library	74.13% <ø> (ø)
pkg_settings_library	90.71% <ø> (ø)
pkg_simcore_sdk	85.50% <ø> (ø)
agent	96.46% <ø> (ø)
api_server	90.55% <ø> (ø)
autoscaling	96.08% <ø> (ø)
catalog	90.33% <ø> (ø)
clusters_keeper	99.24% <ø> (ø)
dask_sidecar	91.26% <ø> (ø)
datcore_adapter	93.19% <ø> (ø)
director	51.25% <ø> (-25.68%)	⬇️
director_v2	91.29% <ø> (-0.02%)	⬇️
dynamic_scheduler	97.17% <ø> (ø)
dynamic_sidecar	89.75% <ø> (ø)
efs_guardian	90.25% <ø> (ø)
invitations	93.28% <ø> (ø)
osparc_gateway_server	∅ <ø> (∅)
payments	92.66% <ø> (ø)
resource_usage_tracker	88.73% <ø> (-0.22%)	⬇️
storage	89.57% <ø> (ø)
webclient	∅ <ø> (∅)
webserver	86.21% <60.00%> (-0.01%)	⬇️

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a8a8046...3aaea4c. Read the comment docs.

[mguidon]

Gracias. Ping me when this goes live

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[odeimaiz]

Saw it live 👌