Paginate error handling

Added error handling in Model::paginate() so a 404 from the gateway now returns an empty paginator instead of throwing an exception

Author: KroderDev

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Fixed
+- `paginate()` returns an empty paginator with a 200 status when the gateway responds with 404.
+
+
 ## [0.4.2] - 2025-07-21
 ### Added
 - Query builder with `where()->get()` support for remote models.

src/Models/Model.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Kroderdev\LaravelMicroserviceCore\Contracts\ApiGatewayClientInterface;
+use Kroderdev\LaravelMicroserviceCore\Exceptions\ApiGatewayException;
 use Kroderdev\LaravelMicroserviceCore\Interfaces\ApiModelContract;
 use Kroderdev\LaravelMicroserviceCore\Traits\ApiModelTrait;
 use Kroderdev\LaravelMicroserviceCore\Traits\ParsesApiResponse;
@@ -99,8 +100,18 @@ public static function paginate($perPage = 15, $columns = ['*'], $pageName = 'pa
     {
         $page = $page ?: LengthAwarePaginator::resolveCurrentPage($pageName);
         $query = [$pageName => $page, 'per_page' => $perPage];
-        $response = static::client()->get(static::endpoint(), $query);
-        $data = static::parseResponse($response);
+
+        // Handle the case where the API returns a 404 for an empty collection
+        try {
+            $response = static::client()->get(static::endpoint(), $query);
+            $data = static::parseResponse($response);
+        } catch (ApiGatewayException $e) {
+            if ($e->getStatusCode() === 404) {
+                return new LengthAwarePaginator([], 0, $perPage);
+            }
+
+            throw $e;
+        }
 
         return static::fromPaginatedResponse($data);
     }

tests/Models/ApiModelTest.php

@@ -386,4 +386,28 @@ public function from_api_response_maps_nested_relations()
         $this->assertEquals('file3.txt', $deep->children[0]->name);
         $this->assertEquals(789, $deep->children[0]->size);
     }
+
+    /** @test */
+    public function paginate_returns_empty_paginator_on_404()
+    {
+        $this->gateway = new class () extends FakeGatewayClient {
+            public function get(string $uri, array $query = [])
+            {
+                parent::get($uri, $query);
+
+                throw new \Kroderdev\LaravelMicroserviceCore\Exceptions\ApiGatewayException(404);
+            }
+        };
+        $this->app->bind(ApiGatewayClientInterface::class, fn () => $this->gateway);
+
+        $paginator = RemoteUser::paginate(10);
+
+        $this->assertSame([
+            ['method' => 'GET', 'uri' => '/users', 'query' => ['page' => 1, 'per_page' => 10]],
+        ], $this->gateway->getCalls());
+        $this->assertInstanceOf(\Illuminate\Pagination\LengthAwarePaginator::class, $paginator);
+        $this->assertCount(0, $paginator->items());
+        $this->assertEquals(0, $paginator->total());
+        $this->assertEquals(200, response()->json($paginator->items())->status());
+    }
 }