Error handling improvements

ApiGatewayException handling now checks if the request expects JSON and aborts only for standard web requests

Author: KroderDev

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Unreleased
 ### Added
 - Query builder with `where()->get()` support for remote models.
+- Smart error handling based on the request's expected format.
+- Error propagation improvements with tests for all status codes.
 
 ## [0.4.1] - 2025-07-10
 ### Added

src/Providers/MicroserviceServiceProvider.php

@@ -214,7 +214,14 @@ public function boot(Router $router): void
 
         if (method_exists($handler, 'renderable')) {
             $handler->renderable(function (ApiGatewayException $e, $request) {
-                return response()->json($e->getData(), $e->getStatusCode());
+                $status = $e->getStatusCode();
+                $message = $e->getMessage();
+
+                if (! $request->expectsJson()) {
+                    abort($status, $message);
+                }
+
+                return response()->json(['error' => $message], $status);
             });
         }
     }

src/Services/ApiGatewayClient.php

@@ -69,12 +69,22 @@ protected function handleResponse($response)
         if (is_object($response) && method_exists($response, 'failed') && $response->failed()) {
             $data = method_exists($response, 'json') ? $response->json() : [];
 
+            $message = '';
+            if (is_array($data)) {
+                $message = $data['message'] ?? ($data['error'] ?? '');
+            }
+
             throw new ApiGatewayException(
                 method_exists($response, 'status') ? $response->status() : 500,
-                is_array($data) ? $data : []
+                is_array($data) ? $data : [],
+                $message
             );
         }
 
+        if (is_object($response) && method_exists($response, 'json')) {
+            return response()->json($response->json(), $response->status());
+        }
+
         return $response;
     }
 }

tests/Services/ApiGatewayErrorTest.php

@@ -18,18 +18,52 @@ protected function getPackageProviders($app)
     protected function setUp(): void
     {
         parent::setUp();
-        Http::fake(['*' => Http::response(['error' => 'unavailable'], 503)]);
 
         Route::get('/gateway-error', function () {
             return app(ApiGatewayClient::class)->get('/fail');
         });
     }
 
+    public static function statusProvider(): array
+    {
+        return [[200], [201], [400], [401], [419], [500]];
+    }
+
+    /**
+     * @test
+     * @dataProvider statusProvider
+     */
+    public function propagates_gateway_status_code(int $status)
+    {
+        Http::fake(['*' => Http::response(['message' => 'm'], $status)]);
+
+        $response = $this->getJson('/gateway-error');
+        $response->assertStatus($status);
+
+        if ($status >= 400) {
+            $response->assertJson(['error' => 'm']);
+        }
+    }
+
     /** @test */
-    public function propagates_gateway_status_code()
+    public function aborts_in_frontend_context()
     {
-        $this->get('/gateway-error')
-            ->assertStatus(503)
-            ->assertJson(['error' => 'unavailable']);
+        Http::fake(['*' => Http::response(['message' => 'nope'], 401)]);
+
+        $this->withoutExceptionHandling();
+        $this->expectException(\Symfony\Component\HttpKernel\Exception\HttpException::class);
+        $this->expectExceptionMessage('nope');
+
+        $this->get('/gateway-error');
+    }
+
+    /** @test */
+    public function returns_json_in_service_context()
+    {
+        Http::fake(['*' => Http::response(['message' => 'bad'], 400)]);
+
+        $this->getJson('/gateway-error')
+            ->assertStatus(400)
+            ->assertJson(['error' => 'bad']);
     }
 }