Refactor: Extract duplicate staged mode preview rendering into shared utility

[Copilot]

Summary

Successfully refactored duplicate staged mode preview rendering code across 5 JavaScript handlers into a shared utility module.

Changes Made

New Files

• pkg/workflow/js/staged_preview.cjs - Shared utility module (31 lines)
• pkg/workflow/js/staged_preview.test.cjs - Test suite (9 comprehensive tests)

Updated Files

• pkg/workflow/js/create_issue.cjs - Now uses shared utility (-10 lines)
• pkg/workflow/js/update_issue.cjs - Now uses shared utility (-4 lines)
• pkg/workflow/js/add_labels.cjs - Now uses shared utility (+1 line but cleaner)
• pkg/workflow/js/create_pr_review_comment.cjs - Now uses shared utility (-1 line)
• pkg/workflow/js/push_to_pull_request_branch.cjs - Now uses shared utility (-1 line)
• pkg/workflow/js/create_issue.test.cjs - Updated test expectations
• pkg/workflow/js.go - Added staged_preview.cjs to embedded sources

Latest Updates

• Added core.info logging for full summary content (addresses @pelikhan feedback)
• Added staged_preview.cjs to compiler bundler sources (addresses @pelikhan feedback)
• Merged main branch, formatted code, and recompiled workflows (addresses @pelikhan feedback)

Verification

• All 710 JavaScript tests passing (2 new tests from main branch)
• All Go unit tests passing
• Build successful
• JavaScript formatting verified with prettier
• JavaScript linting passed
• Bundler correctly includes staged_preview.cjs
• All 68 workflows successfully recompiled

Benefits

• Maintainability: Single source of truth for staged mode previews
• Consistency: All handlers use the same preview structure
• Testability: Dedicated test suite with 9 test cases
• Flexibility: Easy to extend with new preview types
• Code Quality: Cleaner, more maintainable codebase
• Visibility: Full preview content now logged for better debugging
• Up-to-date: Merged with latest main branch changes

Statistics

• Net code change: +131 insertions, -116 deletions
• Production code: +21 lines (handlers simplified, new utility added, bundler updated)
• Test code: +349 lines (comprehensive test coverage)
• Total tests: 710 passing (including 9 new utility tests + 2 from main)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[duplicate-code] 🔍 Duplicate Code Detected: Staged Mode Preview Rendering</issue_title>
<issue_description># 🔍 Duplicate Code Detected: Staged Mode Preview Rendering

Analysis of commit da2590c

Assignee: @copilot

Summary

Multiple agent workflow handlers duplicate the same "staged mode" preview logic: they filter staged items, build a Markdown summary with identical control flow, and bail out early. The structure is nearly identical across issue creation, updates, label application, PR review commenting, and push-to-branch workflows. Any behavioural change (new fields, formatting fixes, bug fixes) must be applied in five places today.

Duplication Details

Pattern: Staged Mode Preview Blocks in JS Handlers

• Severity: Medium
• Occurrences: 5
• Locations:
  • pkg/workflow/js/create_issue.cjs:64
  • pkg/workflow/js/update_issue.cjs:25
  • pkg/workflow/js/add_labels.cjs:19
  • pkg/workflow/js/create_pr_review_comment.cjs:83
  • pkg/workflow/js/push_to_pull_request_branch.cjs:140
• Code Sample:

if (isStaged) {
  let summaryContent = "## 🎭 Staged Mode: Create Issues Preview\n\n";
  summaryContent += "The following issues would be created if staged mode was disabled:\n\n";
  for (let i = 0; i < createIssueItems.length; i++) {
    const item = createIssueItems[i];
    summaryContent += `### Issue ${i + 1}\n`;
    summaryContent += `**Title:** ${item.title || "No title provided"}\n\n`;
    if (item.body) {
      summaryContent += `**Body:**\n${item.body}\n\n`;
    }
    if (item.labels && item.labels.length > 0) {
      summaryContent += `**Labels:** ${item.labels.join(", ")}\n\n`;
    }
    summaryContent += "---\n\n";
  }
  await core.summary.addRaw(summaryContent).write();
  core.info("📝 Issue creation preview written to step summary");
  return;
}

Impact Analysis

• Maintainability: Any tweak to staged-mode behaviour (formatting, localisation, accessibility) has to be replicated manually across five files, increasing the maintenance burden.
• Bug Risk: Divergent fixes are likely—several handlers already drift in messaging, which hints at future inconsistencies if one path is updated without the rest.
• Code Bloat: Each module carries ~15–20 lines of boilerplate that could be centralised, making these files longer and harder to scan.

Refactoring Recommendations

1. Extract Shared Preview Helper

   • Introduce a utility (e.g. pkg/workflow/js/staged_preview.cjs) that takes the staged items and a renderer callback to generate Markdown.
   • Estimated effort: 0.5–1 day, mainly for designing a flexible interface and updating call sites.
   • Benefits: Single source of truth for staged summaries, easier formatting changes, reduced code size.

2. Consolidate Environment Checks

   • Pair the helper with common loadAgentOutput success handling to remove redundant checks.
   • Estimated effort: additional 0.5 day to refactor callers safely.
   • Benefits: Prevents future copy/paste logic for staged-mode detection and reduces chances of divergent behaviour.

Implementation Checklist

• Review duplication findings
• Prioritize refactoring tasks
• Create refactoring plan
• Implement changes
• Update tests
• Verify no functionality broken

Analysis Metadata

• Analyzed Files: 5
• Detection Method: Serena semantic code analysis
• Commit: da2590c
• Analysis Date: 2025-11-05

AI generated by Duplicate Code Detector</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes [duplicate-code] 🔍 Duplicate Code Detected: Staged Mode Preview Rendering #3274

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[pelikhan]

@copilot render summary to core.info as well

[Copilot]

@copilot render summary to core.info as well

Done in 0c1f83a. The staged preview summary content is now logged to core.info in addition to being written to the step summary.

[github-actions]

Agentic Changeset Generator triggered by this pull request.

[pelikhan]

...

[pelikhan]

@copilot You must update the compiler and bundled JavaScript files to inline the new file.

See error: https://github.com/githubnext/gh-aw/actions/runs/19117338988/job/54629867586#step:4:1

[Copilot]

@copilot You must update the compiler and bundled JavaScript files to inline the new file.

See error: https://github.com/githubnext/gh-aw/actions/runs/19117338988/job/54629867586#step:4:1

Fixed in f02cbbe. Added staged_preview.cjs to the embedded JavaScript sources in pkg/workflow/js.go and included it in the GetJavaScriptSources() map so it's available during bundling.

[github-actions]

Agentic Changeset Generator triggered by this pull request.

[Copilot]

Pull Request Overview

This PR refactors duplicate staged mode preview generation logic across multiple workflow scripts by introducing a reusable generateStagedPreview utility function. The refactoring reduces code duplication and standardizes how staged mode previews are generated and displayed.

Key changes:

• Introduces a new staged_preview.cjs module with a generateStagedPreview function
• Refactors five workflow scripts to use the new utility instead of inline logic
• Updates test expectations to match the new standardized preview messages

Reviewed Changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
pkg/workflow/js/staged_preview.cjs	New utility module providing reusable generateStagedPreview function
pkg/workflow/js/staged_preview.test.cjs	Comprehensive test suite for the new utility
pkg/workflow/js/update_issue.cjs	Refactored to use generateStagedPreview
pkg/workflow/js/push_to_pull_request_branch.cjs	Refactored to use generateStagedPreview
pkg/workflow/js/create_pr_review_comment.cjs	Refactored to use generateStagedPreview
pkg/workflow/js/create_issue.cjs	Refactored to use generateStagedPreview
pkg/workflow/js/add_labels.cjs	Refactored to use generateStagedPreview
pkg/workflow/js/create_issue.test.cjs	Updated test assertion for new message format
pkg/workflow/js.go	Registered new script in Go embed mappings
.github/workflows/*.lock.yml	Auto-generated workflow files updated with new function

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[pelikhan]

@copilot merge main, format and recompile, fix tests

[Copilot]

@copilot merge main, format and recompile, fix tests

Done in 5e8eff2. Merged main branch, formatted code with make fmt, recompiled all workflows with make recompile, and verified all tests pass (710 JavaScript tests, all Go unit tests).

[github-actions]

Smoke Test Complete ✅

PR Titles:

• Enable --enable-api-proxy for Claude and Codex engines #15533: Enable --enable-api-proxy for Claude and Codex engines
• Add cache management commands for workflow cache-memory #15519: Add cache management commands for workflow cache-memory

Test Results:

• ✅ GitHub MCP
• ✅ Safe Inputs GH CLI
• ✅ Serena MCP
• ✅ Playwright
• ✅ File Writing
• ✅ Bash
• ✅ Discussion
• ✅ Build
• ✅ Workflow Dispatch
• ✅ PR Review

Status: PASS

cc @pelikhan

AI generated by Smoke Copilot