Skip to content

Update PublicWikiController parameter validation and add unit tests #1156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarrow merged 3 commits into from
Jun 11, 2026
Merged

Update PublicWikiController parameter validation and add unit tests #1156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
22d20ea
Update PublicWikiController parameter validation and add unit tests
outdooracorn Jun 9, 2026
0b72027
Add `per_page` default and remove superfluous conditional
outdooracorn Jun 10, 2026
799491e
Update tests/Http/Controllers/PublicWikiControllerTest.php
tarrow Jun 11, 2026
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
12 changes: 4 additions & 8 deletions app/Http/Controllers/PublicWikiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ class PublicWikiController extends Controller {
private static $defaultParams = [
'sort' => 'sitename',
'direction' => 'asc',
'per_page' => 15,
];

private static $activeThresholdPageCount = 2;
Expand All @@ -24,8 +25,8 @@ public function index(Request $request) {
'direction' => 'in:desc,asc',
'is_featured' => 'boolean',
'is_active' => 'boolean',
'per_page' => 'numeric',
'page' => 'numeric',
'per_page' => 'int|min:1|max:100',
Comment thread
outdooracorn marked this conversation as resolved.
'page' => 'int|min:1',
]);

$params = array_merge(self::$defaultParams, $request->input());
Expand Down Expand Up @@ -61,12 +62,7 @@ public function index(Request $request) {
break;
}

$perPage = null;
if (array_key_exists('per_page', $params)) {
$perPage = intval($params['per_page']);
}

return PublicWikiResource::collection($query->paginate($perPage));
return PublicWikiResource::collection($query->paginate($params['per_page']));
}

/**
Expand Down
41 changes: 41 additions & 0 deletions tests/Http/Controllers/PublicWikiControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@
use App\Http\Resources\PublicWikiResource;
use App\Wiki;
use App\WikiProfile;
use Generator;
use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\ValidationException;
use Tests\TestCase;

class PublicWikiControllerTest extends TestCase {
Expand All @@ -35,6 +38,44 @@ public function testShowLoadsWikiLatestProfileForResource(): void {
$this->assertSame(true, $resource->toArray(new Request())['reuse_prototype']);
}

public static function provideQueryParamsAndErrorExpected(): Generator {
yield 'default params' => [[], false];
yield 'sort by sitename ascending' => [['sort' => 'sitename', 'direction' => 'asc'], false];
yield 'sort by pages descending' => [['sort' => 'pages', 'direction' => 'desc'], false];
yield 'sort by invalid value' => [['sort' => 'invalid'], true];
yield 'sort by invalid direction' => [['direction' => 'invalid'], true];
yield 'is_featured is boolean true' => [['is_featured' => true], false];
yield 'is_featured is boolean 0' => [['is_featured' => 0], false];
yield 'is_featured is invalid' => [['is_featured' => 'invalid'], true];
yield 'is_active is boolean false' => [['is_active' => false], false];
yield 'is_active is boolean 1' => [['is_active' => 1], false];
yield 'is_active is invalid' => [['is_active' => 'invalid'], true];
yield 'per_page is not int' => [['per_page' => 1.2], true];
yield 'per_page is too low' => [['per_page' => 0], true];
yield 'per_page is min value' => [['per_page' => 1], false];
yield 'per_page is max value' => [['per_page' => 100], false];
yield 'per_page is too high' => [['per_page' => 101], true];
yield 'page is not int' => [['page' => 2.3], true];
yield 'page is too low' => [['page' => 0], true];
yield 'page is min value' => [['page' => 1], false];
}

/**
* @dataProvider provideQueryParamsAndErrorExpected
*/
public function testIndexQueryParamValidation(array $queryParams, bool $errorExpected): void {
$controller = new PublicWikiController();
$request = new Request($queryParams);

if ($errorExpected) {
$this->expectException(ValidationException::class);
}

$response = $controller->index($request);

$this->assertInstanceOf(AnonymousResourceCollection::class, $response);
}

public function testIndexReusePrototypeOnlyRequiresOneAdditionalDatabaseQuery(): void {
for ($i = 1; $i <= 3; $i++) {
$wiki = Wiki::factory()->create([
Expand Down
Loading