pull_request: add ability to edit commit message from PR in Lando UI

src/lando/api/views.py

@@ -326,3 +326,21 @@ def get(
             # The StaleMetadataException error message is safe for user consumption.
             return JsonResponse({"errors": [str(exc)]}, status=500)
         return JsonResponse(warnings_and_blockers)
+
+
+class PullRequestContentAPIView(PullRequestAPIView):
+    def put(
+        self, request: WSGIRequest, repo_name: str, pull_number: int
+    ) -> JsonResponse:
+        class Form(forms.Form):
+            body = forms.CharField(required=False)
+            title = forms.CharField(max_length=256)
+
+        form = Form(json.loads(request.body))
+        if not form.is_valid():
+            return JsonResponse(form.errors, status=400)
+
+        result = self.client.update_pull_request_content(
+            self.pull_request.number, **form.cleaned_data
+        )
+        return JsonResponse(result, status=200)

src/lando/static_src/legacy/js/components/Stack.js

@@ -71,7 +71,7 @@ $.fn.stack = function() {
     // This should be cleaned up as part of bug 1995754.
     var is_pull_request_page = Boolean($('button.post-landing-job').length);
     if (is_pull_request_page) {
-        var pull_request_button = $('button.post-landing-job');
+        var pull_request_button = $('button.post-landing-job');          
 
         $('#acknowledge-warnings').on("click", function () {
             if (this.checked) {
@@ -81,7 +81,7 @@ $.fn.stack = function() {
                 pull_request_button.prop("disabled", true);
                 pull_request_button.html("Acknowledge warnings to continue");
             }
-        });
+        });    
 
         if (pull_request_button.data("anonymous") == 1) {
             pull_request_button.prop("disabled", true);
@@ -198,6 +198,46 @@ $.fn.stack = function() {
                 }
             });
         });
-    };
-  });
+
+        $('button.save-pr').on('click', function(e) {
+            var body = document.getElementById('commit-body').value;
+            var title = document.getElementById('commit-title').value;
+
+                fetch(`/api/pulls/${repo_name}/${pull_number}`, {
+                    method: 'PUT',
+                    body: JSON.stringify({"body": body, "title": title}),
+                    headers: {
+                        'Accept': 'application/json',
+                        'Content-Type': 'application/json',
+                        'X-CSRFToken': csrf_token
+                    }
+                }).then(async (response) => {
+                console.log(response);
+                    if (response.status === 400) {
+                        var result = await response.json();
+                        if (result.title){ 
+                            document.getElementById("commit-title-error").textContent = result.title;
+                            document.getElementById("commit-title").classList.add("is-danger");
+                        }
+                        if (result.body){ //redundant right now since there isn't any manual checks for the message body
+                            document.getElementById("commit-body-error").textContent = result.body;
+                            document.getElementById("commit-body").classList.add("is-danger");
+                        }
+                        console.error("400:", result);
+                    }
+                    else if (response.status === 200) {
+                        document.getElementById("commit-title-error").textContent = "";
+                        document.getElementById("commit-body-error").textContent = ""; 
+                        document.getElementById("commit-title").classList.remove("is-danger");
+                        document.getElementById("commit-body").classList.remove("is-danger");
+                        window.location.reload();
+                    }
+                    else{
+                        console.error("error updating pull request:", response);
+                    }
+            });
+        });
+    }
+});
 };
+

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

@@ -61,13 +61,25 @@ <h1>
             </tr>
             <tr>
                 <th>Commit Title</th>
-                <td>{{ pull_request.title }}</td>
+                <td>
+                    <textarea contenteditable="true" id="commit-title" class="textarea">{{ pull_request.title }}</textarea>
+                    <p class="help is-danger" id="commit-title-error"></p>
+                </td>
             </tr>
             <tr>
                 <th>Commit Body</th>
-                <td>{{ pull_request.body }}</td>
+                <td>
+                    <textarea contenteditable="true" id="commit-body" class="textarea">{{ pull_request.parsed_body }}</textarea>
+                    <p class="help is-danger" id="commit-body-error"></p>
+                </td>
             </tr>
         </table>
+        <p>
+            <button class="button save-pr"
+                    data-pull-number="{{ pull_request.number }}"
+                    data-repo-name="{{ target_repo.name }}"
+                    data-csrf-token="{{ csrf_token }}">Save Commit Message</button>
+        </p>
     </div>
     <h1>Landings</h1>
     {% include "stack/partials/timeline.html" %}

src/lando/urls.py

@@ -25,6 +25,7 @@
     LandingJobPullRequestAPIView,
     LegacyDiffWarningView,
     PullRequestChecksAPIView,
+    PullRequestContentAPIView,
     git2hgCommitMapView,
     hg2gitCommitMapView,
 )
@@ -125,6 +126,11 @@
         PullRequestChecksAPIView.as_view(),
         name="api-pull-request-checks",
     ),
+    path(
+        "api/pulls/<str:repo_name>/<int:pull_number>",
+        PullRequestContentAPIView.as_view(),
+        name="api-pull-request-update-content",
+    ),
 ]
 
 # "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,15 @@ def add_comment_to_pull_request(self, pull_number: int, comment: str) -> dict:
             json={"body": comment},
         )
 
+    def update_pull_request_content(
+        self, pull_number: int, body: str, title: str
+    ) -> dict:
+        """Update the pull request description with provided body and title."""
+        return self._patch(
+            f"{self.repo_base_url}/issues/{pull_number}",
+            json={"body": body, "title": title},
+        )
+
     @classmethod
     def convert_timestamp_from_github(cls, timestamp: str) -> str:
         timestamp_datetime = datetime.fromisoformat(timestamp)
@@ -451,6 +472,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 +632,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}")