Merge pull request #1416 from Codium-ai/tr/remove_review_suggestions

refactor: remove legacy code suggestions feature from review tool

README.md

@@ -179,43 +179,6 @@ ___
 </div>
 
 
-
-
-[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/78#issuecomment-1639739496">/reflect_and_review:</a></h4>)
-
-[//]: # (<div align="center">)
-
-[//]: # (<p float="center">)
-
-[//]: # (<img src="https://www.codium.ai/images/reflect_and_review.gif" width="800">)
-
-[//]: # (</p>)
-
-[//]: # (</div>)
-
-[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695020538">/ask:</a></h4>)
-
-[//]: # (<div align="center">)
-
-[//]: # (<p float="center">)
-
-[//]: # (<img src="https://www.codium.ai/images/ask-2.gif" width="800">)
-
-[//]: # (</p>)
-
-[//]: # (</div>)
-
-[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695024952">/improve:</a></h4>)
-
-[//]: # (<div align="center">)
-
-[//]: # (<p float="center">)
-
-[//]: # (<img src="https://www.codium.ai/images/improve-2.gif" width="800">)
-
-[//]: # (</p>)
-
-[//]: # (</div>)
 <div align="left">
 
 

docs/docs/tools/review.md

@@ -46,61 +46,12 @@ extra_instructions = "..."
 - The `pr_commands` lists commands that will be executed automatically when a PR is opened.
 - The `[pr_reviewer]` section contains the configurations for the `review` tool you want to edit (if any).
 
-[//]: # ()
-[//]: # (### Incremental Mode)
-
-[//]: # (Incremental review only considers changes since the last Qodo Merge review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.)
-
-[//]: # (For invoking the incremental mode, the following command can be used:)
-
-[//]: # (```)
-
-[//]: # (/review -i)
-
-[//]: # (```)
-
-[//]: # (Note that the incremental mode is only available for GitHub.)
-
-[//]: # ()
-[//]: # (![incremental review](https://codium.ai/images/pr_agent/incremental_review_2.png){width=512})
-
-[//]: # (### PR Reflection)
-
-[//]: # ()
-[//]: # (By invoking:)
-
-[//]: # (```)
-
-[//]: # (/reflect_and_review)
-
-[//]: # (```)
-
-[//]: # (The tool will first ask the author questions about the PR, and will guide the review based on their answers.)
-
-[//]: # ()
-[//]: # (![reflection questions](https://codium.ai/images/pr_agent/reflection_questions.png){width=512})
-
-[//]: # ()
-[//]: # (![reflection answers](https://codium.ai/images/pr_agent/reflection_answers.png){width=512})
-
-[//]: # ()
-[//]: # (![reflection insights](https://codium.ai/images/pr_agent/reflection_insights.png){width=512})
-
-
 
 ## Configuration options
 
 !!! example "General options"
 
 <table>
-  <tr>
-    <td><b>num_code_suggestions</b></td>
-    <td>Number of code suggestions provided by the 'review' tool. Default is 0, meaning no code suggestions will be provided by the `review` tool. Note that this is a legacy feature, that will be removed in future releases. Use the `improve` tool instead for code suggestions</td>
-  </tr>
-  <tr>
-    <td><b>inline_code_comments</b></td>
-    <td>If set to true, the tool will publish the code suggestions as comments on the code diff. Default is false. Note that you need to set `num_code_suggestions`>0 to get code suggestions </td>
-  </tr>
   <tr>
     <td><b>persistent_comment</b></td>
     <td>If set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.</td>
@@ -189,9 +140,9 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review
 !!! tip "Automation"
     When you first install Qodo Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened) for the `review` tool is:
     ```
-    pr_commands = ["/review --pr_reviewer.num_code_suggestions=0", ...]
+    pr_commands = ["/review", ...]
     ```
-    Meaning the `review` tool will run automatically on every PR, without providing code suggestions.
+    Meaning the `review` tool will run automatically on every PR, without any additional configurations.
     Edit this field to enable/disable the tool, or to change the configurations used.
 
 !!! tip "Possible labels from the review tool"
@@ -249,12 +200,8 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review
     maximal_review_effort = 5
     ```
 
-[//]: # (!!! tip  "Code suggestions")
-
-[//]: # ()
-[//]: # (    If you set `num_code_suggestions`>0 , the `review` tool will also provide code suggestions.)
+!!! tip  "Code suggestions"
 
-[//]: # (    )
-[//]: # (    Notice If you are interested **only** in the code suggestions, it is recommended to use the [`improve`]&#40;./improve.md&#41; feature instead, since it is a dedicated only to code suggestions, and usually gives better results.)
+    The `review` tool previously included a legacy feature for providing code suggestions (controlled by `--pr_reviewer.num_code_suggestion`). This functionality has been deprecated and replaced by the [`improve`](./improve.md) tool, which offers higher quality and more actionable code suggestions.
 
-[//]: # (    Use the `review` tool if you want to get more comprehensive feedback, which includes code suggestions as well.)
+    

docs/docs/usage-guide/automations_and_usage.md

@@ -285,7 +285,7 @@ To control which commands will run automatically when a new PR is opened, you ca
 [azure_devops_server]
 pr_commands = [
     "/describe",
-    "/review --pr_reviewer.num_code_suggestions=0",
+    "/review",
     "/improve",
 ]
 ```

pr_agent/agent/pr_agent.py

@@ -13,7 +13,6 @@
 from pr_agent.tools.pr_description import PRDescription
 from pr_agent.tools.pr_generate_labels import PRGenerateLabels
 from pr_agent.tools.pr_help_message import PRHelpMessage
-from pr_agent.tools.pr_information_from_user import PRInformationFromUser
 from pr_agent.tools.pr_line_questions import PR_LineQuestions
 from pr_agent.tools.pr_questions import PRQuestions
 from pr_agent.tools.pr_reviewer import PRReviewer
@@ -25,8 +24,6 @@
     "answer": PRReviewer,
     "review": PRReviewer,
     "review_pr": PRReviewer,
-    "reflect": PRInformationFromUser,
-    "reflect_and_review": PRInformationFromUser,
     "describe": PRDescription,
     "describe_pr": PRDescription,
     "improve": PRCodeSuggestions,
@@ -76,12 +73,10 @@ async def handle_request(self, pr_url, request, notify=None) -> bool:
 
         action = action.lstrip("/").lower()
         if action not in command2class:
-            get_logger().debug(f"Unknown command: {action}")
+            get_logger().error(f"Unknown command: {action}")
             return False
         with get_logger().contextualize(command=action, pr_url=pr_url):
             get_logger().info("PR-Agent request handler started", analytics=True)
-            if action == "reflect_and_review":
-                get_settings().pr_reviewer.ask_and_reflect = True
             if action == "answer":
                 if notify:
                     notify()

pr_agent/algo/utils.py

@@ -270,22 +270,6 @@ def convert_to_markdown_v2(output_data: dict,
     if gfm_supported:
         markdown_text += "</table>\n"
 
-    if 'code_feedback' in output_data:
-        if gfm_supported:
-            markdown_text += f"\n\n"
-            markdown_text += f"<details><summary> <strong>Code feedback:</strong></summary>\n\n"
-            markdown_text += "<hr>"
-        else:
-            markdown_text += f"\n\n### Code feedback:\n\n"
-        for i, value in enumerate(output_data['code_feedback']):
-            if value is None or value == '' or value == {} or value == []:
-                continue
-            markdown_text += parse_code_suggestion(value, i, gfm_supported)+"\n\n"
-        if markdown_text.endswith('<hr>'):
-            markdown_text= markdown_text[:-4]
-        if gfm_supported:
-            markdown_text += f"</details>"
-
     return markdown_text
 
 def extract_relevant_lines_str(end_line, files, relevant_file, start_line, dedent=False):

pr_agent/settings/configuration.toml

@@ -55,9 +55,6 @@ require_can_be_split_review=false
 require_security_review=true
 require_ticket_analysis_review=true
 # general options
-num_code_suggestions=0 # legacy mode. use the `improve` command instead
-inline_code_comments = false
-ask_and_reflect=false
 persistent_comment=true
 extra_instructions = ""
 final_update_message = true

pr_agent/settings/pr_reviewer_prompts.toml

@@ -1,10 +1,6 @@
 [pr_review_prompt]
 system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
-{%- if num_code_suggestions > 0 %}
-Your task is to provide constructive and concise feedback for the PR, and also provide meaningful code suggestions.
-{%- else %}
 Your task is to provide constructive and concise feedback for the PR.
-{%- endif %}
 The review should focus on new code added in the PR code diff (lines starting with '+')
 
 
@@ -49,16 +45,6 @@ __new hunk__
 {%- endif %}
 - When quoting variables or names from the code, use backticks (`) instead of single quote (').
 
-{%- if num_code_suggestions > 0 %}
-
-
-Code suggestions guidelines:
-- Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
-- Focus on important suggestions like fixing code problems, issues and bugs. As a second priority, provide suggestions for meaningful code improvements, like performance, vulnerability, modularity, and best practices.
-- Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the PR code.
-- Don't suggest to add docstring, type hints, or comments.
-- Suggestions should address the new code added in the PR diff (lines starting with '+')
-{%- endif %}
 
 {%- if extra_instructions %}
 
@@ -118,25 +104,9 @@ class Review(BaseModel):
 {%- 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 %}
-{%- if num_code_suggestions > 0 %}
-
-class CodeSuggestion(BaseModel):
-    relevant_file: str = Field(description="The full file path of the relevant file")
-    language: str = Field(description="The programming language of the relevant file")
-    suggestion: str = Field(description="a concrete suggestion for meaningfully improving the new PR code. Also describe how, specifically, the suggestion can be applied to new PR code. Add tags with importance measure that matches each suggestion ('important' or 'medium'). Do not make suggestions for updating or adding docstrings, renaming PR title and description, or linter like.")
-    relevant_line: str = Field(description="a single code line taken from the relevant file, to which the suggestion applies. The code line should start with a '+'. Make sure to output the line exactly as it appears in the relevant file")
-{%- endif %}
-{%- if num_code_suggestions > 0 %}
 
 class PRReview(BaseModel):
     review: Review
-    code_feedback: List[CodeSuggestion]
-{%- else %}
-
-
-class PRReview(BaseModel):
-    review: Review
-{%- endif %}
 =====
 
 
@@ -185,18 +155,6 @@ review:
     title: ...
   - ...
 {%- endif %}
-
-{%- if num_code_suggestions > 0 %}
-code_feedback:
-- relevant_file: |
-    directory/xxx.py
-  language: |
-    python
-  suggestion: |
-    xxx [important]
-  relevant_line: |
-    xxx
-{%- endif %}
 ```
 
 Answer should be a valid YAML, and nothing else. Each YAML output MUST be after a newline, with proper indent, and block scalar indicator ('|')