feat(LAB-3664): add method for list all available steps in a project (#1896)

Author: FannyGaudin

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

@@ -10,3 +10,12 @@ def project_input_mapper(data: ProjectWorkflowDataKiliAPIGatewayInput) -> Dict:
     return {
         "enforceStepSeparation": data.enforce_step_separation,
     }
+
+
+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.py

@@ -10,3 +10,18 @@ def get_update_project_workflow_mutation(fragment: str) -> str:
             }}
         }}
         """
+
+
+GQL_GET_STEPS = """
+query getSteps($where: ProjectWhere!, $first: PageSize!, $skip: Int!) {
+    data: projects(where: $where, first: $first, skip: $skip) {
+        id
+        steps {
+            id
+            name
+            type
+            isActivated
+        }
+    }
+}
+"""

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

@@ -1,15 +1,17 @@
 """Mixin extending Kili API Gateway class with Projects related operations."""
 
-from typing import Dict
+from typing import Dict, List
 
 from kili.adapters.kili_api_gateway.base import BaseOperationMixin
 from kili.adapters.kili_api_gateway.helpers.queries import (
     fragment_builder,
 )
 from kili.domain.project import ProjectId
+from kili.exceptions import NotFound
 
-from .mappers import project_input_mapper
+from .mappers import project_input_mapper, step_data_mapper
 from .operations import (
+    GQL_GET_STEPS,
     get_update_project_workflow_mutation,
 )
 from .types import ProjectWorkflowDataKiliAPIGatewayInput
@@ -35,3 +37,25 @@ def update_project_workflow(
         variables = {"input": project_workflow_input}
         result = self.graphql_client.execute(mutation, variables)
         return result["data"]
+
+    def get_steps(
+        self,
+        project_id: ProjectId,
+    ) -> List[Dict]:
+        """Get steps in a project workflow."""
+        variables = {"where": {"id": project_id}, "first": 1, "skip": 0}
+        result = self.graphql_client.execute(GQL_GET_STEPS, variables)
+        project = result["data"]
+
+        if len(project) == 0:
+            raise NotFound(f"project ID: {project_id}. The project does not exist.")
+
+        steps = project[0].get("steps")
+
+        if len(steps) == 0:
+            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]

src/kili/presentation/client/project_workflow.py

@@ -1,6 +1,6 @@
 """Client presentation methods for project workflow."""
 
-from typing import Any, Dict, Optional
+from typing import Any, Dict, List, Optional
 
 from typeguard import typechecked
 
@@ -35,3 +35,20 @@ def update_project_workflow(
             project_id=ProjectId(project_id),
             enforce_step_separation=enforce_step_separation,
         )
+
+    @typechecked
+    def get_steps(
+        self,
+        project_id: str,
+    ) -> List[Dict[str, Any]]:
+        """Get steps in a project workflow.
+
+        Args:
+            project_id: Id of the project.
+
+        Returns:
+            A dict with the steps of the project workflow.
+        """
+        return ProjectWorkflowUseCases(self.kili_api_gateway).get_steps(
+            project_id=ProjectId(project_id),
+        )

src/kili/use_cases/project_workflow/__init__.py

@@ -1,6 +1,6 @@
 """Project use cases."""
 
-from typing import Dict, Optional
+from typing import Dict, List, Optional
 
 from kili.adapters.kili_api_gateway.project_workflow.types import (
     ProjectWorkflowDataKiliAPIGatewayInput,
@@ -23,3 +23,10 @@ def update_project_workflow(
         )
 
         return self._kili_api_gateway.update_project_workflow(project_id, project_workflow_data)
+
+    def get_steps(
+        self,
+        project_id: ProjectId,
+    ) -> List[Dict[str, object]]:
+        """Get steps in a project workflow."""
+        return self._kili_api_gateway.get_steps(project_id)

tests/integration/presentation/test_project_workflow.py

@@ -5,6 +5,7 @@
     get_update_project_workflow_mutation,
 )
 from kili.presentation.client.project_workflow import ProjectWorkflowClientMethods
+from kili.use_cases.project_workflow import ProjectWorkflowUseCases
 
 
 def test_when_updating_project_workflow_then_it_returns_updated_project_workflow(
@@ -27,3 +28,26 @@ def test_when_updating_project_workflow_then_it_returns_updated_project_workflow
             "input": {"projectId": "fake_proj_id", "enforceStepSeparation": False},
         },
     )
+
+
+def test_when_getting_steps_then_it_returns_steps(
+    mocker: pytest_mock.MockerFixture,
+):
+    mocker.patch.object(
+        ProjectWorkflowUseCases,
+        "get_steps",
+        return_value=[{"id": "step_id", "name": "step_name", "type": "step_type"}],
+    )
+    kili = ProjectWorkflowClientMethods()
+    kili.kili_api_gateway = KiliAPIGateway(
+        graphql_client=mocker.MagicMock(), http_client=mocker.MagicMock()
+    )
+    # Given
+    project_id = "fake_proj_id"
+
+    # When
+    steps = kili.get_steps(project_id)
+
+    # Then
+
+    assert steps == [{"id": "step_id", "name": "step_name", "type": "step_type"}]