Merge pull request #1943 from kili-technology/feature/lab-3743-aa-api-user-i-can-copy-a-workflow-v2-project-with-labels

feat(LAB-3743): move copy label to backend resolver

Author: BlueGrizzliBear

src/kili/adapters/kili_api_gateway/label/operations.py

@@ -153,3 +153,10 @@ def get_annotations_partial_query(
             {annotation_fragment}
             {inline_fragments}
     """
+
+
+GQL_COPY_LABELS = """
+  mutation CopyLabels($data: CopyLabelsInput!) {
+    copyLabels(data: $data)
+  }
+"""

src/kili/adapters/kili_api_gateway/label/operations_mixin.py

@@ -24,6 +24,7 @@
 from .formatters import load_label_json_fields
 from .mappers import append_label_data_mapper, append_to_labels_data_mapper, label_where_mapper
 from .operations import (
+    GQL_COPY_LABELS,
     GQL_COUNT_LABELS,
     GQL_DELETE_LABELS,
     get_append_many_labels_mutation,
@@ -113,7 +114,7 @@ def list_labels_split(
                         ["content", "jsonContent", "resolution.width", "resolution.height"],
                     )
                 converter.patch_label_json_response(asset, label, label["annotations"])
-                if "annotations" not in fields:
+                if not any("annotations." in element for element in fields):
                     label.pop("annotations")
                 yield label
 
@@ -200,3 +201,15 @@ def create_honeypot_label(
         }
         result = self.graphql_client.execute(query, variables)
         return result["data"]
+
+    def copy_labels(self, src_asset_id: str, dst_asset_id: str, project_id: str) -> bool:
+        """Copy labels from one asset to another."""
+        variables = {
+            "data": {
+                "srcAssetId": src_asset_id,
+                "dstAssetId": dst_asset_id,
+                "projectId": project_id,
+            },
+        }
+        self.graphql_client.execute(GQL_COPY_LABELS, variables)
+        return True

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

@@ -38,12 +38,3 @@ def update_step_mapper(data: Union[WorkflowStepCreate, WorkflowStepUpdate]) -> D
         "assignees": data["assignees"] if "assignees" in data else None,
     }
     return {k: v for k, v in step.items() if v is not None}
-
-
-def step_data_mapper(data: Dict) -> Dict:
-    """Build the GraphQL StepData variable to be sent in an operation."""
-    return {
-        "id": data["id"],
-        "name": data["name"],
-        "type": data["type"],
-    }

src/kili/adapters/kili_api_gateway/project_workflow/operations_mixin.py

@@ -9,7 +9,7 @@
 from kili.domain.project import ProjectId
 from kili.exceptions import NotFound
 
-from .mappers import project_input_mapper, step_data_mapper
+from .mappers import project_input_mapper
 from .operations import (
     GQL_GET_STEPS,
     get_update_project_workflow_mutation,
@@ -44,7 +44,7 @@ def update_project_workflow(
 
     def get_steps(
         self,
-        project_id: ProjectId,
+        project_id: str,
     ) -> List[Dict]:
         """Get steps in a project workflow."""
         variables = {"where": {"id": project_id}, "first": 1, "skip": 0}
@@ -60,6 +60,5 @@ def get_steps(
             raise NotFound(
                 f"project ID: {project_id}. The workflow v2 is not activated on this project."
             )
-        steps_mapper = step_data_mapper(steps)
 
-        return [step for step in steps_mapper if step.get("isActivated") is True]
+        return [step for step in steps if step.get("isActivated") is True]

src/kili/services/copy_project/__init__.py

@@ -2,13 +2,14 @@
 
 import itertools
 import logging
+import warnings
 from typing import TYPE_CHECKING, Optional
 
 from kili.adapters.kili_api_gateway.helpers.queries import QueryOptions
 from kili.adapters.kili_api_gateway.project.types import CopyProjectInput
 from kili.domain.asset import AssetFilters
 from kili.domain.label import LabelFilters
-from kili.domain.project import ProjectId
+from kili.domain.project import InputTypeEnum, ProjectId
 
 if TYPE_CHECKING:
     from kili.client import Kili
@@ -22,9 +23,13 @@ class ProjectCopier:  # pylint: disable=too-few-public-methods
         "description",
         "id",
         "dataConnections.id",
+        "inputType",
+        "jsonInterface",
+        "workflowVersion",
     )
 
     def __init__(self, kili: "Kili") -> None:
+        """Simple initialization."""
         self.disable_tqdm = False
         self.kili = kili
 
@@ -62,6 +67,15 @@ def copy_project(  # pylint: disable=too-many-arguments
         if src_project["dataConnections"] and copy_assets:
             raise NotImplementedError("Copying projects with cloud storage is not supported.")
 
+        if src_project["inputType"] in [
+            InputTypeEnum.LLM_INSTR_FOLLOWING,
+            InputTypeEnum.LLM_RLHF,
+            InputTypeEnum.LLM_STATIC,
+        ]:
+            raise NotImplementedError(
+                f"Copying projects with input type {src_project['inputType']} is not supported."
+            )
+
         logger.info("Copying new project...")
 
         new_project_id = self.kili.kili_api_gateway.copy_project(
@@ -72,7 +86,7 @@ def copy_project(  # pylint: disable=too-many-arguments
             ),
         )
 
-        logger.info(f"Created new project {new_project_id}")
+        logger.info("Created new project %s", new_project_id)
 
         self.kili.update_properties_in_project(
             project_id=new_project_id,
@@ -84,7 +98,18 @@ def copy_project(  # pylint: disable=too-many-arguments
 
         if copy_labels:
             logger.info("Copying labels...")
-            self._copy_labels(from_project_id, new_project_id)
+            if src_project["workflowVersion"] == "V2":
+                self._copy_labels(from_project_id=from_project_id, new_project_id=new_project_id)
+            else:
+                warnings.warn(
+                    "Warning: "
+                    "copying a project of an old workflow mode may cause problems in asset status and assignation. "
+                    "Consider creating a new project instead.",
+                    DeprecationWarning,
+                )
+                self._copy_labels_legacy(
+                    from_project_id=from_project_id, new_project_id=new_project_id
+                )
 
         return new_project_id
 
@@ -100,8 +125,58 @@ def _generate_project_title(self, src_title: str) -> str:
             i += 1
         return new_title
 
-    # pylint: disable=too-many-locals
     def _copy_labels(self, from_project_id: str, new_project_id: str) -> None:
+        """Method to copy labels from the source project to the new project : applicable for WFV2."""
+        nb_labels_to_copy = self.kili.kili_api_gateway.count_labels(
+            LabelFilters(project_id=ProjectId(from_project_id))
+        )
+
+        if nb_labels_to_copy == 0:
+            return
+
+        assets_src_project = self.kili.kili_api_gateway.list_assets(
+            AssetFilters(project_id=ProjectId(from_project_id)),
+            ["id", "externalId", "labels.id"],
+            QueryOptions(disable_tqdm=True),
+        )
+
+        assets_dst_project = self.kili.kili_api_gateway.list_assets(
+            AssetFilters(project_id=ProjectId(new_project_id)),
+            ["id", "externalId"],
+            QueryOptions(disable_tqdm=True),
+        )
+
+        # Iterate on assets of the source project
+        # to copy labels to the new projectq
+        assets_src_project_list = [
+            asset
+            for asset in assets_src_project
+            if "labels" in asset and asset["labels"] and len(asset["labels"]) > 0
+        ]
+        assets_dst_project_map = {asset["externalId"]: asset["id"] for asset in assets_dst_project}
+
+        for src_asset in assets_src_project_list:
+            src_asset_id = src_asset["id"]
+            dst_asset_id = assets_dst_project_map.get(src_asset["externalId"])
+            if not dst_asset_id:
+                raise ValueError(
+                    f"Asset with externalId {src_asset['externalId']} not found in new project {new_project_id}."
+                )
+
+            self.kili.kili_api_gateway.copy_labels(
+                src_asset_id=src_asset_id,
+                dst_asset_id=dst_asset_id,
+                project_id=new_project_id,
+            )
+
+    # pylint: disable=too-many-locals
+    def _copy_labels_legacy(self, from_project_id: str, new_project_id: str) -> None:
+        """Legacy mlethod to copy labels from the source project to the new project : applicable for WFV1.
+
+        !!! warning
+            This method is deprecated and will be removed in the next major release.
+            Asset with send back labels are not supported (status wise) and asset assignation is not supported.
+        """
         assets_new_project = self.kili.kili_api_gateway.list_assets(
             AssetFilters(project_id=ProjectId(new_project_id)),
             ["id", "externalId"],