feat(LAB-3887): add isJsonProcessingEnabled support to cloud storage SDK

Author: paulruelle

src/kili/adapters/kili_api_gateway/cloud_storage/mappers.py

@@ -31,14 +31,17 @@ def data_connection_where_mapper(filters: DataConnectionFilters) -> dict:
 
 def add_data_connection_data_mapper(data: AddDataConnectionKiliAPIGatewayInput) -> dict:
     """Build the GraphQL DataConnectionInput variable to be sent in an operation."""
-    return {
+    result = {
         "exclude": data.exclude,
         "include": data.include,
         "integrationId": data.integration_id,
         "prefix": data.prefix,
         "projectId": data.project_id,
         "selectedFolders": data.selected_folders,
     }
+    if data.is_json_processing_enabled is not None:
+        result["isJsonProcessingEnabled"] = data.is_json_processing_enabled
+    return result
 
 
 def compute_data_connection_difference_data_mapper(

src/kili/adapters/kili_api_gateway/cloud_storage/types.py

@@ -19,6 +19,7 @@ class AddDataConnectionKiliAPIGatewayInput:
     exclude: Optional[list[str]]
     include: Optional[list[str]]
     integration_id: DataIntegrationId
+    is_json_processing_enabled: Optional[bool]
     prefix: Optional[str]
     project_id: ProjectId
     selected_folders: Optional[list[str]]

src/kili/presentation/client/cloud_storage.py

@@ -44,6 +44,7 @@ def cloud_storage_connections(
         project_id: Optional[str] = None,
         fields: ListOrTuple[str] = (
             "id",
+            "isJsonProcessingEnabled",
             "lastCheck",
             "numberOfAssets",
             "selectedFolders",
@@ -65,6 +66,7 @@ def cloud_storage_connections(
         project_id: Optional[str] = None,
         fields: ListOrTuple[str] = (
             "id",
+            "isJsonProcessingEnabled",
             "lastCheck",
             "numberOfAssets",
             "selectedFolders",
@@ -86,6 +88,7 @@ def cloud_storage_connections(
         project_id: Optional[str] = None,
         fields: ListOrTuple[str] = (
             "id",
+            "isJsonProcessingEnabled",
             "lastCheck",
             "numberOfAssets",
             "selectedFolders",
@@ -116,7 +119,7 @@ def cloud_storage_connections(
 
         Examples:
             >>> kili.cloud_storage_connections(project_id="789465123")
-            [{'id': '123456789', 'lastCheck': '2023-02-21T14:49:35.606Z', 'numberOfAssets': 42, 'selectedFolders': ['folder1', 'folder2'], 'projectId': '789465123'}]
+            [{'id': '123456789', 'isJsonProcessingEnabled': False, 'lastCheck': '2023-02-21T14:49:35.606Z', 'numberOfAssets': 42, 'selectedFolders': ['folder1', 'folder2'], 'projectId': '789465123'}]
         """
         if (
             cloud_storage_connection_id is None
@@ -303,6 +306,7 @@ def add_cloud_storage_connection(
         prefix: Optional[str] = None,
         include: Optional[list[str]] = None,
         exclude: Optional[list[str]] = None,
+        is_json_processing_enabled: Optional[bool] = None,
     ) -> dict:
         """Connect a cloud storage to a project. More details about parameters
         can be found in the [documentation](https://docs.kili-technology.com/docs/filtering-assets-from-cloud-storage).
@@ -316,6 +320,9 @@ def add_cloud_storage_connection(
             prefix: Filter files to synchronize based on their base path.
             include: List of pattern used to include files based on their path.
             exclude: List of pattern used to exclude files based on their path.
+            is_json_processing_enabled: Whether JSON file synchronization is enabled.
+                When True, JSON files are processed during synchronization
+                to extract text content or create layered images.
 
         Returns:
             A dict with the DataConnection Id.
@@ -333,6 +340,7 @@ def add_cloud_storage_connection(
             prefix=prefix,
             include=include,
             exclude=exclude,
+            is_json_processing_enabled=is_json_processing_enabled,
         )["id"]
 
         return {"id": data_connection_id}

src/kili/use_cases/cloud_storage/__init__.py

@@ -81,6 +81,7 @@ def add_data_connection(
         prefix: Optional[str] = None,
         include: Optional[list[str]] = None,
         exclude: Optional[list[str]] = None,
+        is_json_processing_enabled: Optional[bool] = None,
     ) -> dict:
         """Add data connection to a project."""
         if (
@@ -96,6 +97,7 @@ def add_data_connection(
                 exclude=exclude,
                 include=include,
                 integration_id=data_integration_id,
+                is_json_processing_enabled=is_json_processing_enabled,
                 prefix=prefix,
                 project_id=project_id,
                 selected_folders=selected_folders,

tests/integration/adapters/kili_api_gateway/test_cloud_storage.py

@@ -3,10 +3,12 @@
     DataConnectionComputeDifferencesKiliAPIGatewayInput,
     DataIntegrationFilters,
 )
+from kili.adapters.kili_api_gateway.cloud_storage.mappers import add_data_connection_data_mapper
 from kili.adapters.kili_api_gateway.cloud_storage.operations import (
     GQL_COUNT_DATA_INTEGRATIONS,
     get_compute_data_connection_differences_mutation,
 )
+from kili.adapters.kili_api_gateway.cloud_storage.types import AddDataConnectionKiliAPIGatewayInput
 from kili.adapters.kili_api_gateway.kili_api_gateway import KiliAPIGateway
 from kili.core.graphql.graphql_client import GraphQLClient
 from kili.domain.cloud_storage import DataConnectionId, DataIntegrationId
@@ -83,3 +85,41 @@ def test_given_gateway_when_calling_count_data_integrations_then_it_works(
             }
         },
     )
+
+
+def test_add_data_connection_mapper_includes_json_processing_when_set():
+    # Given
+    data = AddDataConnectionKiliAPIGatewayInput(
+        exclude=None,
+        include=None,
+        integration_id=DataIntegrationId("fake_integration_id"),
+        is_json_processing_enabled=True,
+        prefix=None,
+        project_id="fake_proj_id",
+        selected_folders=None,
+    )
+
+    # When
+    result = add_data_connection_data_mapper(data)
+
+    # Then
+    assert result["isJsonProcessingEnabled"] is True
+
+
+def test_add_data_connection_mapper_excludes_json_processing_when_none():
+    # Given
+    data = AddDataConnectionKiliAPIGatewayInput(
+        exclude=None,
+        include=None,
+        integration_id=DataIntegrationId("fake_integration_id"),
+        is_json_processing_enabled=None,
+        prefix=None,
+        project_id="fake_proj_id",
+        selected_folders=None,
+    )
+
+    # When
+    result = add_data_connection_data_mapper(data)
+
+    # Then
+    assert "isJsonProcessingEnabled" not in result