Document that Issues::all() does not in fact return all issues due to pagination

[isomorpheme]

The GitLab API normally limits the list of issues to 100 entries per request, with a default of 20. This means that Issues::all() and Project::issues() by extension only return the first 20 issues of a project by default, which is surprising given their respective names. It'd be nice if the docs stated this fact, and provided a workaround.

I'd be willing to write a PR for this.

[fr0z3nfyr]

Although the solution for this would be fairly easy, it would be great to have a wrapper for this functionality.

Look for headers like below in your call to Project:issues()

X-Next-Page: 2
X-Page: 1
X-Per-Page: 10
X-Runtime: 0.165301
X-Total: 42
X-Total-Pages: 5

Then you can use the value of X-Total-Pages to run a loop get issues list and combine them into single object. Make sure to set per_page (default: 20, max: 100 as per docs here) in the initial request to desired value (I prefer 100) to get the correct value for X-Total-Pages.

[andersruneson]

Is there a work around for fetching more then 20 right now? I think I have the same problem fetching more projects with this code:
$pager = new \Gitlab\ResultPager($client); $projects = $pager->fetchall($client->api('projects'),'all',[[]]);

Make sure to set per_page (default: 20, max: 100 as per docs here) in the initial request to desired value (I prefer 100) to get the correct value for X-Total-Pages.

@fr0z3nfyr How?

[fr0z3nfyr]

@andersruneson this particular issue is about fetching list of issues on a project. Your code sample suggests you are trying to fetch list of projects.

Refer to the official docs here which nowhere suggests that the list of projects will be limited to 20. Also, from the docs:

Get a list of all visible projects across GitLab for the authenticated user. When accessed without authentication, only public projects are returned.

Are you sure your authenticated user has access to more than 20 projects on the gitlab server?

[andersruneson]

@fr0z3nfyr Right, I'm trying to fetch projects and thought it was related. I get exactly 40 projects for the above code. The user can access all projects. If I create a new project, that project is listed but the total is still 40 since another project did not list anymore.

[mzeis]

Hi @andersruneson, did you ever figure out why you only got 40 projects returned? If I run the identical code on two different platforms, on one I get all projects listed (more than 400) and on the other the result is limited to 40.

The platforms are quite different (e.g. the one working correctly still uses PHP 7.0 while the other uses 7.2), but I thought I should try and ask before diving deeper myself.

[andersruneson]

@mzeis Can't remember exactly, but I think I do longer use the script which needed to fetch all projects. But I'm also having trouble with pagination with other api calls like fetching jobs etc.

[andersruneson]

@mzeis @fr0z3nfyr
I accidentally had this issue again while writing another script. I had the exact same issue as you @mzeis that it worked fine on one system but not on the other. The strange this is they are both running the same version of PHP 7.2.24-0ubuntu0.18.04.3!
I got some more details this time, I think something is really borked with the pagination. Adding the parameter per_page 20 gave a result of 40 projects, per_page=25 gave 50. So the pagination only doubles the amount of results!

[akondas]

I have exactly the same situation, on one machine the same organization returns 81 projects, and on another only 40, regardless of everything. Did someone find anything?

[akondas]

Hello my friends 😉 I was able to reproduce it. Everything is guilty of the Link header in the response.

When requests are sent from the PHP version without support for the curl extension, php cuts this header (I don't know why). Installing curl and using it (for example, via CurlHttpClient) solves all problems.