fix: Set id field of PullRequest, Comment and Issue to Long
#200
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Represent it as Long instead of Integer. For schema (where id is specified as 'int64') see: https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-issues-and-pull-requests
Represent the id as Long instead of Integer. Official Schema for Pull Request -> int64: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We are experiencing
JsonMappingExceptionissues due toidbeing represented as anIntegerin this client. We have observed the following data structures experiencing the issue:PullRequest,Comment, andIssue.e.g.
As of late October this year, PR ids have exceeded Integer.MAX. This is especially crippling since most Github Endpoints return an updated object as a response, which gets deserialized by the client. In the case of
PullRequest, it results in all use cases related to handling PRs becoming unusable.Official documentation states that PullRequest
idisint64. This is probably the case for all entity ids as well.https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#get-a-pull-request
Note: This PR extends from #180 which is older and has broken tests.
This PR is technically not backwards compatible (since it changes data types), but without the fix, the client is unusable for all use cases related to recent Pull Requests.