✨new style dynamic services can now be marked as collaborative ⚠️🚨 (ITISFoundation#8136)

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

packages/models-library/src/models_library/service_settings_labels.py

@@ -372,6 +372,16 @@ class DynamicSidecarServiceLabels(BaseModel):
         ),
     ] = None
 
+    is_collaborative: Annotated[
+        bool,
+        Field(
+            alias="simcore.service.is-collaborative",
+            description=(
+                "if True, the service is collaborative and will not be locked"
+            ),
+        ),
+    ] = False
+
     compose_spec: Annotated[
         Json[ComposeSpecLabelDict | None] | None,
         Field(
@@ -663,6 +673,7 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                         "simcore.service.user-preferences-path": json_dumps(
                             "/tmp/path_to_preferences"  # noqa: S108
                         ),
+                        "simcore.service.is_collaborative": "False",
                     },
                     # dynamic-service with compose spec
                     {
@@ -702,6 +713,7 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                         "simcore.service.callbacks-mapping": json_dumps(
                             CallbacksMapping.model_json_schema()["examples"][3]
                         ),
+                        "simcore.service.is_collaborative": "True",
                     },
                 ]
             },

packages/models-library/tests/test_service_settings_labels.py

@@ -52,12 +52,12 @@ class _Parametrization(NamedTuple):
     ),
     "dynamic-service": _Parametrization(
         example=SimcoreServiceLabels.model_json_schema()["examples"][1],
-        items=5,
+        items=6,
         uses_dynamic_sidecar=True,
     ),
     "dynamic-service-with-compose-spec": _Parametrization(
         example=SimcoreServiceLabels.model_json_schema()["examples"][2],
-        items=6,
+        items=7,
         uses_dynamic_sidecar=True,
     ),
 }

packages/service-integration/src/service_integration/osparc_config.py

@@ -213,6 +213,8 @@ class RuntimeConfig(BaseModel):
 
     paths_mapping: PathMappingsLabel | None = None
 
+    is_collaborative: bool = False
+
     user_preferences_path: Path | None = None
     boot_options: BootOptions | None = None
     min_visible_inputs: NonNegativeInt | None = None

services/director-v2/openapi.json

@@ -2852,6 +2852,11 @@
           "paths_mapping": {
             "$ref": "#/components/schemas/PathMappingsLabel"
           },
+          "is_collaborative": {
+            "type": "boolean",
+            "title": "Is Collaborative",
+            "default": false
+          },
           "simcore.service.compose-spec": {
             "anyOf": [
               {

services/director-v2/src/simcore_service_director_v2/models/dynamic_services_scheduler.py

@@ -406,6 +406,8 @@ def endpoint(self) -> AnyHttpUrl:
 
     paths_mapping: PathMappingsLabel  # overwrites in DynamicSidecarServiceLabels
 
+    is_collaborative: bool = False
+
     user_preferences_path: Path | None = None
     callbacks_mapping: Annotated[CallbacksMapping, Field(default_factory=dict)]
 
@@ -513,6 +515,7 @@ def from_http_request(
             "product_name": service.product_name,
             "product_api_base_url": service.product_api_base_url,
             "paths_mapping": simcore_service_labels.paths_mapping,
+            "is_collaborative": simcore_service_labels.is_collaborative,
             "callbacks_mapping": simcore_service_labels.callbacks_mapping,
             "compose_spec": json_dumps(simcore_service_labels.compose_spec),
             "container_http_entry": simcore_service_labels.container_http_entry,