Merge pull request #12 from TheDragonCode/2.x

Fixed loading middleware

Author: Andrey Helldar

.editorconfig

@@ -40,6 +40,14 @@ After you've installed the package via composer, you're done. There's no step tw
 This package will automatically register the `DragonCode\LaravelJsonResponse\Middlewares\SetHeaderMiddleware` middleware in the `web` and `api` groups, if they
 exist. The middleware will add a header `Accept` that will effectively convert all responses to JSON format. This header will apply to all responses.
 
+## Troubleshooting
+
+> Why are my error messages not being converted to JSON?
+
+This is a feature of the [Laravel architecture](https://github.com/laravel/framework/blob/9.x/src/Illuminate/Foundation/Http/Kernel.php#L108-L116). The package makes corrections during the loading of the framework and it stores its state internally, and in case of an error, it takes the value of the request from the outside. Therefore, the error text is returned in html format.
+
+To fix this problem, you need to explicitly pass the `Accept: application/json` header in requests, or use the [`dragon-code/api-response`](https://github.com/TheDragonCode/api-response#best-practice-use-with-the-laravel-and-lumen-frameworks) package.
+
 
 [badge_build]:          https://img.shields.io/github/workflow/status/TheDragonCode/laravel-json-response/phpunit?style=flat-square
 

.styleci.yml

@@ -27,7 +27,8 @@
         "illuminate/contracts": "^6.0 || ^7.0 || ^8.0 || ^9.0",
         "illuminate/http": "^6.0 || ^7.0 || ^8.0 || ^9.0",
         "illuminate/support": "^6.0 || ^7.0 || ^8.0 || ^9.0",
-        "lmc/http-constants": "^1.2"
+        "lmc/http-constants": "^1.2",
+        "symfony/http-foundation": "^4.3 || ^5.0 || ^6.0"
     },
     "require-dev": {
         "orchestra/testbench": "^4.0 || ^5.0 || ^6.0 || ^7.0",

README.md

@@ -16,9 +16,20 @@ class SetHeaderMiddleware
      */
     public function handle(Request $request, Closure $next)
     {
-        /** @var \Illuminate\Http\Response $response */
         $response = $next($request);
 
-        return $response->header(Header::ACCEPT, 'application/json');
+        $this->set($response);
+
+        return $response;
+    }
+
+    /**
+     * @param \Illuminate\Http\JsonResponse|\Illuminate\Http\Response $response
+     *
+     * @return void
+     */
+    protected function set($response)
+    {
+        $response->headers->set(Header::ACCEPT, 'application/json');
     }
 }

composer.json

@@ -4,47 +4,15 @@
 
 use DragonCode\LaravelJsonResponse\Middlewares\SetHeaderMiddleware;
 use Illuminate\Contracts\Http\Kernel;
-use Illuminate\Support\Arr;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
 class ServiceProvider extends BaseServiceProvider
 {
-    protected $groups = ['web', 'api'];
+    protected $middleware = SetHeaderMiddleware::class;
 
     public function boot(): void
     {
-        foreach ($this->groups as $group) {
-            $this->prepend($group, SetHeaderMiddleware::class);
-        }
-    }
-
-    protected function prepend(string $group, string $middleware): void
-    {
-        if ($this->has($group, $middleware)) {
-            $this->resolve()->prependMiddlewareToGroup($group, $middleware);
-        }
-    }
-
-    protected function has(string $group, string $middleware): bool
-    {
-        return $this->hasGroup($group) && $this->doesntMiddleware($group, $middleware);
-    }
-
-    protected function hasGroup(string $group): bool
-    {
-        return Arr::has($this->getGroups(), $group);
-    }
-
-    protected function doesntMiddleware(string $group, string $middleware): bool
-    {
-        $group = Arr::get($this->getGroups(), $group);
-
-        return ! in_array($middleware, $group);
-    }
-
-    protected function getGroups(): array
-    {
-        return $this->resolve()->getMiddlewareGroups();
+        $this->resolve()->prependMiddleware($this->middleware);
     }
 
     protected function resolve(): Kernel

src/Middlewares/SetHeaderMiddleware.php

@@ -14,7 +14,7 @@ public function testWeb(): void
             ->assertSuccessful()
             ->assertHeader(Header::ACCEPT, 'application/json')
             ->assertJsonStructure(['data'])
-            ->assertJson(['data' => 'Hello, JSON!']);
+            ->assertJson(['data' => 'Hello, Web!']);
     }
 
     public function testApi(): void
@@ -24,6 +24,16 @@ public function testApi(): void
             ->assertSuccessful()
             ->assertHeader(Header::ACCEPT, 'application/json')
             ->assertJsonStructure(['data'])
-            ->assertJson(['data' => 'Hello, JSON!']);
+            ->assertJson(['data' => 'Hello, Api!']);
+    }
+
+    public function testCustom(): void
+    {
+        $this
+            ->get('custom')
+            ->assertSuccessful()
+            ->assertHeader(Header::ACCEPT, 'application/json')
+            ->assertJsonStructure(['data'])
+            ->assertJson(['data' => 'Hello, Custom!']);
     }
 }

src/ServiceProvider.php

@@ -3,7 +3,6 @@
 namespace Tests;
 
 use DragonCode\LaravelJsonResponse\ServiceProvider;
-use Illuminate\Contracts\Http\Kernel;
 use Orchestra\Testbench\TestCase as BaseTestCase;
 
 abstract class TestCase extends BaseTestCase
@@ -20,17 +19,19 @@ protected function getEnvironmentSetUp($app)
 
     protected function setRoutes($app): void
     {
-        $app['router']->get('web', function () {
-            return ['data' => 'Hello, JSON!'];
+        /** @var \Illuminate\Routing\RouteRegistrar $router */
+        $router = $app['router'];
+
+        $router->get('web', function () {
+            return ['data' => 'Hello, Web!'];
         })->middleware('web');
 
-        $app['router']->get('api', function () {
-            return ['data' => 'Hello, JSON!'];
+        $router->get('api', function () {
+            return ['data' => 'Hello, Api!'];
         })->middleware('api');
-    }
 
-    protected function getMiddlewareGroups(): array
-    {
-        return $this->app->make(Kernel::class)->getMiddlewareGroups();
+        $router->get('custom', function () {
+            return ['data' => 'Hello, Custom!'];
+        });
     }
 }