Schema validation and error detail settings by get params

CHANGELOG.md

@@ -7,13 +7,15 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 * Support for semantic versioning api.
 * [BC] DefaultHandler response code 404 instead 400
 * [BC] Added Container to API Decider
+* [BC] Output Configurator, Allows different methods for output configuration. Needs to be added to config services.
 
 #### Added
 * CorsPreflightHandlerInterface - resolve multiple service registered handler error
 * Lazy API handlers
 
 #### Added
 * Button to copy `Body` content in api console
+* Ability to disable schema validation and provide additional error info with get parameters. 
 
 #### Changed
 * Handler tag wrapper has changed class from `btn` to `label`

README.md

@@ -40,6 +40,13 @@ application:
     Api: Tomaj\NetteApi\Presenters\*Presenter
 ```
 
+Then register your preffered output configurator in *config.neon* services: 
+
+```neon
+services:
+    apiOutputConfigurator: Tomaj\NetteApi\Output\Configurator\DebuggerConfigurator
+```
+
 And add route to you RouterFactory:
 
 ```php

src/Output/Configurator/ConfiguratorInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tomaj\NetteApi\Output\Configurator;
+
+use Nette\Application\Request;
+
+interface ConfiguratorInterface
+{
+    public function validateSchema(?Request $request = null): bool;
+
+    public function showErrorDetail(?Request $request = null): bool;
+}

src/Output/Configurator/DebuggerConfigurator.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tomaj\NetteApi\Output\Configurator;
+
+use Nette\Application\Request;
+use Tracy\Debugger;
+
+class DebuggerConfigurator implements ConfiguratorInterface
+{
+    public function validateSchema(?Request $request = null): bool
+    {
+        return !Debugger::$productionMode;
+    }
+
+    public function showErrorDetail(?Request $request = null): bool
+    {
+        return !Debugger::$productionMode;
+    }
+}

src/Output/Configurator/EnvConfigurator.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tomaj\NetteApi\Output\Configurator;
+
+use Nette\Application\Request;
+
+class EnvConfigurator implements ConfiguratorInterface
+{
+    private $envVariable = 'APP_ENV';
+    private $productionValue = 'production';
+
+    /**
+     * @param string $envVariable Which environment variable to check for production value
+     * @param string $productionValue Value that indicates production environment eg. 'production' or 'prod'...
+     */
+    public function __construct(string $envVariable = 'APP_ENV', string $productionValue = 'production')
+    {
+        $this->envVariable = $envVariable;
+        $this->productionValue = $productionValue;
+    }
+
+    public function validateSchema(?Request $request = null): bool
+    {
+        $appEnv = getenv($this->envVariable);
+        if ($appEnv === $this->productionValue) {
+            return false;
+        }
+        return true;
+    }
+
+    public function showErrorDetail(?Request $request = null): bool
+    {
+        $appEnv = getenv($this->envVariable);
+        if ($appEnv === $this->productionValue) {
+            return false;
+        }
+        return true;
+    }
+}

src/Output/Configurator/QueryConfigurator.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tomaj\NetteApi\Output\Configurator;
+
+use Nette\Application\Request;
+
+class QueryConfigurator implements ConfiguratorInterface
+{
+    private $noSchemaValidateParam = 'no_schema_validate';
+    private $errorDetailParam = 'error_detail';
+
+    /**
+     * @param string $noSchemaValidateParam Name of get parameter to disable schema validation
+     * @param string $errorDetailParam Name of get parameter to show additional info in error response
+     */
+    public function __construct(string $noSchemaValidateParam = 'no_schema_validate', string $errorDetailParam = 'error_detail')
+    {
+        $this->noSchemaValidateParam = $noSchemaValidateParam;
+        $this->errorDetailParam = $errorDetailParam;
+    }
+
+    public function validateSchema(?Request $request = null): bool
+    {
+        if ($request === null) {
+            return false;
+        }
+        $getParams = $request->getParameters();
+        return !isset($getParams[$this->noSchemaValidateParam]);
+    }
+
+    public function showErrorDetail(?Request $request = null): bool
+    {
+        if ($request === null) {
+            return false;
+        }
+        $getParams = $request->getParameters();
+        return isset($getParams[$this->errorDetailParam]);
+    }
+}

src/Presenters/ApiPresenter.php

@@ -21,6 +21,7 @@
 use Tomaj\NetteApi\RateLimit\RateLimitInterface;
 use Tomaj\NetteApi\Response\JsonApiResponse;
 use Tracy\Debugger;
+use Tomaj\NetteApi\Output\Configurator\ConfiguratorInterface;
 
 final class ApiPresenter implements IPresenter
 {
@@ -33,6 +34,9 @@ final class ApiPresenter implements IPresenter
     /** @var Container @inject */
     public $context;
 
+    /** @var ConfiguratorInterface @inject */
+    public $outputConfigurator;
+
     /**
      * CORS header settings
      *
@@ -83,7 +87,7 @@ public function run(Request $request): IResponse
         $paramsProcessor = new ParamsProcessor($handler->params());
         if ($paramsProcessor->isError()) {
             $this->response->setCode(Response::S400_BAD_REQUEST);
-            if (!Debugger::$productionMode) {
+            if ($this->outputConfigurator->showErrorDetail($request)) {
                 $response = new JsonResponse(['status' => 'error', 'message' => 'wrong input', 'detail' => $paramsProcessor->getErrors()]);
             } else {
                 $response = new JsonResponse(['status' => 'error', 'message' => 'wrong input']);
@@ -94,7 +98,8 @@ public function run(Request $request): IResponse
         try {
             $response = $handler->handle($params);
             $code = $response->getCode();
-            if (!Debugger::$productionMode) {  /// If not production mode, validate output
+
+            if ($this->outputConfigurator->validateSchema($request)) {
                 $outputValid = count($handler->outputs()) === 0; // back compatibility for handlers with no outputs defined
                 $outputValidatorErrors = [];
                 foreach ($handler->outputs() as $output) {
@@ -115,7 +120,7 @@ public function run(Request $request): IResponse
                 }
             }
         } catch (Throwable $exception) {
-            if (!Debugger::$productionMode) {
+            if ($this->outputConfigurator->showErrorDetail($request)) {
                 $response = new JsonApiResponse(Response::S500_INTERNAL_SERVER_ERROR, ['status' => 'error', 'message' => 'Internal server error', 'detail' => $exception->getMessage()]);
             } else {
                 $response = new JsonApiResponse(Response::S500_INTERNAL_SERVER_ERROR, ['status' => 'error', 'message' => 'Internal server error']);

tests/Presenters/ApiPresenterTest.php

@@ -4,12 +4,10 @@
 
 namespace Tomaj\NetteApi\Test\Presenters;
 
-use PHPUnit\Framework\TestCase;
 use Nette\Application\Request;
 use Nette\DI\Container;
 use Nette\Http\Response as HttpResponse;
-use Nette\Http\Request as HttpRequest;
-use Nette\Http\UrlScript;
+use PHPUnit\Framework\TestCase;
 use Tomaj\NetteApi\ApiDecider;
 use Tomaj\NetteApi\Authorization\BearerTokenAuthorization;
 use Tomaj\NetteApi\Authorization\NoAuthorization;
@@ -18,6 +16,7 @@
 use Tomaj\NetteApi\Handlers\EchoHandler;
 use Tomaj\NetteApi\Misc\IpDetector;
 use Tomaj\NetteApi\Misc\StaticTokenRepository;
+use Tomaj\NetteApi\Output\Configurator\DebuggerConfigurator;
 use Tomaj\NetteApi\Presenters\ApiPresenter;
 use Tomaj\NetteApi\Test\Handler\TestHandler;
 use Tracy\Debugger;
@@ -41,6 +40,7 @@ public function testSimpleResponse()
         $presenter->apiDecider = $apiDecider;
         $presenter->response = new HttpResponse();
         $presenter->context = new Container();
+        $presenter->outputConfigurator = new DebuggerConfigurator();
 
         $request = new Request('Api:Api:default', 'GET', ['version' => '1', 'package' => 'test', 'apiAction' => 'api']);
         $result = $presenter->run($request);
@@ -64,6 +64,7 @@ public function testWithAuthorization()
         $presenter->apiDecider = $apiDecider;
         $presenter->response = new HttpResponse();
         $presenter->context = new Container();
+        $presenter->outputConfigurator = new DebuggerConfigurator();
 
         $request = new Request('Api:Api:default', 'GET', ['version' => '1', 'package' => 'test', 'apiAction' => 'api']);
         $result = $presenter->run($request);
@@ -85,6 +86,7 @@ public function testWithParams()
         $presenter->apiDecider = $apiDecider;
         $presenter->response = new HttpResponse();
         $presenter->context = new Container();
+        $presenter->outputConfigurator = new DebuggerConfigurator();
 
         Debugger::$productionMode = Debugger::PRODUCTION;
 
@@ -114,6 +116,7 @@ public function testWithOutputs()
         $presenter->apiDecider = $apiDecider;
         $presenter->response = new HttpResponse();
         $presenter->context = new Container();
+        $presenter->outputConfigurator = new DebuggerConfigurator();
 
         $request = new Request('Api:Api:default', 'GET', ['version' => '1', 'package' => 'test', 'apiAction' => 'api']);
         $result = $presenter->run($request);