fix(hide_comment): surface GraphQL node ID guidance in comment_id validation error (#40361)

Author: Copilot

.github/workflows/ai-moderator.lock.yml

@@ -67,6 +67,7 @@ function normalizeIssueClosingKeywordBackticks(content) {
  * @typedef {Object} FieldValidation
  * @property {boolean} [required] - Whether the field is required
  * @property {string} [type] - Expected type: 'string', 'number', 'boolean', 'array'
+ * @property {string} [typeHint] - Overrides the type description in error messages (e.g. "GraphQL node ID string")
  * @property {boolean} [sanitize] - Whether to sanitize string content
  * @property {number} [maxLength] - Maximum length for strings
  * @property {number} [minLength] - Minimum length for strings
@@ -301,7 +302,7 @@ function validateField(value, fieldName, validation, itemType, lineNum, options)
 
   // Handle required check for other fields
   if (validation.required && (value === undefined || value === null)) {
-    const fieldType = validation.type || "string";
+    const fieldType = validation.typeHint || validation.type || "string";
     return {
       isValid: false,
       error: `Line ${lineNum}: ${itemType} requires a '${fieldName}' field (${fieldType})`,
@@ -328,9 +329,10 @@ function validateField(value, fieldName, validation, itemType, lineNum, options)
     if (typeof value !== "string") {
       // For required fields, use "requires a" format for both missing and wrong type
       if (validation.required) {
+        const fieldType = validation.typeHint || "string";
         return {
           isValid: false,
-          error: `Line ${lineNum}: ${itemType} requires a '${fieldName}' field (string)`,
+          error: `Line ${lineNum}: ${itemType} requires a '${fieldName}' field (${fieldType})`,
         };
       }
       return {

.github/workflows/smoke-codex.lock.yml

@@ -164,6 +164,18 @@ const SAMPLE_VALIDATION_CONFIG = {
       inputs: { type: "object" },
     },
   },
+  hide_comment: {
+    defaultMax: 5,
+    fields: {
+      comment_id: {
+        required: true,
+        type: "string",
+        maxLength: 256,
+        typeHint: "GraphQL node ID string (e.g. 'IC_kwDOABCD123456'); numeric REST comment IDs are accepted but may not resolve for all comment types (e.g. PR review comments)",
+      },
+      reason: { type: "string" },
+    },
+  },
 };
 
 const ISSUE_CLOSING_KEYWORDS = ["fix", "fixes", "fixed", "close", "closes", "closed", "resolve", "resolves", "resolved"];
@@ -463,6 +475,32 @@ describe("safe_output_type_validator", () => {
         expect(result.error).toContain("pull_request_number");
       }
     });
+
+    it("should include typeHint in error when hide_comment comment_id is missing", async () => {
+      const { validateItem } = await import("./safe_output_type_validator.cjs");
+
+      const result = validateItem({ type: "hide_comment" }, "hide_comment", 1);
+
+      expect(result.isValid).toBe(false);
+      expect(result.error).toContain("GraphQL node ID");
+    });
+
+    it("should include typeHint in error when hide_comment comment_id is a numeric REST id", async () => {
+      const { validateItem } = await import("./safe_output_type_validator.cjs");
+
+      const result = validateItem({ type: "hide_comment", comment_id: 4748731349 }, "hide_comment", 1);
+
+      expect(result.isValid).toBe(false);
+      expect(result.error).toContain("GraphQL node ID");
+    });
+
+    it("should accept hide_comment with a GraphQL node ID comment_id", async () => {
+      const { validateItem } = await import("./safe_output_type_validator.cjs");
+
+      const result = validateItem({ type: "hide_comment", comment_id: "IC_kwDOABCD123456" }, "hide_comment", 1);
+
+      expect(result.isValid).toBe(true);
+    });
   });
 
   describe("validatePositiveInteger", () => {

actions/setup/js/safe_output_type_validator.cjs

@@ -16,6 +16,7 @@ var safeOutputValidationLog = logger.New("workflow:safe_outputs_validation_confi
 type FieldValidation struct {
 	Required                 bool     `json:"required,omitempty"`
 	Type                     string   `json:"type,omitempty"`
+	TypeHint                 string   `json:"typeHint,omitempty"` // Overrides the type description in error messages (e.g. "GraphQL node ID string")
 	Sanitize                 bool     `json:"sanitize,omitempty"`
 	MaxLength                int      `json:"maxLength,omitempty"`
 	MinLength                int      `json:"minLength,omitempty"`
@@ -403,7 +404,7 @@ var ValidationConfig = map[string]TypeValidationConfig{
 	"hide_comment": {
 		DefaultMax: 5,
 		Fields: map[string]FieldValidation{
-			"comment_id": {Required: true, Type: "string", MaxLength: 256},
+			"comment_id": {Required: true, Type: "string", MaxLength: 256, TypeHint: "GraphQL node ID string (e.g. 'IC_kwDOABCD123456'); numeric REST comment IDs are accepted but may not resolve for all comment types (e.g. PR review comments)"},
 			"reason":     {Type: "string", Enum: []string{"SPAM", "ABUSE", "OFF_TOPIC", "OUTDATED", "RESOLVED", "LOW_QUALITY"}},
 			"repo":       {Type: "string", MaxLength: 256}, // Optional: target repository in format "owner/repo"
 		},