Remote Model Validation Rule

Author: KroderDev

src/Providers/MicroserviceServiceProvider.php

@@ -7,6 +7,7 @@
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\ServiceProvider;
 use Kroderdev\LaravelMicroserviceCore\Auth\GatewayGuard;
 use Kroderdev\LaravelMicroserviceCore\Contracts\AccessUserInterface;
@@ -18,6 +19,7 @@
 use Kroderdev\LaravelMicroserviceCore\Http\Middleware\PermissionMiddleware;
 use Kroderdev\LaravelMicroserviceCore\Http\Middleware\RoleMiddleware;
 use Kroderdev\LaravelMicroserviceCore\Http\Middleware\ValidateJwt;
+use Kroderdev\LaravelMicroserviceCore\Interfaces\ApiModelContract;
 use Kroderdev\LaravelMicroserviceCore\Services\ApiGatewayClient;
 use Kroderdev\LaravelMicroserviceCore\Services\ApiGatewayClientFactory;
 use Kroderdev\LaravelMicroserviceCore\Services\AuthServiceClient;
@@ -189,6 +191,24 @@ public function boot(Router $router): void
                 ->timeout(5);
         });
 
+        // Validation
+        Validator::extend('exists_remote', function ($attribute, $value, $parameters) {
+            $model = $parameters[0] ?? null;
+            $column = $parameters[1] ?? 'id';
+            if (! $model || ! is_subclass_of($model, ApiModelContract::class)) {
+                return false;
+            }
+
+            $values = is_array($value) ? $value : [$value];
+            foreach ($values as $v) {
+                if (! $model::find($v)) {
+                    return false;
+                }
+            }
+
+            return true;
+        });
+
         // Exceptions
         $handler = $this->app->make(ExceptionHandler::class);
 

src/Rules/ExistsRemote.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Kroderdev\LaravelMicroserviceCore\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+class ExistsRemote implements Rule
+{
+    protected string $model;
+    protected string $column;
+
+    public function __construct(string $model, string $column = 'id')
+    {
+        $this->model = $model;
+        $this->column = $column;
+    }
+
+    public function passes($attribute, $value): bool
+    {
+        $values = is_array($value) ? $value : [$value];
+
+        foreach ($values as $v) {
+            if (! $this->model::find($v)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    public function message(): string
+    {
+        return trans('validation.exists');
+    }
+}

tests/Rules/ExistsRemoteTest.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace Tests\Rules;
+
+use Illuminate\Support\Facades\Validator;
+use Orchestra\Testbench\TestCase;
+use Kroderdev\LaravelMicroserviceCore\Contracts\ApiGatewayClientInterface;
+use Kroderdev\LaravelMicroserviceCore\Models\Model as ApiModel;
+use Kroderdev\LaravelMicroserviceCore\Providers\MicroserviceServiceProvider;
+use Tests\Services\FakeGatewayClient;
+
+require_once __DIR__.'/../Services/FakeGatewayClient.php';
+
+class RemoteRole extends ApiModel
+{
+    protected static string $endpoint = '/roles';
+
+    protected $fillable = ['id'];
+}
+
+class ExistsRemoteTest extends TestCase
+{
+    protected FakeGatewayClient $gateway;
+
+    protected function getPackageProviders($app)
+    {
+        return [MicroserviceServiceProvider::class];
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->gateway = new FakeGatewayClient();
+        $this->app->bind(ApiGatewayClientInterface::class, fn () => $this->gateway);
+    }
+
+    /** @test */
+    public function passes_when_all_ids_exist()
+    {
+        $this->gateway = new class () extends FakeGatewayClient {
+            public function get(string $uri, array $query = [])
+            {
+                parent::get($uri, $query);
+                if (in_array($uri, ['/roles/1', '/roles/2'])) {
+                    $id = (int) substr($uri, 7);
+                    return ['data' => ['id' => $id]];
+                }
+
+                return null;
+            }
+        };
+        $this->app->bind(ApiGatewayClientInterface::class, fn () => $this->gateway);
+
+        $validator = Validator::make(
+            ['roles' => [1, 2]],
+            ['roles.*' => ['exists_remote:' . RemoteRole::class . ',id']]
+        );
+
+        $this->assertTrue($validator->passes());
+    }
+
+    /** @test */
+    public function rule_object_works_the_same()
+    {
+        $this->gateway = new class () extends FakeGatewayClient {
+            public function get(string $uri, array $query = [])
+            {
+                parent::get($uri, $query);
+                return ['data' => ['id' => (int) substr($uri, 7)]];
+            }
+        };
+        $this->app->bind(ApiGatewayClientInterface::class, fn () => $this->gateway);
+
+        $rule = new \Kroderdev\LaravelMicroserviceCore\Rules\ExistsRemote(RemoteRole::class);
+
+        $validator = Validator::make(['role' => 1], ['role' => [$rule]]);
+
+        $this->assertTrue($validator->passes());
+    }
+
+    /** @test */
+    public function fails_when_any_id_is_missing()
+    {
+        $this->gateway = new class () extends FakeGatewayClient {
+            public function get(string $uri, array $query = [])
+            {
+                parent::get($uri, $query);
+                if ($uri === '/roles/1') {
+                    return ['data' => ['id' => 1]];
+                }
+
+                return null;
+            }
+        };
+        $this->app->bind(ApiGatewayClientInterface::class, fn () => $this->gateway);
+
+        $validator = Validator::make(
+            ['roles' => [1, 2]],
+            ['roles.*' => ['exists_remote:' . RemoteRole::class . ',id']]
+        );
+
+        $this->assertFalse($validator->passes());
+    }
+}