feat(scm): pull request file issues API #74352
Conversation
github-actions
bot
added
the
Scope: Backend
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #74352 +/- ##
==========================================
- Coverage 78.25% 78.24% -0.01%
==========================================
Files 6829 6830 +1
Lines 303325 303389 +64
Branches 52201 52214 +13
==========================================
+ Hits 237352 237398 +46
- Misses 59597 59611 +14
- Partials 6376 6380 +4
|
cathteng
force-pushed
the
cathy/pr-file-issues-api
branch
from
8d48f2b
to
9a59982
Compare
| ] | ||
| pr_file_issues.sort(key=lambda k: k.get("event_count", 0), reverse=True) | ||
|
|
||
| return Response(pr_file_issues) |
There was a problem hiding this comment.
nit - if the end goal is for others to use this api, i would use a serializer here to return to make life less painful when ur documenting the endpoint. or u can just kick the can when u get there.
There was a problem hiding this comment.
Use a serializer everywhere actually even if it's not going to be publicly documented. It's more typed and readable.
|
This pull request has gone three weeks without activity. In another week, I will close it. But! If you comment or otherwise update it, I will reset the clock, and if you add the label "A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀 |
cathteng
requested review from
RyanSkonnord,
GabeVillalobos and
sentaur-athena
| ] | ||
| pr_file_issues.sort(key=lambda k: k.get("event_count", 0), reverse=True) | ||
|
|
||
| return Response(pr_file_issues) |
There was a problem hiding this comment.
Use a serializer everywhere actually even if it's not going to be publicly documented. It's more typed and readable.
| ) | ||
|
|
||
|
|
||
| class PullRequestFileSerializer(serializers.Serializer): |
There was a problem hiding this comment.
How is this gets related to a PR? Is it by patch? Or I can pass any file and get issues for it regardless of PR?
| return value | ||
|
|
||
| def validate_limit(self, value): | ||
| if value and value < 1 or value > 100: |
There was a problem hiding this comment.
Should be if value is not None? It looks like this won't raise an error on an int value of 0.
Also, nit: value < 1 or value > 100 can be written as not (1 <= value <= 100).
| org_id=organization.id, repo_name=repo_name, pr_filename=filename | ||
| ) | ||
|
|
||
| if not len(projects) or not len(sentry_filenames): |
There was a problem hiding this comment.
Style nit: empty collections are falsy, so you don't need len. Just if not projects or not sentry_filenames will work.
I'd also consider writing if not (projects and sentry_filenames), but that's a matter of taste.
| group_id_to_info = {} | ||
| for issue in top_issues: | ||
| group_id = issue["group_id"] | ||
| group_id_to_info[group_id] = dict(filter(lambda k: k[0] != "group_id", issue.items())) |
There was a problem hiding this comment.
| group_id_to_info[group_id] = dict(filter(lambda k: k[0] != "group_id", issue.items())) | |
| group_id_to_info[group_id] = {k: v for (k, v) in issue.items() if k != "group_id"} |
API for users to upload their PR file information (filename, patch) to find issues associated with those files. This API can fetch issues for a single file.
This expands the scope of open PR issue comments beyond GitHub, and people can hit the API in their custom flows as well.
The API supports the ability to set a max limit on the number of issues to return, open PR comments only fetches a max of 5 per file -- using that as the default here.