Validators queryRules maximum results value throwing exception

[itwebdeveloper]

Reproduction steps:

1. Create a Validator.php file for the resourse. E.g. app/JsonApi/Item/Validators.php

2. Change the queryRules() method to:

   /**
    * @return array
    */
   protected function queryRules(): array
   {
       return [
           'page.number' => 'filled|numeric|min:1',
           'page.size' => 'filled|numeric|between:1,50',
       ];
   }
   

3. Send a GET request to the resource endpoint with a page.size value greater than the maximum value set in the queryRules(), e.g. http://api.example.test/api/v1/item?page[number]=1&page[size]=51

Result:

CloudCreativity\LaravelJsonApi\Exceptions\ValidationException: JSON API error in file /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Exceptions/ValidationException.php on line 49

[lindyhopchris]

Hi! Have you followed the installation instructions for what you need to add to your Exception handler?
https://laravel-json-api.readthedocs.io/en/latest/installation/

[itwebdeveloper]

Hi @lindyhopchris , thanks for your response. Yes, I already have it however it is not handling the exception in this case. Aren't you managing to reproduce it?

[lindyhopchris]

No, if this wasn't working a lot of the tests would be failing and the production apps we've got this running in wouldn't be working.

Can you copy and paste your exception handler code?

[lindyhopchris]

Also can you copy and paste the full stack trace for the exception as the snippet you've provided above doesn't give me enough to go on. Thanks!

[itwebdeveloper]

Hi @lindyhopchris ,
it must surely be my mistake but I was unable to find where I followed the instructions in the wrong way.
This is my app/Exceptions/Handler.php file content:

<?php

namespace App\Exceptions;

use CloudCreativity\LaravelJsonApi\Exceptions\HandlesErrors;
use Exception;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Neomerx\JsonApi\Exceptions\JsonApiException;

class Handler extends ExceptionHandler
{

    use HandlesErrors;

    /**
     * A list of the exception types that are not reported.
     *
     * @var array
     */
    protected $dontReport = [
        JsonApiException::class,
    ];

    /**
     * A list of the inputs that are never flashed for validation exceptions.
     *
     * @var array
     */
    protected $dontFlash = [
        'password',
        'password_confirmation',
    ];

    /**
     * Report or log an exception.
     *
     * @param  \Exception  $exception
     * @return void
     */
    public function report(Exception $exception)
    {
        parent::report($exception);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Exception  $exception
     * @return \Illuminate\Http\Response
     */
    public function render($request, Exception $exception)
    {
        if ($this->isJsonApi($request, $exception)) {
            return $this->renderJsonApi($request, $exception);
        }

        return parent::render($request, $exception);
    }
}

and the full stack trace of the exception is:

CloudCreativity\LaravelJsonApi\Exceptions\ValidationException: JSON API error in file /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Exceptions/ValidationException.php on line 49
Stack trace:
  1. CloudCreativity\LaravelJsonApi\Exceptions\ValidationException->() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Exceptions/ValidationException.php:49
  2. CloudCreativity\LaravelJsonApi\Exceptions\ValidationException->create() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Http/Requests/ValidatedRequest.php:308
  3. CloudCreativity\LaravelJsonApi\Http\Requests\ValidatedRequest->failedValidation() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Http/Requests/ValidatedRequest.php:297
  4. CloudCreativity\LaravelJsonApi\Http\Requests\ValidatedRequest->passes() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Http/Requests/FetchResources.php:59
  5. CloudCreativity\LaravelJsonApi\Http\Requests\FetchResources->validateQuery() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Http/Requests/ValidatedRequest.php:265
  6. CloudCreativity\LaravelJsonApi\Http\Requests\ValidatedRequest->validateResolved() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Providers/FormRequestServiceProvider.php:30
  7. Illuminate\Foundation\Providers\FormRequestServiceProvider->Illuminate\Foundation\Providers\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Container/Container.php:1069
  8. Illuminate\Container\Container->fireCallbackArray() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Container/Container.php:1033
  9. Illuminate\Container\Container->fireAfterResolvingCallbacks() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Container/Container.php:1018
 10. Illuminate\Container\Container->fireResolvingCallbacks() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Container/Container.php:677
 11. Illuminate\Container\Container->resolve() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Container/Container.php:609
 12. Illuminate\Container\Container->make() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Application.php:759
 13. Illuminate\Foundation\Application->make() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/RouteDependencyResolverTrait.php:79
 14. Illuminate\Routing\ControllerDispatcher->transformDependency() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/RouteDependencyResolverTrait.php:46
 15. Illuminate\Routing\ControllerDispatcher->resolveMethodDependencies() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/RouteDependencyResolverTrait.php:27
 16. Illuminate\Routing\ControllerDispatcher->resolveClassMethodDependencies() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php:41
 17. Illuminate\Routing\ControllerDispatcher->dispatch() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Route.php:219
 18. Illuminate\Routing\Route->runController() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Route.php:176
 19. Illuminate\Routing\Route->run() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php:682
 20. Illuminate\Routing\Router->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:30
 21. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Http/Middleware/NegotiateContent.php:102
 22. CloudCreativity\LaravelJsonApi\Http\Middleware\NegotiateContent->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 23. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 24. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Http/Middleware/Authorize.php:87
 25. CloudCreativity\LaravelJsonApi\Http\Middleware\Authorize->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 26. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 27. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/cloudcreativity/laravel-json-api/src/Http/Middleware/BootJsonApi.php:78
 28. CloudCreativity\LaravelJsonApi\Http\Middleware\BootJsonApi->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 29. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 30. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php:41
 31. Illuminate\Routing\Middleware\SubstituteBindings->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 32. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 33. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php:43
 34. Illuminate\Auth\Middleware\Authenticate->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 35. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 36. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php:58
 37. Illuminate\Routing\Middleware\ThrottleRequests->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 38. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 39. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:104
 40. Illuminate\Pipeline\Pipeline->then() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php:684
 41. Illuminate\Routing\Router->runRouteWithinStack() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php:659
 42. Illuminate\Routing\Router->runRoute() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php:625
 43. Illuminate\Routing\Router->dispatchToRoute() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Router.php:614
 44. Illuminate\Routing\Router->dispatch() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php:176
 45. Illuminate\Foundation\Http\Kernel->Illuminate\Foundation\Http\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:30
 46. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/barryvdh/laravel-debugbar/src/Middleware/InjectDebugbar.php:65
 47. Barryvdh\Debugbar\Middleware\InjectDebugbar->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 48. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 49. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/fideloper/proxy/src/TrustProxies.php:57
 50. Fideloper\Proxy\TrustProxies->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 51. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 52. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php:31
 53. Illuminate\Foundation\Http\Middleware\TransformsRequest->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 54. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 55. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php:27
 56. Illuminate\Foundation\Http\Middleware\ValidatePostSize->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 57. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 58. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/CheckForMaintenanceMode.php:62
 59. Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode->handle() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:163
 60. Illuminate\Pipeline\Pipeline->Illuminate\Pipeline\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php:53
 61. Illuminate\Routing\Pipeline->Illuminate\Routing\{closure}() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:104
 62. Illuminate\Pipeline\Pipeline->then() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php:151
 63. Illuminate\Foundation\Http\Kernel->sendRequestThroughRouter() /home/vagrant/code/example-api/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php:116
 64. Illuminate\Foundation\Http\Kernel->handle() /home/vagrant/code/example-api/public/index.php:55

[lindyhopchris]

When you send the GET request, are you sending an Accept: application/vnd.api+json header?

[itwebdeveloper]

No, I wasn't :-(
Adding this header to the request (as per all the other requests, that instead contained it) solved my issue.
Thanks, @lindyhopchris !

[lindyhopchris]

Ah great. Yeah I think this shows up a different issue though... which is to do with JSON API Exceptions being thrown when the client has not requested a JSON API response. Which I think I've spotted before but never made a note of it. I'll create a separate issue for that so I don't forget.