Merge pull request #1869 from PullPullers/feat/review-todo-section

feat: surface TODO comments in review tool

pr_agent/settings/configuration.toml

@@ -78,6 +78,7 @@ require_tests_review=true
 require_estimate_effort_to_review=true
 require_can_be_split_review=false
 require_security_review=true
+require_todo_scan=false
 require_ticket_analysis_review=true
 # general options
 publish_output_no_suggestions=true # Set to "false" if you only need the reviewer's remarks (not labels, not "security audit", etc.) and want to avoid noisy "No major issues detected" comments.

pr_agent/settings/pr_reviewer_prompts.toml

@@ -72,6 +72,13 @@ class KeyIssuesComponentLink(BaseModel):
     start_line: int = Field(description="The start line that corresponds to this issue in the relevant file")
     end_line: int = Field(description="The end line that corresponds to this issue in the relevant file")
 
+{%- if require_todo_scan %}
+class TodoSection(BaseModel):
+    relevant_file: str = Field(description="The file containing the TODO comment")
+    line_range: Tuple[int, int] = Field(description="Start and end line numbers of the TODO comment (inclusive). Must be a tuple of two integers, e.g., (7, 7) for a single line or (7, 10) for a range. Do not use list format [7, 7].")
+    content: str = Field(description="The content of the TODO comment. Only include actual TODO comments within code comments (e.g., lines starting with '#', '//', '/*', '<!--').  Remove leading 'TODO' prefixes. Include lines like '# TODO', even if empty after prefix removal. Exclude TODOs outside comments or without appropriate prefixes. Use | block style only when the line range covers multiple lines (e.g., (7, 10)).")
+{%- endif %}
+
 {%- if related_tickets %}
 
 class TicketCompliance(BaseModel):
@@ -102,6 +109,10 @@ class Review(BaseModel):
 {%- if require_security_review %}
     security_concerns: str = Field(description="Does this PR code introduce possible vulnerabilities such as exposure of sensitive information (e.g., API keys, secrets, passwords), or security concerns like SQL injection, XSS, CSRF, and others ? Answer 'No' (without explaining why) if there are no possible issues. If there are security concerns or issues, start your answer with a short header, such as: 'Sensitive information exposure: ...', 'SQL injection: ...' etc. Explain your answer. Be specific and give examples if possible")
 {%- endif %}
+{%- if require_todo_scan %}
+    todo_sections: Union[List[TodoSection], str] = Field(description="A list of TODO comments found in the PR code. Return 'No' (as a string) if there are no TODO comments in the PR"
+    todo_summary: str = Field(description="Up to 6 words summarizing the functional areas of the TODO comments found in the code.")
+{%- endif %}
 {%- if require_can_be_split_review %}
     can_be_split: List[SubPR] = Field(min_items=0, max_items=3, description="Can this PR, which contains {{ num_pr_files }} changed files in total, be divided into smaller sub-PRs with distinct tasks that can be reviewed and merged independently, regardless of the order ? Make sure that the sub-PRs are indeed independent, with no code dependencies between them, and that each sub-PR represent a meaningful independent task. Output an empty list if the PR code does not need to be split.")
 {%- endif %}
@@ -148,6 +159,12 @@ review:
     - ...
   security_concerns: |
     No
+{%- if require_todo_scan %}
+  todo_sections: |
+    No
+  todo_summary: |
+    ...
+{%- endif %} 
 {%- if require_can_be_split_review %}
   can_be_split:
   - relevant_files:
@@ -266,6 +283,12 @@ review:
     - ...
   security_concerns: |
     No
+{%- if require_todo_scan %}
+  todo_sections: |
+    No
+  todo_summary: |
+    ...
+{%- endif %}
 {%- if require_can_be_split_review %}
   can_be_split:
   - relevant_files: