avoid_full_files

[mrT23]

PR Type

Enhancement

---

Description

• Implemented a new feature to optionally avoid fetching full file content for Bitbucket PRs
• Added bitbucket_app.avoid_full_files configuration option to reduce API calls to Bitbucket
• Updated documentation to explain Bitbucket's rate limits and the new configuration option
• Modified the get_diff_files method in bitbucket_provider.py to respect the new setting
• Set default value for avoid_full_files to false in configuration.toml
• This change helps manage Bitbucket's rate limits at the cost of a small decrease in accuracy

---

Changes walkthrough 📝

	Relevant files
Enhancement	bitbucket_provider.py Implement option to avoid fetching full file content          pr_agent/git_providers/bitbucket_provider.py Added a new condition to check for bitbucket_app.avoid_full_files setting If set to true, original and new file content strings are set to empty This change aims to reduce API calls to Bitbucket +4/-1
Documentation	automations_and_usage.md Document Bitbucket rate limits and new configuration option docs/docs/usage-guide/automations_and_usage.md Added a note about Bitbucket's rate limits (1000 requests per hour) Introduced the bitbucket_app.avoid_full_files=true configuration option Explained the trade-off between reducing API requests and accuracy +6/-0
Configuration changes	configuration.toml Add new configuration option for avoiding full file fetches pr_agent/settings/configuration.toml Added avoid_full_files = false setting under the [bitbucket_app] section +1/-1

---

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

[qodo-merge-pro]

PR Reviewer Guide 🔍

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

🏅 Score: 92

🧪 No relevant tests

🔒 No security concerns identified

🔀 Multiple PR themes Sub-PR theme: Implement avoid_full_files option for Bitbucket provider Relevant files: pr_agent/git_providers/bitbucket_provider.py pr_agent/settings/configuration.toml Sub-PR theme: Update documentation for Bitbucket rate limits and new configuration option Relevant files: docs/docs/usage-guide/automations_and_usage.md

⚡ Key issues to review Code Duplication The condition for counter_valid < MAX_FILES_ALLOWED_FULL // 2 is still present in the code, which might lead to confusion or unexpected behavior when avoid_full_files is set to true.

[qodo-merge-pro]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add a link to external documentation for additional information Consider adding a link to the BitBucket rate limiting documentation for more detailed information. docs/docs/usage-guide/automations_and_usage.md [180] -Note that among other limitations, BitBucket provides relatively low rate-limits for applications (up to 1000 requests per hour), and does not provide an API to track the actual rate-limit usage. +Note that among other limitations, BitBucket provides relatively low rate-limits for applications (up to 1000 requests per hour), and does not provide an API to track the actual rate-limit usage. For more information, see [BitBucket's rate limiting documentation](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#rate-limiting). Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding a link to BitBucket's rate limiting documentation provides valuable additional information for users and improves the overall quality of the documentation.	8
	Add a comment explaining the purpose of setting empty strings Consider adding a comment explaining why we're setting empty strings for original_file_content_str and new_file_content_str when avoiding full files. pr_agent/git_providers/bitbucket_provider.py [230-232] if get_settings().get("bitbucket_app.avoid_full_files", False): + # Set empty strings to avoid fetching full file content, reducing API calls original_file_content_str = "" new_file_content_str = "" Apply this suggestion Suggestion importance[1-10]: 6 Why: Adding a comment to explain the purpose of setting empty strings enhances code readability and helps other developers understand the rationale behind this decision.	6
Maintainability	Use a constant for configuration key to improve maintainability Consider using a constant for the configuration key "bitbucket_app.avoid_full_files" to improve maintainability and reduce the risk of typos. pr_agent/git_providers/bitbucket_provider.py [230-232] -if get_settings().get("bitbucket_app.avoid_full_files", False): +AVOID_FULL_FILES_KEY = "bitbucket_app.avoid_full_files" +if get_settings().get(AVOID_FULL_FILES_KEY, False): original_file_content_str = "" new_file_content_str = "" Apply this suggestion Suggestion importance[1-10]: 7 Why: Using a constant for the configuration key improves code maintainability and reduces the risk of typos, which is a good practice for frequently used string literals.	7