Hl/pr review table

[hussam789]

User description

aaa

---

Type

enhancement, bug_fix

---

Description

• Introduced a new markdown table format for PR reviews, enhancing readability and organization.
• Standardized whitespace and newline stripping for relevant_file and relevant_line across various Git providers to fix inconsistencies.
• Updated documentation and help sections to align with the new PR review format and settings.
• Removed unused settings and updated configuration to increase AI timeout, improving the PR review process.
• Adjusted tests to match the new PR review markdown table format.

---

Changes walkthrough

	Relevant files
Enhancement	3 files utils.py Refactor PR Review Markdown Generation                                      pr_agent/algo/utils.py Introduced a new markdown table format for PR reviews. Added new emojis for possible issues and security concerns. Removed unused emojis and simplified the markdown generation logic. +43/-52  pr_reviewer.py Enhancements and Fixes in PR Reviewer Tool                              pr_agent/tools/pr_reviewer.py Removed unused require_security_review from PR preparation. Changed initial comment header to "## PR Review". Adjusted code feedback processing for inline comments. Updated model type to ModelType.TURBO for prediction preparation. +21/-30  pr_reviewer_prompts.toml Update PR Reviewer Prompts Schema                                                pr_agent/settings/pr_reviewer_prompts.toml Updated the PR review prompt schema to reflect new review and code feedback structure. +58/-118
Bug_fix	5 files bitbucket_provider.py Standardize Whitespace Stripping in Bitbucket Provider      pr_agent/git_providers/bitbucket_provider.py Standardized the stripping of whitespace for relevant_file and relevant_line in generate_link_to_relevant_line_number. +2/-2      bitbucket_server_provider.py Standardize Whitespace Stripping in Bitbucket Server Provider pr_agent/git_providers/bitbucket_server_provider.py Standardized the stripping of whitespace for relevant_file and relevant_line in generate_link_to_relevant_line_number. +2/-2      github_provider.py Standardize Whitespace and Newline Stripping in GitHub Provider pr_agent/git_providers/github_provider.py Standardized the stripping of whitespace and newline for relevant_file and relevant_line in generate_link_to_relevant_line_number. +2/-2      gitlab_provider.py Standardize Whitespace Stripping in GitLab Provider            pr_agent/git_providers/gitlab_provider.py Standardized the stripping of whitespace for relevant_file and relevant_line in generate_link_to_relevant_line_number. +2/-2      pr_description.py Strip Trailing Whitespace from Filenames                                  pr_agent/tools/pr_description.py Ensured filenames are stripped of trailing whitespace before processing. +1/-1
Documentation	2 files help.py Update Help Documentation with New Section Example              pr_agent/servers/help.py Updated the example for extra instructions to reflect the new 'possible issues' section. +1/-1      REVIEW.md Documentation Update for PR Review Settings                            docs/REVIEW.md Removed mention of require_security_review setting. +0/-1
Tests	2 files test_convert_to_markdown.py Update Tests for New Markdown Table Format                              tests/unittest/test_convert_to_markdown.py Updated tests to reflect the new markdown table format for PR reviews. +21/-43  test_load_yaml.py Add Test Case for Loading YAML with Corrected Keys              tests/unittest/test_load_yaml.py Added a test case for loading YAML with corrected keys. +5/-3
Configuration changes	1 files configuration.toml Configuration Updates for PR Agent                                              pr_agent/settings/configuration.toml Increased AI timeout to 120 seconds. Removed require_security_review setting. +1/-3
Formatting	1 files pr_description_prompts.toml Formatting Correction in PR Description Prompts                    pr_agent/settings/pr_description_prompts.toml Minor formatting correction. +1/-1

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎 For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are: 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. true: A collapsable file comment with changes title and a changes summary for each file in the PR. false (default): File changes walkthrough will be added only to the "Conversation" tab.

Utilizing extra instructions The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: [pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

[mrT23]

PR Description updated to latest commit (6837e43)

[mrT23]

Preparing PR description...

[mrT23]

/describe

[mrT23]

/review

[codiumai-pr-agent-pro]

PR Review

(review updated until commit 796e203)

PR feedback
⏱️ Estimated effort to review [1-5]	2, because the PR includes a variety of changes across multiple files, including enhancements and bug fixes, which requires a thorough review of the logic and tests. However, the changes seem well-documented and structured, which may ease the review process.
🧪 Relevant tests	Yes
🔍 Possible issues	The use of .rstrip() in multiple places to clean file paths and lines could potentially remove more characters than intended if the relevant data ends with whitespace characters that are significant. The change from require_security_review setting to not being used might need a clear migration or deprecation path for existing configurations.
🔒 Security concerns	No

Code feedback:

---

relevant file	pr_agent/git_providers/bitbucket_provider.py
suggestion	Consider verifying the existence of relevant_file and relevant_line_str before proceeding with their usage to avoid potential KeyError or AttributeError. This can be done by using .get() method with a default value. [important]
relevant line	relevant_file = suggestion['relevant_file'].strip('`').strip("'").rstrip()

---

\n"

relevant file	pr_agent/algo/utils.py
suggestion	For consistency and readability, consider using a loop to add emojis and their corresponding descriptions to markdown_text instead of manually appending each row. This could reduce the code size and improve maintainability. [medium]
relevant line	markdown_text += f"
{emoji} {key_nice}	\n\n{value}\n\n

---

relevant file	pr_agent/tools/pr_reviewer.py
suggestion	The removal of require_security_review from the settings might leave existing configurations that rely on this setting in an inconsistent state. Consider adding a fallback or warning message for configurations still using this deprecated setting. [important]
relevant line	- "require_security": get_settings().pr_reviewer.require_security_review,

---

relevant file	pr_agent/settings/configuration.toml
suggestion	Since ai_timeout has been increased to 120 seconds, ensure that this change is communicated to users, especially if it impacts the expected response time for generating PR reviews. [medium]
relevant line	ai_timeout=120 # 2minutes

---

---

✨ Usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR Description updated to latest commit (796e203)

• Copy walkthrough table to "Files Changed" Tab

[mrT23]

/improve

[codiumai-pr-agent-pro]

PR Code Suggestions

	Suggestions
enhancement	Check for empty or None output_data at the start of the function. Consider checking for output_data being None or empty at the start of the function to avoid unnecessary processing and directly return an empty string if that's the case. pr_agent/algo/utils.py [55-56] -if not output_data or not output_data.get('review', {}): +if not output_data: return "" Use enumerate() for cleaner iteration over code_feedback. Use enumerate() to get both the index and value from code_feedback instead of manually managing the index with i. pr_agent/tools/pr_reviewer.py [73-74] -for i, value in enumerate(output_data['code_feedback']): +for i, value in enumerate(output_data['code_feedback'], start=1): if value is None or value == '' or value == {} or value == []: continue markdown_text += parse_code_suggestion(value, i, gfm_supported)+"\n\n" Simplify assertion by using the expected output directly.                     Use a direct assertion for load_yaml output instead of setting expected_output when it's used only once. tests/unittest/test_load_yaml.py [48-49] -expected_output = [{'relevant file': 'src/app.py:', 'suggestion content': 'The print statement is outside inside the if __name__ ==: '}] -assert load_yaml(yaml_str) == expected_output +assert load_yaml(yaml_str) == [{'relevant file': 'src/app.py:', 'suggestion content': 'The print statement is outside inside the if __name__ ==: '}]
best practice	Use join() or multi-line strings for building markdown_text. Use a more Pythonic way to build strings, such as using join() or multi-line strings, instead of concatenating strings with += for building markdown_text. pr_agent/algo/utils.py [51-53] -markdown_text += f"## PR Review\n\n" -markdown_text += "<table>\n<tr>\n" -markdown_text += """<td> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong>PR&nbsp;feedback</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </td> <td></td></tr>""" +markdown_text = """ +## PR Review +<table> +<tr> +<td> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong>PR&nbsp;feedback</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </td> <td></td></tr> +""" + Use f-strings for building markdown_text.                        Replace manual string concatenation with f-strings for building markdown_text to improve readability and performance. pr_agent/tools/pr_reviewer.py [99-104] -markdown_text += '<table>' -markdown_text += f"<tr><td>relevant file</td><td>{relevant_file}</td></tr>" +markdown_text = f""" +<table> +<tr><td>relevant file</td><td>{relevant_file}</td></tr> +"""
possible issue	Safely access relevant_file and relevant_line in suggestion. Ensure that relevant_file and relevant_line keys exist in suggestion before accessing them to avoid KeyError. pr_agent/algo/utils.py [243-244] -relevant_file = suggestion['relevant_file'].strip('`').strip("'").rstrip() -relevant_line_str = suggestion['relevant_line'].rstrip() +relevant_file = suggestion.get('relevant_file', '').strip('`').strip("'").rstrip() +relevant_line_str = suggestion.get('relevant_line', '').rstrip()
maintainability	Use a multiline string for long HTML content to enhance readability.          Consider using a multiline string for expected_output to improve readability and maintainability. tests/unittest/test_convert_to_markdown.py [55] -expected_output = '## PR Review\n\n<table>\n<tr>\n<td> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong>PR&nbsp;feedback</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </td> <td></td></tr><tr><td> ⏱️ Estimated effort to review [1-5]</td><td>\n\n1, because the changes are minimal and straightforward, focusing on a single functionality addition.\n\n\n</td></tr>\n<tr><td> 🧪 Relevant tests added</td><td>\n\nNo\n\n\n</td></tr>\n<tr><td> 🔍 Possible issues</td><td>\n\nNo\n\n\n</td></tr>\n<tr><td> 🔒 Security concerns</td><td>\n\nNo\n\n\n</td></tr>\n</table>\n\n\n<details><summary> <strong>Code feedback:</strong></summary>\n\n<hr><table><tr><td>relevant file</td><td>pr_agent/git_providers/git_provider.py\n</td></tr><tr><td>suggestion &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td>\n\n<strong>\n\nConsider raising an exception or logging a warning when \'pr_url\' attribute is not found. This can help in debugging issues related to the absence of \'pr_url\' in instances where it\'s expected. [important]\n\n</strong>\n</td></tr><tr><td>relevant line</td><td><a href=\'https://github.com/Codium-ai/pr-agent-pro/pull/102/files#diff-52d45f12b836f77ed1aef86e972e65404634ea4e2a6083fb71a9b0f9bb9e062fR199\'>return ""</a></td></tr></table><hr>\n\n</details>' +expected_output = """## PR Review +<table> +<tr> +<td> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong>PR&nbsp;feedback</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </td> <td></td></tr> +<tr><td> ⏱️ Estimated effort to review [1-5]</td><td> + +1, because the changes are minimal and straightforward, focusing on a single functionality addition. + + +</td></tr> +<tr><td> 🧪 Relevant tests added</td><td> + +No + + +</td></tr> +<tr><td> 🔍 Possible issues</td><td> + +No + + +</td></tr> +<tr><td> 🔒 Security concerns</td><td> + +No + + +</td></tr> +</table> + + +<details><summary> <strong>Code feedback:</strong></summary> + +<hr><table><tr><td>relevant file</td><td>pr_agent/git_providers/git_provider.py +</td></tr><tr><td>suggestion &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td> + +<strong> + +Consider raising an exception or logging a warning when 'pr_url' attribute is not found. This can help in debugging issues related to the absence of 'pr_url' in instances where it's expected. [important] + +</strong> +</td></tr><tr><td>relevant line</td><td><a href='https://github.com/Codium-ai/pr-agent-pro/pull/102/files#diff-52d45f12b836f77ed1aef86e972e65404634ea4e2a6083fb71a9b0f9bb9e062fR199'>return ""</a></td></tr></table><hr> + +</details>""" + Add a comment explaining the reason for the ai_timeout value.    Consider adding a comment to explain the rationale behind setting ai_timeout to 120 seconds, for better understanding and maintainability. pr_agent/settings/configuration.toml [12] -ai_timeout=120 # 2minutes +ai_timeout=120 # Increased to 2 minutes to accommodate longer processing times for complex PRs

---

✨ Usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[mrT23]

Persistent review updated to latest commit 796e203

[mrT23]

Persistent review updated to latest commit 796e203

[mrT23]

PR Description updated to latest commit (796e203)