api.views: add try push handover functionality (bug 2002566)

- add functionality that adds try_task_config.json file
- update landing worker to process handover jobs
- add PullRequestTryLintAPIView
- add LandingJob.handover_repo field and migrations
- add LandingJob.is_handed_over field and migrations
- add Repo.is_try helper method

Pull request: #748

Author: zzzeid

src/lando/api/legacy/workers/landing_worker.py

@@ -1,4 +1,5 @@
 import configparser
+import json
 import logging
 import subprocess
 from pathlib import Path
@@ -172,15 +173,27 @@ def run_job(self, job: LandingJob) -> bool:
 
         return True
 
+    def add_try_task_config(self, scm: AbstractSCM):
+        with (Path(scm.path) / "try_task_config.json").open("x") as f:
+            data = {
+                "parameters": {
+                    "optimize_target_tasks": True,
+                    "target_tasks_method": "codereview",
+                },
+                "version": 2,
+            }
+            content = json.dumps(data)
+            f.write(content)
+
     def convert_patches_to_diff(self, scm: AbstractSCM, job: LandingJob):
         """Generate a unified diff from multiple patches stored in a revision."""
         # NOTE: this only applies to git patches that are downloaded from GitHub
         # at this time. In theory this would work for any provided patches in a
         # standard format.
 
-        def get_diff_from_patches(revision: Revision) -> str:
+        def add_diff_from_patches(revision: Revision) -> str:
             logger.debug(f"Converting paches to single diff for {revision} ...")
-            return scm.get_diff_from_patches(revision.patches)
+            return scm.add_diff_from_patches(revision.patches)
 
         # NOTE: this is only supported for jobs with a single revision at this time.
         # See bug 2001185.
@@ -197,7 +210,7 @@ def get_diff_from_patches(revision: Revision) -> str:
             raise ValueError("Revision is missing patches.")
 
         diff = self.handle_new_commit_failures(
-            get_diff_from_patches,
+            add_diff_from_patches,
             job.target_repo,
             job,
             scm,
@@ -230,6 +243,19 @@ def apply_patch(revision: Revision):
 
         self.update_repo(repo, job, scm, job.target_commit_hash)
 
+        if job.is_pull_request_job and job.handover_repo:
+            if not job.handover_repo.is_try:
+                raise ValueError(
+                    f"{job} handover to non-try repo ({job.handover_repos}) is not supported"
+                )
+
+            self.add_try_task_config(scm)
+            self.convert_patches_to_diff(scm, job)
+            job.handover()
+            message = "Job deferred to try repo."
+            job.transition_status(JobAction.DEFER, message=message)
+            raise TemporaryFailureException(message)
+
         if job.is_pull_request_job:
             self.convert_patches_to_diff(scm, job)
             self.update_repo(repo, job, scm, job.target_commit_hash)

src/lando/api/views.py

@@ -305,3 +305,48 @@ def get(self, request: WSGIRequest, repo_name: str, number: int) -> JsonResponse
             target_repo, pull_request, request
         )
         return JsonResponse(warnings_and_blockers)
+
+
+class PullRequestTryPushAPIView(APIView):
+    @method_decorator(require_authenticated_user)
+    def post(
+        self, request: WSGIRequest, repo_name: str, pull_number: int
+    ) -> JsonResponse:
+        try:
+            try_repo = Repo.objects.get(name="try")
+        except Repo.DoesNotExist:
+            return JsonResponse({"errors": ["Try repo does not exist"]}, 500)
+
+        target_repo = Repo.objects.get(name=repo_name)
+        client = GitHubAPIClient(target_repo.url)
+        ldap_username = request.user.email
+        pull_request = client.build_pull_request(pull_number)
+
+        job = LandingJob.objects.create(
+            target_repo=target_repo,
+            is_handed_over=False,
+            is_pull_request_job=True,
+            handover_repo=try_repo,
+            requester_email=ldap_username,
+        )
+        author_name, author_email = pull_request.author
+        try:
+            timestamp = int(datetime.fromisoformat(pull_request.updated_at).timestamp())
+        except ValueError:
+            timestamp = int(datetime.now().timestamp())
+        patch_data = {
+            "author_name": author_name,
+            "author_email": author_email,
+            "commit_message": pull_request.commit_message,
+            "timestamp": timestamp,
+        }
+        revision = Revision.objects.create(
+            pull_number=pull_request.number,
+            patches=pull_request.patch,
+            patch_data=patch_data,
+        )
+        add_revisions_to_job([revision], job)
+        job.status = JobStatus.SUBMITTED
+        job.save()
+
+        return JsonResponse({"id": job.id}, status=201)

src/lando/main/migrations/0042_landingjob_handover_repo_landingjob_is_handed_over.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.2.8 on 2025-12-16 17:25
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("main", "0041_revision_pull_base_sha_revision_pull_head_sha"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="landingjob",
+            name="handover_repo",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="handover_jobs",
+                to="main.repo",
+            ),
+        ),
+        migrations.AddField(
+            model_name="landingjob",
+            name="is_handed_over",
+            field=models.BooleanField(blank=True, null=True),
+        ),
+    ]

src/lando/main/models/landing_job.py

@@ -48,6 +48,18 @@ class LandingJob(BaseJob):
 
     is_pull_request_job = models.BooleanField(default=False, blank=True)
 
+    # Reference to the handover repo. A handover repo is a repo that a landing
+    # job is handed over to after being processed in a previous state. If this value
+    # is set, the job will be processed twice, but pushed once.
+    handover_repo = models.ForeignKey(
+        Repo,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name="handover_jobs",
+    )
+    is_handed_over = models.BooleanField(null=True, blank=True)
+
     @property
     def landed_phabricator_revisions(self) -> dict:
         """Return a mapping associating Phabricator revision IDs with the ID of the landed Diff."""
@@ -113,6 +125,25 @@ def serialized_landing_path(self) -> list[dict]:
             for revision_id, diff_id in self.landed_revisions.items()
         ]
 
+    def handover(self):
+        if not self.is_pull_request_job:
+            raise NotImplementedError(
+                "Handover is only supported for pull request jobs"
+            )
+        if self.is_handed_over:
+            raise ValueError(f"{self} is already handed over")
+        if not self.handover_repo:
+            raise ValueError(f"{self} does not have a handover repo defined")
+        if not self.handover_repo.is_try:
+            raise NotImplementedError(
+                "Handover is currently only supported for try repo"
+            )
+
+        self.target_repo = self.handover_repo
+        self.is_pull_request_job = False
+        self.is_handed_over = True
+        self.save()
+
     @property
     def has_phabricator_revisions(self) -> bool:
         """Indicate if this job has Phabricator revisions by checking the first in the stack."""

src/lando/main/models/repo.py

@@ -29,6 +29,8 @@
     ),
 )
 
+TRY_REPO_NAMES = ("try",)
+
 
 def validate_path_in_repo_root(value: str):
     path = Path(value)
@@ -101,6 +103,10 @@ class HooksChoices(models.TextChoices):
     def path(self) -> str:
         return str(self.system_path) or self.get_system_path()
 
+    @property
+    def is_try(self) -> bool:
+        return self.name in TRY_REPO_NAMES
+
     # TODO: help text for fields below.
     name = models.CharField(max_length=255, unique=True)
     default_branch = models.CharField(max_length=255, default="", blank=True)

src/lando/main/scm/git.py

@@ -203,7 +203,7 @@ def apply_patch_git(self, patch_bytes: bytes):
                 raise exc
 
     @detect_patch_conflict
-    def get_diff_from_patches(self, patches: str) -> str:
+    def add_diff_from_patches(self, patches: str) -> str:
         """Apply multiple patches and return the diff output."""
         # TODO: add error handling so that if something goes wrong here,
         # a meaningful error is stored in the landing job. This would be

src/lando/main/tests/test_git.py

@@ -1069,7 +1069,7 @@ def test_GitSCM_process_merge_conflict_no_reject(
     ), "Missing default message from `content` in rejects_paths for that-other-file.txt"
 
 
-def test_GitSCM_get_diff_from_patches(
+def test_GitSCM_add_diff_from_patches(
     git_patch: Callable,
     git_repo: Path,
     git_setup_user: Callable,
@@ -1128,5 +1128,5 @@ def test_GitSCM_get_diff_from_patches(
         """
     ).lstrip()
 
-    diff = scm.get_diff_from_patches(patches)
+    diff = scm.add_diff_from_patches(patches)
     assert diff == expected_diff, "Did not generate expected diff from patches"

src/lando/urls.py

@@ -24,6 +24,7 @@
     LandingJobPullRequestAPIView,
     LegacyDiffWarningView,
     PullRequestChecksAPIView,
+    PullRequestTryPushAPIView,
     git2hgCommitMapView,
     hg2gitCommitMapView,
 )
@@ -116,6 +117,11 @@
         LandingJobPullRequestAPIView.as_view(),
         name="api-landing-job-pull-request",
     ),
+    path(
+        "api/pulls/<str:repo_name>/<int:pull_number>/try_jobs",
+        PullRequestTryPushAPIView.as_view(),
+        name="api-try-job-pull-request",
+    ),
     path(
         "api/pulls/<str:repo_name>/<int:number>/checks",
         PullRequestChecksAPIView.as_view(),