♻️ Refactoring of APIs for computations in web-server, api-server and directorv2

[pcrespov]

What do these changes do?

Cleanup of APIs related to computations in the web-api (web-server rest API), director-v2 (rest API) and finally the public-api (api-server's rest API).

web-api (web-server):

Some refactoring in thedirector-v2 domain in the web-server which is in charge of connecting with the directorv2 micro-service (i.e. services/web/server/src/simcore_service_webserver/director_v2)

• refactor skeleton to include controler/service/repository (none) layers

src/simcore_service_webserver/director_v2
├── _controller
│   ├── __init__.py
│   ├── _rest_exceptions.py  # exception handling for rest
│   └── rest.py              # rest handlers
├── __init__.py
├── _client_base.py          
├── _client.py               # http client to the directorv-2 micro-service rest API
├── _service_abc_default.py  # default implementation of that ABC 
├── _service_abc.py          # service ABC to change run policy
├── _service.py              # service layer interface (private)
├── director_v2_service.py   # service layer interface (public) exposed to other domains
├── plugin.py
├── exceptions.py
└── settings.py

• ♻️ /_handlers.py -> renamed /_contoller/rest.py
  • moved all schemas to packages/models-library/src/models_library/api_schemas_webserver/computations.py
    • For now we avoid enforcing camelcase
  • using parse_request_* functions
  • moved all exception handling to _rest_exceptions
• ♻️ cleanup dependencies and api-specs in api/specs/web-server/_computations.py

directorv2

• docs better rest API entrypoints for the /computations collection

public-api (api-server)

• uses directorv2 schema on client
• drops unused functions

Related issue/s

• Part of Define web.api openapi specs for the tasks table in the front-end #7516
• Will follow up with Maintenance: Use webserver/director_v2._client in the implementation of _services #7527

How to test

tests in place

Dev-ops

[codecov]

Codecov Report

Attention: Patch coverage is 91.34948% with 25 lines in your changes missing coverage. Please review.

Project coverage is 88.16%. Comparing base (aac0abd) to head (ae4df2a).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7520      +/-   ##
==========================================
+ Coverage   87.44%   88.16%   +0.71%     
==========================================
  Files        1740     1725      -15     
  Lines       67432    66412    -1020     
  Branches     1144     1144              
==========================================
- Hits        58968    58554     -414     
+ Misses       8143     7537     -606     
  Partials      321      321              

Flag	Coverage Δ
integrationtests	65.24% <84.43%> (-0.04%)	⬇️
unittests	86.66% <89.96%> (+0.04%)	⬆️

Components	Coverage Δ
api	76.84% <ø> (ø)
pkg_aws_library	93.91% <ø> (ø)
pkg_dask_task_models_library	97.09% <ø> (ø)
pkg_models_library	91.98% <93.75%> (+0.02%)	⬆️
pkg_notifications_library	85.26% <ø> (ø)
pkg_postgres_database	88.18% <ø> (ø)
pkg_service_integration	70.03% <ø> (ø)
pkg_service_library	72.65% <ø> (ø)
pkg_settings_library	90.79% <ø> (ø)
pkg_simcore_sdk	85.40% <ø> (ø)
agent	96.46% <ø> (ø)
api_server	90.26% <100.00%> (+0.23%)	⬆️
autoscaling	96.08% <ø> (ø)
catalog	92.52% <ø> (ø)
clusters_keeper	99.24% <ø> (ø)
dask_sidecar	91.29% <ø> (ø)
datcore_adapter	98.12% <ø> (ø)
director	76.78% <ø> (ø)
director_v2	91.30% <100.00%> (-0.13%)	⬇️
dynamic_scheduler	97.40% <ø> (ø)
dynamic_sidecar	90.16% <ø> (+0.04%)	⬆️
efs_guardian	89.79% <ø> (ø)
invitations	93.28% <ø> (ø)
payments	92.66% <ø> (ø)
resource_usage_tracker	89.29% <ø> (+0.16%)	⬆️
storage	87.59% <ø> (+0.07%)	⬆️
webclient	∅ <ø> (∅)
webserver	88.27% <89.95%> (+2.39%)	⬆️

---

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 c8e880a...ae4df2a. Read the comment docs.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[matusdrobuliak66]

👍 Thanks

[pcrespov]

@mergify queue

[mergify]

queue

🟠 Waiting for conditions to match

• -closed [📌 queue requirement]
• any of: [🔀 queue conditions]
  • all of: [📌 queue conditions of queue default]
    • branch-protection-review-decision = APPROVED [🛡 GitHub branch protection]
    • any of: [🛡 GitHub branch protection]
      • check-neutral = check OAS' are up to date
      • check-skipped = check OAS' are up to date
      • check-success = check OAS' are up to date
    • #approved-reviews-by >= 2 [🛡 GitHub branch protection]
    • #approved-reviews-by>=2
    • #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
    • #changes-requested-reviews-by=0
    • #review-threads-unresolved = 0 [🛡 GitHub branch protection]
    • #review-threads-unresolved=0
    • -conflict
    • -draft
    • base=master
    • label!=🤖-do-not-merge
    • label=🤖-automerge
    • any of: [🛡 GitHub branch protection]
      • check-skipped = deploy to dockerhub
      • check-neutral = deploy to dockerhub
      • check-success = deploy to dockerhub
    • any of: [🛡 GitHub branch protection]
      • check-success = system-tests
      • check-neutral = system-tests
      • check-skipped = system-tests
    • any of: [🛡 GitHub branch protection]
      • check-success = unit-tests
      • check-neutral = unit-tests
      • check-skipped = unit-tests
    • any of: [🛡 GitHub branch protection]
      • check-success = integration-tests
      • check-neutral = integration-tests
      • check-skipped = integration-tests
    • any of: [🛡 GitHub branch protection]
      • check-success = [build] docker images (excluding frontend) (3.11, ubuntu-24.04)
      • check-neutral = [build] docker images (excluding frontend) (3.11, ubuntu-24.04)
      • check-skipped = [build] docker images (excluding frontend) (3.11, ubuntu-24.04)
• -conflict [📌 queue requirement]
• -draft [📌 queue requirement]
• any of: [📌 queue -> configuration change requirements]
  • -mergify-configuration-changed
  • check-success = Configuration changed

[Copilot]

Copilot reviewed 42 out of 43 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

• services/director-v2/openapi.json: Language not supported

Comments suppressed due to low confidence (1)

services/api-server/src/simcore_service_api_server/services_http/director_v2.py:88

• [nitpick] The nested usage of model validation (wrapping DirectorV2ComputationGet.model_validate_json(response.text) inside ComputationTaskGet.model_validate) could be simplified to improve clarity. Consider refactoring to directly use a single validation step with the proper flags if supported.

return ComputationTaskGet.model_validate(

[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