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

163 modify 500 code error response page

Author: DenTray

.github/workflows/run-tests-with-coverage.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install Dependencies
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
       - name: Execute unit tests via PHPUnit with coverage
-        run: vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+        run: php -d zend.exception_ignore_args=0 -d xdebug.collect_params=4 vendor/bin/phpunit --coverage-clover build/logs/clover.xml
       - name: Export coverage report
         if: ${{ matrix.php-version == '8.4' }}
         uses: actions/upload-artifact@v4

composer.json

@@ -24,7 +24,7 @@
     "orchestra/testbench": ">=9.3",
     "php-coveralls/php-coveralls": "^2.7",
     "php-mock/php-mock-phpunit": ">=2.10",
-    "ronasit/laravel-helpers": "^3.4"
+    "ronasit/laravel-helpers": "^3.5"
   },
   "autoload": {
     "psr-4": {

composer.lock

@@ -1 +1,14 @@
-{{ $message }}
+# ❗️ **ERROR** ❗️
+
+## 🚨🚨 {{ $type }} 🚨🚨
+
+---
+
+### **Details:**
+
+{{ $message }}
+
+### **Error place:**
+
+{{ $error_place }}
+---

resources/views/error.blade.php

@@ -4,6 +4,9 @@
 
 use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use RonasIT\AutoDoc\Exceptions\MissedProductionFilePathException;
+use RonasIT\AutoDoc\Exceptions\EmptyDocFileException;
+use RonasIT\AutoDoc\Exceptions\NonJSONDocFileException;
+use Symfony\Component\Filesystem\Path;
 
 class LocalDriver extends BaseDriver
 {
@@ -35,6 +38,14 @@ public function getDocumentation(): array
 
         $fileContent = file_get_contents($this->prodFilePath);
 
+        if (empty($fileContent)) {
+            throw new EmptyDocFileException(Path::makeRelative($this->prodFilePath, base_path()));
+        }
+
+        if (!json_validate($fileContent)) {
+            throw new NonJSONDocFileException(Path::makeRelative($this->prodFilePath, base_path()));
+        }
+
         return json_decode($fileContent, true);
     }
 }

src/Drivers/LocalDriver.php

@@ -4,6 +4,7 @@
 
 use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use RonasIT\AutoDoc\Exceptions\MissedRemoteDocumentationUrlException;
+use RonasIT\AutoDoc\Exceptions\NonJSONDocFileException;
 
 class RemoteDriver extends BaseDriver
 {
@@ -39,6 +40,10 @@ public function getDocumentation(): array
             throw new FileNotFoundException();
         }
 
+        if (!json_validate($content)) {
+            throw new NonJSONDocFileException('Remote documentation');
+        }
+
         return json_decode($content, true);
     }
 

src/Drivers/RemoteDriver.php

@@ -6,6 +6,8 @@
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Support\Facades\Storage;
 use RonasIT\AutoDoc\Exceptions\MissedProductionFilePathException;
+use RonasIT\AutoDoc\Exceptions\EmptyDocFileException;
+use RonasIT\AutoDoc\Exceptions\NonJSONDocFileException;
 
 class StorageDriver extends BaseDriver
 {
@@ -39,6 +41,14 @@ public function getDocumentation(): array
 
         $fileContent = $this->disk->get($this->prodFilePath);
 
+        if (empty($fileContent)) {
+            throw new EmptyDocFileException($this->prodFilePath);
+        }
+
+        if (!json_validate($fileContent)) {
+            throw new NonJSONDocFileException($this->prodFilePath);
+        }
+
         return json_decode($fileContent, true);
     }
 }

src/Drivers/StorageDriver.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace RonasIT\AutoDoc\Exceptions;
+
+use Exception;
+
+class NonJSONDocFileException extends Exception
+{
+    public function __construct(string $filename)
+    {
+        parent::__construct("Doc file '{$filename}' is not a json doc file.");
+    }
+}

src/Exceptions/NonJSONDocFileException.php

@@ -23,7 +23,7 @@
 use RonasIT\AutoDoc\Traits\GetDependenciesTrait;
 use RonasIT\AutoDoc\Validators\SwaggerSpecValidator;
 use Symfony\Component\HttpFoundation\Response;
-use Exception;
+use Throwable;
 
 /**
  * @property SwaggerDriverContract $driver
@@ -73,6 +73,10 @@ public function __construct(Container $container)
         $this->setDriver();
 
         if (config('app.env') === 'testing') {
+            // client must enter at least `contact.email` to generate a default `info` block
+            // otherwise an exception will be called
+            $this->checkEmail();
+
             $this->container = $container;
 
             $this->security = $this->config['security'];
@@ -134,12 +138,6 @@ protected function setDriver()
 
     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'];
         }
@@ -165,6 +163,13 @@ protected function generateEmptyData(?string $view = null, array $viewData = [],
         return $data;
     }
 
+    protected function checkEmail(): void
+    {
+        if (!empty($this->config['info']) && !Arr::get($this->config, 'info.contact.email')) {
+            throw new EmptyContactEmailException();
+        }
+    }
+
     protected function generateSecurityDefinition(): ?array
     {
         if (empty($this->security)) {
@@ -796,18 +801,6 @@ protected function getActionName($uri): string
         return Str::camel($action);
     }
 
-    /**
-     * @deprecated method is not in use
-     * @codeCoverageIgnore
-     */
-    protected function saveTempData()
-    {
-        $exportFile = Arr::get($this->config, 'files.temporary');
-        $data = json_encode($this->data);
-
-        file_put_contents($exportFile, $data);
-    }
-
     public function saveProductionData()
     {
         if (ParallelTesting::token()) {
@@ -831,8 +824,12 @@ public function getDocFileContent()
             $documentation = $this->driver->getDocumentation();
 
             $this->openAPIValidator->validate($documentation);
-        } catch (Exception $exception) {
-            return $this->generateEmptyData($this->config['defaults']['error'], ['message' => $exception->getMessage()]);
+        } catch (Throwable $exception) {
+            return $this->generateEmptyData($this->config['defaults']['error'], [
+                'message' => $exception->getMessage(),
+                'type' => $exception::class,
+                'error_place' => $this->getErrorPlace($exception),
+            ]);
         }
 
         $additionalDocs = config('auto-doc.additional_paths', []);
@@ -852,6 +849,18 @@ public function getDocFileContent()
         return $documentation;
     }
 
+    protected function getErrorPlace(Throwable $exception): string
+    {
+        $firstTraceEntry = Arr::first($exception->getTrace());
+
+        $formattedTraceEntry = Arr::map(
+            array: $firstTraceEntry,
+            callback: fn ($value, $key) => $key . '=' . (is_array($value) ? json_encode($value) : $value),
+        );
+
+        return implode(', ', $formattedTraceEntry);
+    }
+
     protected function camelCaseToUnderScore($input): string
     {
         preg_match_all('!([A-Z][A-Z0-9]*(?=$|[A-Z][a-z0-9])|[A-Za-z][a-z0-9]+)!', $input, $matches);
@@ -973,7 +982,7 @@ protected function prepareInfo(?string $view = null, array $viewData = [], array
         if (!empty($view)) {
             $info['description'] = view($view, $viewData)->render();
         }
-        
+
         return array_merge($this->config['info'], $info);
     }
 

src/Services/SwaggerService.php

@@ -75,7 +75,7 @@ public function testGetJSONDocumentationIsEmpty()
         $mock->expects($this->once());
 
         config([
-            'auto-doc.additional_paths' => ['tests/fixtures/AutoDocControllerTest/documentation__non_json.txt'],
+            'auto-doc.additional_paths' => ['tests/fixtures/AutoDocControllerTest/empty_additional_documentation.json'],
         ]);
 
         $response = $this->json('get', '/auto-doc/documentation');