Merge pull request #2022 from kili-technology/feature/lab-4173-aau-i-use-specific-methods-to-manage-reviewers-in-the

fix(LAB-4173): create methods to add or remove reviewers on a step an…

Author: stchabi

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

@@ -12,15 +12,12 @@ 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
-        }
-    }
-}
-"""
+def get_steps_query(fragment: str) -> str:
+    """Return the GraphQL getSteps query."""
+    return f"""
+        query getSteps($where: ProjectWhere!, $first: PageSize!, $skip: Int!) {{
+            data: projects(where: $where, first: $first, skip: $skip) {{
+            {fragment}
+            }}
+        }}
+        """

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

@@ -1,16 +1,19 @@
 """Mixin extending Kili API Gateway class with Projects related operations."""
-
+import warnings
 
 from kili.adapters.kili_api_gateway.base import BaseOperationMixin
 from kili.adapters.kili_api_gateway.helpers.queries import (
+    QueryOptions,
     fragment_builder,
 )
+from kili.core.graphql.operations.project_user.queries import ProjectUserQuery, ProjectUserWhere
 from kili.domain.project import ProjectId
+from kili.domain.types import ListOrTuple
 from kili.exceptions import NotFound
 
 from .mappers import project_input_mapper
 from .operations import (
-    GQL_GET_STEPS,
+    get_steps_query,
     get_update_project_workflow_mutation,
 )
 from .types import ProjectWorkflowDataKiliAPIGatewayInput
@@ -37,13 +40,12 @@ def update_project_workflow(
         result = self.graphql_client.execute(mutation, variables)
         return result["data"]
 
-    def get_steps(
-        self,
-        project_id: str,
-    ) -> list[dict]:
+    def get_steps(self, project_id: str, fields: ListOrTuple[str]) -> list[dict]:
         """Get steps in a project workflow."""
+        fragment = fragment_builder(fields)
+        query = get_steps_query(fragment)
         variables = {"where": {"id": project_id}, "first": 1, "skip": 0}
-        result = self.graphql_client.execute(GQL_GET_STEPS, variables)
+        result = self.graphql_client.execute(query, variables)
         project = result["data"]
 
         if len(project) == 0:
@@ -57,3 +59,104 @@ def get_steps(
             )
 
         return steps
+
+    def add_reviewers_to_step(
+        self, project_id: str, step_name: str, emails: list[str]
+    ) -> list[str]:
+        """Add reviewers to a specific step."""
+        existing_members = ProjectUserQuery(self.graphql_client, self.http_client)(
+            where=ProjectUserWhere(project_id=project_id, status="ACTIVATED"),
+            fields=["role", "user.email", "user.id", "activated"],
+            options=QueryOptions(None),
+        )
+        members_by_email = {m["user"]["email"]: m for m in (existing_members or [])}
+        assignees_to_add = []
+        assignees_added = []
+        assignees_not_added = []
+        for email in emails:
+            member = members_by_email.get(email)
+
+            if member and member.get("role") != "LABELER":
+                user_id = member["user"]["id"]
+                assignees_to_add.append(user_id)
+                assignees_added.append(email)
+            else:
+                assignees_not_added.append(email)
+        if assignees_not_added:
+            warnings.warn(
+                "These emails were not added (not found or can not review): "
+                + ", ".join(assignees_not_added)
+            )
+        steps = self.get_steps(
+            project_id, fields=["steps.id", "steps.name", "steps.type", "steps.assignees.id"]
+        )
+        target_step = next((s for s in steps if s.get("name") == step_name), None)
+        if not target_step:
+            raise ValueError(f"Step '{step_name}' not found in project workflow")
+        if target_step.get("type") == "DEFAULT":
+            raise ValueError("The step must be a review step, can't add reviewers to a label step")
+        current_ids = [a["id"] for a in target_step.get("assignees", [])]
+
+        merged_ids = list(dict.fromkeys(current_ids + assignees_to_add))
+
+        self.update_project_workflow(
+            project_id=ProjectId(project_id),
+            project_workflow_data=ProjectWorkflowDataKiliAPIGatewayInput(
+                None, None, [{"id": target_step["id"], "assignees": merged_ids}], None
+            ),
+        )
+        return assignees_added
+
+    def remove_reviewers_from_step(
+        self, project_id: str, step_name: str, emails: list[str]
+    ) -> list[str]:
+        """Remove reviewers from a specific step."""
+        steps = self.get_steps(
+            project_id,
+            fields=[
+                "steps.id",
+                "steps.name",
+                "steps.type",
+                "steps.assignees.id",
+                "steps.assignees.email",
+            ],
+        )
+        target_step = next((s for s in steps if s.get("name") == step_name), None)
+        if not target_step:
+            raise ValueError(f"Step '{step_name}' not found in project workflow")
+        if target_step.get("type") == "DEFAULT":
+            raise ValueError(
+                "The step must be a review step, can't remove reviewers from a label step"
+            )
+        assignees = target_step.get("assignees", [])
+        email_to_id = {a["email"]: a["id"] for a in assignees}
+        removed_emails = []
+        not_removed_emails = []
+        ids_to_remove = []
+        for email in emails:
+            user_id = email_to_id.get(email)
+            if not user_id:
+                not_removed_emails.append(email)
+                continue
+            removed_emails.append(email)
+            ids_to_remove.append(user_id)
+
+        if ids_to_remove:
+            new_assignees_ids = [
+                a["id"] for a in assignees if a.get("id") and a["id"] not in ids_to_remove
+            ]
+
+            self.update_project_workflow(
+                project_id=ProjectId(project_id),
+                project_workflow_data=ProjectWorkflowDataKiliAPIGatewayInput(
+                    None, None, [{"id": target_step["id"], "assignees": new_assignees_ids}], None
+                ),
+            )
+
+        if not_removed_emails:
+            warnings.warn(
+                "These emails were not removed because they are not assigned to this step: "
+                + ", ".join(not_removed_emails),
+            )
+
+        return removed_emails

src/kili/domain_api/projects.py

@@ -7,13 +7,7 @@
 
 from collections.abc import Generator, Iterable, Sequence
 from functools import cached_property
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Literal,
-    Optional,
-    TypedDict,
-)
+from typing import TYPE_CHECKING, Any, List, Literal, Optional, TypedDict
 
 from typeguard import typechecked
 from typing_extensions import deprecated
@@ -285,6 +279,48 @@ def list(self, project_id: str) -> list[dict[str, Any]]:
         """
         return self._client.get_steps(project_id=project_id)
 
+    @typechecked
+    def add_reviewers(
+        self,
+        project_id: str,
+        step_name: str,
+        emails: List[str],
+    ) -> List[str]:
+        """Add reviewers to a specific step.
+
+        Args:
+            project_id: Id of the project.
+            step_name: Name of the step.
+            emails: List of emails to add.
+
+        Returns:
+            A list with emails added to the step.
+        """
+        return self._client.add_reviewers_to_step(
+            project_id=project_id, step_name=step_name, emails=emails
+        )
+
+    @typechecked
+    def remove_reviewers(
+        self,
+        project_id: str,
+        step_name: str,
+        emails: List[str],
+    ) -> List[str]:
+        """Remove reviewers from a specific step.
+
+        Args:
+            project_id: Id of the project.
+            step_name: Name of the step.
+            emails: List of emails to remove.
+
+        Returns:
+            A list with emails removed from the step.
+        """
+        return self._client.remove_reviewers_from_step(
+            project_id=project_id, step_name=step_name, emails=emails
+        )
+
 
 class ProjectsNamespace(DomainNamespace):
     """Projects domain namespace providing project-related operations.

src/kili/presentation/client/project_workflow.py

@@ -7,6 +7,7 @@
 from kili.domain.project import ProjectId, WorkflowStepCreate, WorkflowStepUpdate
 from kili.use_cases.project_workflow import ProjectWorkflowUseCases
 
+from ...domain.types import ListOrTuple
 from .base import BaseClientMethods
 
 
@@ -49,15 +50,60 @@ def update_project_workflow(
     def get_steps(
         self,
         project_id: str,
+        fields: ListOrTuple[str] = (
+            "steps.type",
+            "steps.name",
+            "steps.id",
+            "steps.assignees.email",
+            "steps.assignees.id",
+        ),
     ) -> list[dict[str, Any]]:
         """Get steps in a project workflow.
 
         Args:
             project_id: Id of the project.
+            fields: All the fields to request among the possible fields for the project.
+                See the documentation for all possible fields.
 
         Returns:
             A dict with the steps of the project workflow.
         """
         return ProjectWorkflowUseCases(self.kili_api_gateway).get_steps(
-            project_id=ProjectId(project_id),
+            project_id=ProjectId(project_id), fields=fields
+        )
+
+    @typechecked
+    def add_reviewers_to_step(
+        self, project_id: str, step_name: str, emails: list[str]
+    ) -> list[str]:
+        """Add reviewers to a specific step.
+
+        Args:
+            project_id: Id of the project.
+            step_name: Name of the step.
+            emails: List of emails to add.
+
+        Returns:
+            A list with the added emails.
+        """
+        return ProjectWorkflowUseCases(self.kili_api_gateway).add_reviewers_to_step(
+            project_id=project_id, step_name=step_name, emails=emails
+        )
+
+    @typechecked
+    def remove_reviewers_from_step(
+        self, project_id: str, step_name: str, emails: list[str]
+    ) -> list[str]:
+        """Remove reviewers from a specific step.
+
+        Args:
+            project_id: Id of the project.
+            step_name: Name of the step.
+            emails: List of emails to remove.
+
+        Returns:
+            A list with the removed emails.
+        """
+        return ProjectWorkflowUseCases(self.kili_api_gateway).remove_reviewers_from_step(
+            project_id=project_id, step_name=step_name, emails=emails
         )

src/kili/use_cases/project_workflow/__init__.py

@@ -6,6 +6,7 @@
     ProjectWorkflowDataKiliAPIGatewayInput,
 )
 from kili.domain.project import ProjectId, WorkflowStepCreate, WorkflowStepUpdate
+from kili.domain.types import ListOrTuple
 from kili.use_cases.base import BaseUseCases
 
 
@@ -33,6 +34,19 @@ def update_project_workflow(
     def get_steps(
         self,
         project_id: ProjectId,
+        fields: ListOrTuple[str],
     ) -> list[dict[str, object]]:
         """Get steps in a project workflow."""
-        return self._kili_api_gateway.get_steps(project_id)
+        return self._kili_api_gateway.get_steps(project_id, fields)
+
+    def add_reviewers_to_step(
+        self, project_id: str, step_name: str, emails: list[str]
+    ) -> list[str]:
+        """Add reviewers to a specific step."""
+        return self._kili_api_gateway.add_reviewers_to_step(project_id, step_name, emails)
+
+    def remove_reviewers_from_step(
+        self, project_id: str, step_name: str, emails: list[str]
+    ) -> list[str]:
+        """Remove reviewers from a specific step."""
+        return self._kili_api_gateway.remove_reviewers_from_step(project_id, step_name, emails)