Refactor: Extract duplicate expired entity cleanup orchestration

[Copilot]

Three entity cleanup scripts (close_expired_discussions, close_expired_issues, close_expired_pull_requests) duplicated ~250 lines of identical orchestration logic (search → categorize → process → summarize).

Changes

New shared helper: expired_entity_main_flow.cjs

• Centralizes orchestration flow in executeExpiredEntityCleanup()
• Parameterizes entity-specific behavior via processEntity callback
• Supports optional features (dedupe, skipped heading) via config

Refactored entity files

• close_expired_discussions.cjs: 220 → 156 lines (-29%)
• close_expired_issues.cjs: 140 → 77 lines (-45%)
• close_expired_pull_requests.cjs: 139 → 76 lines (-45%)

Test coverage

• Added expired_entity_main_flow.test.cjs (4 integration tests)
• Added close_expired_issues.test.cjs (5 comprehensive tests, was missing)

Example

Before (duplicated in each file):

async function main() {
  // 40+ lines: search logic
  const { items, stats } = await searchEntitiesWithExpiration(...);
  if (items.length === 0) { /* 10 lines: early exit */ }
  
  // 20 lines: categorization
  const { expired, notExpired } = categorizeByExpiration(...);
  if (expired.length === 0) { /* 10 lines: early exit */ }
  
  // 40+ lines: processing & summary
  const { closed, failed } = await processExpiredEntities(...);
  const summary = buildExpirationSummary(...);
  await core.summary.addRaw(summary).write();
}

After:

async function main() {
  await executeExpiredEntityCleanup(github, owner, repo, {
    entityType: "discussions",
    entityLabel: "Discussion",
    summaryHeading: "Expired Discussions Cleanup",
    enableDedupe: true,
    processEntity: async discussion => {
      // 25 lines: entity-specific logic only
      await addComment(...);
      await close(...);
      return { status: "closed", record: {...} };
    },
  });
}

Impact

• 234 duplicate lines eliminated (-57% duplication)
• Single source of truth for orchestration changes
• Extensibility: New entity types require ~20 lines vs. ~150 lines

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Duplicate Code: expired-entity cleanup main flow in JS actions</issue_title>
<issue_description># 🔍 Duplicate Code Detected: Expired entity cleanup flow (issues/PRs/discussions)

Analysis of commit 080dad7

Assignee: @copilot

Summary

The main workflow for expiring entities (search → categorize → summary → close) is implemented three times with nearly identical control flow in the expired discussions/issues/PR scripts. The differences are limited to entity labels and the specific close/comment helpers, so this is a good candidate for shared orchestration to reduce maintenance drift.

Duplication Details

Pattern: Expired entity cleanup main flow

• Severity: Medium
• Occurrences: 3
• Locations:
  • actions/setup/js/close_expired_discussions.cjs (lines 89-216)
  • actions/setup/js/close_expired_issues.cjs (lines 46-136)
  • actions/setup/js/close_expired_pull_requests.cjs (lines 45-135)
• Code Sample:

// Shared structure across all three files
core.info(`Searching for expired … in ${owner}/${repo}`);
const { items, stats } = await searchEntitiesWithExpiration(...);
if (items.length === 0) { /* write summary; return */ }
const { expired, notExpired, now } = categorizeByExpiration(items, ...);
if (expired.length === 0) { /* write summary; return */ }
const { closed, failed } = await processExpiredEntities(expired, { processEntity: async entity => { /* comment + close */ } });
const summaryContent = buildExpirationSummary({ ... });
await core.summary.addRaw(summaryContent).write();

Impact Analysis

• Maintainability: Changes to summary format, logging, or error handling must be repeated across three files.
• Bug Risk: Inconsistent fixes are likely (e.g., one entity type gets improved handling and others do not).
• Code Bloat: ~250+ duplicated lines across three files.

Refactoring Recommendations

1. Extract a shared orchestration helper

   • Extract to: actions/setup/js/expired_entity_cleanup_helpers.cjs (or a new expired_entity_main_flow.cjs)
   • Estimated effort: 2-4 hours
   • Benefits: Single place to update summary and flow control

2. Parameterize entity-specific behavior

   • Pass in labels, result keys, and the processEntity implementation
   • Keeps entity-specific API calls local while sharing the flow

Implementation Checklist

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

Analysis Metadata

• Analyzed Files: 3
• Detection Method: Serena semantic code analysis
• Commit: 080dad7
• Analysis Date: 2026-02-07

AI generated by Duplicate Code Detector

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

• Fixes Duplicate Code: expired-entity cleanup main flow in JS actions #14291

---

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

[github-actions]

🔍 PR Triage Results

Category: refactor | Risk: medium | Priority: 56/100

Scores Breakdown

• Impact: 30/50 - Eliminates 234 duplicate lines across 3 entity cleanup scripts. Significant maintainability improvement.
• Urgency: 10/30 - Very recent (0.5 hours). Addresses technical debt identified by automated analysis. CI unstable.
• Quality: 16/20 - Excellent description with before/after examples. Comprehensive test coverage added. Still in draft.

📋 Recommended Action: batch_review

High-quality refactor addressing code duplication. Groups with PR #14289 for batch workflow/code improvements review.

Batch ID: batch-refactor-001 (grouped with PRs #14289)

---

Triaged by PR Triage Agent on 2026-02-07

AI generated by PR Triage Agent

[github-actions]

🔍 PR Triage Results

Category: refactor | Risk: medium | Priority: 56/100

Scores Breakdown

• Impact: 30/50 - Eliminates 234 duplicate lines across 3 entity cleanup scripts. Significant maintainability improvement by extracting shared orchestration logic.
• Urgency: 10/30 - Addresses technical debt identified by automated analysis. Recent (4.1 hours old). CI unstable needs attention.
• Quality: 16/20 - Excellent description with before/after examples showing the code duplication. Comprehensive test coverage added. Still in draft for review.

📋 Recommended Action: batch_review

This code cleanup refactoring is part of the code deduplication batch (batch-refactor-001). The PR extracts duplicate orchestration patterns into shared helper functions, improving maintainability.

Next Steps: Fix CI issues, then review for merge. Consider grouping with other deduplication PRs if they emerge.

---

Triaged by PR Triage Agent on 2026-02-07

AI generated by PR Triage Agent

[Copilot]

Pull request overview

Refactors the three “close expired *” cleanup scripts by extracting the shared orchestration (search → categorize → process → summarize) into a reusable helper, reducing duplication and adding/expanding test coverage around the shared flow and issue cleanup behavior.

Changes:

• Added a shared orchestrator executeExpiredEntityCleanup() to centralize the expired-entity cleanup flow.
• Updated discussions/issues/pull-requests cleanup scripts to delegate orchestration to the shared helper and keep only entity-specific close/comment logic.
• Added new integration-style tests for the shared flow and introduced comprehensive tests for close_expired_issues.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
actions/setup/js/expired_entity_main_flow.cjs	New shared orchestration helper to standardize expired entity cleanup flow.
actions/setup/js/close_expired_discussions.cjs	Refactored to use the shared orchestration helper with discussion-specific behavior (dedupe + skipped section).
actions/setup/js/close_expired_issues.cjs	Refactored to use the shared orchestration helper with issue-specific close/comment behavior.
actions/setup/js/close_expired_pull_requests.cjs	Refactored to use the shared orchestration helper with PR-specific close/comment behavior.
actions/setup/js/expired_entity_main_flow.test.cjs	New integration tests for the shared orchestration helper.
actions/setup/js/close_expired_issues.test.cjs	New comprehensive test suite for closing expired issues (previously missing).

---

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

[Copilot]

EntityFlowConfig.resultKey is documented as "Key to use in return object", but this flow doesn’t return an object and only forwards resultKey to searchEntitiesWithExpiration() (which doesn’t appear to use it). Consider removing resultKey from this typedef/callers, or updating the JSDoc to reflect its actual purpose (or that it’s unused).

Suggested change

	* @property {string} resultKey - Key to use in return object (e.g., "issues", "pullRequests", "discussions")
	* @property {string} resultKey - Key forwarded to searchEntitiesWithExpiration (reserved for its internal/result handling)

[Copilot]

Deriving the singular form via config.entityType.slice(0, -1) assumes entityType is a plural ending in "s". If a caller ever passes a non-"...s" plural (or an already-singular string), the output will be wrong (e.g., "issue" → "issu"). Consider making the singular form explicit in config (or derive from entityLabel.toLowerCase()), and/or validate entityType before slicing so the contract is explicit.