feat(lab-3717): handle update of workflow steps (#1909)

Author: florianlega

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

@@ -14,8 +14,9 @@
     load_project_json_fields,
 )
 from kili.adapters.kili_api_gateway.project.operations import get_projects_query
+from kili.adapters.kili_api_gateway.project_workflow.mappers import create_project_workflow_mapper
 from kili.core.enums import DemoProjectType, ProjectType
-from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId
+from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId, Workflow
 from kili.domain.types import ListOrTuple
 
 from .common import get_project
@@ -46,6 +47,7 @@ def create_project(
         project_type: Optional[ProjectType],
         compliance_tags: Optional[ListOrTuple[ComplianceTag]],
         from_demo_project: Optional[DemoProjectType],
+        workflow: Optional[Workflow] = None,
     ) -> ProjectId:
         """Create a project."""
         variables = {
@@ -56,6 +58,7 @@ def create_project(
                 "jsonInterface": json.dumps(json_interface),
                 "projectType": project_type,
                 "title": title,
+                "workflow": create_project_workflow_mapper(workflow) if workflow else None,
             }
         }
         # compliance tags are only available for Kili app > 2.138

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

@@ -1,6 +1,8 @@
 """GraphQL payload data mappers for project operations."""
 
-from typing import Dict
+from typing import Dict, Union
+
+from kili.domain.project import Workflow, WorkflowStepCreate, WorkflowStepUpdate
 
 from .types import ProjectWorkflowDataKiliAPIGatewayInput
 
@@ -9,7 +11,41 @@ def project_input_mapper(data: ProjectWorkflowDataKiliAPIGatewayInput) -> Dict:
     """Build the GraphQL ProjectWorfklowData variable to be sent in an operation."""
     return {
         "enforceStepSeparation": data.enforce_step_separation,
+        "steps": {
+            "creates": [update_step_mapper(step) for step in data.create_steps]
+            if data.create_steps
+            else [],
+            "updates": [update_step_mapper(step) for step in data.update_steps]
+            if data.update_steps
+            else [],
+            "deletes": data.delete_steps if data.delete_steps else [],
+        },
+    }
+
+
+def create_project_workflow_mapper(data: Workflow) -> Dict:
+    """Build the GraphQL Workflow variable to be sent in an operation."""
+    return {
+        "enforceStepSeparation": data["enforce_step_separation"],
+        "steps": [update_step_mapper(step) for step in data["steps"]] if data["steps"] else [],
+    }
+
+
+def update_step_mapper(data: Union[WorkflowStepCreate, WorkflowStepUpdate]) -> Dict:
+    """Build the GraphQL create StepData variable to be sent in an operation."""
+    step = {
+        "id": data["id"] if "id" in data else None,
+        "name": data["name"] if "name" in data else None,
+        "consensusCoverage": data["consensus_coverage"] if "consensus_coverage" in data else None,
+        "numberOfExpectedLabelsForConsensus": data["number_of_expected_labels_for_consensus"]
+        if "number_of_expected_labels_for_consensus" in data
+        else None,
+        "order": data["order"] if "order" in data else None,
+        "stepCoverage": data["step_coverage"] if "step_coverage" in data else None,
+        "type": data["type"] if "type" in data else None,
+        "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:

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

@@ -28,7 +28,11 @@ def update_project_workflow(
         """Update properties in a project workflow."""
         project_workflow_input = project_input_mapper(data=project_workflow_data)
 
-        fields = tuple(name for name, val in project_workflow_input.items() if val is not None)
+        fields = tuple(
+            name
+            for name, val in project_workflow_input.items()
+            if val is not None and name != "steps"
+        )
         fragment = fragment_builder(fields)
         mutation = get_update_project_workflow_mutation(fragment)
 

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

@@ -1,11 +1,16 @@
 """Types for the ProjectWorkflow-related Kili API gateway functions."""
 
 from dataclasses import dataclass
-from typing import Optional
+from typing import List, Optional
+
+from kili.domain.project import WorkflowStepCreate, WorkflowStepUpdate
 
 
 @dataclass
 class ProjectWorkflowDataKiliAPIGatewayInput:
     """ProjectWorkflow input data for Kili API Gateway."""
 
     enforce_step_separation: Optional[bool]
+    create_steps: Optional[List[WorkflowStepCreate]]
+    update_steps: Optional[List[WorkflowStepUpdate]]
+    delete_steps: Optional[List[str]]

src/kili/domain/project.py

@@ -2,7 +2,9 @@
 
 from dataclasses import dataclass
 from enum import Enum
-from typing import TYPE_CHECKING, Literal, NewType, Optional, TypedDict
+from typing import TYPE_CHECKING, List, Literal, NewType, Optional, TypedDict
+
+from typing_extensions import Required
 
 from .types import ListOrTuple
 
@@ -23,6 +25,39 @@ class ProjectStep(TypedDict, total=True):
     name: str
 
 
+class WorkflowStepCreate(TypedDict, total=False):
+    """Project workflow step."""
+
+    name: Required[str]
+    consensus_coverage: Optional[int]
+    number_of_expected_labels_for_consensus: Optional[int]
+    order: Required[int]
+    step_coverage: Optional[int]
+    type: Required[Literal["DEFAULT", "REVIEW"]]
+    assignees: Required[List[str]]
+
+
+class WorkflowStepUpdate(TypedDict, total=False):
+    """Project workflow step."""
+
+    id: Required[str]
+    name: Optional[str]
+    consensus_coverage: Optional[int]
+    number_of_expected_labels_for_consensus: Optional[int]
+    order: Optional[int]
+    step_coverage: Optional[int]
+    type: Optional[Literal["DEFAULT", "REVIEW"]]
+    assignees: Optional[List[str]]
+
+
+@dataclass(frozen=True)
+class Workflow(TypedDict, total=True):
+    """Workflow step type."""
+
+    enforce_step_separation: bool
+    steps: List[WorkflowStepCreate]
+
+
 class InputTypeEnum(str, Enum):
     """Input type enum."""
 

src/kili/presentation/client/project.py

@@ -16,7 +16,7 @@
 
 from kili.adapters.kili_api_gateway.helpers.queries import QueryOptions
 from kili.core.enums import DemoProjectType, ProjectType
-from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId
+from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId, Workflow
 from kili.domain.tag import TagId
 from kili.domain.types import ListOrTuple
 from kili.exceptions import IncompatibleArgumentsError
@@ -47,6 +47,7 @@ def create_project(
         tags: Optional[ListOrTuple[str]] = None,
         compliance_tags: Optional[ListOrTuple[ComplianceTag]] = None,
         from_demo_project: Optional[DemoProjectType] = None,
+        workflow: Optional[Workflow] = None,
     ) -> Dict[Literal["id"], str]:
         """Create a project.
 
@@ -81,6 +82,7 @@ def create_project(
                 - `DEMO_LLM`
                 - `DEMO_LLM_INSTR_FOLLOWING`
                 - `DEMO_SEGMENTATION`
+            workflow: The workflow settings to use for the project.
 
         Returns:
             A dict with the id of the created project.
@@ -113,6 +115,7 @@ def create_project(
             project_type=project_type,
             compliance_tags=compliance_tags,
             from_demo_project=from_demo_project,
+            workflow=workflow,
         )
 
         if tags is not None:

src/kili/presentation/client/project_workflow.py

@@ -4,7 +4,7 @@
 
 from typeguard import typechecked
 
-from kili.domain.project import ProjectId
+from kili.domain.project import ProjectId, WorkflowStepCreate, WorkflowStepUpdate
 from kili.use_cases.project_workflow import ProjectWorkflowUseCases
 
 from .base import BaseClientMethods
@@ -18,6 +18,9 @@ def update_project_workflow(
         self,
         project_id: str,
         enforce_step_separation: Optional[bool] = None,
+        create_steps: Optional[List[WorkflowStepCreate]] = None,
+        update_steps: Optional[List[WorkflowStepUpdate]] = None,
+        delete_steps: Optional[List[str]] = None,
     ) -> Dict[str, Any]:
         """Update properties of a project workflow.
 
@@ -26,6 +29,9 @@ def update_project_workflow(
             enforce_step_separation: Prevents the same user from being assigned to
                 multiple steps in the workflow for a same asset,
                 ensuring independent review and labeling processes
+            create_steps: List of steps to create in the project workflow.
+            update_steps: List of steps to update in the project workflow.
+            delete_steps: List of step IDs to delete from the project workflow.
 
         Returns:
             A dict with the changed properties which indicates if the mutation was successful,
@@ -34,6 +40,9 @@ def update_project_workflow(
         return ProjectWorkflowUseCases(self.kili_api_gateway).update_project_workflow(
             project_id=ProjectId(project_id),
             enforce_step_separation=enforce_step_separation,
+            create_steps=create_steps,
+            update_steps=update_steps,
+            delete_steps=delete_steps,
         )
 
     @typechecked

src/kili/use_cases/project/project.py

@@ -12,7 +12,14 @@
 from kili.adapters.kili_api_gateway.project.mappers import project_data_mapper
 from kili.adapters.kili_api_gateway.project.types import ProjectDataKiliAPIGatewayInput
 from kili.core.enums import DemoProjectType, ProjectType
-from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId, ProjectStep
+from kili.domain.project import (
+    ComplianceTag,
+    InputType,
+    ProjectFilters,
+    ProjectId,
+    ProjectStep,
+    Workflow,
+)
 from kili.domain.types import ListOrTuple
 from kili.exceptions import NotFound
 from kili.use_cases.base import BaseUseCases
@@ -32,6 +39,7 @@ def create_project(
         project_id: Optional[ProjectId] = None,
         input_type: Optional[InputType] = None,
         json_interface: Optional[Dict] = None,
+        workflow: Optional[Workflow] = None,
     ) -> ProjectId:
         """Create or copy a project if project_id is set."""
         if project_id is not None:
@@ -49,6 +57,7 @@ def create_project(
                 project_type=project_type,
                 compliance_tags=compliance_tags,
                 from_demo_project=from_demo_project,
+                workflow=workflow,
             )
             if project_copied["instructions"]:
                 self.update_properties_in_project(
@@ -78,6 +87,7 @@ def create_project(
                 project_type=project_type,
                 compliance_tags=compliance_tags,
                 from_demo_project=from_demo_project,
+                workflow=workflow,
             )
 
         # The project is not immediately available after creation

src/kili/use_cases/project_workflow/__init__.py

@@ -5,7 +5,7 @@
 from kili.adapters.kili_api_gateway.project_workflow.types import (
     ProjectWorkflowDataKiliAPIGatewayInput,
 )
-from kili.domain.project import ProjectId
+from kili.domain.project import ProjectId, WorkflowStepCreate, WorkflowStepUpdate
 from kili.use_cases.base import BaseUseCases
 
 
@@ -16,10 +16,16 @@ def update_project_workflow(
         self,
         project_id: ProjectId,
         enforce_step_separation: Optional[bool] = None,
+        create_steps: Optional[List[WorkflowStepCreate]] = None,
+        update_steps: Optional[List[WorkflowStepUpdate]] = None,
+        delete_steps: Optional[List[str]] = None,
     ) -> Dict[str, object]:
         """Update properties in a project workflow."""
         project_workflow_data = ProjectWorkflowDataKiliAPIGatewayInput(
             enforce_step_separation=enforce_step_separation,
+            create_steps=create_steps,
+            update_steps=update_steps,
+            delete_steps=delete_steps,
         )
 
         return self._kili_api_gateway.update_project_workflow(project_id, project_workflow_data)

tests/integration/presentation/test_project.py

@@ -29,6 +29,7 @@ def test_when_creating_project_then_it_returns_project_id(mocker: pytest_mock.Mo
                 "projectType": None,
                 "title": "fake_title",
                 "fromDemoProject": None,
+                "workflow": None,
             }
         },
     )