Add warning when summary code suggestions are not supported

[MarkRx]

User description

#1074

commitable_code_suggestions	gfm_markdown	post_as_summary
false	false	false
false	true	true
true	false	false
true	true	false

---

PR Type

enhancement, error handling

---

Description

• Added a warning when the Git provider does not support summary code suggestions.
• Introduced a post_as_summary variable to manage the decision of posting summarized suggestions.
• Implemented a fallback mechanism to revert to commitable_code_suggestions=True if summary suggestions are unsupported.

---

Changes walkthrough 📝

	Relevant files
Enhancement	pr_code_suggestions.py Add warning and fallback for unsupported summary code suggestions pr_agent/tools/pr_code_suggestions.py Added a warning when summary code suggestions are not supported by the Git provider. Introduced a post_as_summary variable to control the posting behavior. Reverted to commitable_code_suggestions=True if summary suggestions are not supported. +7/-2

---

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

[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 Reviewer Guide 🔍

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

🏅 Score: 85

🧪 No relevant tests

🔒 No security concerns identified

🔀 No multiple PR themes

⚡ Key issues to review Logic Redundancy The variable post_as_summary is set twice in a way that might be redundant. Consider simplifying the logic to avoid setting post_as_summary to False in line 124 if it's already handled by the condition in line 122.

[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	Suggestion	Score
Performance	Reduce redundant calls to get_settings() by storing its result in a variable To avoid calling get_settings() multiple times which may be computationally expensive if it involves I/O operations or complex computations, consider storing the result in a variable and reusing it. pr_agent/tools/pr_code_suggestions.py [120] -post_as_summary = not get_settings().pr_code_suggestions.commitable_code_suggestions +settings = get_settings() +post_as_summary = not settings.pr_code_suggestions.commitable_code_suggestions Apply this suggestion Suggestion importance[1-10]: 8 Why: This suggestion improves performance by reducing redundant calls to get_settings(), which can be computationally expensive. It is a good practice to store the result in a variable and reuse it.	8
Maintainability	Improve code organization by extracting conditional checks into a separate method Refactor the conditional checks into a separate method to improve readability and maintainability of the run method. pr_agent/tools/pr_code_suggestions.py [122-124] -if post_as_summary and not self.git_provider.is_supported("gfm_markdown"): - get_logger().warning(f"Git provider does not support summary code suggestions. Reverting to commitable_code_suggestions=True.") - post_as_summary = False +def check_provider_support(): + if not self.git_provider.is_supported("gfm_markdown"): + get_logger().warning(f"Git provider does not support summary code suggestions. Reverting to commitable_code_suggestions=True.") + return False + return True +post_as_summary = check_provider_support() + Apply this suggestion Suggestion importance[1-10]: 7 Why: Extracting conditional checks into a separate method improves readability and maintainability. This refactoring makes the run method cleaner and easier to understand.	7
Possible issue	Handle unsupported operations by raising an exception to prevent silent errors Instead of using a warning log when the git provider does not support the required features, consider raising an exception or handling the error in a way that does not silently revert settings, as this might lead to unexpected behavior. pr_agent/tools/pr_code_suggestions.py [123-124] -get_logger().warning(f"Git provider does not support summary code suggestions. Reverting to commitable_code_suggestions=True.") -post_as_summary = False +raise NotImplementedError("Git provider does not support summary code suggestions. Please configure commitable_code_suggestions=True.") Apply this suggestion Suggestion importance[1-10]: 6 Why: Raising an exception instead of logging a warning can prevent silent errors and make the issue more visible. However, it changes the behavior of the code significantly, which might not be desirable in all contexts.	6
Best practice	Enhance the clarity of debug logs by providing more descriptive messages Use a more descriptive log message for debugging that includes more context about the operation being performed. pr_agent/tools/pr_code_suggestions.py [129] -get_logger().debug(f"PR output", artifact=pr_body) +get_logger().debug("Generated PR summary output", artifact=pr_body) Apply this suggestion Suggestion importance[1-10]: 5 Why: Using a more descriptive log message improves the clarity of debug logs, making it easier to understand the context of the operation being performed. This is a minor but useful improvement.	5

[Zwingz2019]

@CodiumAI-Agent /review

[CodiumAI-Agent]

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Code Clarity The variable post_as_summary is modified multiple times which might lead to confusion. Consider simplifying the logic or adding more comments for clarity.

[mrT23]

This PR is in a critical tool, and its too intrusive for a simple warning log, tailored just for bitbucket (as all other providers do support gfm markdown)

I would have considered a one-line addition for this specific log (instead of 7), but the correct solution is properly updating the docs.

If you are interested, open a relevant PR for updating the docs with bitbucket server limitations.

[mrT23]

closing as inavctive