Merge pull request #51 from aldump/issue-50/debug-mode-for-server

Server error details #50

Author: wolfy-j

example/server/worker.php

@@ -9,6 +9,7 @@
 ini_set('display_errors', 'stderr');
 require "vendor/autoload.php";
 
+//To run server in debug mode - new \Spiral\GRPC\Server(null, ['debug' => true]);
 $server = new \Spiral\GRPC\Server();
 $server->registerService(\Service\EchoInterface::class, new EchoService());
 

src/Server.php

@@ -29,12 +29,19 @@ final class Server
     /** @var ServiceWrapper[] */
     private $services = [];
 
+    /**
+     * @var array
+     */
+    private $options;
+
     /**
      * @param InvokerInterface|null $invoker
+     * @param array $options
      */
-    public function __construct(InvokerInterface $invoker = null)
+    public function __construct(InvokerInterface $invoker = null, array $options = [])
     {
         $this->invoker = $invoker ?? new Invoker();
+        $this->options = $options;
     }
 
     /**
@@ -86,7 +93,13 @@ public function serve(Worker $worker, callable $finalize = null): void
             } catch (GRPCException $e) {
                 $worker->error($this->packError($e));
             } catch (\Throwable $e) {
-                $worker->error((string)$e);
+                if ($this->isDebugMode()) {
+                    $errorText = $e->__toString();
+                } else {
+                    $errorText = $e->getMessage();
+                }
+
+                $worker->error($errorText);
             } finally {
                 if ($finalize !== null) {
                     call_user_func($finalize, $e ?? null);
@@ -148,4 +161,20 @@ private function packError(GRPCException $e): string
 
         return implode('|:|', $data);
     }
+
+    /**
+     * If server runs in debug mode
+     *
+     * @return bool
+     */
+    private function isDebugMode(): bool
+    {
+        $debug = false;
+
+        if (isset($this->options['debug'])) {
+            $debug = filter_var($this->options['debug'], FILTER_VALIDATE_BOOLEAN);
+        }
+
+        return $debug;
+    }
 }

tests/GRPC/ServerTest.php

@@ -85,6 +85,28 @@ public function testNotFound2(): void
         $this->assertTrue($w->done());
     }
 
+    public function testServerDebugModeNotEnabled(): void
+    {
+        $s = new Server();
+        $s->registerService(TestInterface::class, new TestService());
+
+        $w = new TestWorker($this, [
+            [
+                'ctx'   => [
+                    'service' => 'service.Test',
+                    'method'  => 'Throw',
+                    'context' => [],
+                ],
+                'send'  => $this->packMessage('regularException'),
+                'error' => 'Just another exception'
+            ]
+        ]);
+
+        $s->serve($w);
+
+        $this->assertTrue($w->done());
+    }
+
     private function packMessage(string $message): string
     {
         $m = new Message();

tests/src/Test/TestService.php

@@ -33,6 +33,9 @@ public function Throw(ContextInterface $ctx, Message $in): Message
                 $grpcException = new GRPCException("main exception message", 3, [$detailsMessage]);
 
                 throw $grpcException;
+            case "regularException": {
+                throw new \Exception("Just another exception");
+            }
         }
 
         return $out;