🎨 Replaces built-in JSON serialization with common_library utilities (#7569)

Author: pcrespov

.github/copilot-instructions.md

@@ -23,6 +23,13 @@ This document provides guidelines and best practices for using GitHub Copilot in
 - ensure we use `fastapi` >0.100 compatible code
 - use f-string formatting
 
+
+### Json serialization
+
+- Generally use `json_dumps`/`json_loads` from `common_library.json_serialization` to built-in `json.dumps` / `json.loads`.
+- Prefer Pydantic model methods (e.g., `model.model_dump_json()`) for serialization.
+
+
 ## Node.js-Specific Instructions
 
 - Use ES6+ syntax and features.

packages/dask-task-models-library/src/dask_task_models_library/container_tasks/io.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 from typing import Annotated, Any, TypeAlias
 
+from common_library.json_serialization import json_loads
 from models_library.basic_regex import MIME_TYPE_RE
 from models_library.generics import DictModel
 from models_library.services_types import ServicePortKey
@@ -160,7 +161,7 @@ def from_task_output(
             with suppress(json.JSONDecodeError):
                 # NOTE: The suppression here is ok, since if the data is empty,
                 # there will be a validation error anyway
-                data = json.loads(output_data_file.read_text())
+                data = json_loads(output_data_file.read_text())
 
         for output_key, output_params in schema.items():
             if isinstance(output_params, FilePortSchema):

packages/models-library/src/models_library/function_services_catalog/_settings.py

@@ -1,11 +1,12 @@
 import json
 import os
 
+from common_library.json_serialization import json_loads
 from pydantic_settings import BaseSettings
 
 # Expects env var: FUNCTION_SERVICES_AUTHORS='{"OM":{"name": ...}, "EN":{...} }'
 try:
-    AUTHORS = json.loads(os.environ.get("FUNCTION_SERVICES_AUTHORS", "{}"))
+    AUTHORS = json_loads(os.environ.get("FUNCTION_SERVICES_AUTHORS", "{}"))
 except json.decoder.JSONDecodeError:
     AUTHORS = {}
 

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

@@ -27,7 +27,9 @@
 from .services_resources import DEFAULT_SINGLE_SERVICE_NAME
 
 _BaseConfig = ConfigDict(
-    extra="forbid", arbitrary_types_allowed=True, ignored_types=(cached_property,)
+    extra="forbid",
+    arbitrary_types_allowed=True,
+    ignored_types=(cached_property,),
 )
 
 

packages/models-library/src/models_library/utils/change_case.py

@@ -1,16 +1,15 @@
-""" String convesion
+"""String convesion
 
 
 Example of usage in pydantic:
 
 [...]
-    class Config:
-        extra = Extra.forbid
-        alias_generator = snake_to_camel  # <--------
-        json_loads = orjson.loads
-        json_dumps = json_dumps
+    model_config = ConfigDict(
+        alias_generator=snake_to_camel, # <-- note
+    )
 
 """
+
 # Partially taken from  https://github.com/autoferrit/python-change-case/blob/master/change_case/change_case.py#L131
 import re
 from typing import Final

packages/models-library/src/models_library/utils/labels_annotations.py

@@ -1,14 +1,13 @@
-""" Image labels annotations
+"""Image labels annotations
 
 osparc expects the service configuration (in short: config) attached to the service's image as label annotations.
 This module defines how this config is serialized/deserialized to/from docker labels annotations
 """
 
-import json
 from json.decoder import JSONDecodeError
 from typing import Any, TypeAlias
 
-from common_library.json_serialization import json_dumps
+from common_library.json_serialization import json_dumps, json_loads
 
 LabelsAnnotationsDict: TypeAlias = dict[str, str | float | bool | None]
 
@@ -57,7 +56,7 @@ def from_labels(
     for key, label in labels.items():
         if key.startswith(f"{prefix_key}."):
             try:
-                value = json.loads(label)  # type: ignore
+                value = json_loads(label)
             except JSONDecodeError:
                 value = label
 

packages/models-library/src/models_library/utils/nodes.py

@@ -64,8 +64,8 @@ async def compute_node_hash(
             if payload is not None:
                 resolved_payload[port_type][port_key] = payload
 
-    # now create the hash
     # WARNING: Here we cannot change to json_serialization.json_dumps because if would create a different dump string and therefore a different hash
+    # typically test_node_ports_v2_serialization_v2.py::test_dump will fail if you do this change.
     # NOTE that these hashes might have been already stored elsewhere
     block_string = json.dumps(resolved_payload, sort_keys=True).encode("utf-8")
     raw_hash = hashlib.sha256(block_string)

packages/postgres-database/src/simcore_postgres_database/models/products.py

@@ -5,10 +5,10 @@
 - Every product has a front-end with exactly the same name
 """
 
-import json
 from typing import Literal
 
 import sqlalchemy as sa
+from common_library.json_serialization import json_dumps
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.sql import func
 from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
@@ -114,7 +114,7 @@ class ProductLoginSettingsDict(TypedDict, total=False):
 
 # NOTE: defaults affects migration!!
 LOGIN_SETTINGS_DEFAULT = ProductLoginSettingsDict()  # = {}
-_LOGIN_SETTINGS_SERVER_DEFAULT = json.dumps(LOGIN_SETTINGS_DEFAULT)
+_LOGIN_SETTINGS_SERVER_DEFAULT = json_dumps(LOGIN_SETTINGS_DEFAULT)
 
 
 #

packages/service-integration/src/service_integration/cli/_config.py

@@ -1,10 +1,10 @@
-import json
 from pathlib import Path
 from typing import Annotated, Final
 
 import rich
 import typer
 import yaml
+from common_library.json_serialization import json_loads
 from models_library.utils.labels_annotations import LabelsAnnotationsDict
 from pydantic import BaseModel
 
@@ -57,7 +57,7 @@ def _save(service_name: str, filename: Path, model: BaseModel):
             rich.print(f"Creating {output_path} ...", end="")
 
             with output_path.open("wt") as fh:
-                data = json.loads(
+                data = json_loads(
                     model.model_dump_json(by_alias=True, exclude_none=True)
                 )
                 yaml.safe_dump(data, fh, sort_keys=False)

packages/service-integration/src/service_integration/pytest_plugin/docker_integration.py

@@ -18,6 +18,7 @@
 import jsonschema
 import pytest
 import yaml
+from common_library.json_serialization import json_loads
 from docker.errors import APIError
 from docker.models.containers import Container
 
@@ -206,7 +207,7 @@ def convert_to_simcore_labels(image_labels: dict) -> dict:
     io_simcore_labels = {}
     for key, value in image_labels.items():
         if str(key).startswith("io.simcore."):
-            simcore_label = json.loads(value)
+            simcore_label = json_loads(value)
             simcore_keys = list(simcore_label.keys())
             assert len(simcore_keys) == 1
             simcore_key = simcore_keys[0]