163 modify 500 code error response page #174

RGO230 · 2025-07-02T12:38:03Z

#163

…hub.com/RonasIT/laravel-swagger into 163-modify-500-code-error-response-page

sonarqubecloud · 2025-07-09T15:03:59Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.5% Duplication on New Code

See analysis details on SonarQube Cloud

src/Services/SwaggerService.php

Copilot

Pull Request Overview

This PR modifies the error response page formatting for Swagger validation errors, addressing issue #163. The changes enhance error presentation with structured markdown formatting and proper error context display.

Reformats error page display with markdown structure including headers and visual separators
Updates error handling to include exception type information alongside error messages
Fixes test parameter ordering and adds new test case for incorrect documentation structure

Reviewed Changes

Copilot reviewed 44 out of 44 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
resources/views/error.blade.php	Updates error page template with structured markdown formatting
src/Services/SwaggerService.php	Modifies exception handling to capture and pass exception type information
tests/SwaggerServiceTest.php	Updates test expectations and adds new test case for documentation structure errors
tests/TestCase.php	Fixes parameter order in exportContent method call
tests/fixtures/SwaggerServiceTest/*.html	Updates all error fixture files to match new markdown-formatted error template

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/SwaggerServiceTest.php

src/Services/SwaggerService.php

tests/SwaggerServiceTest.php

Copilot

Pull Request Overview

Copilot reviewed 62 out of 64 changed files in this pull request and generated 8 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-06T07:33:49Z

tests/SwaggerServiceTest.php

+            [
+                'tmpDoc' => 'documentation/invalid_format__missing_ref_file',
+                'fixture' => 'php_8.4_invalid_format_missing_ref_file.html',
+            ],


Duplicate test case entry detected. Lines 267-270 and 271-274 have identical values for both 'tmpDoc' and 'fixture'. Remove the duplicate entry to avoid redundant test execution.

Suggested change

[

'tmpDoc' => 'documentation/invalid_format__missing_ref_file',

'fixture' => 'php_8.4_invalid_format_missing_ref_file.html',

],

Copilot · 2025-11-06T07:33:49Z

tests/SwaggerServiceTest.php

            ],
            headers: [
-                'authorization' => 'Bearer some_token',
+                'authorization' => 'Bearer some_timplementationoken',


Corrected spelling of 'some_timplementationoken' to 'some_token'.

Suggested change

'authorization' => 'Bearer some_timplementationoken',

'authorization' => 'Bearer some_token',

tests/SwaggerServiceTest.php

Copilot · 2025-11-06T07:33:50Z

tests/SwaggerServiceTest.php

+        if (version_compare(PHP_VERSION, '8.4.0', '<=')) {
+            $this->mockDriverGetDocumentation($this->getJsonFixture($tmpDoc));
+
+            $content = app(SwaggerService::class)->getDocFileContent();
+
+            $this->assertExceptionHTMLEqualsFixture($fixture, $content['info']['description']);
+        } else {
+            $this->markTestSkipped('This test requires PHP version <= 8.4.0');


Incorrect version comparison operator. The condition should be '<' instead of '<=' to check for PHP versions before 8.4.0. Currently, this test will run on PHP 8.4.0 when it should be skipped, which contradicts the skip message on line 322 stating 'This test requires PHP version <= 8.4.0' (note: the message itself is misleading as '<= 8.4.0' would include 8.4.0).

Suggested change

if (version_compare(PHP_VERSION, '8.4.0', '<=')) {

$this->mockDriverGetDocumentation($this->getJsonFixture($tmpDoc));

$content = app(SwaggerService::class)->getDocFileContent();

$this->assertExceptionHTMLEqualsFixture($fixture, $content['info']['description']);

} else {

$this->markTestSkipped('This test requires PHP version <= 8.4.0');

if (version_compare(PHP_VERSION, '8.4.0', '<')) {

$this->mockDriverGetDocumentation($this->getJsonFixture($tmpDoc));

$content = app(SwaggerService::class)->getDocFileContent();

$this->assertExceptionHTMLEqualsFixture($fixture, $content['info']['description']);

} else {

$this->markTestSkipped('This test requires PHP version < 8.4.0');

Copilot · 2025-11-06T07:33:50Z

tests/TestCase.php

    {
        if ($exportMode || $this->globalExportMode) {
-            $this->exportContent($fixtureName, $data);
+            $this->exportContent($data, $fixtureName);


The parameter order in this call has been swapped. Based on the method signature at line 59 which defines exportContent($content, string $fixtureName), the first parameter should be the content. Verify that all calls to assertEqualsFixture still work correctly with this parameter order change, as exportContent now expects content first.

method realization

protected function exportContent($content, string $fixtureName): void { file_put_contents($this->getFixturePath($fixtureName), $content); }

Copilot · 2025-11-06T07:33:51Z

tests/SwaggerServiceTest.php

    public function testMergeTempDocumentation()
    {
-        $this->mockParallelTestingToken();
+        $this->mockParallelTestingToken('workerID');


Method mockParallelTestingToken is called but was removed from TestCase.php (see lines 213-217 of the diff). This will cause a fatal error. Either restore this method or use an alternative implementation.

Copilot · 2025-11-06T07:33:51Z

tests/SwaggerServiceTest.php

    public function testMergeToEmptyTempDocumentation()
    {
-        $this->mockParallelTestingToken();
+        $this->mockParallelTestingToken('workerID');


Method mockParallelTestingToken is called but was removed from TestCase.php (see lines 213-217 of the diff). This will cause a fatal error. Either restore this method or use an alternative implementation.

method was moved in helpers package

Copilot · 2025-11-06T07:33:51Z

tests/LocalDriverTest.php

    public function testSaveProcessTmpDataCheckTokenBasedPath()
    {
-        $this->mockParallelTestingToken();
+        $this->mockParallelTestingToken('workerID');


Method mockParallelTestingToken is called but was removed from TestCase.php (see lines 213-217 of the TestCase.php diff). This will cause a fatal error. Either restore this method or use an alternative implementation.

method was moved in helpers package

Co-authored-by: Copilot <[email protected]>

DenTray · 2025-11-06T08:10:47Z

@RGO230 please review copilot's comments and increase test coverage

…hub.com/RonasIT/laravel-swagger into 163-modify-500-code-error-response-page

sonarqubecloud · 2025-11-06T11:34:08Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

RGO230 added 2 commits July 2, 2025 15:35

refactor: display throwable errors too

dee3246

Merge branch '163-modify-500-code-error-response-page' of https://git…

115f599

…hub.com/RonasIT/laravel-swagger into 163-modify-500-code-error-response-page

RGO230 self-assigned this Jul 2, 2025

refactor: set empty array for not exception errors

1c7dfcf

RGO230 assigned AZabolotnikov and RGO230 and unassigned RGO230 and AZabolotnikov Jul 3, 2025

refactor: add empty email exception message to view

fe96b4b

RGO230 assigned AZabolotnikov and unassigned RGO230 Jul 9, 2025

fix: remove useless

241a8f7

AZabolotnikov reviewed Jul 31, 2025

View reviewed changes

src/Services/SwaggerService.php Outdated Show resolved Hide resolved

AZabolotnikov assigned DenTray and RGO230 and unassigned AZabolotnikov Jul 31, 2025

DenTray requested changes Aug 12, 2025

View reviewed changes

src/Services/SwaggerService.php Outdated Show resolved Hide resolved

DenTray removed their assignment Aug 12, 2025

astorozhevsky requested a review from Copilot August 28, 2025 09:37

Copilot AI reviewed Aug 28, 2025

View reviewed changes

tests/SwaggerServiceTest.php Outdated Show resolved Hide resolved

src/Services/SwaggerService.php Outdated Show resolved Hide resolved

refactor: add defaul unhandled error message

6624b40

RGO230 assigned AZabolotnikov and unassigned RGO230 Sep 1, 2025

AZabolotnikov assigned RGO230 and unassigned AZabolotnikov Sep 4, 2025

AZabolotnikov reviewed Sep 4, 2025

View reviewed changes

tests/SwaggerServiceTest.php Outdated Show resolved Hide resolved

RGO230 added 3 commits September 11, 2025 17:10

refactor: use try catch

79d523c

refactor: use try catch in correct place

66d348a

fix: tests

c48e7f2

RGO230 assigned AZabolotnikov and RGO230 and unassigned RGO230 and AZabolotnikov Nov 4, 2025

fix:tests

5eef605

RGO230 assigned AZabolotnikov and unassigned RGO230 Nov 4, 2025

DenTray requested changes Nov 6, 2025

View reviewed changes

DenTray added 7 commits November 6, 2025 13:23

Update tests/SwaggerServiceTest.php

f70a93b

Update tests/SwaggerServiceTest.php

17c2b2a

Update tests/SwaggerServiceTest.php

a080402

Update tests/SwaggerServiceTest.php

229e545

Update tests/SwaggerServiceTest.php

4f0254c

Update tests/SwaggerServiceTest.php

a0ba34f

Update tests/SwaggerServiceTest.php

208ce11

DenTray requested a review from Copilot November 6, 2025 07:30

Copilot AI reviewed Nov 6, 2025

View reviewed changes

Update tests/SwaggerServiceTest.php

5c8cfeb

Co-authored-by: Copilot <[email protected]>

DenTray assigned RGO230 and unassigned AZabolotnikov Nov 6, 2025

RGO230 added 4 commits November 6, 2025 13:56

tests: make correct php 8.4 tests

c07712a

Merge branch '163-modify-500-code-error-response-page' of https://git…

b6ab02c

…hub.com/RonasIT/laravel-swagger into 163-modify-500-code-error-response-page

fix:tests

30f0f23

refactor: remove useless

8a1c80b

RGO230 assigned AZabolotnikov and unassigned RGO230 Nov 6, 2025

AZabolotnikov assigned DenTray and unassigned AZabolotnikov Nov 7, 2025

	'authorization' => 'Bearer some_timplementationoken',
	'authorization' => 'Bearer some_token',

163 modify 500 code error response page #174

Are you sure you want to change the base?

163 modify 500 code error response page #174

Uh oh!

Conversation

RGO230 commented Jul 2, 2025

Uh oh!

sonarqubecloud bot commented Jul 9, 2025

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

RGO230 Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

RGO230 Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

RGO230 Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

DenTray commented Nov 6, 2025

Uh oh!

sonarqubecloud bot commented Nov 6, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

RGO230 Nov 6, 2025 •

edited

Loading