Support Azure Inline Comment

[yochail]

User description

add support for azure inline commnets

---

Type

enhancement

---

Description

• Implemented functionality for publishing inline comments in Azure DevOps.
• This includes methods for creating and publishing individual or multiple comments, determining the exact line for comments, and handling errors.
• Removed previous placeholders indicating lack of support for inline comments, enabling this feature for Azure DevOps users.

---

Changes walkthrough

Relevant files

Enhancement

azuredevops_provider.py Implement Inline Comment Publishing for Azure DevOps                      pr_agent/git_providers/azuredevops_provider.py Added support for publishing inline comments in Azure DevOps. Implemented publish_inline_comment and publish_inline_comments methods. Utilized find_line_number_of_relevant_line_in_file to find the exact position for inline comments. Removed the NotImplementedError for inline comment publishing, enabling this feature. +54/-14

---

✨ 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.

[codiumai-pr-agent-pro]

PR Description updated to latest commit (ba854c2)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR Review

PR feedback
⏱️ Estimated effort to review [1-5]	3, because the PR involves adding new functionalities to support inline comments in Azure DevOps, including methods for creating and publishing comments, and handling errors. The changes are moderate in size and complexity, requiring a detailed review of the implementation logic and error handling.
🧪 Relevant tests	No
🔍 Possible issues	The method publish_inline_comments does not handle the case where comment["path"] or comment["absolute_position"] might not be present in the comment dictionary, which could lead to KeyError. The offset value in rightFileStart and rightFileEnd is hardcoded to 1. This might not be appropriate for all cases and could lead to incorrect comment positioning. Exception handling in publish_inline_comments catches all exceptions and logs an error without re-raising, which could suppress important errors and make debugging difficult.
🔒 Security concerns	No

---

✨ 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 Code Suggestions

	Suggestions
maintainability	Improve variable naming for clarity.                                          Consider using a more descriptive variable name than absolute_position for clarity, as it's used to represent both an input parameter and a calculated value within the same function. pr_agent/git_providers/azuredevops_provider.py [176] def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str, - absolute_position: int = None): + initial_absolute_position: int = None): Refactor method to separate concerns for better maintainability.              Refactor the publish_inline_comments method to separate concerns, such as comment creation and thread creation, into different methods for better readability and maintainability. pr_agent/git_providers/azuredevops_provider.py [191-213] -def publish_inline_comments(self, comments: list[dict], disable_fallback: bool = False): - try: - for comment in comments: - comment_obj = Comment(content=comment["body"], comment_type=1) - thread = CommentThread(comments=[comment_obj], - thread_context={ - "filePath": comment["path"], - "rightFileStart": { - "line": comment["absolute_position"], - "offset": 1, - }, - "rightFileEnd": { - "line": comment["absolute_position"], - "offset": 1, - }, - }, - status="active") - self.azure_devops_client.create_thread( - comment_thread=thread, - project=self.workspace_slug, - repository_id=self.repo_slug, - pull_request_id=self.pr_num - ) +# Suggested refactoring into separate methods not shown due to space constraints
best practice	Avoid magic numbers by using a constant for the offset value.                 Replace the hardcoded offset value with a variable or a constant to avoid magic numbers and improve maintainability. pr_agent/git_providers/azuredevops_provider.py [200] -"offset": 1, # TODO +"offset": DEFAULT_OFFSET, # Assuming DEFAULT_OFFSET is defined appropriately elsewhere Use structured logging for improved log management.                           Use a structured logging approach instead of string formatting for better log management and analysis. pr_agent/git_providers/azuredevops_provider.py [184] -get_logger().info(f"Could not find position for {relevant_file} {relevant_line_in_file}") +get_logger().info("Could not find position for file", extra={"file": relevant_file, "line": relevant_line_in_file})
enhancement	Improve error handling in the comment publication loop.                       Implement error handling for each comment publication in the loop to continue processing subsequent comments even if one fails. pr_agent/git_providers/azuredevops_provider.py [193-213] for comment in comments: - comment_obj = Comment(content=comment["body"], comment_type=1) - thread = CommentThread(comments=[comment_obj], - thread_context={ - "filePath": comment["path"], - "rightFileStart": { - "line": comment["absolute_position"], - "offset": 1, + try: + comment_obj = Comment(content=comment["body"], comment_type=1) + thread = CommentThread(comments=[comment_obj], + thread_context={ + "filePath": comment["path"], + "rightFileStart": { + "line": comment["absolute_position"], + "offset": 1, + }, + "rightFileEnd": { + "line": comment["absolute_position"], + "offset": 1, + }, }, - "rightFileEnd": { - "line": comment["absolute_position"], - "offset": 1, - }, - }, - status="active") - self.azure_devops_client.create_thread( - comment_thread=thread, - project=self.workspace_slug, - repository_id=self.repo_slug, - pull_request_id=self.pr_num - ) + status="active") + self.azure_devops_client.create_thread( + comment_thread=thread, + project=self.workspace_slug, + repository_id=self.repo_slug, + pull_request_id=self.pr_num + ) + except Exception as e: + if get_settings().config.verbosity_level >= 2: + get_logger().error(f"Failed to publish comment for {comment['path']}, error: {e}")

---

✨ 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]

Hi @yochail, thanks for the PR.

Take a look at the Code Suggestions that PR-Agent gave, I think some of them are more than reasonable.

For example, use try-catch per comment is a must:

Also better present the offset (why did you leave is as 'toDo' ? is there something better ?)

[yochail]

@mrT23 relevant comments fixed