Extend 'similar_issue' Feature for Bitbucket Support and Update Documentation

[sarbjitsinghgrewal]

User description

User description

Type:

Enhancement

---

Description:

This PR extends the 'similar_issue' feature to support Bitbucket, in addition to the existing support for GitHub. The changes include:

• Modifications to the BitbucketProvider class to handle Bitbucket-specific operations.
• Updates to the GithubProvider class to handle similar operations for GitHub.
• Changes to the PRSimilarIssue class to use the appropriate Git provider based on the issue URL.
• Updates to the README.md file to reflect the new support for Bitbucket in the 'similar_issue' feature.

---

Main files walkthrough:

files:

• pr_agent/git_providers/bitbucket_provider.py: The BitbucketProvider class has been extended with methods to handle Bitbucket-specific operations. These include methods to parse issue URLs, get issues, get issue details, create comments on issues, and handle similar issues.
• pr_agent/git_providers/github_provider.py: The GithubProvider class has been updated with similar methods to handle operations for GitHub. These include methods to get issues, create comments on issues, and handle similar issues.
• pr_agent/tools/pr_similar_issue.py: The PRSimilarIssue class has been updated to use the appropriate Git provider based on the issue URL. It now supports both GitHub and Bitbucket.
• README.md: The README.md file has been updated to reflect the new support for Bitbucket in the 'similar_issue' feature.

---

Type

Enhancement

---

Description

• Extended BitbucketProvider with new attributes and methods for handling issues and comments on Bitbucket.
• Updated GitHubProvider for consistent issue and comment handling, aligning with BitbucketProvider enhancements.
• Generalized PRSimilarIssue class to support both GitHub and Bitbucket, removing the GitHub-specific restriction.
• Updated README to reflect the new support for Bitbucket in the 'similar_issue' feature and marked additional support for the 'Actions' feature.

---

Changes walkthrough

	Relevant files
Enhancement	bitbucket_provider.py Extend BitbucketProvider for Issue Handling and Comments  pr_agent/git_providers/bitbucket_provider.py Added new attributes to the BitbucketProvider class for handling features, issue numbers, and issue names. Implemented methods for parsing issue URLs, getting issues, and creating comments on issues in Bitbucket. Enhanced the BitbucketProvider class to support operations specific to Bitbucket issues. +114/-5  github_provider.py Update GitHub Provider for Consistent Issue Handling          pr_agent/git_providers/github_provider.py Updated logging to use get_logger() for consistency. Added methods to handle GitHub issues similar to the new Bitbucket functionality. Enhanced GitHub provider with issue and comment handling capabilities. +70/-2    pr_similar_issue.py Generalize PRSimilarIssue for GitHub and Bitbucket Support pr_agent/tools/pr_similar_issue.py Removed GitHub-specific restriction, allowing for general Git provider usage. Updated to use new methods from Git providers for issue and comment handling. Enhanced PRSimilarIssue class to support both GitHub and Bitbucket. +21/-25
Documentation	README.md Update README for Extended 'Find similar issue' Feature Support README.md Updated the README to indicate support for the 'Find similar issue' feature on both GitHub and Bitbucket. Marked the 'Actions' feature as supported across more platforms. +2/-2

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

---

PR Type

Enhancement, Documentation

---

Description

• Extended BitbucketProvider with new attributes and methods for handling issues and comments on Bitbucket.
• Updated GitHubProvider for consistent issue and comment handling, aligning with BitbucketProvider.
• Refactored PRSimilarIssue to support both GitHub and Bitbucket by using provider-specific methods.
• Updated README.md to reflect the new support for Bitbucket in the similar_issue feature.

---

Changes walkthrough 📝

	Relevant files
Enhancement	bitbucket_provider.py Extend BitbucketProvider with issue handling capabilities pr_agent/git_providers/bitbucket_provider.py Added methods to handle Bitbucket-specific issue operations. Introduced parsing for Bitbucket issue URLs. Implemented methods to create comments and fetch issue details. +114/-5  github_provider.py Update GitHubProvider for consistent issue handling            pr_agent/git_providers/github_provider.py Added methods for consistent issue handling. Implemented methods to create comments and fetch issue details. +70/-2    pr_similar_issue.py Update PRSimilarIssue to support GitHub and Bitbucket        pr_agent/tools/pr_similar_issue.py Updated to support both GitHub and Bitbucket. Refactored to use provider-specific methods for issue handling. +21/-25
Documentation	README.md Update README for Bitbucket support in similar_issue feature README.md Updated documentation to reflect Bitbucket support. Added entries for similar issue feature and actions. +2/-2

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[mrT23]

/review

[github-actions]

PR Analysis

(review updated until commit f995b3e)

• 🎯 Main theme: Extending 'similar_issue' feature to support Bitbucket
• 📝 PR summary: This PR extends the 'similar_issue' feature to support Bitbucket, in addition to the existing support for GitHub. It includes modifications to the BitbucketProvider and GithubProvider classes to handle operations specific to their respective platforms, and updates the PRSimilarIssue class to use the appropriate Git provider based on the issue URL. The README.md file is also updated to reflect the new support for Bitbucket in the 'similar_issue' feature.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 4, because the PR includes a significant amount of new code and changes to existing code, which requires a thorough review to ensure that the new functionality is implemented correctly and that existing functionality is not negatively affected.
• 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The PR is well-structured and the changes are logically grouped. However, it would be beneficial to include tests for the new functionality to ensure it works as expected and does not introduce any regressions. Additionally, it would be helpful to include more detailed comments in the code to explain the purpose and functionality of the new methods.

🤖 Code feedback:

---

relevant file	pr_agent/git_providers/bitbucket_provider.py
suggestion	It seems like the BitbucketProvider class is doing too much work. Consider breaking down the class into smaller classes or modules, each with a single responsibility. This would improve the modularity and maintainability of the code. [important]
relevant line	class BitbucketProvider(GitProvider):

---

relevant file	pr_agent/git_providers/github_provider.py
suggestion	Similar to the BitbucketProvider class, the GithubProvider class could also benefit from being broken down into smaller classes or modules. This would make the code easier to understand and maintain. [important]
relevant line	class GithubProvider(GitProvider):

---

relevant file	pr_agent/tools/pr_similar_issue.py
suggestion	The PRSimilarIssue class seems to be tightly coupled with the BitbucketProvider and GithubProvider classes. Consider introducing an interface or abstract base class for the Git providers, which would make the PRSimilarIssue class more flexible and easier to test. [important]
relevant line	class PRSimilarIssue:

---

relevant file	README.md
suggestion	The changes to the README.md file are clear and informative. However, it would be helpful to include a section explaining how to use the 'similar_issue' feature with Bitbucket, similar to the existing instructions for GitHub. [medium]
relevant line	| | Find similar issue | ✅ | | ✅ | | | |

---

---

✨ 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 'general suggestions' 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.

[mrT23]

PR Description updated to latest commit (f995b3e)

[mrT23]

PR Description updated to latest commit (f995b3e)

[GadiZimerman]

• 👍
• 👎

@okotek can you tick these?

[codiumai-pr-agent-pro]

PR Description updated to latest commit (f995b3e)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

Persistent review updated to latest commit f995b3e

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions

Category	Suggestions
Maintainability	Replace direct access to private attributes with getter methods. Replace the direct access to private attributes of the pr object with proper getter methods or public properties to ensure encapsulation and maintainability. pr_agent/git_providers/bitbucket_provider.py [42-43] -self.bitbucket_comment_api_url = self.pr._BitbucketBase__data["links"]["comments"]["href"] -self.bitbucket_pull_request_api_url = self.pr._BitbucketBase__data["links"]['self']['href'] +self.bitbucket_comment_api_url = self.pr.get_comment_api_url() +self.bitbucket_pull_request_api_url = self.pr.get_pull_request_api_url()
	Avoid returning within a loop to improve code clarity and maintainability. Refactor the method to avoid returning within a loop which can lead to unexpected behaviors and make the code harder to understand and maintain. pr_agent/git_providers/bitbucket_provider.py [363-364] -for issue_number in int_list: - return issue_number +return int_list[0] if int_list else None
Error handling	Improve error handling for network requests. Use a more specific exception handling for the requests library calls to handle potential network issues or data processing errors more gracefully. pr_agent/git_providers/bitbucket_provider.py [331] -response = requests.request("GET", url, headers=headers, data=payload) +try: + response = requests.request("GET", url, headers=headers, data=payload) + response.raise_for_status() # Raises HTTPError for bad responses +except requests.exceptions.RequestException as e: + get_logger().error(f"Failed to fetch data: {e}") + return None
Security	Replace ast.literal_eval with json.loads for safer string to list conversion. Avoid using ast.literal_eval for converting string to list due to potential security risks and replace it with a safer alternative. pr_agent/git_providers/bitbucket_provider.py [361] -int_list = ast.literal_eval(issues) +import json +int_list = json.loads(issues)
Best practice	Properly initialize and use payload and headers in network requests. Ensure that the payload and headers dictionaries are properly initialized and used in the requests call to avoid sending empty data and headers. pr_agent/git_providers/bitbucket_provider.py [328-331] -payload = {} -headers = {} -response = requests.request("POST", url, headers=headers, data=payload) +payload = {'key': 'value'} # Example payload +headers = {'Content-Type': 'application/json'} +response = requests.request("POST", url, headers=headers, json=payload)
Enhancement	Update the "Actions" row to accurately reflect support across all platforms. Ensure that all relevant platforms or features are marked appropriately in the "Actions" row to maintain accurate documentation. README.md [122] -| | Actions | :white_check_mark: | | :white_check_mark: | | | +| | Actions | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |

---

✨ Improve tool 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=...

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

[barnett-yuxiang]

/describe
--pr_description.generate_ai_title=true
--pr_description.use_description_markers=true

[barnett-yuxiang]

/review
--pr_reviewer.extra_instructions="
In the possible issues section, emphasize the following:

• Is the code logic efficient?
  "

[barnett-yuxiang]

/ask Is the code logic efficient?

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Review 🔍

⏱️ Estimated effort to review [1-5]	4, due to the extensive changes across multiple files and the integration of new functionalities for both Bitbucket and GitHub providers. The logic within these changes is complex, involving URL parsing, API interactions, and conditional logic based on the URL contents.
🏅 Score	75
🧪 Relevant tests	No
⚡ Possible issues	Efficiency Concern: The methods parse_issue_url_and_get_comments and parse_issue_url_and_create_comment in both provider classes perform URL parsing and API requests every time they are called. This could be inefficient, especially in loops or repeated calls. Consider caching results or restructuring to minimize redundant operations.
	Logic Redundancy: There is a noticeable redundancy in methods across the Bitbucket and GitHub provider classes, such as URL parsing and issue retrieval. This could be streamlined by abstracting common functionalities into a base class or utility functions.
🔒 Security concerns	No

Code feedback:

---

relevant file	pr_agent/git_providers/bitbucket_provider.py
suggestion	Consider implementing caching for the parse_issue_url_and_get_comments method to avoid repeated API calls for the same URL, which can enhance performance and reduce API rate limit consumption. [important]
relevant line	response = requests.request("GET", url, headers=headers, data=payload)

---

relevant file	pr_agent/git_providers/bitbucket_provider.py
suggestion	Refactor the repeated URL parsing logic in parse_issue_url_and_get_comments and other methods into a single method within the class to reduce code duplication and improve maintainability. [important]
relevant line	workspace_slug, repo_name, original_issue_number = self._parse_issue_url(issue_url)

---

relevant file	pr_agent/git_providers/github_provider.py
suggestion	Abstract common functionalities such as get_issue_url, get_issue_body, and get_issue_number into a base class to be shared between BitbucketProvider and GitHubProvider to reduce redundancy and improve code maintainability. [important]
relevant line	def get_issue_url(self, issue):

---

relevant file	pr_agent/git_providers/github_provider.py
suggestion	Optimize the parse_issue_url_and_get_comments method by checking if the issue object is already retrieved and use it directly instead of making a new API call. [important]
relevant line	issue = self.repo_obj.get_issue(original_issue_number)

---

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

Ask❓

Is the code logic efficient?

Answer:

The code logic in the PR generally appears to be efficient, with a few areas for potential improvement:

1. Error Handling and URL Parsing:

   • The methods _parse_issue_url in both BitbucketProvider and GithubProvider classes are crucial for the functionality of parsing URLs to extract necessary components like repository name and issue number. The error handling in these methods is robust, ensuring that only valid URLs are processed. This is efficient as it prevents unnecessary API calls with invalid data.

2. API Calls and Data Handling:

   • The methods get_issue, parse_issue_url_and_get_comments, and parse_issue_url_and_create_comment in both provider classes handle API interactions. These methods are designed to perform specific tasks such as fetching issues, comments, and posting comments, which are essential for the feature of finding similar issues.
   • However, there is a potential inefficiency in how API responses are handled. For example, in the parse_issue_url_and_get_comments method, the entire response is converted to JSON and directly returned. It might be more efficient to parse this response and extract only the necessary data to reduce memory usage and improve processing speed.

3. Handling of Similar Issues:

   • The PRSimilarIssue class handles the logic of finding similar issues based on embeddings. The method _process_issue efficiently extracts necessary data from issues for processing. However, the method run could be optimized by reducing the number of API calls. For instance, the method makes separate calls to fetch an issue and then its comments. Combining these into a single call, if possible, could reduce the overhead.

4. Use of External Libraries:

   • The use of ast.literal_eval in get_issue_numbers_from_list method in BitbucketProvider is potentially risky and might not be the most efficient way to handle type conversion. A safer and more efficient approach could be manually parsing the string to extract integers.

5. Redundant Code:

   • There are some redundancies and inconsistencies, such as the repeated definition of the get_issue_body method in github_provider.py. Streamlining these methods and ensuring that each method is defined once would improve maintainability and potentially increase efficiency.

Overall, the PR introduces several well-structured methods to handle interactions with GitHub and Bitbucket APIs efficiently. However, optimizing API usage, improving data handling, and removing redundant code could further enhance efficiency.

[mrT23]

/improve

[codiumai-pr-agent-pro]

PR Code Suggestions ✨

Category	Suggestion	Score
Maintainability	Replace direct access to private attributes with method calls to improve encapsulation and maintainability Replace the direct access to private attributes with a method call or property, to avoid breaking encapsulation and to maintain code maintainability. pr_agent/git_providers/bitbucket_provider.py [42-43] -self.bitbucket_comment_api_url = self.pr._BitbucketBase__data["links"]["comments"]["href"] -self.bitbucket_pull_request_api_url = self.pr._BitbucketBase__data["links"]['self']['href'] +self.bitbucket_comment_api_url = self.pr.get_comment_api_url() +self.bitbucket_pull_request_api_url = self.pr.get_pull_request_api_url() Suggestion importance[1-10]: 8 Why: Accessing private attributes directly can lead to maintenance issues if the class implementation changes. Using getter methods improves encapsulation and maintainability.	8
	Refactor code to reduce duplication by introducing a helper function for URL parsing Refactor the method to avoid code duplication by creating a helper function for parsing URLs that can be reused across different methods. pr_agent/git_providers/bitbucket_provider.py [349-350] -workspace_slug, repo_name, original_issue_number = self._parse_issue_url(issue_url) +def extract_workspace_repo(issue_url): + workspace_slug, repo_name, original_issue_number = self._parse_issue_url(issue_url) + return workspace_slug, repo_name +workspace_slug, repo_name = extract_workspace_repo(issue_url) + Suggestion importance[1-10]: 7 Why: Reducing code duplication by creating reusable helper functions improves code maintainability and readability. The suggestion correctly identifies a repetitive pattern that can be abstracted into a function.	7
Robustness	Add error handling for network requests to improve robustness and error reporting Add error handling for the requests operations to handle potential network issues or API errors gracefully. pr_agent/git_providers/bitbucket_provider.py [331] -response = requests.request("GET", url, headers=headers, data=payload) +try: + response = requests.request("GET", url, headers=headers, data=payload) + response.raise_for_status() # Raises an HTTPError for bad responses +except requests.exceptions.RequestException as e: + get_logger().error(f"Failed to fetch comments: {e}") + return None Suggestion importance[1-10]: 8 Why: Adding error handling for network requests is crucial to ensure the robustness of the application, especially in a network-dependent feature.	8
Clarity	Use placeholders to clearly indicate unsupported features in the markdown table Add placeholders (e.g., ':x:') for the 'Actions' row to indicate explicitly the absence of support or functionality in certain columns. README.md [122] -| | Actions | :white_check_mark: | | :white_check_mark: | | | +| | Actions | :white_check_mark: | :x: | :white_check_mark: | :x: | :x: | Suggestion importance[1-10]: 8 Why: This suggestion improves clarity by explicitly marking unsupported features, which is crucial for correct documentation and user understanding.	8
Consistency	Add missing checkmarks to maintain consistency in the markdown table Ensure consistency in the markdown table by adding missing checkmarks or placeholders for the 'Find similar issue' row across all relevant columns. README.md [116] -| | Find similar issue | :white_check_mark: | | :white_check_mark: | | | | +| | Find similar issue | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | | Suggestion importance[1-10]: 7 Why: The suggestion correctly identifies the need for consistency in the markdown table and proposes a valid improvement. However, the exact checkmarks to add should be verified for correctness based on project requirements.	7

[mrT23]

PR Reviewer Guide 🔍

(Review updated until commit f995b3e)

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Error Handling The method parse_issue_url_and_create_comment does not handle potential exceptions from the requests.request call, which could lead to unhandled exceptions if the network request fails or returns an unexpected response. Hardcoded URL The URL in parse_issue_url_and_get_comments is hardcoded, which could make the code less flexible and harder to maintain if the API base URL changes or needs to be configurable. Missing Import The json module is used in parse_issue_url_and_create_comment but is not imported, which will cause a NameError if this method is called. Logging Comment The commented out logging line in get_user_id might be useful for debugging and should be considered for inclusion or removal based on the logging policy.

[mrT23]

Persistent review updated to latest commit f995b3e

[mrT23]

Preparing review...

[mrT23]

Preparing review...

[mrT23]

Preparing review...

[mrT23]

Persistent review updated to latest commit f995b3e

[mrT23]

PR Description updated to latest commit (f995b3e)

[Zwingz2019]

@CodiumAI-Agent /review

[CodiumAI-Agent]

Persistent review updated to latest commit f995b3e

[xu71ng]

/@codeium analyse

[GadiZimerman]

@CodiumAI-Agent /improve
--pr_code_suggestions.num_code_suggestions_per_chunk="4"
--pr_code_suggestions.commitable_code_suggestions=true

[CodiumAI-Agent]

Suggestion: Instead of commenting out the logging statement, consider using the get_logger() function to log the exception, which is consistent with the logging approach used elsewhere in the codebase. [best practice, importance: 7]

Suggested change

	self.github_user_id = ""
	# logging.exception(f"Failed to get user id, error: {e}")
	# get_logger().exception(f"Failed to get user id, error: {e}")
	self.github_user_id = ""
	get_logger().exception(f"Failed to get user id, error: {e}")

[CodiumAI-Agent]

Suggestion: The print statement for debugging purposes should be removed or replaced with proper logging using get_logger() to maintain consistency with the rest of the codebase. [code cleanup, importance: 6]

Suggested change

	comments = self.git_provider.parse_issue_url_and_get_comments(self.issue_url.split('=')[-1])
	print('comments: ', comments)
	comments = self.git_provider.parse_issue_url_and_get_comments(self.issue_url.split('=')[-1])
	get_logger().debug(f'comments: {comments}')

[CodiumAI-Agent]

Suggestion: Remove the duplicate line that assigns the bearer variable. The line bearer = context.get("bitbucket_bearer_token", None) is repeated unnecessarily. [code cleanup, importance: 9]

[CodiumAI-Agent]

Suggestion: The except clause is empty and doesn't handle any specific exceptions. Consider adding proper exception handling or removing the try-except block if it's not necessary. [error handling, importance: 8]