Skip to content

[octocrab] Backport #750 from main repo#8

Open
nataliejameson wants to merge 9 commits intodiscordfrom
nmj/moar-nullable-non-nullable-fields
Open

[octocrab] Backport #750 from main repo#8
nataliejameson wants to merge 9 commits intodiscordfrom
nmj/moar-nullable-non-nullable-fields

Conversation

@nataliejameson
Copy link

Just backport XAMPPRocky#750 which allows a the sha for a file in a commit (via diffentry) to be null.

rossdylan and others added 9 commits August 28, 2024 15:16
Despite the API docs saying this is a required field, it is possible to make
commits using the api that have no login field. There are prior cases where the
github rest api has just been wrong so this isn't that weird.
Another weird api spec incompatibility. I've found that some responses that are
missing an Authors field will either serialize it as `null` or `{}`. No idea why
Octocrab's retry logic is... less than ideal. We need to handle both 401
and 429 statuses, so just allow an array of status codes to be checked
against. If one wanted this to be more generic, they could thread some
extra types and such through, but that feels like a bigger thing to do
than what I have here.
In some cases it seems the Compare Commits endpoint (`/repos/{owner}/{repo}/compare/{base}...{head}`) will return *either* a full Author object for committer and author of each commit *or* just the name, email, etc that are in GitUser. This appears to be the case when e.g. a bot does the commit that github cannot tie to a user specifically? In any case, this change allows us to deserialize that commit comparison endpoint's results while also allowing us to get full information if it's available.

Also bump the version
In #4 , this was changed from Author -> GitUser. Prefer to allow both of these so we can pull user logins for commits without having to guess from their email.
We're currently seeing some issues where sometimes we hit secondary rate limits from github. https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28 describes what headers to look for and how long to wait between retries, so add a new retry implementation that respects these hints.
The commit compare endpoint does not conform to how octocrab expects paginated response bodies to be shaped. So, we need to expose a way to get the pagination headers from the response and manually do a little pagination ourselves.
Just backport XAMPPRocky#750 which has an optional field now
@nataliejameson
Copy link
Author

Or alternatively, #9 rebases us, and then we'll just have this for free.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants