Compare commits

..

38 Commits

Author SHA1 Message Date
2d5b0fa37f Fix repo settings bug in Gitlab 2023-08-20 14:39:05 +03:00
99f5a2ab0f Merge pull request #216 from idavidov/idavidov/specific_version
Adding Instructions for Specific Docker Image Version and GitHub Action Commit in Installation Guide
2023-08-20 14:12:29 +03:00
d7dcecfe00 Merge pull request #220 from zmeir/zmeir-safe_parse_config_overrides
Safe parse key value in config override
2023-08-20 10:29:53 +03:00
c6f8d985c2 Safe parse key value in config override 2023-08-20 10:11:39 +03:00
532dfd223e Merge pull request #215 from tjwp/auto-review
Addition of Automatic Review Configuration for GitHub App
2023-08-19 16:50:34 +03:00
6e7622822e Merge branch 'main' into idavidov/specific_version 2023-08-18 10:04:23 +03:00
631fb93b28 Implement Automatic Review Configuration for GitHub app 2023-08-16 16:24:30 -04:00
dee1f168f8 Merge pull request #206 from pzarfos/fix/bitbucket_get_repo_settings
Implement get_repo_settings for BitbucketProvider
2023-08-16 18:54:36 +03:00
bb18e32c56 Merge pull request #209 from tjwp/no-suggestions
Publish comment when improve has no suggestions
2023-08-16 18:53:39 +03:00
7803d8eec4 + pin to specific commit with gihub actions in Istallation part of readme 2023-08-16 14:22:14 +03:00
9a84b4b184 + digest usage for docker in Istallation part of readme 2023-08-16 12:56:15 +03:00
70286e9574 Make the message more modest 2023-08-15 08:35:57 -04:00
3f60d12a9a Publish comment when improve has no suggestions 2023-08-14 13:07:00 -04:00
164b340c29 Merge branch 'main' into fix/bitbucket_get_repo_settings 2023-08-14 08:30:14 -04:00
4bb035ec0f Merge pull request #208 from sarbjitsinghgrewal/fix_bitbucket_ask_issue
Fix bitbucket ask issue
2023-08-14 14:52:45 +03:00
23a79bc8fe Merge pull request #183 from zmeir/zmeir-fallback_deployments
Support fallback deployments to accompany fallback models
2023-08-14 14:51:14 +03:00
1db53ae1ad update readme file 2023-08-14 14:45:25 +05:30
cca951d787 fix bitbucket ask issue 2023-08-14 14:30:30 +05:30
230d684cd3 Merge pull request #202 from zmeir/zmeir-remove_blank_line
Remove extra blank line in help message
2023-08-14 07:12:50 +03:00
0a02fa8597 Merge pull request #203 from tjwp/tjwp/contents-permission
Contents read-only permission needed by /review -i
2023-08-14 07:12:38 +03:00
f82b9620af Implement get_repo_settings for BitbucketProvider 2023-08-13 18:25:11 -04:00
ce29d9eb49 Contents read-only permission needed by /review -i 2023-08-13 07:28:05 -04:00
b7b650eb05 Remove extra blank line in help message 2023-08-13 11:32:02 +03:00
6ca0655517 Extracted to helper functions 2023-08-13 11:03:10 +03:00
edcf89a456 Improve comment 2023-08-13 10:56:16 +03:00
7762a67250 Fail if not enough fallback deployments 2023-08-13 10:55:44 +03:00
7049c73790 Merge branch 'main' into zmeir-fallback_deployments 2023-08-13 10:48:21 +03:00
cc7be0811a Merge pull request #200 from Codium-ai/tr/block_scalar
Block scalar format
2023-08-12 09:49:27 +03:00
d3a5aea89e update_changelog 2023-08-11 18:50:56 +03:00
dd87df49f5 block scalar 2023-08-11 18:43:46 +03:00
e85bcf3a17 Merge remote-tracking branch 'origin/tr/block_scalar' into tr/block_scalar 2023-08-11 18:38:06 +03:00
abb754b16b block scalar 2023-08-11 18:37:55 +03:00
bb5878c99a Merge branch 'main' into tr/block_scalar 2023-08-11 18:36:21 +03:00
273a9e35d9 block scalar 2023-08-11 18:35:34 +03:00
1b0b90e51d block scalar 2023-08-09 14:11:58 +03:00
95b6abef09 Merge branch 'main' into zmeir-fallback_deployments 2023-08-08 11:00:13 +03:00
7f1849a867 Logging 2023-08-07 22:42:53 +03:00
6c4a5bae52 Support fallback deployments to accompany fallback models
This is useful for example in Azure OpenAI deployments where you have a different deployment per model, so the current fallback implementation doesn't work (still uses the same deployment for each fallback attempt)
2023-08-07 16:18:48 +03:00
18 changed files with 158 additions and 34 deletions

View File

@ -18,6 +18,18 @@ docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> c
```
docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent --pr_url <pr_url> ask "<your question>"
```
Note: If you want to ensure you're running a specific version of the Docker image, consider using the image's digest.
The digest is a unique identifier for a specific version of an image. You can pull and run an image using its digest by referencing it like so: repository@sha256:digest. Always ensure you're using the correct and trusted digest for your operations.
1. To request a review for a PR using a specific digest, run the following command:
```bash
docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent@sha256:71b5ee15df59c745d352d84752d01561ba64b6d51327f97d46152f0c58a5f678 --pr_url <pr_url> review
```
2. To ask a question about a PR using the same digest, run the following command:
```bash
docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent@sha256:71b5ee15df59c745d352d84752d01561ba64b6d51327f97d46152f0c58a5f678 --pr_url <pr_url> ask "<your question>"
```
Possible questions you can ask include:
@ -51,7 +63,24 @@ jobs:
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
** if you want to pin your action to a specific commit for stability reasons
```yaml
on:
pull_request:
issue_comment:
jobs:
pr_agent_job:
runs-on: ubuntu-latest
name: Run pr agent on every pull request, respond to user comments
steps:
- name: PR Agent action step
id: pragent
uses: Codium-ai/pr-agent@<commit_sha>
env:
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
2. Add the following secret to your repository under `Settings > Secrets`:
```
@ -92,6 +121,7 @@ pip install -r requirements.txt
```
cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
chmod 600 pr_agent/settings/.secrets.toml
# Edit .secrets.toml file
```
@ -128,6 +158,7 @@ Allowing you to automate the review process on your private or public repositori
- Pull requests: Read & write
- Issue comment: Read & write
- Metadata: Read-only
- Contents: Read-only
- Set the following events:
- Issue comment
- Pull request

View File

@ -79,7 +79,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull
|-------|---------------------------------------------|:------:|:------:|:---------:|
| TOOLS | Review | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| | ⮑ Inline review | :white_check_mark: | :white_check_mark: | |
| | Ask | :white_check_mark: | :white_check_mark: | |
| | Ask | :white_check_mark: | :white_check_mark: | :white_check_mark:
| | Auto-Description | :white_check_mark: | :white_check_mark: | |
| | Improve Code | :white_check_mark: | :white_check_mark: | |
| | Reflect and Review | :white_check_mark: | | |

View File

@ -15,6 +15,7 @@ from pr_agent.tools.pr_update_changelog import PRUpdateChangelog
from pr_agent.tools.pr_config import PRConfig
command2class = {
"auto_review": PRReviewer,
"answer": PRReviewer,
"review": PRReviewer,
"review_pr": PRReviewer,
@ -70,6 +71,8 @@ class PRAgent:
if notify:
notify()
await PRReviewer(pr_url, is_answer=True, args=args).run()
elif action == "auto_review":
await PRReviewer(pr_url, is_auto=True, args=args).run()
elif action in command2class:
if notify:
notify()

View File

@ -29,7 +29,6 @@ class AiHandler:
self.azure = False
if get_settings().get("OPENAI.ORG", None):
litellm.organization = get_settings().openai.org
self.deployment_id = get_settings().get("OPENAI.DEPLOYMENT_ID", None)
if get_settings().get("OPENAI.API_TYPE", None):
if get_settings().openai.api_type == "azure":
self.azure = True
@ -47,6 +46,13 @@ class AiHandler:
except AttributeError as e:
raise ValueError("OpenAI key is required") from e
@property
def deployment_id(self):
"""
Returns the deployment ID for the OpenAI API.
"""
return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
@retry(exceptions=(APIError, Timeout, TryAgain, AttributeError, RateLimitError),
tries=OPENAI_RETRIES, delay=2, backoff=2, jitter=(1, 3))
async def chat_completion(self, model: str, temperature: float, system: str, user: str):
@ -70,9 +76,15 @@ class AiHandler:
TryAgain: If there is an attribute error during OpenAI inference.
"""
try:
deployment_id = self.deployment_id
if get_settings().config.verbosity_level >= 2:
logging.debug(
f"Generating completion with {model}"
f"{(' from deployment ' + deployment_id) if deployment_id else ''}"
)
response = await acompletion(
model=model,
deployment_id=self.deployment_id,
deployment_id=deployment_id,
messages=[
{"role": "system", "content": system},
{"role": "user", "content": user}

View File

@ -208,18 +208,45 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo
async def retry_with_fallback_models(f: Callable):
all_models = _get_all_models()
all_deployments = _get_all_deployments(all_models)
# try each (model, deployment_id) pair until one is successful, otherwise raise exception
for i, (model, deployment_id) in enumerate(zip(all_models, all_deployments)):
try:
get_settings().set("openai.deployment_id", deployment_id)
return await f(model)
except Exception as e:
logging.warning(
f"Failed to generate prediction with {model}"
f"{(' from deployment ' + deployment_id) if deployment_id else ''}: "
f"{traceback.format_exc()}"
)
if i == len(all_models) - 1: # If it's the last iteration
raise # Re-raise the last exception
def _get_all_models() -> List[str]:
model = get_settings().config.model
fallback_models = get_settings().config.fallback_models
if not isinstance(fallback_models, list):
fallback_models = [fallback_models]
fallback_models = [m.strip() for m in fallback_models.split(",")]
all_models = [model] + fallback_models
for i, model in enumerate(all_models):
try:
return await f(model)
except Exception as e:
logging.warning(f"Failed to generate prediction with {model}: {traceback.format_exc()}")
if i == len(all_models) - 1: # If it's the last iteration
raise # Re-raise the last exception
return all_models
def _get_all_deployments(all_models: List[str]) -> List[str]:
deployment_id = get_settings().get("openai.deployment_id", None)
fallback_deployments = get_settings().get("openai.fallback_deployments", [])
if not isinstance(fallback_deployments, list) and fallback_deployments:
fallback_deployments = [d.strip() for d in fallback_deployments.split(",")]
if fallback_deployments:
all_deployments = [deployment_id] + fallback_deployments
if len(all_deployments) < len(all_models):
raise ValueError(f"The number of deployments ({len(all_deployments)}) "
f"is less than the number of models ({len(all_models)})")
else:
all_deployments = [deployment_id] * len(all_models)
return all_deployments
def find_line_number_of_relevant_line_in_file(diff_files: List[FilePatchInfo],

View File

@ -245,14 +245,12 @@ def update_settings_from_args(args: List[str]) -> List[str]:
arg = arg.strip()
if arg.startswith('--'):
arg = arg.strip('-').strip()
vals = arg.split('=')
vals = arg.split('=', 1)
if len(vals) != 2:
logging.error(f'Invalid argument format: {arg}')
other_args.append(arg)
continue
key, value = vals
key = key.strip().upper()
value = value.strip()
key, value = _fix_key_value(*vals)
get_settings().set(key, value)
logging.info(f'Updated setting {key} to: "{value}"')
else:
@ -260,8 +258,18 @@ def update_settings_from_args(args: List[str]) -> List[str]:
return other_args
def _fix_key_value(key: str, value: str):
key = key.strip().upper()
value = value.strip()
try:
value = yaml.safe_load(value)
except Exception as e:
logging.error(f"Failed to parse YAML for config override {key}={value}", exc_info=e)
return key, value
def load_yaml(review_text: str) -> dict:
review_text = review_text.lstrip('```yaml').rstrip('`')
review_text = review_text.removeprefix('```yaml').rstrip('`')
try:
data = yaml.load(review_text, Loader=yaml.SafeLoader)
except Exception as e:

View File

@ -26,6 +26,13 @@ class BitbucketProvider:
if pr_url:
self.set_pr(pr_url)
def get_repo_settings(self):
try:
contents = self.repo_obj.get_contents(".pr_agent.toml", ref=self.pr.head.sha).decoded_content
return contents
except Exception:
return ""
def is_supported(self, capability: str) -> bool:
if capability in ['get_issue_comments', 'create_inline_comment', 'publish_inline_comments', 'get_labels']:
return False
@ -93,6 +100,13 @@ class BitbucketProvider:
def get_issue_comments(self):
raise NotImplementedError("Bitbucket provider does not support issue comments yet")
def get_repo_settings(self):
try:
contents = self.repo_obj.get_contents(".pr_agent.toml", ref=self.pr.head.sha).decoded_content
return contents
except Exception:
return ""
def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
return True
@ -104,7 +118,7 @@ class BitbucketProvider:
parsed_url = urlparse(pr_url)
if 'bitbucket.org' not in parsed_url.netloc:
raise ValueError("The provided URL is not a valid GitHub URL")
raise ValueError("The provided URL is not a valid Bitbucket URL")
path_parts = parsed_url.path.strip('/').split('/')

View File

@ -89,6 +89,10 @@ class GitProvider(ABC):
def get_issue_comments(self):
pass
@abstractmethod
def get_repo_settings(self):
pass
@abstractmethod
def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
pass

View File

@ -93,7 +93,7 @@ async def handle_request(body: Dict[str, Any]):
api_url = pull_request.get("url")
if not api_url:
return {}
await agent.handle_request(api_url, "/review")
await agent.handle_request(api_url, "/auto_review")
return {}

View File

@ -2,8 +2,9 @@ commands_text = "> **/review [-i]**: Request a review of your Pull Request. For
"considers changes since the last review, include the '-i' option.\n" \
"> **/describe**: Modify the PR title and description based on the contents of the PR.\n" \
"> **/improve**: Suggest improvements to the code in the PR. \n" \
"> **/ask \\<QUESTION\\>**: Pose a question about the PR.\n\n" \
">To edit any configuration parameter from 'configuration.toml', add --config_path=new_value\n" \
"> **/ask \\<QUESTION\\>**: Pose a question about the PR.\n" \
"> **/update_changelog**: Update the changelog based on the PR's contents.\n\n" \
">To edit any configuration parameter from **configuration.toml**, add --config_path=new_value\n" \
">For example: /review --pr_reviewer.extra_instructions=\"focus on the file: ...\" \n" \
">To list the possible configuration parameters, use the **/config** command.\n" \

View File

@ -14,6 +14,7 @@ key = "" # Acquire through https://platform.openai.com
#api_version = '2023-05-15' # Check Azure documentation for the current API version
#api_base = "" # The base URL for your Azure OpenAI resource. e.g. "https://<your resource name>.openai.azure.com"
#deployment_id = "" # The deployment name you chose when you deployed the engine
#fallback_deployments = [] # For each fallback model specified in configuration.toml in the [config] section, specify the appropriate deployment_id
[anthropic]
key = "" # Optional, uncomment if you want to use Anthropic. Acquire through https://www.anthropic.com/

View File

@ -19,6 +19,7 @@ require_security_review=true
num_code_suggestions=3
inline_code_comments = false
ask_and_reflect=false
automatic_review=true
extra_instructions = ""
[pr_description] # /describe #

View File

@ -3,7 +3,7 @@ system="""You are CodiumAI-PR-Reviewer, a language model designed to review git
Your task is to provide full description of the PR content.
- Make sure not to focus the new PR code (the '+' lines).
- Notice that the 'Previous title', 'Previous description' and 'Commit messages' sections may be partial, simplistic, non-informative or not up-to-date. Hence, compare them to the PR diff code, and use them only as a reference.
- If needed, each YAML output should be in block scalar format ('|-')
{%- if extra_instructions %}
Extra instructions from the user:
@ -33,7 +33,7 @@ PR Description:
PR Main Files Walkthrough:
type: array
maxItems: 10
description: >-
description: |-
a walkthrough of the PR changes. Review main files, and shortly describe the changes in each file (up to 10 most important files).
items:
filename:
@ -46,10 +46,12 @@ PR Main Files Walkthrough:
Example output:
```yaml
PR Title: ...
PR Title: |-
...
PR Type:
- Bug fix
PR Description: ...
PR Description: |-
...
PR Main Files Walkthrough:
- ...
- ...

View File

@ -7,6 +7,7 @@ Your task is to provide constructive and concise feedback for the PR, and also p
- Suggestions should focus on improving the new added code lines.
- Make sure not to provide suggestions repeating modifications already implemented in the new PR code (the '+' lines).
{%- endif %}
- If needed, each YAML output should be in block scalar format ('|-')
{%- if extra_instructions %}
@ -78,7 +79,7 @@ PR Feedback:
description: the relevant file full path
suggestion:
type: string
description: >-
description: |
a concrete suggestion for meaningfully improving the new PR code. Also
describe how, specifically, the suggestion can be applied to new PR
code. Add tags with importance measure that matches each suggestion
@ -86,10 +87,10 @@ PR Feedback:
adding docstrings, renaming PR title and description, or linter like.
relevant line:
type: string
description: >-
a single code line taken from the relevant file, to which the
suggestion applies. The line should be a '+' line. Make sure to output
the line exactly as it appears in the relevant file
description: |
a single code line taken from the relevant file, to which the suggestion applies.
The line should be a '+' line.
Make sure to output the line exactly as it appears in the relevant file
{%- endif %}
{%- if require_security %}
Security concerns:

View File

@ -93,6 +93,10 @@ class PRCodeSuggestions:
def push_inline_code_suggestions(self, data):
code_suggestions = []
if not data['Code suggestions']:
return self.git_provider.publish_comment('No suggestions found to improve this PR.')
for d in data['Code suggestions']:
try:
if get_settings().config.verbosity_level >= 2:

View File

@ -23,7 +23,7 @@ class PRReviewer:
"""
The PRReviewer class is responsible for reviewing a pull request and generating feedback using an AI model.
"""
def __init__(self, pr_url: str, is_answer: bool = False, args: list = None):
def __init__(self, pr_url: str, is_answer: bool = False, is_auto: bool = False, args: list = None):
"""
Initialize the PRReviewer object with the necessary attributes and objects to review a pull request.
@ -40,6 +40,7 @@ class PRReviewer:
)
self.pr_url = pr_url
self.is_answer = is_answer
self.is_auto = is_auto
if self.is_answer and not self.git_provider.is_supported("get_issue_comments"):
raise Exception(f"Answer mode is not supported for {get_settings().config.git_provider} for now")
@ -93,7 +94,11 @@ class PRReviewer:
"""
Review the pull request and generate feedback.
"""
logging.info('Reviewing PR...')
if self.is_auto and not get_settings().pr_reviewer.automatic_review:
logging.info(f'Automatic review is disabled {self.pr_url}')
return None
logging.info(f'Reviewing PR: {self.pr_url} ...')
if get_settings().config.publish_output:
self.git_provider.publish_comment("Preparing review...", is_temporary=True)
@ -237,7 +242,7 @@ class PRReviewer:
return
review_text = self.prediction.strip()
review_text = review_text.lstrip('```yaml').rstrip('`')
review_text = review_text.removeprefix('```yaml').rstrip('`')
try:
data = yaml.load(review_text, Loader=SafeLoader)
except Exception as e:

View File

@ -0,0 +1,10 @@
from pr_agent.git_providers.bitbucket_provider import BitbucketProvider
class TestBitbucketProvider:
def test_parse_pr_url(self):
url = "https://bitbucket.org/WORKSPACE_XYZ/MY_TEST_REPO/pull-requests/321"
workspace_slug, repo_slug, pr_number = BitbucketProvider._parse_pr_url(url)
assert workspace_slug == "WORKSPACE_XYZ"
assert repo_slug == "MY_TEST_REPO"
assert pr_number == 321