Merge branch 'main' into fix/bot-intermediate-assignment-guard

Author: parvninama

.github/scripts/bot-gfi-assign-on-comment.js

@@ -340,23 +340,54 @@ module.exports = async ({ github, context }) => {
         console.log('[gfi-assign] Assignment completed successfully');
 
         // Chain mentor assignment after successful GFI assignment
+        let mentorAssignmentSucceeded = false;
         try {
             const assignMentor = require('./bot-mentor-assignment.js');
             await assignMentor({
                 github,
                 context,
                 assignee: { login: requesterUsername, type: 'User' }  // Pass freshly-assigned username
             });
+            mentorAssignmentSucceeded = true;
             console.log('[gfi-assign] Mentor assignment chained successfully');
         } catch (error) {
             console.error('[gfi-assign] Mentor assignment failed but user assignment succeeded:', {
                 message: error.message,
                 status: error.status,
-                issueNumber: context.payload.issue?.number,
+                owner,
+                repo,
+                issueNumber,
                 assignee: requesterUsername,
             });
             // Don't throw error - user assignment was successful
         }
+
+        // Chain CodeRabbit plan trigger after mentor assignment
+        // Only trigger if mentor assignment succeeded to maintain the expected flow
+        if (mentorAssignmentSucceeded) {
+            try {
+                const { triggerCodeRabbitPlan, hasExistingCodeRabbitPlan } = require('./coderabbit_plan_trigger.js');
+                
+                // Check if CodeRabbit plan already exists to avoid duplicate comments
+                const planExists = await hasExistingCodeRabbitPlan(github, owner, repo, issueNumber);
+                if (planExists) {
+                    console.log('[gfi-assign] CodeRabbit plan already exists, skipping');
+                } else {
+                    await triggerCodeRabbitPlan(github, owner, repo, issue);
+                    console.log('[gfi-assign] CodeRabbit plan chained successfully');
+                }
+            } catch (error) {
+                console.error('[gfi-assign] CodeRabbit plan failed but user assignment succeeded:', {
+                    message: error.message,
+                    status: error.status,
+                    owner,
+                    repo,
+                    issueNumber,
+                    assignee: requesterUsername,
+                });
+                // Don't throw error - user assignment was successful
+            }
+        }
     } catch (error) {
         console.error('[gfi-assign] Error:', {
             message: error.message,

.github/scripts/coderabbit_plan_trigger.js

@@ -1,8 +1,8 @@
 // Script to trigger CodeRabbit plan for intermediate and advanced issues
 
-const marker = '<!-- CodeRabbit Plan Trigger -->';
+const CODERABBIT_MARKER = '<!-- CodeRabbit Plan Trigger -->';
 
-async function triggerCodeRabbitPlan(github, owner, repo, issue, marker) {
+async function triggerCodeRabbitPlan(github, owner, repo, issue, marker = CODERABBIT_MARKER) {
   const comment = `${marker} @coderabbitai plan`;
 
   try {
@@ -15,41 +15,64 @@ async function triggerCodeRabbitPlan(github, owner, repo, issue, marker) {
     console.log(`Triggered CodeRabbit plan for issue #${issue.number}`);
     return true;
   } catch (commentErr) {
-    console.log(`Failed to trigger CodeRabbit plan for issue #${issue.number}:`, commentErr.message || commentErr);
+    console.log('Failed to trigger CodeRabbit plan:', {
+      message: commentErr?.message,
+      status: commentErr?.status,
+      owner,
+      repo,
+      issueNumber: issue?.number,
+    });
     return false;
   }
 }
 
 function hasBeginnerOrHigherLabel(issue, label) {
   // Check if issue has beginner, intermediate or advanced label (case-insensitive)
-
-  const allowed = ['beginner', 'intermediate', "advanced"];
+  const allowed = ['beginner', 'intermediate', 'advanced'];
 
   const hasAllowedLabel = issue.labels?.some(l => allowed.includes(l?.name?.toLowerCase()));
 
-  // Also check if newly added label is intermediate/advanced
-
+  // Also check if newly added label is beginner/intermediate/advanced
   const isNewLabelAllowed = allowed.includes(label?.name?.toLowerCase());
 
   return hasAllowedLabel || isNewLabelAllowed;
-  
 }
 
 async function hasExistingCodeRabbitPlan(github, owner, repo, issueNumber) {
   // Check for existing CodeRabbit plan comment (limited to first 500 comments)
-  const comments = [];
-  const iterator = github.paginate.iterator(github.rest.issues.listComments, {
-    owner, repo, issue_number: issueNumber, per_page: 100
-  });
-  
-  let count = 0;
-  for await (const { data: page } of iterator) {
-    comments.push(...page);
-    count += page.length;
-    if (count >= 500) break; // Hard upper bound to prevent unbounded pagination
+  // Uses marker-based detection to avoid false positives from quoted text
+  try {
+    const comments = [];
+    const iterator = github.paginate.iterator(github.rest.issues.listComments, {
+      owner,
+      repo,
+      issue_number: issueNumber,
+      per_page: 100,
+    });
+
+    let count = 0;
+    for await (const { data: page } of iterator) {
+      comments.push(...page);
+      count += page.length;
+      if (count >= 500) break; // Hard upper bound to prevent unbounded pagination
+    }
+
+    // Check for marker-based comment OR @coderabbitai plan text
+    return comments.some(c =>
+      typeof c?.body === 'string' &&
+      (c.body.includes(CODERABBIT_MARKER) || c.body.includes('@coderabbitai plan'))
+    );
+  } catch (error) {
+    console.log('Failed to check existing CodeRabbit plan comments:', {
+      message: error?.message,
+      status: error?.status,
+      owner,
+      repo,
+      issueNumber,
+    });
+    // Return false to allow plan trigger attempt (fail-open for better UX)
+    return false;
   }
-  
-  return comments.some(c => c.body?.includes('@coderabbitai plan'));
 }
 
 function logSummary(owner, repo, issue) {
@@ -60,27 +83,42 @@ function logSummary(owner, repo, issue) {
   console.log(`Labels: ${issue.labels?.map(l => l.name).join(', ') || 'none'}`);
 }
 
-module.exports = async ({ github, context }) => {
+// Main workflow handler (default export for workflow usage)
+async function main({ github, context }) {
   try {
     const { owner, repo } = context.repo;
     const { issue, label } = context.payload;
 
     // Validations
     if (!issue?.number) return console.log('No issue in payload');
-    
+
     if (!hasBeginnerOrHigherLabel(issue, label)) {
-      return console.log('Issue does not have intermediate or advanced label');
+      return console.log('Issue does not have beginner/intermediate/advanced label');
     }
 
     if (await hasExistingCodeRabbitPlan(github, owner, repo, issue.number)) {
       return console.log(`CodeRabbit plan already triggered for #${issue.number}`);
     }
 
     // Post CodeRabbit plan trigger
-    await triggerCodeRabbitPlan(github, owner, repo, issue, marker);
+    await triggerCodeRabbitPlan(github, owner, repo, issue, CODERABBIT_MARKER);
 
     logSummary(owner, repo, issue);
   } catch (err) {
-    console.log('❌ Error:', err.message);
+    console.log('❌ Error:', {
+      message: err?.message,
+      status: err?.status,
+      owner: context?.repo?.owner,
+      repo: context?.repo?.repo,
+      issueNumber: context?.payload?.issue?.number,
+    });
   }
-};
+}
+
+// Default export for workflow usage: await script({ github, context })
+module.exports = main;
+
+// Named exports for reuse by other scripts (e.g., GFI assignment bot)
+module.exports.triggerCodeRabbitPlan = triggerCodeRabbitPlan;
+module.exports.hasExistingCodeRabbitPlan = hasExistingCodeRabbitPlan;
+module.exports.CODERABBIT_MARKER = CODERABBIT_MARKER;

CHANGELOG.md

@@ -12,6 +12,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Added comprehensive docstring to `FeeAssessmentMethod` enum explaining inclusive vs exclusive fee assessment methods with usage examples. (#1391)
 - Added comprehensive docstring to `TokenType` enum explaining fungible vs non-fungible tokens with practical use cases. (#1392)
 - Enable dry run support for office hours bot via `workflow_dispatch` trigger for testing without posting comments. (#1426)
+- Trigger CodeRabbit plan comment after Good First Issue assignment to provide AI-generated implementation guidance to new contributors. (#1432)
 
 - Added a notification workflow that alerts the support team when an issue is labeled as a Good First Issue Candidate.[(#1296)]
 - Added comprehensive training documentation for the `Query` class, covering execution flow, payments, retries, and building child queries. (#1238)
@@ -100,6 +101,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Added prompt for coderabbit to review `Query` and it's sub-classes.
 
 ### Changed
+- Refactored `file_info_query.py` to use `print(info)` instead of manual formatting (#1451)
 
 - Enable CodeRabbit walkthrough mode by default to improve PR review visibility (#1439)
 - Move assignment guards to be directly inside the gfi and beginner auto assign

examples/file/file_info_query.py

@@ -73,15 +73,9 @@ def query_file_info():
 
     info = FileInfoQuery().set_file_id(file_id).execute(client)
 
+    # Use the SDK's built-in pretty print method
     print("\nFile Info:")
-    print(f"File ID: {info.file_id}")
-    print(f"Size: {info.size} bytes")
-    print(f"Memo: {info.file_memo}")
-    print(f"Expiration Time: {info.expiration_time}")
-    print(f"Deleted: {info.is_deleted}")
-    print(f"Total key(s): {len(info.keys)}")
-    for i, key in enumerate(info.keys, 1):
-        print(f"Key {i}: {key.to_string()}")
+    print(info)
 
 
 if __name__ == "__main__":