Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion framework/core/src/Http/RequestUtil.php
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,11 @@ public static function extractLimit(Request $request, ?int $defaultLimit = null,
$limit = $defaultLimit;
}

if (! $limit) {
// Only short-circuit when there is genuinely no limit (no page[limit] and no
// default). A loose `! $limit` check here also caught the string "0", returning
// null which then broke OffsetPagination's non-nullable int $limit. An explicit
// page[limit]=0 must instead fall through to the `< 1` guard below and 400.
if ($limit === null) {
return null;
}

Expand Down
50 changes: 50 additions & 0 deletions framework/core/tests/unit/Http/RequestUtilTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Psr\Http\Message\ServerRequestInterface;
use Tobyz\JsonApiServer\Exception\BadRequestException;

class RequestUtilTest extends TestCase
{
Expand All @@ -25,6 +26,55 @@ private function requestWithAccept(?string $accept): ServerRequestInterface
return $accept === null ? $request : $request->withHeader('Accept', $accept);
}

private function requestWithLimit(?string $limit): ServerRequestInterface
{
$request = new ServerRequest([], [], '/', 'GET');

return $request->withQueryParams($limit === null ? [] : ['page' => ['limit' => $limit]]);
}

#[Test]
public function extract_limit_uses_an_explicitly_requested_limit(): void
{
$this->assertSame(20, RequestUtil::extractLimit($this->requestWithLimit('20'), 50, 100));
}

#[Test]
public function extract_limit_caps_at_the_maximum(): void
{
$this->assertSame(50, RequestUtil::extractLimit($this->requestWithLimit('100'), 20, 50));
}

#[Test]
public function extract_limit_falls_back_to_the_default_when_absent(): void
{
$this->assertSame(20, RequestUtil::extractLimit($this->requestWithLimit(null), 20, 50));
}

#[Test]
public function extract_limit_returns_null_when_there_is_no_limit_and_no_default(): void
{
$this->assertNull(RequestUtil::extractLimit($this->requestWithLimit(null), null, 50));
}

#[Test]
public function extract_limit_rejects_an_explicit_zero(): void
{
// Regression test: page[limit]=0 used to return null and then break
// OffsetPagination's non-nullable int $limit with a 500. It must 400 instead.
$this->expectException(BadRequestException::class);

RequestUtil::extractLimit($this->requestWithLimit('0'), 20, 50);
}

#[Test]
public function extract_limit_rejects_a_negative_limit(): void
{
$this->expectException(BadRequestException::class);

RequestUtil::extractLimit($this->requestWithLimit('-5'), 20, 50);
}

public static function apiAcceptHeaders(): array
{
return [
Expand Down
Loading