-
Notifications
You must be signed in to change notification settings - Fork 17.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
x/build/maintner: GitHubIssue.ClosedBy field is never populated #28745
Comments
Let's just document it for now with a TODO to this issue. The first person who needs it can implement. We have the issue events synced anyway, so the data's in the corpus. We just need to track the oldest close event per issue. |
Change https://golang.org/cl/149238 mentions this issue: |
That's a great idea to consider, then no need for extra queries. The close event has additional information like the SHA of the commit that closed the issue (if any): |
The ClosedBy field is currently always nil due to the cause described in the linked issue. Document it with a TODO comment so people don't need to spend time on figuring that out for themselves. Updates golang/go#28745 Change-Id: Icaa7b8fd5614dffbfd13a9783b9a71cb87e2af40 Reviewed-on: https://go-review.googlesource.com/c/149238 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Hi. Just noting here, that any fix to this, depends on this being fixed: #29396. Because:
In same cases apparently that's not recorded. I'm still trying to figure out the why to that. It's somewhere in the chain where the events are recorded. |
There exists a
GitHubIssue.ClosedBy
field inmaintner
:What did you expect to see?
Accurate values.
What did you see instead?
The field is never populated and always equals to
nil
for all GitHub issues.This can be misleading for anyone looking to use that information.
Cause
The
closed_by
JSON field is documented and shown in the sample response at https://developer.github.com/v3/issues/#get-a-single-issue.However,
maintner
uses the https://developer.github.com/v3/issues/#list-issues-for-a-repository endpoint for getting information about many issues at once:https://github.com/golang/build/blob/23803abc1638efbf100d69fe6d901b14a9ad55fd/maintner/github.go#L1605-L1613
But GitHub doesn't include all detailed fields when listing many issues rather than getting a single issue. The
closed_by
field is indeed missing:Response from Get Single Issue Endpoint
Response from List Issues Endpoint
Possible Fixes
I see two possible solutions:
Since this field isn't included in the existing endpoint queried by
maintner
, it would require making additional API calls per issue. That can be extremely expensive and simply not viable.I'd suggest removing it or documenting, at least as an intermediate step. But open to ideas. /cc @bradfitz
The text was updated successfully, but these errors were encountered: