Merge pull request #152 from hungthai1401/master

Add gRPC client support

Author: butschster

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog][keepachangelog] and this project adheres to [Semantic Versioning][semver].
 
+### Added
+
+- gRPC client support
+
 ## Unreleased
 
 ### Fixed

README.md

@@ -34,6 +34,7 @@ This package provides complete Laravel integration with RoadRunner, offering:
   - [HTTP Plugin](#http-plugin)
   - [Jobs (Queue) Plugin](#jobs-queue-plugin)
   - [gRPC Plugin](#grpc-plugin)
+  - [gRPC Client](#grpc-client)
   - [Temporal](#temporal)
 - [Custom Workers](#custom-workers)
 - [Support](#support)
@@ -219,6 +220,66 @@ return [
 ];
 ```
 
+#### gRPC Client Usage
+
+The package also allows your Laravel application to act as a gRPC client, making requests to external gRPC services.
+
+##### Client Configuration
+
+Add your gRPC client configuration to `config/roadrunner.php`:
+
+```php
+return [
+    // ... other configuration
+    'grpc' => [
+        // ... server config
+        'clients' => [
+            'services' => [
+                [
+                    'connection' => '127.0.0.1:9001', // gRPC server address
+                    'interfaces' => [
+                        \App\Grpc\EchoServiceInterface::class,
+                    ],
+                    // 'tls' => [ ... ] // Optional TLS configuration
+                ],
+            ],
+            // 'interceptors' => [ ... ] // Optional interceptors
+        ],
+    ],
+];
+```
+
+##### Using the gRPC Client in Laravel
+
+You can inject `Spiral\Grpc\Client\ServiceClientProvider` into your services or controllers to obtain a gRPC client instance:
+
+```php
+use Spiral\Grpc\Client\ServiceClientProvider;
+use App\Grpc\EchoServiceInterface;
+use App\Grpc\EchoRequest;
+
+class GrpcController extends Controller
+{
+    public function callService(ServiceClientProvider $provider)
+    {
+        /** @var EchoServiceInterface $client */
+        $client = $provider->get(EchoServiceInterface::class);
+
+        $request = new EchoRequest();
+        $request->setMessage('Hello from client!');
+
+        $response = $client->Echo($request);
+
+        return $response->getMessage();
+    }
+}
+```
+
+> **Note:**
+> - Make sure you have generated the PHP classes from your `.proto` files (using `protoc`).
+> - The `connection` and `interfaces` must match the service you want to call.
+> - You can configure multiple gRPC client services as needed.
+
 ### Temporal
 
 Temporal is a workflow engine that enables orchestration of microservices and provides sophisticated workflow

composer.json

@@ -42,7 +42,8 @@
         "spiral/roadrunner-http": "^3.0",
         "spiral/roadrunner-worker": "^3.0",
         "temporal/sdk": "^2.0",
-        "internal/dload": "^1.1"
+        "internal/dload": "^1.1",
+        "spiral/grpc-client": "^1.0.0-rc1"
     },
     "require-dev": {
         "laravel/framework": "^12.0",

config/roadrunner.php

@@ -18,6 +18,31 @@
         'services' => [
             // GreeterInterface::class => new Greeter::class,
         ],
+        'clients' => [
+            'interceptors' => [
+                // LoggingInterceptor::class,
+            ],
+            'services' => [
+                // [
+                //     'connection' => 'my-grpc-server:9002',
+                //     'interfaces' => [
+                //         GreeterInterface::class,
+                //     ],
+                // ],
+                // [
+                //     'connection' => 'my-secure-grpc-server:9002',
+                //     'interfaces' => [
+                //         GreeterInterface::class,
+                //     ],
+                //     'tls' => [
+                //         'rootCerts' => '/path/to/ca.pem',
+                //         'privateKey' => '/path/to/client.key',
+                //         'certChain'  => '/path/to/client.crt',
+                //         'serverName' => 'my.grpc.server',
+                //     ],
+                // ],
+            ],
+        ],
     ],
 
     'temporal' => [

src/ServiceProvider.php

@@ -4,8 +4,15 @@
 
 namespace Spiral\RoadRunnerLaravel;
 
+use Illuminate\Contracts\Container\Container;
 use Spiral\Attributes\AttributeReader;
 use Spiral\Attributes\ReaderInterface;
+use Spiral\Core\FactoryInterface;
+use Spiral\Grpc\Client\Config\ConnectionConfig;
+use Spiral\Grpc\Client\Config\GrpcClientConfig;
+use Spiral\Grpc\Client\Config\ServiceConfig;
+use Spiral\Grpc\Client\Config\TlsConfig;
+use Spiral\Grpc\Client\ServiceClientProvider;
 
 final class ServiceProvider extends \Illuminate\Support\ServiceProvider
 {
@@ -23,6 +30,7 @@ public function register(): void
     {
         $this->app->singleton(ReaderInterface::class, AttributeReader::class);
         $this->initializeConfigs();
+        $this->initializeGrpcClientServices();
     }
 
     protected function initializeConfigs(): void
@@ -33,4 +41,70 @@ protected function initializeConfigs(): void
             \realpath(self::getConfigPath()) => config_path(\basename(self::getConfigPath())),
         ], 'config');
     }
+
+    protected function initializeGrpcClientServices(): void
+    {
+        $this->app->singleton(FactoryInterface::class, fn() => new class($this->app) implements FactoryInterface {
+            public function __construct(
+                private readonly Container $container,
+            ) {}
+
+            /**
+             * @param  class-string  $class
+             * @param  array<int, mixed>  $parameters
+             */
+            public function make(string $class, array $parameters = []): object
+            {
+                return $this->container->make($class, $parameters);
+            }
+        });
+        $this->app->singleton(ServiceClientProvider::class, function () {
+            $toNonEmptyStringOrNull = static fn($value): ?string => (is_string($value) && $value !== '') ? $value : null;
+            /**
+             * @var array<int, array{
+             *     connection: non-empty-string,
+             *     interfaces: list<class-string>,
+             *     tls?: array{
+             *         rootCerts?: non-empty-string|null,
+             *         privateKey?: non-empty-string|null,
+             *         certChain?: non-empty-string|null,
+             *         serverName?: non-empty-string|null
+             *     }
+             * }>
+             */
+            $rawServices = config('roadrunner.grpc.clients.services', []);
+            $services = collect($rawServices);
+            $serviceConfigs = [];
+            foreach ($services as $service) {
+                $tls = null;
+                if (isset($service['tls'])) {
+                    $tlsConfig = $service['tls'];
+                    $tls = new TlsConfig(
+                        $toNonEmptyStringOrNull($tlsConfig['rootCerts'] ?? null),
+                        $toNonEmptyStringOrNull($tlsConfig['privateKey'] ?? null),
+                        $toNonEmptyStringOrNull($tlsConfig['certChain'] ?? null),
+                        $toNonEmptyStringOrNull($tlsConfig['serverName'] ?? null),
+                    );
+                }
+                /** @var non-empty-string $connection */
+                $connection = $service['connection'];
+                /** @var list<class-string> $interfaces */
+                $interfaces = $service['interfaces'];
+                $serviceConfigs[] = new ServiceConfig(
+                    connections: new ConnectionConfig($connection, $tls),
+                    interfaces: $interfaces,
+                );
+            }
+
+            /** @var array<class-string<\Spiral\Interceptors\InterceptorInterface>|\Spiral\Core\Container\Autowire<\Spiral\Interceptors\InterceptorInterface>|\Spiral\Interceptors\InterceptorInterface> $interceptors */
+            $interceptors = config('roadrunner.grpc.clients.interceptors', []);
+            $config = new GrpcClientConfig(
+                interceptors: $interceptors,
+                services: $serviceConfigs,
+            );
+
+            return new ServiceClientProvider($config, $this->app->make(FactoryInterface::class));
+        });
+
+    }
 }