uplift: display commands required to resolve merge conflicts (Bug 2004186)

Add a dropdown to display commands for the user to run to manually
resolve merge conflicts and submit their uplift.

Pull request: #746

Author: cgsheeh

src/lando/jinja.py

@@ -10,6 +10,7 @@
 from django.urls import reverse
 from django.utils.html import escape
 from jinja2 import Environment
+from markupsafe import Markup
 
 from lando.main.models import JobStatus, LandingJob, Repo, UpliftJob
 from lando.main.scm import SCM_TYPE_GIT
@@ -137,7 +138,7 @@ def uplift_status_icon_class(job: UpliftJob) -> str:
     return ""
 
 
-def uplift_status_label(job: UpliftJob) -> str:
+def uplift_status_label(job: UpliftJob) -> str | Markup:
     try:
         status = JobStatus(job.status)
     except ValueError:
@@ -146,9 +147,63 @@ def uplift_status_label(job: UpliftJob) -> str:
     if status == JobStatus.LANDED:
         return "Requested revisions apply cleanly to uplift branch; uplift revisions created"
 
+    if status == JobStatus.FAILED and job.error_breakdown:
+        return Markup(
+            "Manual merge conflict resolution and submission with "
+            "<code>moz-phab uplift</code> required"
+        )
+
     return status.label
 
 
+def build_manual_uplift_instructions(job: UpliftJob) -> str:
+    """Build manual uplift instructions for a failed uplift job.
+
+    Args:
+        job: The UpliftJob that failed with merge conflicts
+
+    Returns:
+        A multi-line string containing step-by-step instructions for manually
+        resolving conflicts and submitting the uplift.
+    """
+    # Get the train (repo short_name).
+    train = job.target_repo.short_name or "<train>"
+
+    # Get the default branch for the target repo.
+    default_branch = job.target_repo.default_branch or "<branch name>"
+
+    # Get the ordered revisions for this job.
+    revisions = list(job.revisions.all())
+
+    # Generate a suggested branch name.
+    if revisions and revisions[0].revision_id:
+        branch_name = f"uplift-{train}-D{revisions[0].revision_id}"
+    else:
+        branch_name = f"uplift-{train}-<revision>"
+
+    # Build the instructions.
+    instructions = []
+    instructions.append("git fetch origin")
+    instructions.append(f"git switch -c {branch_name} origin/{default_branch}")
+
+    # Add cherry-pick commands for each revision.
+    if revisions:
+        for revision in revisions:
+            if revision.commit_id:
+                instructions.append(f"git cherry-pick {revision.commit_id}")
+            else:
+                instructions.append(
+                    f"git cherry-pick <commit SHA for D{revision.revision_id}>"
+                )
+    else:
+        instructions.append("git cherry-pick <commit-sha-1>")
+        instructions.append("# ... cherry-pick additional commits as needed")
+
+    instructions.append(f"moz-phab uplift --train {train}")
+
+    return "\n".join(instructions)
+
+
 def reason_category_to_display(reason_category_str: str) -> str:
     try:
         return ReasonCategory(reason_category_str).label
@@ -416,6 +471,7 @@ def environment(**options):  # noqa: ANN201
             "uplift_status_icon_class": uplift_status_icon_class,
             "uplift_status_label": uplift_status_label,
             "uplift_status_tag_class": uplift_status_tag_class,
+            "build_manual_uplift_instructions": build_manual_uplift_instructions,
             "tree_category_to_display": tree_category_to_display,
             "treestatus_to_status_badge_class": treestatus_to_status_badge_class,
         }

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

@@ -6,5 +6,43 @@ $.fn.uplifts = function() {
 
     // Format timestamps.
     $uplifts.find('time[data-timestamp]').formatTime();
+
+    // Ensure all toggle content is hidden on page load.
+    $uplifts.find('.uplift-toggle-content').hide();
+
+    // Handle toggle for error details and command sections.
+    $uplifts.on('click', '.uplift-toggle', function(e) {
+      e.preventDefault();
+
+      let $button = $(this);
+      let targetId = $button.data('toggle-target');
+
+      // Find the content section with matching data-toggle-id.
+      let $targetContent = $uplifts.find(`.uplift-toggle-content[data-toggle-id="${targetId}"]`);
+
+      // Check if content is currently visible.
+      let isVisible = $targetContent.is(':visible');
+
+      // Toggle the visibility of the target content.
+      $targetContent.toggle();
+
+      // Find all buttons with the same target that are NOT inside the content.
+      // These are the "Show" buttons.
+      let $showButtons = $uplifts.find(`.uplift-toggle[data-toggle-target="${targetId}"]`).not($targetContent.find('.uplift-toggle'));
+
+      // Find all buttons with the same target (including inside content).
+      let $allButtons = $uplifts.find(`.uplift-toggle[data-toggle-target="${targetId}"]`);
+
+      // Update aria-expanded attributes for all related buttons.
+      if (isVisible) {
+        // Content is being hidden.
+        $showButtons.show().attr('aria-expanded', 'false');
+        $targetContent.find('.uplift-toggle').attr('aria-expanded', 'false');
+      } else {
+        // Content is being shown.
+        $showButtons.hide().attr('aria-expanded', 'true');
+        $targetContent.find('.uplift-toggle').attr('aria-expanded', 'true');
+      }
+    });
   });
 };

src/lando/ui/jinja2/stack/partials/uplift-section.html

@@ -209,13 +209,67 @@ <h1>Uplifts</h1>
                                             </p>
                                             {% if job.error %}
                                                 <div>
-                                                    <button type="button" class="button is-small is-light toggle-content">Show error details</button>
+                                                    <button type="button"
+                                                            class="button is-small is-light uplift-toggle"
+                                                            data-toggle-target="error-{{ job.id }}"
+                                                            aria-expanded="false"
+                                                            aria-controls="error-content-{{ job.id }}">
+                                                        Show error details
+                                                    </button>
+                                                    {% if job.error_breakdown %}
+                                                        <button type="button"
+                                                                class="button is-small is-light uplift-toggle ml-2"
+                                                                data-toggle-target="command-{{ job.id }}"
+                                                                aria-expanded="false"
+                                                                aria-controls="command-content-{{ job.id }}">
+                                                            Show resolution steps
+                                                        </button>
+                                                    {% endif %}
                                                 </div>
-                                                <div class="hidden-content has-text-left">
+                                                <div class="uplift-toggle-content hidden-content"
+                                                     id="error-content-{{ job.id }}"
+                                                     data-toggle-id="error-{{ job.id }}">
                                                     {% include "partials/error-breakdown.html" %}
                                                     <pre><strong>Raw error output:</strong>{{ "\n" + job.error }}</pre>
-                                                    <button type="button" class="button is-small is-light toggle-content">Hide error details</button>
+                                                    <button type="button"
+                                                            class="button is-small is-light uplift-toggle"
+                                                            data-toggle-target="error-{{ job.id }}"
+                                                            aria-expanded="true"
+                                                            aria-controls="error-content-{{ job.id }}">
+                                                        Hide error details
+                                                    </button>
                                                 </div>
+                                                {% if job.error_breakdown %}
+                                                    <div class="uplift-toggle-content hidden-content"
+                                                         id="command-content-{{ job.id }}"
+                                                         data-toggle-id="command-{{ job.id }}">
+                                                        <div class="notification is-info is-light mt-3">
+                                                            <p class="has-text-weight-semibold">
+                                                                <span class="icon is-small">
+                                                                    <i class="fa fa-terminal"></i>
+                                                                </span>
+                                                                To manually resolve conflicts and submit your uplift:
+                                                            </p>
+                                                            <pre class="mt-2"><code>{{ job|build_manual_uplift_instructions }}</code></pre>
+                                                            <p class="is-size-7 mt-2 has-text-grey-dark">
+                                                                Run these commands from your Firefox checkout. Resolve any merge conflicts during the cherry-pick process, then submit with <code>moz-phab uplift</code>.
+                                                            </p>
+                                                            <p class="is-size-7 mt-2 has-text-grey-dark">
+                                                                <strong>Note:</strong> These commands assume your official Firefox remote is named <code>origin</code>. If you use a different remote name, adjust the commands accordingly.
+                                                            </p>
+                                                            <p class="is-size-7 mt-2 has-text-grey-dark">
+                                                                After running <code>moz-phab uplift</code>, visit the Lando page for your new uplift revision and use the "Link Existing Assessment" button to link it to the assessment form you previously submitted.
+                                                            </p>
+                                                        </div>
+                                                        <button type="button"
+                                                                class="button is-small is-light uplift-toggle"
+                                                                data-toggle-target="command-{{ job.id }}"
+                                                                aria-expanded="true"
+                                                                aria-controls="command-content-{{ job.id }}">
+                                                            Hide resolution steps
+                                                        </button>
+                                                    </div>
+                                                {% endif %}
                                             {% endif %}
                                             {% if job.created_revision_ids %}
                                                 <div class="content">

src/lando/ui/tests/test_template_helpers.py

@@ -5,6 +5,7 @@
 
 from lando.jinja import (
     avatar_url,
+    build_manual_uplift_instructions,
     linkify_bug_numbers,
     linkify_faq,
     linkify_revision_ids,
@@ -16,6 +17,8 @@
     revision_url,
 )
 from lando.main.models import SCM_TYPE_GIT, SCM_TYPE_HG, JobStatus, LandingJob, Repo
+from lando.main.models.revision import Revision
+from lando.main.models.uplift import UpliftAssessment, UpliftJob, UpliftSubmission
 
 
 @pytest.mark.parametrize(
@@ -301,3 +304,54 @@ def test_revision_url__general_case_with_diff():
     expected_result = "http://phabricator.test/D123?id=456"
     actual_result = revision_url(revision_id, diff_id)
     assert expected_result == actual_result
+
+
+@pytest.mark.django_db
+def test_build_manual_uplift_instructions(user):
+    """Test manual uplift instructions with complete data."""
+    # Create repo with all expected fields set.
+    repo = Repo.objects.create(
+        name="firefox-beta",
+        short_name="beta",
+        default_branch="beta",
+        url="https://github.com/mozilla/gecko-dev",
+        scm_type=SCM_TYPE_GIT,
+    )
+
+    # Create revisions with commit IDs.
+    rev1 = Revision.objects.create(revision_id=123, commit_id="abc123def456")
+    rev2 = Revision.objects.create(revision_id=124, commit_id="def789ghi012")
+    rev3 = Revision.objects.create(revision_id=125, commit_id="ghi345jkl678")
+
+    # Create assessment and submission.
+    assessment = UpliftAssessment.objects.create(
+        user=user,
+        user_impact="Test impact",
+        risk_level_explanation="Low risk",
+        string_changes="None",
+    )
+    submission = UpliftSubmission.objects.create(
+        requested_by=user,
+        assessment=assessment,
+        requested_revision_ids=[123, 124, 125],
+    )
+
+    # Create job and link revisions.
+    job = UpliftJob.objects.create(
+        target_repo=repo, status=JobStatus.FAILED, submission=submission
+    )
+    job.add_revisions([rev1, rev2, rev3])
+    job.sort_revisions([rev1, rev2, rev3])
+
+    result = build_manual_uplift_instructions(job)
+
+    expected = (
+        "git fetch origin\n"
+        "git switch -c uplift-beta-D123 origin/beta\n"
+        "git cherry-pick abc123def456\n"
+        "git cherry-pick def789ghi012\n"
+        "git cherry-pick ghi345jkl678\n"
+        "moz-phab uplift --train beta"
+    )
+
+    assert result == expected, "Generated commands should match expected."