Merge branch 'main' into introduce-pre-commit

Codium-ai · Nov 8, 2024 · 5c5a3e2 · 5c5a3e2
2 parents 852bb37 + f9380c2
commit 5c5a3e2
Show file tree

Hide file tree

Showing 21 changed files with 377 additions and 132 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,38 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by
 
 ## News and Updates
 
+### November 7, 2024
+
+Added new option: `--pr_code_suggestions.focus_only_on_problems=true`
+
+When enabled, this option reduces the number of code suggestions and categorizes them into just two groups: "Possible Issues" and "General". The suggestions will focus primarily on identifying and fixing code problems, rather than style considerations like best practices, maintainability, or readability.
+
+This mode is ideal for developers who want to concentrate specifically on finding and fixing potential bugs in their pull request code.
+
+
+**Example results:**
+
+Original mode
+
+<kbd><img src="https://qodo.ai/images/pr_agent/code_suggestions_original_mode.png" width="512"></kbd>
+
+Focused mode
+
+<kbd><img src="https://qodo.ai/images/pr_agent/code_suggestions_focused_mode.png" width="512"></kbd>
+
+
+### November 4, 2024
+
+Qodo Merge PR Agent will now leverage context from Jira or GitHub tickets to enhance the PR Feedback. Read more about this feature 
+[here](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)
+
+### November 3, 2024
+
+Meaningful improvement to the quality of code suggestions by separating the code suggestion generation from [line number detection](https://github.com/Codium-ai/pr-agent/pull/1338)
+
+<kbd>![image](https://github.com/user-attachments/assets/093c185c-31ca-47a1-a4fe-be7d9335ea66)</kbd>
+
+
 ### October 27, 2024
 
 Qodo Merge PR Agent will now automatically document accepted code suggestions in a dedicated wiki page (`.pr_agent_accepted_suggestions`), enabling users to track historical changes, assess the tool's effectiveness, and learn from previously implemented recommendations in the repository.

diff --git a/docs/docs/core-abilities/fetching_ticket_context.md b/docs/docs/core-abilities/fetching_ticket_context.md
@@ -0,0 +1,115 @@
+# Fetching Ticket Context for PRs
+## Overview
+Qodo Merge PR Agent streamlines code review workflows by seamlessly connecting with multiple ticket management systems.
+This integration enriches the review process by automatically surfacing relevant ticket information and context alongside code changes.
+
+
+## Affected Tools
+
+Ticket Recognition Requirements:
+
+1. The PR description should contain a link to the ticket.
+2. For Jira tickets, you should follow the instructions in [Jira Integration](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira.
+
+
+### Describe tool
+Qodo Merge PR Agent will recognize the ticket and use the ticket content (title, description, labels) to provide additional context for the code changes.
+By understanding the reasoning and intent behind modifications, the LLM can offer more insightful and relevant code analysis.
+
+### Review tool
+Similarly to the `describe` tool, the `review` tool will use the ticket content to provide additional context for the code changes.
+
+In addition, this feature will evaluate how well a Pull Request (PR) adheres to its original purpose/intent as defined by the associated ticket or issue mentioned in the PR description.
+Each ticket will be assigned a label (Compliance/Alignment level), Indicates the degree to which the PR fulfills its original purpose, Options: Fully compliant, Partially compliant or Not compliant.
+
+
+![Ticket Compliance](https://www.qodo.ai/images/pr_agent/ticket_compliance_review.png){width=768}
+
+By default, the tool will automatically validate if the PR complies with the referenced ticket.
+If you want to disable this feedback, add the following line to your configuration file:
+
+```toml
+[pr_reviewer]
+require_ticket_analysis_review=false
+```
+
+## Providers
+
+### Github Issues Integration
+
+Qodo Merge PR Agent will automatically recognize Github issues mentioned in the PR description and fetch the issue content.
+Examples of valid GitHub issue references:
+
+- `https://github.com/<ORG_NAME>/<REPO_NAME>/issues/<ISSUE_NUMBER>`
+- `#<ISSUE_NUMBER>`
+- `<ORG_NAME>/<REPO_NAME>#<ISSUE_NUMBER>`
+
+Since Qodo Merge PR Agent is integrated with GitHub, it doesn't require any additional configuration to fetch GitHub issues.
+
+### Jira Integration 💎
+
+We support both Jira Cloud and Jira Server/Data Center.
+To integrate with Jira, The PR Description should contain a link to the Jira ticket.
+
+For Jira integration, include a ticket reference in your PR description using either the complete URL format `https://<JIRA_ORG>.atlassian.net/browse/ISSUE-123` or the shortened ticket ID `ISSUE-123`.
+
+!!! note "Jira Base URL"
+    If using the shortened format, ensure your configuration file contains the Jira base URL under the [jira] section like this:
+
+    ```toml
+    [jira]
+    jira_base_url = "https://<JIRA_ORG>.atlassian.net"
+    ```
+
+#### Jira Cloud 💎
+There are two ways to authenticate with Jira Cloud:
+
+**1) Jira App Authentication**
+
+The recommended way to authenticate with Jira Cloud is to install the Qodo Merge app in your Jira Cloud instance. This will allow Qodo Merge to access Jira data on your behalf.
+
+Installation steps:
+
+1. Click [here](https://auth.atlassian.com/authorize?audience=api.atlassian.com&client_id=8krKmA4gMD8mM8z24aRCgPCSepZNP1xf&scope=read%3Ajira-work%20offline_access&redirect_uri=https%3A%2F%2Fregister.jira.pr-agent.codium.ai&state=qodomerge&response_type=code&prompt=consent) to install the Qodo Merge app in your Jira Cloud instance, click the `accept` button.<br>
+![Jira Cloud App Installation](https://www.qodo.ai/images/pr_agent/jira_app_installation1.png){width=384}
+
+2. After installing the app, you will be redirected to the Qodo Merge registration page. and you will see a success message.<br>
+![Jira Cloud App success message](https://www.qodo.ai/images/pr_agent/jira_app_success.png){width=384}
+
+3. Now you can use the Jira integration in Qodo Merge PR Agent.
+
+**2) Email/Token Authentication**
+
+You can create an API token from your Atlassian account:
+
+1. Log in to https://id.atlassian.com/manage-profile/security/api-tokens.
+
+2. Click Create API token.
+
+3. From the dialog that appears, enter a name for your new token and click Create.
+
+4. Click Copy to clipboard.
+
+![Jira Cloud API Token](https://images.ctfassets.net/zsv3d0ugroxu/1RYvh9lqgeZjjNe5S3Hbfb/155e846a1cb38f30bf17512b6dfd2229/screenshot_NewAPIToken){width=384}
+
+5. In your [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) add the following lines:
+
+```toml
+[jira]
+jira_api_token = "YOUR_API_TOKEN"
+jira_api_email = "YOUR_EMAIL"
+```
+
+
+#### Jira Server/Data Center 💎
+
+Currently, we only support the Personal Access Token (PAT) Authentication method.
+
+1. Create a [Personal Access Token (PAT)](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) in your Jira account
+2. In your Configuration file/Environment variables/Secrets file, add the following lines:
+
+```toml
+[jira]
+jira_base_url = "YOUR_JIRA_BASE_URL" # e.g. https://jira.example.com
+jira_api_token = "YOUR_API_TOKEN"
+```
diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md
@@ -1,6 +1,7 @@
 # Core Abilities
 Qodo Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include:
 
+- [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)
 - [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/)
 - [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)
 - [Self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/)

diff --git a/docs/docs/core-abilities/self_reflection.md b/docs/docs/core-abilities/self_reflection.md
@@ -46,6 +46,5 @@ This results in a more refined and valuable set of suggestions for the user, sav
 ## Appendix - Relevant Configuration Options
 ```
 [pr_code_suggestions]
-self_reflect_on_suggestions	= true # Enable self-reflection on code suggestions
 suggestions_score_threshold	= 0 # Filter out suggestions with a score below this threshold (0-10)
 ```
diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md
@@ -3,7 +3,7 @@
 
 You can use the Bitbucket Pipeline system to run Qodo Merge on every pull request open or update.
 
-1. Add the following file in your repository bitbucket_pipelines.yml
+1. Add the following file in your repository bitbucket-pipelines.yml
 
 ```yaml
 pipelines:

diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md
@@ -276,12 +276,12 @@ Using a combination of both can help the AI model to provide relevant and tailor
         <td>Minimum score threshold for suggestions to be presented as commitable PR comments in addition to the table. Default is -1 (disabled).</td>
       </tr>
       <tr>
-        <td><b>persistent_comment</b></td>
-        <td>If set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false.</td>
+        <td><b>focus_only_on_problems</b></td>
+        <td>If set to true, suggestions will focus primarily on identifying and fixing code problems, and less on style considerations like best practices, maintainability, or readability. Default is false.</td> 
       </tr>
       <tr>
-        <td><b>self_reflect_on_suggestions</b></td>
-        <td>If set to true, the improve tool will calculate an importance score for each suggestion [1-10], and sort the suggestion labels group based on this score. Default is true.</td>
+        <td><b>persistent_comment</b></td>
+        <td>If set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false.</td>
       </tr>
       <tr>
         <td><b>suggestions_score_threshold</b></td>

diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md
@@ -140,7 +140,7 @@ num_code_suggestions = ...
   </tr>
   <tr>
     <td><b>require_ticket_analysis_review</b></td>
-    <td>If set to true, and the PR contains a GitHub ticket number, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.</td>
+    <td>If set to true, and the PR contains a GitHub or Jira ticket link, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.</td>
   </tr>
 </table>
 

diff --git a/docs/docs/usage-guide/additional_configurations.md b/docs/docs/usage-guide/additional_configurations.md
@@ -160,3 +160,13 @@ ignore_pr_target_branches = ["qa"]
 
 Where the `ignore_pr_source_branches` and `ignore_pr_target_branches` are lists of regex patterns to match the source and target branches you want to ignore.
 They are not mutually exclusive, you can use them together or separately.
+
+
+To allow only specific folders (often needed in large monorepos), set:
+
+```
+[config]
+allow_only_specific_folders=['folder1','folder2']
+```
+
+For the configuration above, automatic feedback will only be triggered when the PR changes include files from 'folder1' or 'folder2'
diff --git a/docs/docs/usage-guide/automations_and_usage.md b/docs/docs/usage-guide/automations_and_usage.md
@@ -72,13 +72,14 @@ The configuration parameter `pr_commands` defines the list of tools that will be
 ```
 [github_app]
 pr_commands = [
-    "/describe --pr_description.final_update_message=false",
-    "/review --pr_reviewer.num_code_suggestions=0",
-    "/improve",
+    "/describe",
+    "/review",
+    "/improve --pr_code_suggestions.suggestions_score_threshold=5",
 ]
 ```
-This means that when a new PR is opened/reopened or marked as ready for review, Qodo Merge will run the `describe`, `review` and `improve` tools.
-For the `review` tool, for example, the `num_code_suggestions` parameter will be set to 0.
+
+This means that when a new PR is opened/reopened or marked as ready for review, Qodo Merge will run the `describe`, `review` and `improve` tools.  
+For the `improve` tool, for example, the `suggestions_score_threshold` parameter will be set to 5 (suggestions below a score of 5 won't be presented)
 
 You can override the default tool parameters by using one the three options for a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/): **wiki**, **local**, or **global**.
 For example, if your local `.pr_agent.toml` file contains:
@@ -105,7 +106,7 @@ The configuration parameter `push_commands` defines the list of tools that will
 handle_push_trigger = true
 push_commands = [
     "/describe",
-    "/review  --pr_reviewer.num_code_suggestions=0 --pr_reviewer.final_update_message=false",
+    "/review",
 ]
 ```
 This means that when new code is pushed to the PR, the Qodo Merge will run the `describe` and `review` tools, with the specified parameters.
@@ -148,7 +149,7 @@ After setting up a GitLab webhook, to control which commands will run automatica
 [gitlab]
 pr_commands = [
     "/describe",
-    "/review --pr_reviewer.num_code_suggestions=0",
+    "/review",
     "/improve",
 ]
 ```
@@ -161,7 +162,7 @@ The configuration parameter `push_commands` defines the list of tools that will
 handle_push_trigger = true
 push_commands = [
     "/describe",
-    "/review  --pr_reviewer.num_code_suggestions=0 --pr_reviewer.final_update_message=false",
+    "/review",
 ]
 ```
 
@@ -182,7 +183,7 @@ Each time you invoke a `/review` tool, it will use the extra instructions you se
 
 
 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.
-If you experience lack of responses from Qodo Merge, you might want to set: `bitbucket_app.avoid_full_files=true` in your configuration file.
+If you experience a lack of responses from Qodo Merge, you might want to set: `bitbucket_app.avoid_full_files=true` in your configuration file.
 This will prevent Qodo Merge from acquiring the full file content, and will only use the diff content. This will reduce the number of requests made to BitBucket, at the cost of small decrease in accuracy, as dynamic context will not be applicable.
 
 
@@ -194,13 +195,23 @@ Specifically, set the following values:
 ```
 [bitbucket_app]
 pr_commands = [
-    "/review --pr_reviewer.num_code_suggestions=0",
+    "/review",
     "/improve --pr_code_suggestions.commitable_code_suggestions=true --pr_code_suggestions.suggestions_score_threshold=7",
 ]
 ```
 Note that we set specifically for bitbucket, we recommend using: `--pr_code_suggestions.suggestions_score_threshold=7` and that is the default value we set for bitbucket.
 Since this platform only supports inline code suggestions, we want to limit the number of suggestions, and only present a limited number.
 
+To enable BitBucket app to respond to each **push** to the PR, set (for example):
+```
+[bitbucket_app]
+handle_push_trigger = true
+push_commands = [
+    "/describe",
+    "/review",
+]
+```
+
 ## Azure DevOps provider
 
 To use Azure DevOps provider use the following settings in configuration.toml:

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -43,6 +43,7 @@ nav:
     - 💎 Similar Code: 'tools/similar_code.md'
   - Core Abilities:
       - 'core-abilities/index.md'
+      - Fetching ticket context: 'core-abilities/fetching_ticket_context.md'
       - Local and global metadata: 'core-abilities/metadata.md'
       - Dynamic context: 'core-abilities/dynamic_context.md'
       - Self-reflection: 'core-abilities/self_reflection.md'

diff --git a/pr_agent/algo/__init__.py b/pr_agent/algo/__init__.py
@@ -31,6 +31,7 @@
     'vertex_ai/codechat-bison': 6144,
     'vertex_ai/codechat-bison-32k': 32000,
     'vertex_ai/claude-3-haiku@20240307': 100000,
+    'vertex_ai/claude-3-5-haiku@20241022': 100000,
     'vertex_ai/claude-3-sonnet@20240229': 100000,
     'vertex_ai/claude-3-opus@20240229': 100000,
     'vertex_ai/claude-3-5-sonnet@20240620': 100000,
@@ -48,11 +49,13 @@
     'anthropic/claude-3-opus-20240229': 100000,
     'anthropic/claude-3-5-sonnet-20240620': 100000,
     'anthropic/claude-3-5-sonnet-20241022': 100000,
+    'anthropic/claude-3-5-haiku-20241022': 100000,
     'bedrock/anthropic.claude-instant-v1': 100000,
     'bedrock/anthropic.claude-v2': 100000,
     'bedrock/anthropic.claude-v2:1': 100000,
     'bedrock/anthropic.claude-3-sonnet-20240229-v1:0': 100000,
     'bedrock/anthropic.claude-3-haiku-20240307-v1:0': 100000,
+    'bedrock/anthropic.claude-3-5-haiku-20241022-v1:0': 100000,
     'bedrock/anthropic.claude-3-5-sonnet-20240620-v1:0': 100000,
     'bedrock/anthropic.claude-3-5-sonnet-20241022-v2:0': 100000,
     'claude-3-5-sonnet': 100000,

diff --git a/pr_agent/algo/ai_handlers/openai_ai_handler.py b/pr_agent/algo/ai_handlers/openai_ai_handler.py
@@ -1,5 +1,7 @@
+from os import environ
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
 import openai
-from openai.error import APIError, RateLimitError, Timeout, TryAgain
+from openai import APIError, AsyncOpenAI, RateLimitError, Timeout
 from retry import retry
 
 from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
@@ -14,7 +16,7 @@ def __init__(self):
         # Initialize OpenAIHandler specific attributes here
         try:
             super().__init__()
-            openai.api_key = get_settings().openai.key
+            environ["OPENAI_API_KEY"] = get_settings().openai.key
             if get_settings().get("OPENAI.ORG", None):
                 openai.organization = get_settings().openai.org
             if get_settings().get("OPENAI.API_TYPE", None):
@@ -24,7 +26,7 @@ def __init__(self):
             if get_settings().get("OPENAI.API_VERSION", None):
                 openai.api_version = get_settings().openai.api_version
             if get_settings().get("OPENAI.API_BASE", None):
-                openai.api_base = get_settings().openai.api_base
+                environ["OPENAI_BASE_URL"] = get_settings().openai.api_base
 
         except AttributeError as e:
             raise ValueError("OpenAI key is required") from e
@@ -36,33 +38,31 @@ def deployment_id(self):
         """
         return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
 
-    @retry(exceptions=(APIError, Timeout, TryAgain, AttributeError, RateLimitError),
+    @retry(exceptions=(APIError, Timeout, AttributeError, RateLimitError),
            tries=OPENAI_RETRIES, delay=2, backoff=2, jitter=(1, 3))
     async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
         try:
-            deployment_id = self.deployment_id
             get_logger().info("System: ", system)
             get_logger().info("User: ", user)
             messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]
-
-            chat_completion = await openai.ChatCompletion.acreate(
+            client = AsyncOpenAI()
+            chat_completion = await client.chat.completions.create(
                 model=model,
-                deployment_id=deployment_id,
                 messages=messages,
                 temperature=temperature,
             )
-            resp = chat_completion["choices"][0]['message']['content']
-            finish_reason = chat_completion["choices"][0]["finish_reason"]
-            usage = chat_completion.get("usage")
+            resp = chat_completion.choices[0].message.content
+            finish_reason = chat_completion.choices[0].finish_reason
+            usage = chat_completion.usage
             get_logger().info("AI response", response=resp, messages=messages, finish_reason=finish_reason,
                               model=model, usage=usage)
             return resp, finish_reason
-        except (APIError, Timeout, TryAgain) as e:
+        except (APIError, Timeout) as e:
             get_logger().error("Error during OpenAI inference: ", e)
             raise
         except (RateLimitError) as e:
             get_logger().error("Rate limit error during OpenAI inference: ", e)
             raise
         except (Exception) as e:
             get_logger().error("Unknown error during OpenAI inference: ", e)
-            raise TryAgain from e
+            raise