feat(lab-3461): use autoAssign field instead of seconds_to_label_befo… (#1881)

Author: florianlega

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

@@ -50,7 +50,7 @@ def project_data_mapper(data: ProjectDataKiliAPIGatewayInput) -> Dict:
         "numberOfRemainingAssets": data.number_of_remaining_assets,
         "numberOfReviewedAssets": data.number_of_reviewed_assets,
         "reviewCoverage": data.review_coverage,
-        "secondsToLabelBeforeAutoAssign": data.seconds_to_label_before_auto_assign,
+        "shouldAutoAssign": data.should_auto_assign,
         "shouldRelaunchKpiComputation": data.should_relaunch_kpi_computation,
         "title": data.title,
         "useHoneyPot": data.use_honeypot,

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

@@ -32,7 +32,7 @@ class ProjectDataKiliAPIGatewayInput:
     number_of_remaining_assets: Optional[int]
     number_of_reviewed_assets: Optional[int]
     review_coverage: Optional[int]
-    seconds_to_label_before_auto_assign: Optional[int]
+    should_auto_assign: Optional[bool]
     should_relaunch_kpi_computation: Optional[bool]
     title: Optional[str]
     use_honeypot: Optional[bool]

src/kili/presentation/client/project.py

@@ -1,5 +1,6 @@
 """Client presentation methods for projects."""
 
+import warnings
 from typing import (
     Any,
     Dict,
@@ -304,6 +305,7 @@ def update_properties_in_project(
         use_honeypot: Optional[bool] = None,
         metadata_types: Optional[dict] = None,
         seconds_to_label_before_auto_assign: Optional[int] = None,
+        should_auto_assign: Optional[bool] = None,
     ) -> Dict[str, Any]:
         """Update properties of a project.
 
@@ -340,9 +342,8 @@ def update_properties_in_project(
             metadata_types: 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`
-            seconds_to_label_before_auto_assign: When a user begins to annotate an asset,
-                it automatically gets assigned to them.
-                This ensures the user retains the asset until it is submitted.
+            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,
@@ -369,6 +370,14 @@ def update_properties_in_project(
             Not providing a type for a metadata field or providing an unsupported one
             will default to the `string` type.
         """
+        if seconds_to_label_before_auto_assign is not None:
+            warnings.warn(
+                "seconds_to_label_before_auto_assign is going to be deprecated. Please use"
+                " `should_auto_assign` field instead to auto assign assets",
+                DeprecationWarning,
+                stacklevel=1,
+            )
+
         return ProjectUseCases(self.kili_api_gateway).update_properties_in_project(
             ProjectId(project_id),
             can_navigate_between_assets=can_navigate_between_assets,
@@ -391,6 +400,7 @@ def update_properties_in_project(
             use_honeypot=use_honeypot,
             title=title,
             metadata_types=metadata_types,
+            should_auto_assign=should_auto_assign,
             seconds_to_label_before_auto_assign=seconds_to_label_before_auto_assign,
         )
 

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,
+        should_auto_assign: Optional[bool] = None,
         seconds_to_label_before_auto_assign: Optional[int] = None,
     ) -> Dict[str, object]:
         """Update properties in a project."""
@@ -141,6 +142,10 @@ def update_properties_in_project(
         if review_coverage is not None and not 0 <= review_coverage <= 100:
             raise ValueError("Argument `review_coverage` must be comprised between 0 and 100.")
 
+        # if should_auto_assign is True or false use it, else use seconds_to_label_before_auto_assign
+        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
+
         project_data = ProjectDataKiliAPIGatewayInput(
             can_navigate_between_assets=can_navigate_between_assets,
             can_skip_asset=can_skip_asset,
@@ -159,7 +164,7 @@ def update_properties_in_project(
             number_of_remaining_assets=number_of_remaining_assets,
             number_of_reviewed_assets=number_of_reviewed_assets,
             review_coverage=review_coverage,
-            seconds_to_label_before_auto_assign=seconds_to_label_before_auto_assign,
+            should_auto_assign=should_auto_assign,
             should_relaunch_kpi_computation=should_relaunch_kpi_computation,
             title=title,
             use_honeypot=use_honeypot,

tests/integration/presentation/test_project.py

@@ -69,7 +69,7 @@ def test_when_updating_project_then_it_returns_updated_project(mocker: pytest_mo
                 "numberOfRemainingAssets": None,
                 "numberOfReviewedAssets": None,
                 "reviewCoverage": 42,
-                "secondsToLabelBeforeAutoAssign": None,
+                "shouldAutoAssign": None,
                 "shouldRelaunchKpiComputation": None,
                 "title": None,
                 "useHoneyPot": None,