Skip to content

Refactor: extract shared count-gated handler scaffold for safe-output handlers #25903

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 4 commits into from
Apr 12, 2026
Merged

Refactor: extract shared count-gated handler scaffold for safe-output handlers #25903

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
95d5dba
Initial plan
Copilot Apr 12, 2026
5a6743d
refactor: extract shared count-gated handler scaffold for safe-output…
Copilot Apr 12, 2026
e717d42
fix: use || instead of ?? for maxCount default to match prior handler…
Copilot Apr 12, 2026
445f696
refactor: move isStagedMode into handler scaffold
Copilot Apr 12, 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
300 changes: 145 additions & 155 deletions actions/setup/js/add_labels.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,183 +23,173 @@ const { isStagedMode } = require("./safe_output_helpers.cjs");
const { createAuthenticatedGitHubClient } = require("./handler_auth.cjs");
const { resolveRepoIssueTarget, loadTemporaryIdMapFromResolved } = require("./temporary_id.cjs");
const { MAX_LABELS } = require("./constants.cjs");
const { createCountGatedHandler } = require("./handler_scaffold.cjs");

/**
* Main handler factory for add_labels
* Returns a message handler function that processes individual add_labels messages
* Uses shared count-gated scaffold for max-limit enforcement.
* @type {HandlerFactoryFunction}
*/
async function main(config = {}) {
const { allowed: allowedLabels = [], blocked: blockedPatterns = [] } = config;
const maxCount = config.max ?? 10;
const { defaultTargetRepo, allowedRepos } = resolveTargetRepoConfig(config);
const githubClient = await createAuthenticatedGitHubClient(config);
const isStaged = isStagedMode(config);

core.info(`Add labels configuration: max=${maxCount}`);
if (allowedLabels.length > 0) core.info(`Allowed labels: ${allowedLabels.join(", ")}`);
if (blockedPatterns.length > 0) core.info(`Blocked patterns: ${blockedPatterns.join(", ")}`);
core.info(`Default target repo: ${defaultTargetRepo}`);
if (allowedRepos.size > 0) core.info(`Allowed repos: ${[...allowedRepos].join(", ")}`);

let processedCount = 0;

/**
* Message handler function that processes a single add_labels message
* @param {AddLabelsMessage} message - The add_labels message to process
* @param {ResolvedTemporaryIds} resolvedTemporaryIds - Map of temporary IDs to {repo, number}
* @returns {Promise<HandlerResult>} Result with success/error status
*/
return async function handleAddLabels(message, resolvedTemporaryIds) {
// Check if we've hit the max limit
if (processedCount >= maxCount) {
core.warning(`Skipping add_labels: max count of ${maxCount} reached`);
return {
success: false,
error: `Max count of ${maxCount} reached`,
};
}

processedCount++;

// Resolve and validate target repository
const repoResult = resolveAndValidateRepo(message, defaultTargetRepo, allowedRepos, "label");
if (!repoResult.success) {
core.warning(`Skipping add_labels: ${repoResult.error}`);
return {
success: false,
error: repoResult.error,
};
}
const { repo: itemRepo, repoParts } = repoResult;
core.info(`Target repository: ${itemRepo}`);

// Determine target issue/PR number
let itemNumber;
if (message.item_number !== undefined) {
// Resolve temporary IDs if present
const tempIdMap = loadTemporaryIdMapFromResolved(resolvedTemporaryIds);
const resolvedTarget = resolveRepoIssueTarget(message.item_number, tempIdMap, repoParts.owner, repoParts.repo);

// Check if this is an unresolved temporary ID
if (resolvedTarget.wasTemporaryId && !resolvedTarget.resolved) {
core.info(`Deferring add_labels: unresolved temporary ID (${message.item_number})`);
const main = createCountGatedHandler({
handlerType: HANDLER_TYPE,
setup: async (config, maxCount) => {
const { allowed: allowedLabels = [], blocked: blockedPatterns = [] } = config;
const { defaultTargetRepo, allowedRepos } = resolveTargetRepoConfig(config);
const githubClient = await createAuthenticatedGitHubClient(config);
const isStaged = isStagedMode(config);

core.info(`Add labels configuration: max=${maxCount}`);
if (allowedLabels.length > 0) core.info(`Allowed labels: ${allowedLabels.join(", ")}`);
if (blockedPatterns.length > 0) core.info(`Blocked patterns: ${blockedPatterns.join(", ")}`);
core.info(`Default target repo: ${defaultTargetRepo}`);
if (allowedRepos.size > 0) core.info(`Allowed repos: ${[...allowedRepos].join(", ")}`);

/**
* Message handler function that processes a single add_labels message
* @param {AddLabelsMessage} message - The add_labels message to process
* @param {ResolvedTemporaryIds} resolvedTemporaryIds - Map of temporary IDs to {repo, number}
* @returns {Promise<HandlerResult>} Result with success/error status
*/
return async function handleAddLabels(message, resolvedTemporaryIds) {
// Resolve and validate target repository
const repoResult = resolveAndValidateRepo(message, defaultTargetRepo, allowedRepos, "label");
if (!repoResult.success) {
core.warning(`Skipping add_labels: ${repoResult.error}`);
return {
success: false,
deferred: true,
error: resolvedTarget.errorMessage || `Unresolved temporary ID: ${message.item_number}`,
error: repoResult.error,
};
}
const { repo: itemRepo, repoParts } = repoResult;
core.info(`Target repository: ${itemRepo}`);

// Determine target issue/PR number
let itemNumber;
if (message.item_number !== undefined) {
// Resolve temporary IDs if present
const tempIdMap = loadTemporaryIdMapFromResolved(resolvedTemporaryIds);
const resolvedTarget = resolveRepoIssueTarget(message.item_number, tempIdMap, repoParts.owner, repoParts.repo);

// Check if this is an unresolved temporary ID
if (resolvedTarget.wasTemporaryId && !resolvedTarget.resolved) {
core.info(`Deferring add_labels: unresolved temporary ID (${message.item_number})`);
return {
success: false,
deferred: true,
error: resolvedTarget.errorMessage || `Unresolved temporary ID: ${message.item_number}`,
};
}

// Check for other resolution errors
if (resolvedTarget.errorMessage || !resolvedTarget.resolved) {
const error = `Invalid item number: ${message.item_number}`;
core.warning(error);
return { success: false, error };
}

itemNumber = resolvedTarget.resolved.number;
} else {
itemNumber = context.payload?.issue?.number ?? context.payload?.pull_request?.number;
}

// Check for other resolution errors
if (resolvedTarget.errorMessage || !resolvedTarget.resolved) {
const error = `Invalid item number: ${message.item_number}`;
if (!itemNumber || isNaN(itemNumber)) {
const error = "No issue/PR number available";
core.warning(error);
return { success: false, error };
}

itemNumber = resolvedTarget.resolved.number;
} else {
itemNumber = context.payload?.issue?.number ?? context.payload?.pull_request?.number;
}

if (!itemNumber || isNaN(itemNumber)) {
const error = "No issue/PR number available";
core.warning(error);
return { success: false, error };
}

const contextType = context.payload?.pull_request ? "pull request" : "issue";
const requestedLabels = message.labels ?? [];
core.info(`Requested labels: ${JSON.stringify(requestedLabels)}`);

// If no labels provided, return a helpful message with allowed labels if configured
if (requestedLabels.length === 0) {
const labelSource = allowedLabels.length > 0 ? `the allowed list: ${JSON.stringify(allowedLabels)}` : "the repository's available labels";
const error = `No labels provided. Please provide at least one label from ${labelSource}`;
core.info(error);
return { success: false, error };
}

// Enforce max limits on labels before validation
const limitResult = tryEnforceArrayLimit(requestedLabels, MAX_LABELS, "labels");
if (!limitResult.success) {
core.warning(`Label limit exceeded: ${limitResult.error}`);
return { success: false, error: limitResult.error };
}

// Use validation helper to sanitize and validate labels
const labelsResult = validateLabels(requestedLabels, allowedLabels, maxCount, blockedPatterns);
if (!labelsResult.valid) {
// If no valid labels, log info and return gracefully
if (labelsResult.error?.includes("No valid labels")) {
const contextType = context.payload?.pull_request ? "pull request" : "issue";
const requestedLabels = message.labels ?? [];
core.info(`Requested labels: ${JSON.stringify(requestedLabels)}`);

// If no labels provided, return a helpful message with allowed labels if configured
if (requestedLabels.length === 0) {
const labelSource = allowedLabels.length > 0 ? `the allowed list: ${JSON.stringify(allowedLabels)}` : "the repository's available labels";
const error = `No labels provided. Please provide at least one label from ${labelSource}`;
core.info(error);
return { success: false, error };
}

// Enforce max limits on labels before validation
const limitResult = tryEnforceArrayLimit(requestedLabels, MAX_LABELS, "labels");
if (!limitResult.success) {
core.warning(`Label limit exceeded: ${limitResult.error}`);
return { success: false, error: limitResult.error };
}

// Use validation helper to sanitize and validate labels
const labelsResult = validateLabels(requestedLabels, allowedLabels, maxCount, blockedPatterns);
if (!labelsResult.valid) {
// If no valid labels, log info and return gracefully
if (labelsResult.error?.includes("No valid labels")) {
core.info("No labels to add");
return {
success: true,
number: itemNumber,
labelsAdded: [],
message: "No valid labels found",
};
}
// For other validation errors, return error
core.warning(`Label validation failed: ${labelsResult.error}`);
return {
success: false,
error: labelsResult.error ?? "Invalid labels",
};
}

const uniqueLabels = labelsResult.value ?? [];

// Early return if no labels after validation
if (uniqueLabels.length === 0) {
core.info("No labels to add");
return {
success: true,
number: itemNumber,
labelsAdded: [],
message: "No valid labels found",
message: "No labels to add",
};
}
// For other validation errors, return error
core.warning(`Label validation failed: ${labelsResult.error}`);
return {
success: false,
error: labelsResult.error ?? "Invalid labels",
};
}

const uniqueLabels = labelsResult.value ?? [];

// Early return if no labels after validation
if (uniqueLabels.length === 0) {
core.info("No labels to add");
return {
success: true,
number: itemNumber,
labelsAdded: [],
message: "No labels to add",
};
}

core.info(`Adding ${uniqueLabels.length} labels to ${contextType} #${itemNumber} in ${itemRepo}: ${JSON.stringify(uniqueLabels)}`);

// If in staged mode, preview the labels without adding them
if (isStaged) {
logStagedPreviewInfo(`Would add ${uniqueLabels.length} labels to ${contextType} #${itemNumber} in ${itemRepo}`);
return {
success: true,
staged: true,
previewInfo: {
number: itemNumber,
repo: itemRepo,

core.info(`Adding ${uniqueLabels.length} labels to ${contextType} #${itemNumber} in ${itemRepo}: ${JSON.stringify(uniqueLabels)}`);

// If in staged mode, preview the labels without adding them
if (isStaged) {
logStagedPreviewInfo(`Would add ${uniqueLabels.length} labels to ${contextType} #${itemNumber} in ${itemRepo}`);
return {
success: true,
staged: true,
previewInfo: {
number: itemNumber,
repo: itemRepo,
labels: uniqueLabels,
contextType,
},
};
}

try {
await githubClient.rest.issues.addLabels({
owner: repoParts.owner,
repo: repoParts.repo,
issue_number: itemNumber,
labels: uniqueLabels,
});

core.info(`Successfully added ${uniqueLabels.length} labels to ${contextType} #${itemNumber} in ${itemRepo}`);
return {
success: true,
number: itemNumber,
labelsAdded: uniqueLabels,
contextType,
},
};
}

try {
await githubClient.rest.issues.addLabels({
owner: repoParts.owner,
repo: repoParts.repo,
issue_number: itemNumber,
labels: uniqueLabels,
});

core.info(`Successfully added ${uniqueLabels.length} labels to ${contextType} #${itemNumber} in ${itemRepo}`);
return {
success: true,
number: itemNumber,
labelsAdded: uniqueLabels,
contextType,
};
} catch (error) {
const errorMessage = getErrorMessage(error);
core.error(`Failed to add labels: ${errorMessage}`);
return { success: false, error: errorMessage };
}
};
}
};
} catch (error) {
const errorMessage = getErrorMessage(error);
core.error(`Failed to add labels: ${errorMessage}`);
return { success: false, error: errorMessage };
}
};
},
});

module.exports = { main };
Loading
Loading