Skip to content

Extract shared close-older marker search/filter logic into helpers module #26023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Apr 13, 2026
+590 −153
Merged

Extract shared close-older marker search/filter logic into helpers module #26023

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
94b6dcc
Initial plan
Copilot Apr 13, 2026
60e7474
Extract shared close-older marker search/filter logic into close_olde…
Copilot Apr 13, 2026
f3aae0e
fix: check excludeNumber before additionalFilter in filterByMarker
Copilot Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 37 additions & 85 deletions actions/setup/js/close_older_discussions.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

const { getCloseOlderDiscussionMessage } = require("./messages_close_discussion.cjs");
const { getErrorMessage } = require("./error_helpers.cjs");
const { getWorkflowIdMarkerContent, generateWorkflowIdMarker, generateWorkflowCallIdMarker, generateCloseKeyMarker, getCloseKeyMarkerContent } = require("./generate_footer.cjs");
const { sanitizeContent } = require("./sanitize_content.cjs");
const { closeOlderEntities, MAX_CLOSE_COUNT: SHARED_MAX_CLOSE_COUNT } = require("./close_older_entities.cjs");
const { buildMarkerSearchQuery, filterByMarker, logFilterSummary } = require("./close_older_search_helpers.cjs");

/**
* Maximum number of older discussions to close
Expand Down Expand Up @@ -44,27 +44,13 @@ async function searchOlderDiscussions(github, owner, repo, workflowId, categoryI
return [];
}

// Build GraphQL search query.
// When a close-older-key is provided it becomes the primary search term; otherwise
// fall back to the workflow-id marker.
let searchQuery;
let exactMarker;
if (closeOlderKey) {
const closeKeyMarkerContent = getCloseKeyMarkerContent(closeOlderKey);
const escapedMarker = closeKeyMarkerContent.replace(/"/g, '\\"');
searchQuery = `repo:${owner}/${repo} is:open "${escapedMarker}" in:body`;
exactMarker = generateCloseKeyMarker(closeOlderKey);
core.info(` Using close-older-key for search: "${escapedMarker}" in:body`);
} else {
// Build GraphQL search query
// Search for open discussions with the workflow-id marker in the body
const workflowIdMarker = getWorkflowIdMarkerContent(workflowId);
// Escape quotes in workflow ID to prevent query injection
const escapedMarker = workflowIdMarker.replace(/"/g, '\\"');
searchQuery = `repo:${owner}/${repo} is:open "${escapedMarker}" in:body`;
exactMarker = callerWorkflowId ? generateWorkflowCallIdMarker(callerWorkflowId) : generateWorkflowIdMarker(workflowId);
core.info(` Added workflow ID marker filter to query: "${escapedMarker}" in:body`);
}
const { searchQuery, exactMarker } = buildMarkerSearchQuery({
owner,
repo,
workflowId,
callerWorkflowId,
closeOlderKey,
});
core.info(`Executing GitHub search with query: ${searchQuery}`);

const result = await github.graphql(
Expand Down Expand Up @@ -96,73 +82,39 @@ async function searchOlderDiscussions(github, owner, repo, workflowId, categoryI
return [];
}

// Filter results:
// 1. Must not be the excluded discussion (newly created one)
// 2. Must not be already closed
// 3. If categoryId is specified, must match
// 4. Body must contain the exact marker. When closeOlderKey is set the close-key marker
// is used. Otherwise, when callerWorkflowId is set, match `gh-aw-workflow-call-id` so
// that callers sharing the same reusable workflow do not close each other's discussions.
// Fall back to `gh-aw-workflow-id` for backward compat with older discussions.
core.info("Filtering search results...");
let filteredCount = 0;
let excludedCount = 0;
let closedCount = 0;
let markerMismatchCount = 0;

const filtered = result.search.nodes
.filter(
/** @param {any} d */ d => {
if (!d) {
return false;
}

// Exclude the newly created discussion
if (d.number === excludeNumber) {
excludedCount++;
core.info(` Excluding discussion #${d.number} (the newly created discussion)`);
return false;
}

// Exclude already closed discussions
if (d.closed) {
closedCount++;
return false;
}

// Check category if specified
if (categoryId && (!d.category || d.category.id !== categoryId)) {
return false;
}

// Exact-match the marker in the discussion body to prevent GitHub search
// substring tokenization from matching related workflow IDs
// (e.g. "foo" would otherwise match discussions from "foo-bar")
if (!d.body?.includes(exactMarker)) {
markerMismatchCount++;
core.info(` Excluding discussion #${d.number} (body does not contain exact marker)`);
return false;
}

filteredCount++;
core.info(` ✓ Discussion #${d.number} matches criteria: ${d.title}`);
return true;
const { filtered: filteredItems, counters } = filterByMarker({
items: result.search.nodes,
excludeNumber,
exactMarker,
entityType: "discussion",
additionalFilter: (d, extra) => {
if (d.closed) {
extra.closedCount = (extra.closedCount || 0) + 1;
return false;
}
if (categoryId && (!d.category || d.category.id !== categoryId)) {
return false;
}
)
.map(
/** @param {any} d */ d => ({
id: d.id,
number: d.number,
title: d.title,
url: d.url,
})
);
return true;
},
});

const filtered = filteredItems.map(
/** @param {any} d */ d => ({
id: d.id,
number: d.number,
title: d.title,
url: d.url,
})
);

core.info(`Filtering complete:`);
core.info(` - Matched discussions: ${filteredCount}`);
core.info(` - Excluded new discussion: ${excludedCount}`);
core.info(` - Excluded closed discussions: ${closedCount}`);
core.info(` - Excluded marker mismatch: ${markerMismatchCount}`);
logFilterSummary({
entityTypePlural: "discussions",
counters,
extraLabels: [["closedCount", "Excluded closed discussions"]],
});

return filtered;
}
Expand Down
99 changes: 31 additions & 68 deletions actions/setup/js/close_older_issues.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// @ts-check
/// <reference types="@actions/github-script" />

const { getWorkflowIdMarkerContent, generateWorkflowIdMarker, generateWorkflowCallIdMarker, generateCloseKeyMarker, getCloseKeyMarkerContent } = require("./generate_footer.cjs");
const { sanitizeContent } = require("./sanitize_content.cjs");
const { closeOlderEntities, MAX_CLOSE_COUNT: SHARED_MAX_CLOSE_COUNT } = require("./close_older_entities.cjs");
const { buildMarkerSearchQuery, filterByMarker, logFilterSummary } = require("./close_older_search_helpers.cjs");

/**
* Maximum number of older issues to close
Expand Down Expand Up @@ -41,26 +41,14 @@ async function searchOlderIssues(github, owner, repo, workflowId, excludeNumber,
return [];
}

// Build REST API search query.
// When a close-older-key is provided it becomes the primary search term; otherwise
// fall back to the workflow-id marker.
let searchQuery;
let exactMarker;
if (closeOlderKey) {
const closeKeyMarkerContent = getCloseKeyMarkerContent(closeOlderKey);
const escapedMarker = closeKeyMarkerContent.replace(/"/g, '\\"');
searchQuery = `repo:${owner}/${repo} is:issue is:open "${escapedMarker}" in:body`;
exactMarker = generateCloseKeyMarker(closeOlderKey);
core.info(` Using close-older-key for search: "${escapedMarker}" in:body`);
} else {
// Search for open issues with the workflow-id marker in the body
const workflowIdMarker = getWorkflowIdMarkerContent(workflowId);
// Escape quotes in workflow ID to prevent query injection
const escapedMarker = workflowIdMarker.replace(/"/g, '\\"');
searchQuery = `repo:${owner}/${repo} is:issue is:open "${escapedMarker}" in:body`;
exactMarker = callerWorkflowId ? generateWorkflowCallIdMarker(callerWorkflowId) : generateWorkflowIdMarker(workflowId);
core.info(` Added workflow-id marker filter to query: "${escapedMarker}" in:body`);
}
const { searchQuery, exactMarker } = buildMarkerSearchQuery({
owner,
repo,
workflowId,
callerWorkflowId,
closeOlderKey,
entityQualifier: "is:issue",
});
core.info(`Executing GitHub search with query: ${searchQuery}`);

const result = await github.rest.search.issuesAndPullRequests({
Expand All @@ -75,60 +63,35 @@ async function searchOlderIssues(github, owner, repo, workflowId, excludeNumber,
return [];
}

// Filter results:
// 1. Must not be the excluded issue (newly created one)
// 2. Must not be a pull request
// 3. Body must contain the exact marker. When closeOlderKey is set the close-key marker
// is used. Otherwise, when callerWorkflowId is set, match `gh-aw-workflow-call-id` so
// that callers sharing the same reusable workflow do not close each other's issues.
// Fall back to `gh-aw-workflow-id` for backward compat with older issues.
core.info("Filtering search results...");
let filteredCount = 0;
let pullRequestCount = 0;
let excludedCount = 0;
let markerMismatchCount = 0;

const filtered = result.data.items
.filter(item => {
// Exclude pull requests
const { filtered: filteredItems, counters } = filterByMarker({
items: result.data.items,
excludeNumber,
exactMarker,
entityType: "issue",
additionalFilter: (item, extra) => {
if (item.pull_request) {
pullRequestCount++;
return false;
}

// Exclude the newly created issue
if (item.number === excludeNumber) {
excludedCount++;
core.info(` Excluding issue #${item.number} (the newly created issue)`);
return false;
}

// Exact-match the marker in the issue body to prevent GitHub search
// substring tokenization from matching related workflow IDs
// (e.g. "foo" would otherwise match issues from "foo-bar")
if (!item.body?.includes(exactMarker)) {
markerMismatchCount++;
core.info(` Excluding issue #${item.number} (body does not contain exact marker)`);
extra.pullRequestCount = (extra.pullRequestCount || 0) + 1;
return false;
}

filteredCount++;
core.info(` ✓ Issue #${item.number} matches criteria: ${item.title}`);
return true;
})
.map(item => ({
number: item.number,
title: item.title,
html_url: item.html_url,
labels: item.labels || [],
created_at: item.created_at,
}));
},
});

core.info(`Filtering complete:`);
core.info(` - Matched issues: ${filteredCount}`);
core.info(` - Excluded pull requests: ${pullRequestCount}`);
core.info(` - Excluded new issue: ${excludedCount}`);
core.info(` - Excluded marker mismatch: ${markerMismatchCount}`);
const filtered = filteredItems.map(item => ({
number: item.number,
title: item.title,
html_url: item.html_url,
labels: item.labels || [],
created_at: item.created_at,
}));

logFilterSummary({
entityTypePlural: "issues",
counters,
extraLabels: [["pullRequestCount", "Excluded pull requests"]],
});

return filtered;
}
Expand Down
Loading
Loading