Go-github: BUG > ListIDPGroupsInOrganization paginates using int instead of string

[kuwas]

Description

Current Behavior

• ListIDPGroupsInOrganization
  
  
  
  • expects to be provided with ListOptions with Page value as int
  
  
  • https://github.com/google/go-github/blob/master/github/github.go#L193
  
  
  • returns response with type github.Response and NextPage, PrevPage, etc, values as int
  
  
  • https://github.com/google/go-github/blob/c74e92b2275cbb12471ed0fd6204dac07e130943/github/github.go#L399
  
  
• However, unlike other GitHub APIs, GET /orgs/:org/team-sync/groups return a page that is not numeric
  
  
  
  • For example: Link: <https://api.github.com/organizations/<redacted>/team-sync/groups?per_page=100&page=X%274<redacted>0000000000000000000000%27>; rel="next"
  
  
  • I've redacted from 274 to 000..., but its basically an alphanumeric string
  
  
  • Resulting github.Response will have NextPage with value as 0 since its expecting int
  
  
  • Pagination does not work, since NextPage is always 0
  
  

Expected Behavior

• ListIDPGroupsInOrganization should paginate properly

Additional Details

Request

2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: ---[ RESPONSE ]--------------------------------------
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: HTTP/1.1 200 OK
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Transfer-Encoding: chunked
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Access-Control-Allow-Origin: *
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Cache-Control: private, max-age=60, s-maxage=60
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Content-Security-Policy: default-src 'none'
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Content-Type: application/json; charset=utf-8
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Date: Fri, 17 Jan 2020 20:43:46 GMT
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Etag: <redacted>
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Link: <https://api.github.com/organizations/<redacted>/team-sync/groups?Page=&PerPage=10&page=X%274<redacted>0000000000000000000000%27>; rel="next"
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Server: GitHub.com
5:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Status: 200 OK
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Strict-Transport-Security: max-age=31536000; includeSubdomains; preload
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: Vary: Accept, Authorization, Cookie, X-GitHub-OTP
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Accepted-Oauth-Scopes: admin:org, repo
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Content-Type-Options: nosniff
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Frame-Options: deny
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Github-Media-Type: github.v3; param=team-sync-preview; format=json
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Github-Request-Id: <redacted>
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Oauth-Scopes: admin:org, delete_repo, repo, workflow
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Ratelimit-Limit: 5000
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Ratelimit-Remaining: 4970
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Ratelimit-Reset: <redacted>
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github: X-Xss-Protection: 1; mode=block
2020-01-17T15:43:46.945-0500 [DEBUG] plugin.terraform-provider-github:

[gmlewis]

Thank you, @kuwas! This sounds like a fun challenge that I would like to take on.

[kuwas]

👍

[gmlewis]

@kuwas - could you please take a look at #1384 and approve if you believe it will solve this issue?
Feel free to test it out as well and send feedback.

[kuwas]

@gmlewis Yes, this looks like it would work. I will test it out tomorrow at work and let you know the results. Thanks for the fast turnaround!

[kuwas]

@gmlewis Works great, thanks again.

[lynncyrin]

I had this same problem, and it turns out that it already has a fix! ✨ 🚀 ✨