Update review progress dynamically

Author: simondanielsson

src/main.py

@@ -21,7 +21,7 @@ def launch_app() -> None:
 async def listen_for_messages() -> None:
     """Listen for messages from the RabbitMQ queue."""
     if config.amqp_mode == "rabbitmq":
-        logger.info("Starting AMQP consumer...")
+        logger.info("Starting RabbitMQ consumer...")
         rabbitmq_client = AsyncRabbitMQClient()
         await rabbitmq_client.connect()
 

src/reviews/constants.py

@@ -1,9 +1,17 @@
 """Constants for the reviews module."""
 
-from enum import StrEnum
+from enum import StrEnum, auto
 
 
 class AMQPQueues(StrEnum):
     """Constants for the AMQP queues used by the reviews module."""
 
     REVIEW_FILE_DIFF_QUEUE = "review-file-diffs"
+
+
+class ReviewStatus(StrEnum):
+    """Constants for the review status."""
+
+    queued = auto()
+    processing = auto()
+    available = auto()

src/reviews/dto/requests.py

@@ -2,7 +2,7 @@
 
 from pydantic import BaseModel
 
-from src.reviews.models.pull_requests import PullRequestFileChanges
+from src.reviews.models.pull_requests import FileReview, PullRequestFileChanges
 
 
 class CreateReviewFromFileDiffRequest(BaseModel):
@@ -11,3 +11,18 @@ class CreateReviewFromFileDiffRequest(BaseModel):
     review_id: int
     review_status_id: int
     file_diffs: list[PullRequestFileChanges]
+
+
+class UpdateProgressRequest(BaseModel):
+    """Request to update the progress of a review."""
+
+    progress: int
+    status: str
+
+
+class CompleteReviewRequest(BaseModel):
+    """Request to complete a review."""
+
+    review_id: int
+    review_status_id: int
+    file_reviews: list[FileReview]

src/reviews/dto/responses.py

@@ -1,13 +1 @@
 """Response DTOs for the reviews module."""
-
-from pydantic import BaseModel
-
-from src.reviews.models.pull_requests import FileReview
-
-
-class PRReviewResponse(BaseModel):
-    """Response for a pull request review."""
-
-    review_id: int
-    review_status_id: int
-    file_reviews: list[FileReview]

src/reviews/services/pull_requests_service.py

@@ -5,9 +5,9 @@
 
 from src.common.tools.review_pull_request import ReviewPullRequest
 from src.config import config
-from src.reviews.dto.responses import PRReviewResponse
+from src.reviews.constants import ReviewStatus
 from src.reviews.models.pull_requests import FileReview, PullRequestFileChanges
-from src.utils.http import send_http_post_request
+from src.utils import api
 
 logger = logging.getLogger(__name__)
 
@@ -20,35 +20,51 @@ async def create_review_from_file_diffs(
     """Create a pull request review from file diffs."""
     semaphore = asyncio.Semaphore(config.modules.reviews.max_concurrent_file_reviews)
 
+    total_files = len(file_diffs)
+    reviewed_files = 0
+
     review_tasks = [
         _review_file_diff(file_diff=file_diff, semaphore=semaphore)
         for file_diff in file_diffs
     ]
-    review_contents = await asyncio.gather(*review_tasks)
-    file_names = [review.filename for review in file_diffs]
-    patches = [review.patch for review in file_diffs]
+    review_per_file: dict[str, str] = {}
+    for task in asyncio.as_completed(review_tasks):
+        review_per_file |= await task
+
+        reviewed_files += 1
+        progress_value = int((reviewed_files / total_files) * 100)
+        await api.update_progress(
+            review_status_id,
+            progress_value,
+            ReviewStatus.processing,
+        )
 
-    review = PRReviewResponse(
+    patches_per_file = {file_diff.filename: file_diff.patch for file_diff in file_diffs}
+
+    file_reviews = [
+        FileReview(
+            filename=filename,
+            content=content,
+            patch=patches_per_file.get(filename, ""),
+        )
+        for filename, content in review_per_file.items()
+    ]
+    await api.complete_review(
         review_id=review_id,
         review_status_id=review_status_id,
-        file_reviews=[
-            FileReview(filename=filename, content=content, patch=patch)
-            for filename, content, patch in zip(file_names, review_contents, patches)
-        ],
+        file_reviews=file_reviews,
     )
-    url = f"{config.approved_api_url}/reviews/complete"
-    await send_http_post_request(content=review.model_dump(), url=url)
 
 
 async def _review_file_diff(
     file_diff: PullRequestFileChanges,
     semaphore: asyncio.Semaphore,
-) -> str:
+) -> dict[str, str]:
     """Create a review task for a single file.
 
     :param file_changes: The pull request file changes.
     :param semaphore: The semaphore.
-    :return: The review content.
+    :return: A mapping from the file name to the review content.
     """
     answer = ""
     async with semaphore:
@@ -57,4 +73,4 @@ async def _review_file_diff(
         async for review_content in review_content_iterator:
             answer += review_content
 
-    return answer
+    return {file_diff.filename: answer}

src/utils/api.py

@@ -0,0 +1,47 @@
+"""Utility functions for making API requests."""
+
+import logging
+
+from src.config import config
+from src.reviews.constants import ReviewStatus
+from src.reviews.dto.requests import CompleteReviewRequest, UpdateProgressRequest
+from src.reviews.models.pull_requests import FileReview
+from src.utils.http import send_http_post_request, send_http_put_request
+
+logger = logging.getLogger(__name__)
+
+
+async def update_progress(
+    review_status_id: int,
+    progress: int,
+    status: ReviewStatus,
+) -> None:
+    """Update progress of a review."""
+    payload = UpdateProgressRequest(
+        progress=progress,
+        status=status,
+    )
+
+    url = f"{config.approved_api_url}/review-status/{review_status_id}"
+    logger.info(
+        "Updating progress of review status %s to %s",
+        review_status_id,
+        progress,
+    )
+    await send_http_put_request(content=payload.model_dump(), url=url)
+
+
+async def complete_review(
+    review_id: int,
+    review_status_id: int,
+    file_reviews: list[FileReview],
+) -> None:
+    """Complete a review."""
+    review = CompleteReviewRequest(
+        review_id=review_id,
+        review_status_id=review_status_id,
+        file_reviews=file_reviews,
+    )
+    url = f"{config.approved_api_url}/reviews/complete"
+    logger.info("Completing review %s", review_id)
+    await send_http_post_request(content=review.model_dump(), url=url)

src/utils/http.py

@@ -28,3 +28,24 @@ async def send_http_post_request(content: dict, url: str) -> None:
             ) from e
 
     logger.info("Successfully sent HTTP request to %s", url)
+
+
+async def send_http_put_request(content: dict, url: str) -> None:
+    """Send."""
+    timeout = httpx.Timeout(config.modules.common.request_timeout, read=None)
+
+    async with httpx.AsyncClient() as client:
+        try:
+            callback = await client.put(
+                url,
+                timeout=timeout,
+                json=content,
+            )
+            callback.raise_for_status()
+        except httpx.HTTPStatusError as e:
+            msg = "Failed to send HTTP request message."
+            raise ValueError(
+                msg,
+            ) from e
+
+    logger.info("Successfully sent HTTP request to %s", url)