Merge pull request #18 from aaheli8/main

4379 Feat: Add Code Analyzer

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,20 @@
+name: "CodeQL"
+
+on: [pull_request]
+jobs:
+  lint:
+    name: CodeQL
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 2
+
+    - run: git checkout HEAD^2
+
+    - name: Run CodeQL
+      run: |
+        docker run --rm -v $PWD:/app composer sh -c \
+        "composer install --profile --ignore-platform-reqs && composer check"

composer.json

@@ -4,6 +4,9 @@
     "type": "library",
     "keywords": ["php","framework", "upf", "utopia", "websocket"],
     "license": "MIT",
+    "scripts": {
+        "check": "./vendor/bin/phpstan analyse --level max src tests"
+    },
     "minimum-stability": "stable",
     "autoload": {
         "psr-4": {"Utopia\\WebSocket\\": "src/WebSocket"}
@@ -16,6 +19,7 @@
         "textalk/websocket": "1.5.2",
         "phpunit/phpunit": "^9.5.5",
         "vimeo/psalm": "^4.8.1",
-        "workerman/workerman": "^4.0"
+        "workerman/workerman": "^4.0",
+        "phpstan/phpstan": "^1.8"
     }
 }

src/WebSocket/Adapter.php

@@ -6,6 +6,10 @@ abstract class Adapter
 {
     protected string $host;
     protected int $port;
+      /**
+      * @var array<int|string,bool|int|string>
+      */
+
     protected array $config = [];
 
     function __construct(string $host = '0.0.0.0', int $port = 80) {
@@ -27,7 +31,7 @@ public abstract function shutdown(): void;
 
     /**
      * Sends a message to passed connections.
-     * @param array $connections Array of connection ID's.
+     * @param array<mixed,mixed> $connections Array of connection ID's.
      * @param string $message Message.
      * @return void 
      */
@@ -105,7 +109,7 @@ public abstract function getNative(): mixed;
 
     /**
      * Returns all connections.
-     * @return array 
+     * @return array<mixed>
      */
     public abstract function getConnections(): array;
 }

src/WebSocket/Adapter/Swoole.php

@@ -18,7 +18,9 @@ class Swoole extends Adapter
 
     protected string $host;
     protected int $port;
-
+     /**
+     * @var array<int|string,bool|int|string>
+     */
     private static array $connections = [];
 
     public function __construct(string $host = '0.0.0.0', int $port = 80)

src/WebSocket/Adapter/Workerman.php

@@ -25,18 +25,22 @@ public function __construct(string $host = '0.0.0.0', int $port = 80)
 
         $this->server = new Worker("websocket://{$this->host}:{$this->port}");
     }
-
+    
     public function start(): void
     {
         Worker::runAll();
-        call_user_func($this->callbackOnStart);
+        $callable = ($this->callbackOnStart);
+		if (!is_callable($callable)) {
+			throw new \Exception();
+		}
+		\call_user_func($callable);
     }
 
     public function shutdown(): void
     {
         Worker::stopAll();
     }
-
+    
     public function send(array $connections, string $message): void
     {
         foreach ($connections as $connection) {
@@ -65,10 +69,10 @@ public function onWorkerStart(callable $callback): self
 
     public function onOpen(callable $callback): self
     {
-        $this->server->onConnect = function (mixed $connection) use ($callback): void {
+        $this->server->onConnect = function ($connection) use ($callback): void {
             $connection->onWebSocketConnect = function(TcpConnection $connection) use ($callback): void
             {
-                /** @var array $_SERVER */
+                /** @var array<string> $_SERVER */
                 call_user_func($callback, $connection->id, $_SERVER);
             };
         };

src/WebSocket/Server.php

@@ -8,14 +8,14 @@
 
 class Server
 {
+
     /**
      * Callbacks that will be executed when an error occurs
-     *
-     * @var array
+     * 
+     * @var array<callable>
      */
     protected $errorCallbacks = [];
 
-
     protected Adapter $adapter;
 
     /**
@@ -59,7 +59,7 @@ public function shutdown(): void
 
     /**
      * Sends a message to passed connections.
-     * @param array $connections Array of connection ID's.
+     * @param array<mixed,mixed> $connections Array of connection ID's.
      * @param string $message Message.
      * @return void 
      */
@@ -182,8 +182,7 @@ public function onClose(callable $callback): self
 
     /**
      * Returns all connections.
-     * @param callable $callback
-     * @return array
+     * @return array<mixed>
      */
     public function getConnections(): array
     {
@@ -193,7 +192,6 @@ public function getConnections(): array
     /**
      * Register callback. Will be executed when error occurs.
      * @param callable $callback
-     * @param Throwable $error
      * @return self
      */
     public function error(callable $callback): self

tests/e2e/AdapterTest.php

@@ -25,7 +25,7 @@ public function testWorkerman(): void
         $this->testServer(8002);
     }
 
-    private function testServer(int $port)
+    private function testServer(int $port) :void
     {
         $client = $this->getWebsocket('localhost', $port);
         $client->send('ping');