Refactor: Extract duplicate comment helpers into separate modules by Copilot · Pull Request #3565 · github/gh-aw

Copilot · 2025-11-10T13:54:06Z

Refactor: Extract Duplicate Comment Output Helpers

This PR addresses duplicate code in comment-related safe-output scripts by extracting shared footer generation and repository URL helper logic into separate modules following the repository's pattern.

Plan

Changes Made

Split into separate modules following repository pattern:

pkg/workflow/js/generate_footer.cjs - Footer generation helper (44 lines)
pkg/workflow/js/generate_footer.test.cjs - Test suite (11 test cases)
pkg/workflow/js/get_repository_url.cjs - Repository URL helper (27 lines)
pkg/workflow/js/get_repository_url.test.cjs - Test suite (6 test cases)

Modified Files:

pkg/workflow/js/create_issue.cjs - Updated import
pkg/workflow/js/add_comment.cjs - Updated imports
pkg/workflow/js/create_pr_review_comment.cjs - Updated imports
pkg/workflow/js.go - Added both modules to embedded sources
26 workflow .lock.yml files - Recompiled with bundled helpers

Total Impact:

Code removed: ~154 lines of duplicate code
Code added: 71 lines of helpers (split into 2 files) + 229 lines of tests
Net reduction: ~83 lines (excluding tests)

Benefits

✅ Single point of truth for footer generation and repository URL logic
✅ Consistent messaging across all comment types (issues, PRs, discussions)
✅ Easier maintenance and future updates
✅ Follows repository pattern (one function per file)
✅ Comprehensive test coverage (17 total test cases split across 2 files)
✅ Valid bundled JavaScript (bundler fix from main handles multi-line exports)
✅ All workflows recompiled with updated helpers
✅ No functionality broken - all tests pass

Test Results

✓ generate_footer.test.cjs (11 tests)
✓ get_repository_url.test.cjs (6 tests)
✓ create_issue.test.cjs (22 tests)
✓ add_comment.test.cjs (16 tests)
✓ create_pr_review_comment.test.cjs (16 tests)

Total: 780 JavaScript tests pass + Go unit tests pass

Merged from main

Bundler fix for multi-line module.exports (Fix bundler generating invalid JavaScript for multi-line module.exports #3566)
Prompt generation refactoring (Standardize prompt generation pattern - move scattered functions to dedicated files #3564)
golang.org/x/sys update (Update golang.org/x/sys from v0.37.0 to v0.38.0 #3563)

Original prompt

This section details on the original issue you should resolve

<issue_title>[duplicate-code] 🔍 Duplicate Code Detected: Comment Output Helpers</issue_title>
<issue_description># 🔍 Duplicate Code Detected: Comment Output Helpers

Analysis of commit 7292890

Assignee: @copilot

Summary

Multiple comment-related safe-output scripts reimplement the same footer generation and repository URL helper logic. Keeping three divergent copies makes it easy to miss fixes (for example when updating footer text or URL logic) and inflates maintenance cost.

Duplication Details

Pattern: Repeated footer/repository helper functions across comment scripts
Severity: Medium

Occurrences: 5 helper copies across 3 files

Locations:

pkg/workflow/js/create_issue.cjs:19

pkg/workflow/js/add_comment.cjs:17

pkg/workflow/js/create_pr_review_comment.cjs:18

pkg/workflow/js/create_pr_review_comment.cjs:51

pkg/workflow/js/add_comment.cjs:142
Code Sample:
function generateFooter(
  workflowName,
  runUrl,
  workflowSource,
  workflowSourceURL,
  triggeringIssueNumber,
  triggeringPRNumber,
  triggeringDiscussionNumber
) {
  let footer = `\n\n> AI generated by [${workflowName}](${runUrl})`;
  if (triggeringIssueNumber) {
    footer += ` for #${triggeringIssueNumber}`;
  } else if (triggeringPRNumber) {
    footer += ` for #${triggeringPRNumber}`;
  } else if (triggeringDiscussionNumber) {
    footer += ` for discussion #${triggeringDiscussionNumber}`;
  }
  if (workflowSource && workflowSourceURL) {
    footer += `\n>\n> To add this workflow in your repository, run \`gh aw add ${workflowSource}\``;
  }
  footer += "\n";
  return footer;
}
Impact Analysis

Maintainability: Fixes to wording, attribution, or safe-output links must be applied in three places. A missed update will silently produce inconsistent comments.

Bug Risk: Future behavior changes (e.g., adding more context links) risk diverging between issue comments, PR review comments, and general comments.

Code Bloat: Each file carries ~40 extra lines of duplicated helpers, obscuring the core logic.

Refactoring Recommendations

Extract shared helpers

Move footer generation and repository URL computation into a new shared module (e.g., pkg/workflow/js/comment_helpers.cjs).

Estimated effort: 2-3 hours to introduce the module, add exports, and update imports/tests.

Benefits: Single point of truth for messaging and URL logic, easier future evolution.

Add coverage to avoid regressions

Extend existing unit tests to cover the new helper module and confirm each consumer uses it.

Estimated effort: 1 hour for focused tests around footer content and URL selection.

Implementation Checklist

Review duplication findings

Prioritize refactoring tasks

Create refactoring plan

Implement changes

Update tests

Verify no functionality broken

Analysis Metadata

Analyzed Files: 3 primary scripts (additional utilities inspected for comparison)

Detection Method: Serena semantic code analysis (symbol + pattern search)

Commit: 7292890

Analysis Date: 2025-11-09

AI generated by Duplicate Code Detector</issue_description>

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

Fixes [duplicate-code] 🔍 Duplicate Code Detected: Comment Output Helpers #3549

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

- Create new comment_helpers.cjs with generateFooter() and getRepositoryUrl() - Add comprehensive tests for the new module (17 test cases) - Refactor create_issue.cjs to use shared helpers - Refactor add_comment.cjs to use shared helpers - Refactor create_pr_review_comment.cjs to use shared helpers - Add comment_helpers.cjs to Go embedded sources - All tests pass (780 JavaScript tests + Go unit tests) Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2025-11-10T14:12:52Z

+ * This helper handles trial mode where target repository URLs are different from execution context
+ * @returns {string} Repository URL
+ */
+function getRepositoryUrl() {


@copilot split helpers in different files

Split into separate files following the repository pattern:

generate_footer.cjs - Footer generation helper

get_repository_url.cjs - Repository URL helper

Each with their own test files. All 780 JavaScript tests + Go unit tests pass.

Commit: da12d73

- Split comment_helpers.cjs into generate_footer.cjs and get_repository_url.cjs - Create separate test files for each helper - Update all consumers to import from separate modules - Update Go embedded sources to register both new modules - All tests pass (780 JavaScript tests + Go unit tests) Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2025-11-10T14:27:36Z

+                return `${githubServer}/${context.repo.owner}/${context.repo.repo}`;
+              }
+            }
+              generateFooter,


@copilot looks like invalid generated JavaScript , check bundler code

Fixed. Changed module.exports to single-line format to match the repository pattern (like sanitize_content.cjs). The bundler now correctly removes the entire export statement instead of leaving dangling fragments.

Before (multi-line):

module.exports = { generateFooter, };

After (single-line):

module.exports = { generateFooter };

All 780 JavaScript tests + Go tests pass. Lock files now contain valid JavaScript.

Commit: 9eae7b7

- Change module.exports from multi-line to single-line format - Fixes invalid JavaScript generation in bundled lock files - Follows repository pattern used by other helper modules - All 780 JavaScript tests + Go unit tests pass Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2025-11-10T15:04:06Z

@copilot revert previous commit, merge main

This reverts commit 9eae7b7. The bundler fix is already included in main branch. Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

…ent-output-helpers

Copilot · 2025-11-10T15:15:43Z

@copilot revert previous commit, merge main

Reverted commit 9eae7b7 and merged main branch. The bundler fix from main (#3566) now handles multi-line module.exports correctly. All 780 JavaScript tests + Go unit tests pass.

Commits:

e1b4400: Revert bundler fix
5b5967c: Merge main

pelikhan

@copilot recompile all

- Regenerate all 26 lock files with bundled helper functions - generateFooter and getRepositoryUrl properly inlined - All 780 JavaScript tests pass Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-11-10T16:04:11Z

@copilot recompile all

Recompiled all 26 workflows. Helper functions generateFooter and getRepositoryUrl are properly bundled into lock files. All 780 JavaScript tests pass.

Commit: a7306aa

Copilot

Pull Request Overview

This PR successfully refactors duplicate comment helper code by extracting shared footer generation and repository URL logic into separate, reusable modules. The refactoring eliminates ~154 lines of duplicate code across three safe-output scripts while maintaining full test coverage and following the repository's established patterns.

Key Changes:

Creates two focused helper modules (generate_footer.cjs and get_repository_url.cjs) with comprehensive test suites
Updates three consumer scripts to use the new shared helpers via require()
Properly registers both modules in Go's embedded JavaScript sources
Successfully recompiles all 26 workflow lock files with correctly bundled helper functions

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
`pkg/workflow/js/generate_footer.cjs`	New helper module for AI attribution footer generation with workflow context
`pkg/workflow/js/generate_footer.test.cjs`	Comprehensive test suite with 11 test cases covering all footer variations
`pkg/workflow/js/get_repository_url.cjs`	New helper module handling repository URL resolution in trial and normal modes
`pkg/workflow/js/get_repository_url.test.cjs`	Test suite with 6 test cases covering all URL resolution scenarios
`pkg/workflow/js/create_issue.cjs`	Refactored to import and use `generateFooter` helper
`pkg/workflow/js/add_comment.cjs`	Refactored to import both `generateFooter` and `getRepositoryUrl` helpers
`pkg/workflow/js/create_pr_review_comment.cjs`	Refactored to import both helpers for PR review comment creation
`pkg/workflow/js.go`	Added embed directives and registration for both new helper modules
`.github/workflows/*.lock.yml` (26 files)	Recompiled workflows with correctly inlined helper functions via bundler

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

Initial plan

6383638

Copilot AI assigned Copilot and pelikhan Nov 10, 2025

Copilot started work on behalf of pelikhan November 10, 2025 13:54 View session

Copilot AI changed the title ~~[WIP] Refactor duplicate code in comment output helpers~~ Refactor: Extract duplicate comment helpers into shared module Nov 10, 2025

Copilot AI requested a review from pelikhan November 10, 2025 14:12

Copilot finished work on behalf of pelikhan November 10, 2025 14:12

pelikhan reviewed Nov 10, 2025

View reviewed changes

Copilot started work on behalf of pelikhan November 10, 2025 14:13 View session

Copilot AI changed the title ~~Refactor: Extract duplicate comment helpers into shared module~~ Refactor: Extract duplicate comment helpers into separate modules Nov 10, 2025

Copilot AI requested a review from pelikhan November 10, 2025 14:23

Copilot finished work on behalf of pelikhan November 10, 2025 14:23

pelikhan reviewed Nov 10, 2025

View reviewed changes

Copilot started work on behalf of pelikhan November 10, 2025 14:28 View session

Copilot finished work on behalf of pelikhan November 10, 2025 14:39

Copilot AI requested a review from pelikhan November 10, 2025 14:39

Copilot started work on behalf of pelikhan November 10, 2025 15:04 View session

Copilot AI and others added 2 commits November 10, 2025 15:12

Revert "Fix bundler issue: use single-line module.exports"

e1b4400

This reverts commit 9eae7b7. The bundler fix is already included in main branch. Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into copilot/refactor-comm…

5b5967c

…ent-output-helpers

Copilot finished work on behalf of pelikhan November 10, 2025 15:17

pelikhan reviewed Nov 10, 2025

View reviewed changes

Copilot started work on behalf of pelikhan November 10, 2025 15:57 View session

Recompile all workflows with updated helper modules

a7306aa

- Regenerate all 26 lock files with bundled helper functions - generateFooter and getRepositoryUrl properly inlined - All 780 JavaScript tests pass Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI requested a review from pelikhan November 10, 2025 16:06

Copilot finished work on behalf of pelikhan November 10, 2025 16:06

pelikhan approved these changes Nov 10, 2025

View reviewed changes

pelikhan marked this pull request as ready for review November 10, 2025 20:50

Copilot AI review requested due to automatic review settings November 10, 2025 20:50

pelikhan merged commit 15fc225 into main Nov 10, 2025
44 checks passed

pelikhan deleted the copilot/refactor-comment-output-helpers branch November 10, 2025 20:52

Copilot AI reviewed Nov 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor: Extract duplicate comment helpers into separate modules#3565

Refactor: Extract duplicate comment helpers into separate modules#3565
pelikhan merged 7 commits intomainfrom
copilot/refactor-comment-output-helpers

Copilot AI commented Nov 10, 2025 •

edited

Loading

Uh oh!

pelikhan Nov 10, 2025

Uh oh!

Copilot AI Nov 10, 2025

Uh oh!

pelikhan Nov 10, 2025

Uh oh!

Copilot AI Nov 10, 2025

Uh oh!

pelikhan commented Nov 10, 2025

Uh oh!

Copilot AI commented Nov 10, 2025

Uh oh!

pelikhan left a comment

Uh oh!

Copilot AI commented Nov 10, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Refactor: Extract Duplicate Comment Output Helpers

Plan

Changes Made

Benefits

Test Results

Merged from main

Summary

Duplication Details

Pattern: Repeated footer/repository helper functions across comment scripts

Impact Analysis

Refactoring Recommendations

Implementation Checklist

Analysis Metadata

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

Uh oh!

pelikhan Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan commented Nov 10, 2025

Uh oh!

Copilot AI commented Nov 10, 2025

Uh oh!

pelikhan left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Nov 10, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Nov 10, 2025 •

edited

Loading