Add remove-labels safe output

actions/setup/js/remove_labels.cjs

@@ -0,0 +1,156 @@
+// @ts-check
+/// <reference types="@actions/github-script" />
+
+/**
+ * @typedef {import('./types/handler-factory').HandlerFactoryFunction} HandlerFactoryFunction
+ */
+
+/** @type {string} Safe output type handled by this module */
+const HANDLER_TYPE = "remove_labels";
+
+const { validateLabels } = require("./safe_output_validator.cjs");
+const { getErrorMessage } = require("./error_helpers.cjs");
+
+/**
+ * Main handler factory for remove_labels
+ * Returns a message handler function that processes individual remove_labels messages
+ * @type {HandlerFactoryFunction}
+ */
+async function main(config = {}) {
+  // Extract configuration
+  const allowedLabels = config.allowed || [];
+  const maxCount = config.max || 10;
+
+  core.info(`Remove labels configuration: max=${maxCount}`);
+  if (allowedLabels.length > 0) {
+    core.info(`Allowed labels to remove: ${allowedLabels.join(", ")}`);
+  }
+
+  // Track how many items we've processed for max limit
+  let processedCount = 0;
+
+  /**
+   * Message handler function that processes a single remove_labels message
+   * @param {Object} message - The remove_labels message to process
+   * @param {Object} resolvedTemporaryIds - Map of temporary IDs to {repo, number}
+   * @returns {Promise<Object>} Result with success/error status
+   */
+  return async function handleRemoveLabels(message, resolvedTemporaryIds) {
+    // Check if we've hit the max limit
+    if (processedCount >= maxCount) {
+      core.warning(`Skipping remove_labels: max count of ${maxCount} reached`);
+      return {
+        success: false,
+        error: `Max count of ${maxCount} reached`,
+      };
+    }
+
+    processedCount++;
+
+    // Determine target issue/PR number
+    const itemNumber = message.item_number !== undefined ? parseInt(String(message.item_number), 10) : context.payload?.issue?.number || context.payload?.pull_request?.number;
+
+    if (!itemNumber || isNaN(itemNumber)) {
+      const errorMsg = message.item_number !== undefined ? `Invalid item number: ${message.item_number}` : "No item_number provided and not in issue/PR context";
+      core.warning(errorMsg);
+      return {
+        success: false,
+        error: message.item_number !== undefined ? `Invalid item number: ${message.item_number}` : "No issue/PR number available",
+      };
+    }
+
+    const contextType = context.payload?.pull_request ? "pull request" : "issue";
+    const requestedLabels = message.labels ?? [];
+    core.info(`Requested labels to remove: ${JSON.stringify(requestedLabels)}`);
+
+    // If no labels provided, return a helpful message with allowed labels if configured
+    if (!requestedLabels || requestedLabels.length === 0) {
+      let errorMessage = "No labels provided. Please provide at least one label from";
+      if (allowedLabels.length > 0) {
+        errorMessage += ` the allowed list: ${JSON.stringify(allowedLabels)}`;
+      } else {
+        errorMessage += " the issue/PR's current labels";
+      }
+      core.info(errorMessage);
+      return {
+        success: false,
+        error: errorMessage,
+      };
+    }
+
+    // Use validation helper to sanitize and validate labels
+    const labelsResult = validateLabels(requestedLabels, allowedLabels, maxCount);
+    if (!labelsResult.valid) {
+      // If no valid labels, log info and return gracefully
+      if (labelsResult.error?.includes("No valid labels")) {
+        core.info("No labels to remove");
+        return {
+          success: true,
+          number: itemNumber,
+          labelsRemoved: [],
+          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 ?? [];
+
+    if (uniqueLabels.length === 0) {
+      core.info("No labels to remove");
+      return {
+        success: true,
+        number: itemNumber,
+        labelsRemoved: [],
+        message: "No labels to remove",
+      };
+    }
+
+    core.info(`Removing ${uniqueLabels.length} labels from ${contextType} #${itemNumber}: ${JSON.stringify(uniqueLabels)}`);
+
+    // Track successfully removed labels
+    const removedLabels = [];
+    const failedLabels = [];
+
+    // Remove labels one at a time (GitHub API doesn't have a bulk remove endpoint)
+    for (const label of uniqueLabels) {
+      try {
+        await github.rest.issues.removeLabel({
+          ...context.repo,
+          issue_number: itemNumber,
+          name: label,
+        });
+        removedLabels.push(label);
+        core.info(`Removed label "${label}" from ${contextType} #${itemNumber}`);
+      } catch (error) {
+        // Label might not exist on the issue/PR - this is not a failure
+        const errorMessage = getErrorMessage(error);
+        if (errorMessage.includes("Label does not exist") || errorMessage.includes("404")) {
+          core.info(`Label "${label}" was not present on ${contextType} #${itemNumber}, skipping`);
+        } else {
+          core.warning(`Failed to remove label "${label}": ${errorMessage}`);
+          failedLabels.push({ label, error: errorMessage });
+        }
+      }
+    }
+
+    if (removedLabels.length > 0) {
+      core.info(`Successfully removed ${removedLabels.length} labels from ${contextType} #${itemNumber}`);
+    }
+
+    return {
+      success: true,
+      number: itemNumber,
+      labelsRemoved: removedLabels,
+      failedLabels: failedLabels.length > 0 ? failedLabels : undefined,
+      contextType,
+    };
+  };
+}
+
+module.exports = { main };