Merge pull request #164 from RonasIT/163-modify-500-code-error-response-page

Modify 500 code error response page

Author: DenTray

composer.lock

@@ -101,6 +101,15 @@
             '204' => 'Operation successfully done',
             '404' => 'This entity not found',
         ],
+
+        /*
+        |--------------------------------------------------------------------------
+        | Error Template
+        |--------------------------------------------------------------------------
+        |
+        | You can use your custom description view for errors.
+        */
+        'error' => 'auto-doc::error',
     ],
 
     /*
@@ -211,5 +220,5 @@
         ],
     ],
 
-    'config_version' => '2.9',
+    'config_version' => '2.10',
 ];

config/auto-doc.php

@@ -0,0 +1 @@
+{{ $message }}

resources/views/error.blade.php

@@ -17,6 +17,7 @@ public function boot()
 
         $this->publishes([
             __DIR__ . '/../resources/views/swagger-description.blade.php' => resource_path('views/vendor/auto-doc/swagger-description.blade.php'),
+            __DIR__ . '/../resources/views/error.blade.php' => resource_path('views/vendor/auto-doc/error.blade.php'),
         ], 'view');
 
         if (!$this->app->routesAreCached()) {

src/AutoDocServiceProvider.php

@@ -2,7 +2,7 @@
 
 namespace RonasIT\AutoDoc\Drivers;
 
-use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use RonasIT\AutoDoc\Exceptions\MissedProductionFilePathException;
 
 class LocalDriver extends BaseDriver
@@ -30,7 +30,7 @@ public function saveData(): void
     public function getDocumentation(): array
     {
         if (!file_exists($this->prodFilePath)) {
-            throw new FileNotFoundException();
+            throw new FileNotFoundException($this->prodFilePath);
         }
 
         $fileContent = file_get_contents($this->prodFilePath);

src/Drivers/LocalDriver.php

@@ -2,7 +2,7 @@
 
 namespace RonasIT\AutoDoc\Drivers;
 
-use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use RonasIT\AutoDoc\Exceptions\MissedRemoteDocumentationUrlException;
 
 class RemoteDriver extends BaseDriver

src/Drivers/RemoteDriver.php

@@ -2,7 +2,7 @@
 
 namespace RonasIT\AutoDoc\Drivers;
 
-use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Support\Facades\Storage;
 use RonasIT\AutoDoc\Exceptions\MissedProductionFilePathException;
@@ -34,7 +34,7 @@ public function saveData(): void
     public function getDocumentation(): array
     {
         if (!$this->disk->exists($this->prodFilePath)) {
-            throw new FileNotFoundException();
+            throw new FileNotFoundException($this->prodFilePath);
         }
 
         $fileContent = $this->disk->get($this->prodFilePath);

src/Drivers/StorageDriver.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace RonasIT\AutoDoc\Exceptions;
+
+use Illuminate\Contracts\Filesystem\FileNotFoundException as BaseException;
+
+class FileNotFoundException extends BaseException
+{
+    public function __construct(string $filePath = null)
+    {
+        parent::__construct("Documentation file not found {$filePath}");
+    }
+}

src/Exceptions/FileNotFoundException.php

@@ -23,6 +23,7 @@
 use RonasIT\AutoDoc\Traits\GetDependenciesTrait;
 use RonasIT\AutoDoc\Validators\SwaggerSpecValidator;
 use Symfony\Component\HttpFoundation\Response;
+use Exception;
 
 /**
  * @property SwaggerDriverContract $driver
@@ -131,14 +132,18 @@ protected function setDriver()
         }
     }
 
-    protected function generateEmptyData(): array
+    protected function generateEmptyData(?string $view = null, array $viewData = [], array $license = []): array
     {
         // client must enter at least `contact.email` to generate a default `info` block
         // otherwise an exception will be called
         if (!empty($this->config['info']) && !Arr::get($this->config, 'info.contact.email')) {
             throw new EmptyContactEmailException();
         }
 
+        if (empty($view) && !empty($this->config['info'])) {
+            $view = $this->config['info']['description'];
+        }
+
         $data = [
             'openapi' => self::OPEN_API_VERSION,
             'servers' => [
@@ -148,7 +153,7 @@ protected function generateEmptyData(): array
             'components' => [
                 'schemas' => $this->config['definitions'],
             ],
-            'info' => $this->prepareInfo($this->config['info'])
+            'info' => $this->prepareInfo($view, $viewData, $license),
         ];
 
         $securityDefinitions = $this->generateSecurityDefinition();
@@ -260,7 +265,7 @@ protected function generatePathDescription(string $key): string
 
         foreach ($exploded as $value) {
             if (!preg_match('/^[a-zA-Z0-9\.]+$/', $value)) {
-                return  "regexp: {$expression}";
+                return "regexp: {$expression}";
             }
         }
 
@@ -596,8 +601,13 @@ protected function saveParameterType(&$data, $parameter, $parameterType)
         ];
     }
 
-    protected function saveParameterDescription(&$data, $parameter, array $rulesArray, array $attributes, array $annotations)
-    {
+    protected function saveParameterDescription(
+        array &$data,
+        string $parameter,
+        array $rulesArray,
+        array $attributes,
+        array $annotations
+    ) {
         $description = Arr::get($annotations, $parameter);
 
         if (empty($description)) {
@@ -803,7 +813,7 @@ public function saveProductionData()
         if (ParallelTesting::token()) {
             $this->driver->appendProcessDataToTmpFile(function (array $sharedTmpData) {
                 $resultDocContent = (empty($sharedTmpData))
-                    ? $this->generateEmptyData()
+                    ? $this->generateEmptyData($this->config['info']['description'])
                     : $sharedTmpData;
 
                 $this->mergeOpenAPIDocs($resultDocContent, $this->data);
@@ -817,9 +827,13 @@ public function saveProductionData()
 
     public function getDocFileContent()
     {
-        $documentation = $this->driver->getDocumentation();
+        try {
+            $documentation = $this->driver->getDocumentation();
 
-        $this->openAPIValidator->validate($documentation);
+            $this->openAPIValidator->validate($documentation);
+        } catch (Exception $exception) {
+            return $this->generateEmptyData($this->config['defaults']['error'], ['message' => $exception->getMessage()]);
+        }
 
         $additionalDocs = config('auto-doc.additional_paths', []);
 
@@ -946,27 +960,21 @@ protected function getDefaultValueByType($type)
         return $values[$type];
     }
 
-    protected function prepareInfo(array $info): array
+    protected function prepareInfo(?string $view = null, array $viewData = [], array $license = []): array
     {
-        if (empty($info)) {
-            return $info;
-        }
+        $info = [];
 
-        foreach ($info['license'] as $key => $value) {
-            if (empty($value)) {
-                unset($info['license'][$key]);
-            }
-        }
+        $license = array_filter($license);
 
-        if (empty($info['license'])) {
-            unset($info['license']);
+        if (!empty($license)) {
+            $info['license'] = $license;
         }
 
-        if (!empty($info['description'])) {
-            $info['description'] = view($info['description'])->render();
+        if (!empty($view)) {
+            $info['description'] = view($view, $viewData)->render();
         }
-
-        return $info;
+        
+        return array_merge($this->config['info'], $info);
     }
 
     protected function getOpenAPIFileContent(string $filePath): array

src/Services/SwaggerService.php

@@ -4,11 +4,9 @@
 
 use Illuminate\Http\Response;
 use phpmock\phpunit\PHPMock;
-use RonasIT\Support\Traits\MockTrait;
 
 class AutoDocControllerTest extends TestCase
 {
-    use MockTrait;
     use PHPMock;
 
     protected static array $documentation;