xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 04:40:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: Refactor comment verification in github_provider.py

Browse Source
This commit is contained in:
mrT23
2024-01-14 11:49:51 +02:00
parent d6f4c1638d
commit 7377f4e4b2
1 changed files with 55 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
pr_agent/git_providers/github_provider.py
View File

@ -222,26 +222,29 @@ class GithubProvider(GitProvider):
path = relevant_file.strip() path = relevant_file.strip()
return dict(body=body, path=path, position=position) if subject_type == "LINE" else {} return dict(body=body, path=path, position=position) if subject_type == "LINE" else {}
def publish_inline_comments(self, comments: list[dict]): def publish_inline_comments(self, comments: list[dict], disable_fallback: bool = False):
try: try:
# publish all comments in a single message # publish all comments in a single message
self.pr.create_review(commit=self.last_commit_id, comments=comments) self.pr.create_review(commit=self.last_commit_id, comments=comments)
except Exception as e: except Exception as e:
if get_settings().config.verbosity_level >= 2: if get_settings().config.verbosity_level >= 2:
get_logger().error(f"Failed to publish inline comments, error: {e}") get_logger().error(f"Failed to publish inline comments")
if ( if (
getattr(e, "status", None) == 422 getattr(e, "status", None) == 422
and get_settings().github.publish_inline_comments_fallback_with_verification and get_settings().github.publish_inline_comments_fallback_with_verification
and not disable_fallback
): ):
pass # continue to try _publish_inline_comments_fallback_with_verification pass # continue to try _publish_inline_comments_fallback_with_verification
else: else:
raise e raise e
try:
self._publish_inline_comments_fallback_with_verification(comments) try:
except Exception as e: self._publish_inline_comments_fallback_with_verification(comments)
if get_settings().config.verbosity_level >= 2: except Exception as e:
get_logger().error(f"Failed to publish inline code comments fallback, error: {e}") if get_settings().config.verbosity_level >= 2:
raise e get_logger().error(f"Failed to publish inline code comments fallback, error: {e}")
raise e
def _publish_inline_comments_fallback_with_verification(self, comments: list[dict]): def _publish_inline_comments_fallback_with_verification(self, comments: list[dict]):
""" """
@ -249,44 +252,69 @@ class GithubProvider(GitProvider):
then publish all the remaining valid comments in a single review. then publish all the remaining valid comments in a single review.
For invalid comments, also try removing the suggestion part and posting the comment just on the first line. For invalid comments, also try removing the suggestion part and posting the comment just on the first line.
""" """
verified_comments, invalid_comments = self._verify_inline_comments(comments) verified_comments, invalid_comments = self._verify_code_comments(comments)
if invalid_comments and get_settings().github.try_fix_invalid_inline_comments:
fixed_comments = self._try_fix_invalid_inline_comments([comment for comment, _ in invalid_comments])
verified_fixed_comments, invalid_fixed_comments = self._verify_inline_comments(fixed_comments)
verified_comments += verified_fixed_comments
invalid_comments += invalid_fixed_comments
if invalid_comments and get_settings().config.verbosity_level >= 2:
get_logger().error(f"Dropped {len(invalid_comments)} invalid comments: {invalid_comments}")
if verified_comments:
self.pr.create_review(commit=self.last_commit_id, comments=verified_comments)
elif get_settings().config.verbosity_level >= 2:
get_logger().error("Dropped all comments - no verified comments left to publish")
def _verif_comment(self, comment: dict): # publish as a group verified comments
if verified_comments:
try:
self.pr.create_review(commit=self.last_commit_id, comments=verified_comments)
except:
pass
# try to publish one by one invalid comments, as a one-line comment
if invalid_comments and get_settings().github.try_fix_invalid_inline_comments:
fixed_comments_as_one_liner = self._try_fix_invalid_inline_comments(
[comment for comment, _ in invalid_comments])
for comment in fixed_comments_as_one_liner:
try:
self.publish_inline_comments([comment], disable_fallback=True)
if get_settings().config.verbosity_level >= 2:
get_logger().info(f"Published invalid comment as a single line comment: {comment}")
except:
if get_settings().config.verbosity_level >= 2:
get_logger().error(f"Failed to publish invalid comment as a single line comment: {comment}")
# verified_comments, invalid_comments = self._verify_inline_comments(comments)
# if invalid_comments and get_settings().github.try_fix_invalid_inline_comments:
# fixed_comments = self._try_fix_invalid_inline_comments([comment for comment, _ in invalid_comments])
# verified_fixed_comments, invalid_fixed_comments = self._verify_inline_comments(fixed_comments)
# verified_comments += verified_fixed_comments
# invalid_comments += invalid_fixed_comments
# if invalid_comments and get_settings().config.verbosity_level >= 2:
# get_logger().error(f"Dropped {len(invalid_comments)} invalid comments: {invalid_comments}")
# if verified_comments:
# self.pr.create_review(commit=self.last_commit_id, comments=verified_comments)
# elif get_settings().config.verbosity_level >= 2:
# get_logger().error("Dropped all comments - no verified comments left to publish")
def _verify_code_comment(self, comment: dict):
is_verified = False is_verified = False
e = None e = None
try: try:
# event ="" # By leaving this blank, you set the review action state to PENDING
input = dict(commit_id=self.last_commit_id.sha, comments=[comment])
headers, data = self.pr._requester.requestJsonAndCheck( headers, data = self.pr._requester.requestJsonAndCheck(
"POST", f"{self.pr.url}/reviews", input=dict(commit_id=self.last_commit_id.sha, comments=[comment]) "POST", f"{self.pr.url}/reviews", input=input)
)
pending_review_id = data["id"] pending_review_id = data["id"]
is_verified = True is_verified = True
except Exception as e: except Exception as err:
is_verified = False is_verified = False
pending_review_id = None pending_review_id = None
e = err
if pending_review_id is not None: if pending_review_id is not None:
try: try:
self.pr._requester.requestJsonAndCheck("DELETE", f"{self.pr.url}/reviews/{pending_review_id}") self.pr._requester.requestJsonAndCheck("DELETE", f"{self.pr.url}/reviews/{pending_review_id}")
except Exception as e: except Exception:
pass pass
return is_verified, e return is_verified, e
def _verify_inline_comments(self, comments: list[dict]) -> tuple[list[dict], list[tuple[dict, Exception]]]:
def _verify_code_comments(self, comments: list[dict]) -> tuple[list[dict], list[tuple[dict, Exception]]]:
"""Very each comment against the GitHub API and return 2 lists: 1 of verified and 1 of invalid comments""" """Very each comment against the GitHub API and return 2 lists: 1 of verified and 1 of invalid comments"""
verified_comments = [] verified_comments = []
invalid_comments = [] invalid_comments = []
for comment in comments: for comment in comments:
time.sleep(1) # for avoiding secondary rate limit time.sleep(1) # for avoiding secondary rate limit
is_verified, e = self._verif_comment(comment) is_verified, e = self._verify_code_comment(comment)
if is_verified: if is_verified:
verified_comments.append(comment) verified_comments.append(comment)
else: else: