Added phpstan & phpunit

Added PayloadInterface.php for websocket connection

Author: ahmard

composer.json

@@ -18,7 +18,13 @@
         "php": ">=8.1",
         "guzzlehttp/psr7": "^2.0"
     },
+    "scripts": {
+        "analyse": "phpstan analyse",
+        "test": "phpunit"
+    },
     "require-dev": {
-        "openswoole/ide-helper": "^4.10"
+        "openswoole/ide-helper": "^4.10",
+        "phpstan/phpstan": "^1.4",
+        "phpunit/phpunit": "^9.5"
     }
 }

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+    level: 8
+    paths: ['src', 'tests']
+    checkMissingIterableValueType: false

phpunit.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+>
+    <testsuites>
+        <testsuite name="PHP RTC Websocket Server Tests">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/Http/HttpException.php

@@ -12,7 +12,7 @@ abstract public static function throw(
         string           $message,
         int              $code = 0,
         Throwable|null   $previous = null
-    );
+    ): never;
 
     abstract public function getRequest(): RequestInterface;
 }

src/Http/RequestMiddlewareInterface.php

@@ -2,7 +2,6 @@
 
 namespace RTC\Contracts\Http;
 
-use RTC\Http\Exceptions\MiddlewareException;
 use SplQueue;
 
 interface RequestMiddlewareInterface
@@ -21,7 +20,7 @@ public function push(MiddlewareInterface $middleware): void;
      * Executes next middleware in the queue
      *
      * @return void
-     * @throws MiddlewareException
+     * @throws HttpException
      */
     public function next(): void;
 
@@ -49,7 +48,7 @@ public function getCurrent(): null|MiddlewareInterface;
     /**
      * Retrieve middlewares queue object
      *
-     * @return SplQueue
+     * @return SplQueue<MiddlewareInterface>
      */
     public function getQueue(): SplQueue;
 }

src/Http/ResponseInterface.php

@@ -28,11 +28,11 @@ public function write(string $data): static;
     public function cookie(
         string $key,
         string $value = '',
-        int $expire = 0,
+        int    $expire = 0,
         string $path = '/',
         string $domain = '',
-        bool $secure = false,
-        bool $httponly = false,
+        bool   $secure = false,
+        bool   $httponly = false,
         string $samesite = '',
         string $priority = ''
     ): static;

src/Http/Router/CollectorInterface.php

@@ -2,6 +2,8 @@
 
 namespace RTC\Contracts\Http\Router;
 
+use FastRoute\RouteCollector;
+
 interface CollectorInterface
 {
     public function collectFile(string $filePath, array $routesInfo = []): static;
@@ -14,7 +16,7 @@ public function prefixDelimiter(string $delimiter): static;
 
     public function register(): static;
 
-    public function getFastRouteCollector(bool $createNew = false): \FastRoute\RouteCollector;
+    public function getFastRouteCollector(bool $createNew = false): RouteCollector;
 
     public function getCollectedRoutes(): array;
 

src/Websocket/FrameInterface.php

@@ -9,23 +9,30 @@ interface FrameInterface
     public function __construct(Frame $frame);
 
     /**
-     * Returns Swoole frame object
+     * Gets message sent from client
      *
-     * @return Frame
+     * @return mixed
      */
-    public function getFrame(): Frame;
+    public function getMessage(): mixed;
 
     /**
-     * Returns json-decoded message array
+     * Returns command name sent by client
      *
-     * @return array
+     * @return string|null
      */
-    public function getMessage(): array;
+    public function getCommand(): string|null;
 
     /**
-     * Returns json-decoded message array
+     * Returns payload-sent time
      *
      * @return string
      */
-    public function getRawMessage(): string;
+    public function getTime(): string;
+
+    /**
+     * Returns json-decoded message array
+     *
+     * @return PayloadInterface
+     */
+    public function getPayload(): PayloadInterface;
 }

src/Websocket/PayloadInterface.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace RTC\Contracts\Websocket;
+
+use Swoole\WebSocket\Frame;
+
+interface PayloadInterface
+{
+    public function __construct(Frame $frame);
+
+    /**
+     * Returns payload sent from client
+     *
+     * @return string
+     */
+    public function getRaw(): string;
+
+    /**
+     * Returns json-decoded client-sent payload
+     *
+     * @return array
+     */
+    public function getDecoded(): array;
+
+    /**
+     * Returns Swoole frame object
+     *
+     * @return Frame
+     */
+    public function getSwooleFrame(): Frame;
+
+    /**
+     * Returns time which the server receives this payload
+     *
+     * @return string
+     */
+    public function getServerTime(): string;
+
+}

src/Websocket/WebsocketHandlerInterface.php

@@ -3,7 +3,6 @@
 namespace RTC\Contracts\Websocket;
 
 use RTC\Server\Server;
-use RTC\Websocket\Frame;
 use Throwable;
 
 interface WebsocketHandlerInterface
@@ -14,11 +13,11 @@ public function __construct(Server $server);
      * Method that will be called when message is received
      *
      * @param ConnectionInterface $connection
-     * @param Frame $frame
+     * @param FrameInterface $frame
      * @return void
      * @throws Throwable
      */
-    public function onMessage(ConnectionInterface $connection, Frame $frame): void;
+    public function onMessage(ConnectionInterface $connection, FrameInterface $frame);
 
     /**
      * Method that will be called when new connection is received