feat(LAB-3532): deprecate metadata_types, add metadata_properties in update_properties_in_project

Author: paulruelle

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

@@ -29,7 +29,7 @@ def project_where_mapper(filters: ProjectFilters) -> Dict:
 
 def project_data_mapper(data: ProjectDataKiliAPIGatewayInput) -> Dict:
     """Build the GraphQL ProjectData variable to be sent in an operation."""
-    return {
+    result = {
         "archived": data.archived,
         "author": data.author,
         "complianceTags": data.compliance_tags,
@@ -42,7 +42,6 @@ def project_data_mapper(data: ProjectDataKiliAPIGatewayInput) -> Dict:
         "inputType": data.input_type,
         "instructions": data.instructions,
         "jsonInterface": data.json_interface,
-        "metadataTypes": data.metadata_types,
         "minConsensusSize": data.min_consensus_size,
         "numberOfAssets": data.number_of_assets,
         "rules": data.rules,
@@ -55,3 +54,18 @@ def project_data_mapper(data: ProjectDataKiliAPIGatewayInput) -> Dict:
         "title": data.title,
         "useHoneyPot": data.use_honeypot,
     }
+
+    if data.metadata_properties is not None:
+        result["metadataProperties"] = data.metadata_properties
+    elif data.metadata_types is not None:
+        metadata_properties = {}
+        for key, type_value in data.metadata_types.items():
+            metadata_properties[key] = {
+                "filterable": True,
+                "type": type_value,
+                "visibleByLabeler": True,
+                "visibleByReviewer": True,
+            }
+        result["metadataProperties"] = metadata_properties
+
+    return result

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

@@ -25,6 +25,7 @@ class ProjectDataKiliAPIGatewayInput:
     instructions: Optional[str]
     json_interface: Optional[str]
     metadata_types: Optional[Dict]
+    metadata_properties: Optional[Dict]
     min_consensus_size: Optional[int]
     number_of_assets: Optional[int]
     rules: Optional[str]

src/kili/entrypoints/mutations/project/queries.py

@@ -24,7 +24,7 @@
     $instructions: String
     $inputType: InputType
     $jsonInterface: String
-    $metadataTypes: JSON
+    $metadataProperties: JSON
     $minConsensusSize: Int
     $numberOfAssets: Int
     $numberOfSkippedAssets: Int
@@ -50,7 +50,7 @@
       instructions: $instructions
       inputType: $inputType
       jsonInterface: $jsonInterface
-      metadataTypes: $metadataTypes
+      metadataProperties: $metadataProperties
       minConsensusSize: $minConsensusSize
       numberOfAssets: $numberOfAssets
       numberOfSkippedAssets: $numberOfSkippedAssets

src/kili/presentation/client/project.py

@@ -304,6 +304,7 @@ def update_properties_in_project(
         title: Optional[str] = None,
         use_honeypot: Optional[bool] = None,
         metadata_types: Optional[dict] = None,
+        metadata_properties: Optional[dict] = None,
         seconds_to_label_before_auto_assign: Optional[int] = None,
         should_auto_assign: Optional[bool] = None,
     ) -> Dict[str, Any]:
@@ -339,36 +340,59 @@ def update_properties_in_project(
                 in honeypot or consensus settings
             title: Title of the project
             use_honeypot: Activate / Deactivate the use of honeypot in the project
-            metadata_types: Types of the project metadata.
+            metadata_types: DEPRECATED. Types of the project metadata.
                 Should be a `dict` of metadata fields name as keys and metadata types as values.
                 Currently, possible types are: `string`, `number`
+            metadata_properties: Properties of the project metadata.
+                Should be a `dict` of metadata fields name as keys and metadata properties as values.
+                Each property is a dict with the following keys:
+                    - `type`: Type of the metadata. Currently, possible types are: `string`, `number`
+                    - `filterable`: If `True`, the metadata can be used as filters in project queue
+                    - `visibleByLabeler`: If `True`, the metadata is visible one the asset by labelers
+                    - `visibleByReviewer`: If `True`, the metadata is visible one the asset by reviewers
             seconds_to_label_before_auto_assign: DEPRECATED, use `should_auto_assign` instead.
             should_auto_assign: If `True`, assets are automatically assigned to users when they start annotating.
 
         Returns:
             A dict with the changed properties which indicates if the mutation was successful,
                 else an error message.
 
-        !!! example "Change Metadata Types"
-            Metadata fields are by default interpreted as `string` types. To change the type
-            of a metadata field, you can use the `update_properties_in_project` function with the
-            metadata_types argument. `metadata_types` is given as a dict of metadata field names
-            as keys and metadata types as values.
+        !!! example "Change Metadata Properties"
+            Metadata fields are by default interpreted as `string` types and have default properties.
+            To change the properties of a metadata field, you can use the `update_properties_in_project`
+            function with the `metadata_properties` argument. `metadata_properties` is given as a dict
+            of metadata field names as keys and metadata properties as values.
 
             ```python
             kili.update_properties_in_project(
                 project_id = project_id,
-                metadata_types = {
-                    'customConsensus': 'number',
-                    'sensitiveData': 'string',
-                    'uploadedFromCloud': 'string',
-                    'modelLabelErrorScore': 'number'
+                metadata_properties = {
+                    'customConsensus': {
+                        'filterable': True,
+                        'type': 'number',
+                        'visibleByLabeler': True,
+                        'visibleByReviewer': True,
+                    },
+                    'sensitiveData': {
+                        'filterable': True,
+                        'type': 'string',
+                        'visibleByLabeler': False,
+                        'visibleByReviewer': True,
+                    }
                 }
             )
             ```
 
-            Not providing a type for a metadata field or providing an unsupported one
-            will default to the `string` type.
+            Not providing a property or providing an unsupported one will use the default values:
+            ```
+            filterable: True
+            type: 'string'
+            visibleByLabeler: True
+            visibleByReviewer: True
+            ```
+
+        !!! note "Deprecated: Change Metadata Types"
+            The `metadata_types` parameter is deprecated. Please use `metadata_properties` instead.
         """
         if seconds_to_label_before_auto_assign is not None:
             warnings.warn(
@@ -378,6 +402,14 @@ def update_properties_in_project(
                 stacklevel=1,
             )
 
+        if metadata_types is not None:
+            warnings.warn(
+                "metadata_types is going to be deprecated. Please use"
+                " `metadata_properties` field instead to configure metadata properties.",
+                DeprecationWarning,
+                stacklevel=1,
+            )
+
         return ProjectUseCases(self.kili_api_gateway).update_properties_in_project(
             ProjectId(project_id),
             can_navigate_between_assets=can_navigate_between_assets,
@@ -400,6 +432,7 @@ def update_properties_in_project(
             use_honeypot=use_honeypot,
             title=title,
             metadata_types=metadata_types,
+            metadata_properties=metadata_properties,
             should_auto_assign=should_auto_assign,
             seconds_to_label_before_auto_assign=seconds_to_label_before_auto_assign,
         )

src/kili/types.py

@@ -153,6 +153,7 @@ class ProjectWithoutDataset(TypedDict, total=False):
     interface: Dict
     interfaceCompute: Dict
     jsonInterface: Dict
+    metadataProperties: Dict
     metadataTypes: Dict
     minConsensusSize: int
     mlTasks: str

src/kili/use_cases/project/project.py

@@ -127,6 +127,7 @@ def update_properties_in_project(
         title: Optional[str] = None,
         use_honeypot: Optional[bool] = None,
         metadata_types: Optional[Dict] = None,
+        metadata_properties: Optional[Dict] = None,
         should_auto_assign: Optional[bool] = None,
         seconds_to_label_before_auto_assign: Optional[int] = None,
     ) -> Dict[str, object]:
@@ -146,6 +147,29 @@ def update_properties_in_project(
         if should_auto_assign is None and seconds_to_label_before_auto_assign is not None:
             should_auto_assign = seconds_to_label_before_auto_assign is not None
 
+        # Handle metadata_types deprecation and conversion to metadata_properties
+        if metadata_types is not None:
+            if metadata_properties is None:
+                metadata_properties = {}
+                for key, type_value in metadata_types.items():
+                    metadata_properties[key] = {
+                        "filterable": True,
+                        "type": type_value,
+                        "visibleByLabeler": True,
+                        "visibleByReviewer": True,
+                    }
+
+        if metadata_properties is not None:
+            for key, properties in metadata_properties.items():
+                if "filterable" not in properties:
+                    properties["filterable"] = True
+                if "type" not in properties:
+                    properties["type"] = "string"
+                if "visibleByLabeler" not in properties:
+                    properties["visibleByLabeler"] = True
+                if "visibleByReviewer" not in properties:
+                    properties["visibleByReviewer"] = True
+
         project_data = ProjectDataKiliAPIGatewayInput(
             can_navigate_between_assets=can_navigate_between_assets,
             can_skip_asset=can_skip_asset,
@@ -158,6 +182,7 @@ def update_properties_in_project(
             input_type=input_type,
             json_interface=json.dumps(json_interface) if json_interface is not None else None,
             metadata_types=metadata_types,
+            metadata_properties=metadata_properties,
             min_consensus_size=min_consensus_size,
             number_of_assets=number_of_assets,
             number_of_skipped_assets=number_of_skipped_assets,

tests/integration/presentation/test_project.py

@@ -61,7 +61,6 @@ def test_when_updating_project_then_it_returns_updated_project(mocker: pytest_mo
                 "inputType": None,
                 "instructions": None,
                 "jsonInterface": None,
-                "metadataTypes": None,
                 "minConsensusSize": None,
                 "numberOfAssets": None,
                 "rules": None,