Fix: include all reviewers in GitHubReview and fixes issue #3440 #4775
Conversation
WalkthroughUpdated the GitHub issues management command to store reviews from any reviewer by deriving Changes
Sequence DiagramsequenceDiagram
participant cmd as update_github_issues command
participant gh as GitHub API
participant db as Database
cmd->>gh: Fetch PR reviews
gh-->>cmd: Reviews (each includes review["user"]["login"])
loop For each review
cmd->>cmd: Extract reviewer_login = review["user"]["login"]
cmd->>db: Query UserProfile where github_url == "https://github.com/{reviewer_login}"
alt Profile found
cmd->>db: Create/Update GitHubReview with reviewer = UserProfile
db-->>cmd: Success
else Profile not found
cmd->>cmd: Log warning and skip storing review
end
opt Lookup error
cmd->>cmd: Log warning and continue
end
end
cmd->>db: Bulk update PR records (unchanged flow)
db-->>cmd: Complete
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
website/management/commands/update_github_issues.py (1)
143-168: Consider pre-loading UserProfiles to reduce database queries.The current implementation queries the database for each review to find the reviewer's UserProfile. For PRs with many reviews, this could result in numerous queries. Consider pre-loading all UserProfiles into a dictionary at the start of the command for better performance.
Example optimization:
# At the start of handle() method, after line 17 github_username_to_profile = {} for profile in users_with_github: username = profile.github_url.rstrip('/').split('/')[-1] github_username_to_profile[username.lower()] = profile # Then in the review loop, replace lines 147-149 with: reviewer_profile = github_username_to_profile.get(reviewer_login.lower())
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
📒 Files selected for processing (1)
website/management/commands/update_github_issues.py(1 hunks)
🧰 Additional context used
🪛 Ruff (0.14.4)
website/management/commands/update_github_issues.py
165-165: Do not catch blind exception: Exception
(BLE001)
167-167: Use explicit conversion flag
Replace with conversion flag
(RUF010)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Run Tests
- GitHub Check: docker-test
🔇 Additional comments (1)
website/management/commands/update_github_issues.py (1)
140-141: LGTM! Comment accurately reflects the fix.The updated comment clearly indicates the intended behavior change to capture reviews from all users, which aligns with the PR objective to fix the Code Review Leaderboard.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
website/management/commands/update_github_issues.py (1)
169-174: Address the exception handling concern from the previous review.This broad
Exceptioncatch and the string formatting issue were already flagged in a previous review comment. Please catch specific exceptions (UserProfile.DoesNotExist,UserProfile.MultipleObjectsReturned) and use the explicit conversion flag{e!s}instead ofstr(e).Apply this diff as suggested in the previous review:
- except Exception as e: + except (UserProfile.DoesNotExist, UserProfile.MultipleObjectsReturned) as e: self.stdout.write( - self.style.WARNING(f"Could not find UserProfile for reviewer {reviewer_login}: {str(e)}") + self.style.WARNING(f"Could not find UserProfile for reviewer {reviewer_login}: {e!s}") )
🧹 Nitpick comments (1)
website/management/commands/update_github_issues.py (1)
153-168: Add logging when reviews are skipped due to missing UserProfile.When
reviewer_profileisNone(line 153), the review is silently skipped with no indication in the logs. This makes it difficult to debug incomplete leaderboard data or identify reviewers who should have profiles created.Apply this diff to log skipped reviews:
if reviewer_profile: GitHubReview.objects.update_or_create( review_id=review["id"], defaults={ "pull_request": github_issue, "reviewer": reviewer_profile, # The actual reviewer, not the PR author "body": review.get("body", ""), "state": review["state"], "submitted_at": timezone.make_aware( datetime.strptime( review["submitted_at"], "%Y-%m-%dT%H:%M:%SZ" ) ), "url": review["html_url"], }, ) + else: + self.stdout.write( + self.style.WARNING( + f"Skipping review by {reviewer_login} (no UserProfile found)" + ) + )
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
📒 Files selected for processing (1)
website/management/commands/update_github_issues.py(1 hunks)
🧰 Additional context used
🪛 Ruff (0.14.4)
website/management/commands/update_github_issues.py
169-169: Do not catch blind exception: Exception
(BLE001)
172-172: Use explicit conversion flag
Replace with conversion flag
(RUF010)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Run Tests
- GitHub Check: docker-test
🔇 Additional comments (2)
website/management/commands/update_github_issues.py (2)
140-140: LGTM! Comment clarifies the fix.The updated comment accurately reflects the corrected behavior of storing reviews from any user, which directly addresses the bug described in issue #3440.
148-151: Useiendswithfor more robust URL matching, or normalize github_url values.The current approach using
__iexacton lines 149-150 requires an exact string match. This will silently fail if any storedgithub_urlvalues have trailing slashes (e.g.,"https://github.com/username/"vs"https://github.com/username"), causing valid reviews to be skipped. While your code constructs URLs without trailing slashes, Django'sURLFieldvalidator accepts both forms, creating inconsistency risk.The codebase already recognizes this pattern:
extract_github_username()inwebsite/views/user.pyline 75 normalizes URLs by stripping trailing slashes, indicating prior awareness of this issue.Recommended fix:
- expected_github_url = f"https://github.com/{reviewer_login}" - reviewer_profile = UserProfile.objects.filter( - github_url__iexact=expected_github_url - ).first() + reviewer_profile = UserProfile.objects.filter( + github_url__iendswith=f"/{reviewer_login}" + ).first()This handles both
https://github.com/{username}andhttps://github.com/{username}/, and is case-insensitive by default for URL schemes.Alternatively, add a
clean()method to normalizegithub_urlon theUserProfilemodel to strip trailing slashes on save.
|
Hi @DonnieBLT Would you mind reviewing when you get a chance? |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes issue #3440 by correcting the logic in the GitHub review data collection process to capture reviews from all reviewers, not just PR authors. Previously, the Code Review Leaderboard had missing data because only reviews made by the PR author were stored.
- Removed the condition that filtered reviews to only those made by the PR author
- Added logic to look up reviewer UserProfiles based on their GitHub URL
- Implemented error handling for cases where reviewer profiles cannot be found
|
deployed, please test it and let me know if it worked |
This pr fix issue #3440 review Leaderboard so it shows the users who have reviewed PRs on the projects / repos
This PR fixes a logic issue in update_github_issues.py where only reviews made by the PR author were stored.
As a result, the Code Review Leaderboard had missing data.
Fixes #3440
Summary by CodeRabbit