What do these changes do?

The main motiviation to this PR was to fix the 503 response from get_project_services in the web-api when a service listed in one of the project nodes is not anymore part of the catalog.

We took the opportunity to:

• Introduces generic batch operations models for handling partial success scenarios (for any interface)
• Updates the API to return missing services in addition to found ones
• Refactors batch-get operations throughout the catalog service to use the new envelope pattern

Highlights

• 🐛 Fixes 503 response from GET /v0/projects/{project_id}/nodes/-/services when one of the services in the project was not found int he catalog:

{
  "error_code": "OEC:83e338830cbb-1759912388229",
  "context": {
    "request": "<Request GET /v0/projects/fe9494f6-e2ad-5970-b860-e6cb97dc25ce/nodes/-/services >",
    "request.method": "GET",
    "request.path": "/v0/projects/fe9494f6-e2ad-5970-b860-e6cb97dc25ce/nodes/-/services",
    "error_code": "OEC:83e338830cbb-1759912388229",
    "user_id": 6,
    "product_name": "osparc",
    "services_ids": [
      [
        "simcore/services/dynamic/cc-1d-viewer",
        "3.0.3"
      ],
      [
        "simcore/services/frontend/file-picker",
        "1.0.0"
      ],
      [
        "simcore/services/comp/rabbit-ss-0d-cardiac-model",
        "1.0.0"
      ],
      [
        "simcore/services/comp/rabbit-ss-1d-cardiac-model",
        "1.0.0"
      ],
      [
        "simcore/services/comp/rabbit-ss-2d-cardiac-model",
        "1.0.0"
      ],
      [
        "simcore/services/dynamic/cc-0d-viewer",
        "3.0.3"  <----------this was not in the catalog
      ]
    ],
    "message": "Catalog service failed unexpectedly",
    "code": "CatalogApiBaseError.CatalogNotAvailableError"
  },
  "tip": null
}

This is because the underlying batch-get operations did not allow partial failure and one of the services in the project is not in the catalog.

Now that endpoints returns missing services in the response payload (see changes in OAS)

• ✨ introduces generics to build models for batch operations
• ✨ @odeimaiz new missing field in the GET /v0/projects/{project_id}/nodes/-/services response model that include a list of key/value tuples of missing services

In Detail (AI generated)

This pull request introduces a new generic batch-get envelope model for service retrieval operations, enabling partial success responses and improved error handling when some requested services are missing. It refactors the batch-get endpoints and service logic to use this new model, ensures deduplication and validation of input identifiers, and updates related error handling and tests to reflect these changes.

Batch-get envelope and validation improvements

• Added a generic BatchGetEnvelope model and a create_batch_ids_validator utility in batch_operations.py to support partial results and deduplicate input identifiers for batch operations.
• Updated the catalog service API schemas to use MyServicesRpcBatchGet, which returns both found and missing services, replacing the previous list-based response. [1] [2]

Service logic and error handling

• Refactored batch_get_user_services and related endpoints to use the new envelope model, handle missing services gracefully, and raise a new CatalogServiceNotFoundError when no services are found. [1] [2] [3] [4] [5]
• Introduced CatalogBadRequestError and improved error templates for catalog-related exceptions.

API and test updates

• Updated API endpoints and RPC interfaces to return the new batch-get envelope, including changes in the webserver project node schema for missing services. [1] [2] [3] [4] [5] [6] [7]
• Added comprehensive tests for batch identifier validation and updated service catalog tests to check for missing identifiers in batch-get results. [1] [2] [3] [4]

Type aliasing and code organization

• Introduced BatchGetUserServicesResult type alias for future-proofing schema/domain separation.
• Improved code organization by importing new utilities and error types where needed. [1] [2]

Related issue/s

• Found in logs of staging deploy

How to test

• models_library: new generic batch-operations models and utils
  - packages/models-library/tests/test_batch_operations.py for new generic models and utils
• web-server services
  • rest api: services/web/server/tests/unit/with_dbs/02/test_projects_nodes_handlers__services_access.py
• catalog services
  • service layer: services/catalog/tests/unit/with_dbs/test_service_catalog_services.py
  • rpc client: services/catalog/tests/unit/with_dbs/test_api_rpc.py

Dev-ops

None