Feature: GraphQL Pagination

[tisonkun]

Something like https://github.com/octokit/plugin-paginate-graphql.js

[yanyongyu]

I'm not familiar with GraphQL pagination queries, but I can give it a try 😄

[tisonkun]

@yanyongyu The main design of the SDK above is a convention:

        pageInfo {
          hasNextPage
          endCursor
        }

that the GraphQL query must have the pageInfo section. And it will extract the related fields to fulfill after: $cursor.

It should be possible for users to handle this iteration logic manually but an out-of-the-box API can help.

[tisonkun]

And here is the related GitHub docs: https://docs.github.com/en/graphql/guides/using-pagination-in-the-graphql-api

[yanyongyu]

After a deep understanding of octokit plugin paginate graphql, I'll record some key points and notes here:

• graphql pagination relies on the pageInfo object, and should be defined by user in the query.
• graphql pagination should define an input cursor variable and octokit supports create cursor var name dynamically.
• octokit does not support nested pagination and it seems hard to achieve.
• octokit finds the pageInfo key of dicts recursively to detect pagination. [Ref]
• octokit finds the path of the pageInfo object and merges the nodes and edges [Ref]
• the main logic of iteration is here.
• octokit supports both forward and backward page iteration by detecting the hasNextPage/endCursor and hasPreviousPage/startCursor key of the page info.