Files
pr-agent/pr_agent/tools/pr_reviewer.py

125 lines
5.6 KiB
Python
Raw Normal View History

2023-07-06 00:21:08 +03:00
import copy
import json
import logging
from jinja2 import Environment, StrictUndefined
from pr_agent.algo.ai_handler import AiHandler
from pr_agent.algo.pr_processing import get_pr_diff
from pr_agent.algo.token_handler import TokenHandler
from pr_agent.algo.utils import convert_to_markdown, try_fix_json
2023-07-06 00:21:08 +03:00
from pr_agent.config_loader import settings
from pr_agent.git_providers import get_git_provider
2023-07-07 16:33:25 +03:00
from pr_agent.git_providers.git_provider import get_main_pr_language
2023-07-06 00:21:08 +03:00
class PRReviewer:
2023-07-08 08:52:11 +03:00
def __init__(self, pr_url: str, cli_mode=False):
2023-07-06 00:21:08 +03:00
2023-07-07 15:02:40 +03:00
self.git_provider = get_git_provider()(pr_url)
2023-07-07 16:31:28 +03:00
self.main_language = get_main_pr_language(
2023-07-07 16:10:33 +03:00
self.git_provider.get_languages(), self.git_provider.get_files()
)
2023-07-06 00:21:08 +03:00
self.ai_handler = AiHandler()
self.patches_diff = None
self.prediction = None
self.cli_mode = cli_mode
2023-07-06 00:21:08 +03:00
self.vars = {
"title": self.git_provider.pr.title,
"branch": self.git_provider.get_pr_branch(),
2023-07-07 15:02:40 +03:00
"description": self.git_provider.get_pr_description(),
2023-07-06 17:34:40 +03:00
"language": self.main_language,
2023-07-06 00:21:08 +03:00
"diff": "", # empty diff for initial calculation
"require_tests": settings.pr_reviewer.require_tests_review,
"require_security": settings.pr_reviewer.require_security_review,
2023-07-11 08:50:28 +03:00
"require_focused": settings.pr_reviewer.require_focused_review,
2023-07-06 00:21:08 +03:00
'num_code_suggestions': settings.pr_reviewer.num_code_suggestions,
}
self.token_handler = TokenHandler(self.git_provider.pr,
self.vars,
settings.pr_review_prompt.system,
settings.pr_review_prompt.user)
async def review(self):
logging.info('Reviewing PR...')
if settings.config.publish_review:
2023-07-06 08:44:08 +03:00
self.git_provider.publish_comment("Preparing review...", is_temporary=True)
2023-07-06 00:21:08 +03:00
logging.info('Getting PR diff...')
self.patches_diff = get_pr_diff(self.git_provider, self.token_handler)
logging.info('Getting AI prediction...')
self.prediction = await self._get_prediction()
logging.info('Preparing PR review...')
pr_comment = self._prepare_pr_review()
if settings.config.publish_review:
logging.info('Pushing PR review...')
self.git_provider.publish_comment(pr_comment)
2023-07-06 08:44:08 +03:00
self.git_provider.remove_initial_comment()
2023-07-13 09:44:33 +03:00
if settings.pr_reviewer.inline_code_comments:
logging.info('Pushing inline code comments...')
self._publish_inline_code_comments()
2023-07-06 00:21:08 +03:00
return ""
async def _get_prediction(self):
variables = copy.deepcopy(self.vars)
variables["diff"] = self.patches_diff # update diff
environment = Environment(undefined=StrictUndefined)
system_prompt = environment.from_string(settings.pr_review_prompt.system).render(variables)
user_prompt = environment.from_string(settings.pr_review_prompt.user).render(variables)
if settings.config.verbosity_level >= 2:
logging.info(f"\nSystem prompt:\n{system_prompt}")
logging.info(f"\nUser prompt:\n{user_prompt}")
model = settings.config.model
response, finish_reason = await self.ai_handler.chat_completion(model=model, temperature=0.2,
system=system_prompt, user=user_prompt)
2023-07-11 17:32:48 +03:00
2023-07-06 00:21:08 +03:00
return response
def _prepare_pr_review(self) -> str:
review = self.prediction.strip()
try:
data = json.loads(review)
except json.decoder.JSONDecodeError:
data = try_fix_json(review)
2023-07-06 12:49:10 +03:00
# reordering for nicer display
if 'PR Feedback' in data:
if 'Security concerns' in data['PR Feedback']:
val = data['PR Feedback']['Security concerns']
del data['PR Feedback']['Security concerns']
data['PR Analysis']['Security concerns'] = val
2023-07-13 09:44:33 +03:00
if settings.config.git_provider == 'github' and settings.pr_reviewer.inline_code_comments:
del data['PR Feedback']['Code suggestions']
2023-07-06 00:21:08 +03:00
markdown_text = convert_to_markdown(data)
user = self.git_provider.get_user_id()
if not self.cli_mode:
markdown_text += "\n### How to use\n"
if user and '[bot]' not in user:
markdown_text += f"> Tag me in a comment '@{user}' to ask for a new review after you update the PR.\n"
markdown_text += "> You can also tag me and ask any question, " \
f"for example '@{user} is the PR ready for merge?'"
else:
markdown_text += "> Add a comment that says 'review' to ask for a new review " \
"after you update the PR.\n"
markdown_text += "> You can also add a comment that says 'answer QUESTION', " \
"for example 'answer is the PR ready for merge?'"
2023-07-06 00:21:08 +03:00
if settings.config.verbosity_level >= 2:
logging.info(f"Markdown response:\n{markdown_text}")
2023-07-13 09:44:33 +03:00
return markdown_text
def _publish_inline_code_comments(self):
review = self.prediction.strip()
try:
data = json.loads(review)
except json.decoder.JSONDecodeError:
data = try_fix_json(review)
for d in data['PR Feedback']['Code suggestions']:
relevant_file = d['relevant file'].strip()
relevant_line_in_file = d['relevant line in file'].strip()
content = d['suggestion content']
2023-07-14 22:48:13 +03:00
self.git_provider.publish_inline_comment(content, relevant_file, relevant_line_in_file)