api.views: add pull request description view (bug 2024944)

Author: zzzeid

src/lando/api/views.py

@@ -5,14 +5,17 @@
 from typing import Callable
 
 from django import forms
+from django.conf import settings
 from django.core.handlers.wsgi import WSGIRequest
 from django.http import HttpRequest, JsonResponse
+from django.template.loader import render_to_string
+from django.urls import reverse
 from django.utils.decorators import method_decorator
 from django.utils.html import escape
 from django.views import View
 from django.views.decorators.csrf import csrf_exempt
 
-from lando.api.legacy.commit_message import replace_reviewers
+from lando.api.legacy.commit_message import parse_bugs, replace_reviewers
 from lando.main.auth import require_authenticated_user
 from lando.main.models import (
     CommitMap,
@@ -25,7 +28,12 @@
 from lando.main.models.landing_job import get_jobs_for_pull
 from lando.main.models.revision import DiffWarning, DiffWarningStatus
 from lando.main.scm import SCMType
-from lando.utils.github import GitHubAPIClient, PullRequest, PullRequestPatchHelper
+from lando.utils.github import (
+    SPECIAL_DELIMITER,
+    GitHubAPIClient,
+    PullRequest,
+    PullRequestPatchHelper,
+)
 from lando.utils.github_checks import (
     ALL_PULL_REQUEST_BLOCKERS,
     ALL_PULL_REQUEST_WARNINGS,
@@ -372,3 +380,45 @@ def post(
         job.save()
 
         return JsonResponse({"id": job.id}, status=201)
+
+
+@method_decorator(csrf_exempt, name="dispatch")
+class PullRequestEnhancedDescriptionAPIView(PullRequestAPIView):
+    """API methods to modify the pull request description box."""
+
+    @method_decorator(require_authenticated_user)
+    def get(
+        self, request: WSGIRequest, repo_name: str, pull_number: int
+    ) -> JsonResponse:
+        """Update PR description box with parsed content."""
+
+        if not request.user.has_perm("main.can_change_landing_job"):
+            raise PermissionError()
+
+        context = {}
+        context.update(
+            generate_warnings_and_blockers(self.target_repo, self.pull_request, request)
+        )
+
+        path = reverse(
+            "pull-request",
+            kwargs={
+                "repo_name": self.target_repo.name,
+                "number": self.pull_request.number,
+            },
+        )
+
+        context["lando_url"] = f"{settings.SITE_URL}{path}"
+        context["special_delimiter"] = SPECIAL_DELIMITER
+        bugs = parse_bugs(self.pull_request.title)
+        context["bugs"] = []
+
+        for bug in bugs:
+            context["bugs"].append((bug, f"{settings.BUGZILLA_URL}/{bug}"))
+
+        context["title"] = self.pull_request.title
+        context["body"] = self.pull_request.parsed_body
+
+        rendered = render_to_string("pr_description.md", context)
+        self.client.update_pull_request_body(pull_number, rendered)
+        return JsonResponse({"context": context, "md": rendered})

src/lando/jinja.py

@@ -448,6 +448,7 @@ def message_type_to_notification_class(flash_message_category: str) -> str:
 
 
 def environment(**options) -> Environment:
+    options.update({"trim_blocks": True, "lstrip_blocks": True})
     env = Environment(extensions=[CompressorExtension], **options)
     env.globals.update(
         {

src/lando/ui/jinja2/pr_description.md

@@ -0,0 +1,37 @@
+{# Helpers for generating warnings and blockers #}
+{% macro _warning(content) %}:warning: {{ content }}{% endmacro %}
+{% macro _blocker(content) %}:no_entry_sign: {{ content }}{% endmacro %}
+{% macro _column(content) %}|{{ content }}|{% endmacro %}
+{% macro _header() %}|---------|{% endmacro %}
+{% macro _table(title, entries, macro) %}
+{{ _column(title) }}
+{{ _header() }}
+{% for entry in entries %}
+{{ macro(entry) }}
+{% endfor %}
+{% endmacro %}
+
+{% block upper %}
+Lando: [link]({{ lando_url }})
+{% if bugs %}Bugzilla: {% for bug in bugs %}[bug {{ bug.0 }}]({{ bug.1 }}){% endfor %}{% endif %}
+
+{% if not warnings and not blockers %}
+:white_check_mark: All Lando checks passed
+{% endif %}
+
+{% if warnings %}
+{{ _table("Warnings", warnings, _warning) }}
+{% endif %}
+
+{% if blockers %}
+{{ _table("Blockers", blockers, _blocker) }}
+{% endif %}
+
+{% endblock %}
+
+<!--/ DO NOT REMOVE THE LINE BELOW /-->
+{{ special_delimiter }}
+
+{% block lower %}
+{{ body|e }}
+{% endblock %}

src/lando/ui/jinja2/stack/pull_request.html

@@ -82,7 +82,7 @@ <h1>
             </tr>
             <tr>
                 <th>Commit Body</th>
-                <td>{{ pull_request.body }}</td>
+                <td>{{ pull_request.parsed_body }}</td>
             </tr>
         </table>
     </div>

src/lando/ui/pull_requests.py

@@ -13,7 +13,7 @@
     get_jobs_for_pull,
 )
 from lando.ui.views import LandoView
-from lando.utils.github import GitHubAPIClient
+from lando.utils.github import SPECIAL_DELIMITER, GitHubAPIClient
 
 logger = logging.getLogger(__name__)
 
@@ -70,6 +70,7 @@ def get(
             "landing_jobs": landing_jobs,
             "last_try_job": last_try_job,
             "is_try_compatible": is_try_compatible,
+            "special_delimiter": SPECIAL_DELIMITER,
         }
 
         return TemplateResponse(

src/lando/urls.py

@@ -25,6 +25,7 @@
     LandingJobPullRequestAPIView,
     LegacyDiffWarningView,
     PullRequestChecksAPIView,
+    PullRequestEnhancedDescriptionAPIView,
     PullRequestTryPushAPIView,
     git2hgCommitMapView,
     hg2gitCommitMapView,
@@ -131,6 +132,11 @@
         PullRequestChecksAPIView.as_view(),
         name="api-pull-request-checks",
     ),
+    path(
+        "api/pulls/<str:repo_name>/<int:pull_number>/description",
+        PullRequestEnhancedDescriptionAPIView.as_view(),
+        name="api-pull-request-description",
+    ),
 ]
 
 # "API" endpoints ported from legacy API app.

src/lando/utils/github.py

@@ -22,6 +22,9 @@
 logger = logging.getLogger(__name__)
 
 
+SPECIAL_DELIMITER = "-" * 9
+
+
 class GitHub:
     """Work with authentication to GitHub repositories."""
 
@@ -150,6 +153,11 @@ def post(self, path: str, *args, **kwargs) -> requests.Response:
         url = f"{self.GITHUB_BASE_URL}/{path}"
         return self.session.post(url, *args, **kwargs)
 
+    def patch(self, path: str, *args, **kwargs) -> requests.Response:
+        """Send a PATCH request to the GitHub API with given args and kwargs."""
+        url = f"{self.GITHUB_BASE_URL}/{path}"
+        return self.session.patch(url, *args, **kwargs)
+
 
 class GitHubAPIClient:
     """A convenience client that provides various methods to interact with the GitHub API."""
@@ -230,6 +238,10 @@ def _post(self, path: str, *args, **kwargs):
         result = self._api.post(path, *args, **kwargs)
         return result.json()
 
+    def _patch(self, path: str, *args, **kwargs):
+        result = self._api.patch(path, *args, **kwargs)
+        return result.json()
+
     def build_pull_request(self, pull_number: int) -> "PullRequest":
         """Build a PullRequest object.
 
@@ -370,6 +382,13 @@ def add_comment_to_pull_request(self, pull_number: int, comment: str) -> dict:
             json={"body": comment},
         )
 
+    def update_pull_request_body(self, pull_number: int, body: str) -> dict:
+        """Update the pull request description with provided body."""
+        return self._patch(
+            f"{self.repo_base_url}/issues/{pull_number}",
+            json={"body": body},
+        )
+
     @classmethod
     def convert_timestamp_from_github(cls, timestamp: str) -> str:
         timestamp_datetime = datetime.fromisoformat(timestamp)
@@ -451,6 +470,9 @@ def __init__(self, client: GitHubAPIClient, data: dict):
         self.diff_url = data["diff_url"]
         self.patch_url = data["patch_url"]
         self.body = data["body"]  # description
+        self.parsed_body = (
+            self.body.split(SPECIAL_DELIMITER)[-1].strip() if self.body else ""
+        )
         self.is_draft = data["draft"]
         self.comments_url = data["comments_url"]
         self.commits_url = data["commits_url"]
@@ -608,8 +630,8 @@ def commit_message(self) -> str:
 
         lines = [self.title, ""]
 
-        if self.body:
-            lines += [self.body, ""]
+        if self.parsed_body:
+            lines += [self.parsed_body, ""]
 
         lines.append(f"Pull request: {self.html_url}")