Add codeql workflow

Author: abnegate

.github/workflows/codeql.yml

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

.gitignore

@@ -1,3 +1,4 @@
 vendor
 composer.lock
 .phpunit.result.cache
+.idea

Dockerfile

@@ -1,8 +1,6 @@
 FROM composer:2.0 AS step0
 
-
 ARG TESTING=true
-
 ENV TESTING=$TESTING
 
 WORKDIR /usr/local/src/
@@ -13,17 +11,16 @@ RUN composer update --ignore-platform-reqs --optimize-autoloader \
     --no-plugins --no-scripts --prefer-dist \
     `if [ "$TESTING" != "true" ]; then echo "--no-dev"; fi`
 
-FROM php:8.0-cli-alpine as final
+FROM php:8.4-cli-alpine3.21 AS final
 LABEL maintainer="team@appwrite.io"
 
 ENV DEBIAN_FRONTEND=noninteractive \
-    PHP_VERSION=8
+    PHP_VERSION=84
 
 RUN \
   apk add --no-cache --virtual .deps \
   supervisor php$PHP_VERSION php$PHP_VERSION-fpm nginx bash
 
-
 # Nginx Configuration (with self-signed ssl certificates)
 COPY ./tests/docker/nginx.conf /etc/nginx/nginx.conf
 

docker-compose.yml

@@ -1,10 +1,8 @@
-version: '3'
-
 services:
-    web:
-        build: .
-        ports:
-            - "9020:80"
-        volumes:
-            - ./tests:/usr/share/nginx/html/tests
-            - ./src:/usr/share/nginx/html/src
+  web:
+    build: .
+    ports:
+      - "9020:80"
+    volumes:
+      - ./tests:/usr/share/nginx/html/tests
+      - ./src:/usr/share/nginx/html/src

src/Platform/Action.php

@@ -41,16 +41,34 @@ abstract class Action
 
     protected ?string $desc = null;
 
+    /**
+     * @var array<string>
+     */
     protected array $groups = [];
 
+    /**
+     * @var callable
+     */
     protected $callback;
 
+    /**
+     * @var array<string, mixed>
+     */
     protected array $options = [];
 
+    /**
+     * @var array<string, array<string, mixed>>
+     */
     protected array $params = [];
 
+    /**
+     * @var array<int, string>
+     */
     protected array $injections = [];
 
+    /**
+     * @var array<string, mixed>
+     */
     protected array $labels = [];
 
     protected string $type = self::TYPE_DEFAULT;
@@ -104,7 +122,7 @@ public function desc(string $description): self
     /**
      * Get the value of groups
      *
-     * @return array
+     * @return array<string>
      */
     public function getGroups(): array
     {
@@ -114,7 +132,7 @@ public function getGroups(): array
     /**
      * Set Groups
      *
-     * @param  array  $groups
+     * @param  array<string>  $groups
      * @return self
      */
     public function groups(array $groups): self
@@ -150,7 +168,7 @@ public function callback(mixed $callback): self
     /**
      * Get the value of params
      *
-     * @return array
+     * @return array<string, array<string, mixed>>
      */
     public function getParams(): array
     {
@@ -165,7 +183,7 @@ public function getParams(): array
      * @param Validator|callable $validator
      * @param string $description
      * @param bool $optional
-     * @param array $injections
+     * @param array<string> $injections
      * @param bool $skipValidation
      * @param bool $deprecated
      * @param string $example
@@ -204,7 +222,7 @@ public function param(
     /**
      * Get the value of injections
      *
-     * @return array
+     * @return array<int, string>
      */
     public function getInjections(): array
     {
@@ -237,7 +255,7 @@ public function inject(string $injection): self
     /**
      * Get the value of labels
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function getLabels(): array
     {
@@ -261,7 +279,7 @@ public function label(string $key, mixed $value): self
     /**
      * Get Http Options
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function getOptions(): array
     {

src/Platform/Module.php

@@ -6,6 +6,9 @@
 
 abstract class Module
 {
+    /**
+     * @var array<string, array<string, Service>>
+     */
     protected array $services = [
         'all' => [],
         Service::TYPE_TASK => [],
@@ -19,7 +22,7 @@ abstract class Module
      *
      * @param  string  $key
      * @param  Service  $service
-     * @return Platform
+     * @return self
      */
     public function addService(string $key, Service $service): self
     {
@@ -33,7 +36,7 @@ public function addService(string $key, Service $service): self
      * Remove Service
      *
      * @param  string  $key
-     * @return Platform
+     * @return self
      */
     public function removeService(string $key): self
     {
@@ -68,7 +71,7 @@ public function getService(string $key): ?Service
     /**
      * Get Services
      *
-     * @return array
+     * @return array<string, Service>
      */
     public function getServices(): array
     {
@@ -79,7 +82,7 @@ public function getServices(): array
      * Get services by type
      *
      * @param  string  $type
-     * @return array<Service>
+     * @return array<string, Service>
      */
     public function getServicesByType(string $type): array
     {

src/Platform/Platform.php

@@ -33,6 +33,7 @@ public function __construct(Module $module)
     /**
      * Initialize Application
      *
+     * @param array<string, mixed> $params
      * @return void
      */
     public function init(string $type, array $params = []): void
@@ -71,7 +72,7 @@ public function init(string $type, array $params = []): void
     /**
      * Init HTTP service
      *
-     * @param  Service  $service
+     * @param  array<string, Service>  $services
      * @return void
      */
     protected function initHttp(array $services): void
@@ -94,7 +95,12 @@ protected function initHttp(array $services): void
                         break;
                     case Action::TYPE_DEFAULT:
                     default:
-                        $hook = App::addRoute($action->getHttpMethod(), $action->getHttpPath());
+                        $httpMethod = $action->getHttpMethod();
+                        $httpPath = $action->getHttpPath();
+                        if ($httpMethod === null || $httpPath === null) {
+                            throw new Exception('HTTP method and path must be set for default actions');
+                        }
+                        $hook = App::addRoute($httpMethod, $httpPath);
                         break;
                 }
 
@@ -143,6 +149,7 @@ protected function initHttp(array $services): void
     /**
      * Init CLI Services
      *
+     * @param  array<string, Service>  $services
      * @return void
      */
     protected function initTasks(array $services): void
@@ -193,7 +200,7 @@ protected function initTasks(array $services): void
     /**
      * Init worker Services
      *
-     * @param  array  $params
+     * @param  array<string, Service>  $services
      * @return void
      */
     protected function initWorker(array $services, string $workerName): void
@@ -310,7 +317,7 @@ public function getService(string $key): ?Service
     /**
      * Get Services
      *
-     * @return array
+     * @return array<string, Service>
      */
     public function getServices(): array
     {
@@ -362,7 +369,7 @@ public function setWorker(Server $worker): self
      * @param  string|null  $default
      * @return mixed
      */
-    public function getEnv(string $key, string $default = null): mixed
+    public function getEnv(string $key, ?string $default = null): mixed
     {
         return $_SERVER[$key] ?? $default;
     }

src/Platform/Scope/HTTP.php

@@ -10,6 +10,9 @@ trait HTTP
 
     protected ?string $httpAliasPath = null;
 
+    /**
+     * @var array<string, mixed>
+     */
     protected array $httpAliasParams = [];
 
     /**
@@ -41,9 +44,9 @@ public function setHttpMethod(string $method): self
     /**
      * Get httpPath
      *
-     * @return string
+     * @return string|null
      */
-    public function getHttpPath(): string
+    public function getHttpPath(): ?string
     {
         return $this->httpPath;
     }
@@ -61,7 +64,7 @@ public function getHttpAliasPath(): ?string
     /**
      * Get the value of httpAliasParams
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function getHttpAliasParams(): array
     {
@@ -71,9 +74,9 @@ public function getHttpAliasParams(): array
     /**
      * Get the value of httpMethod
      *
-     * @return string
+     * @return string|null
      */
-    public function getHttpMethod(): string
+    public function getHttpMethod(): ?string
     {
         return $this->httpMethod;
     }
@@ -82,7 +85,7 @@ public function getHttpMethod(): string
      * Set httpAlias path and params
      *
      * @param  string  $path
-     * @param  array  $params
+     * @param  array<string, mixed>  $params
      * @return self
      */
     public function httpAlias(string $path, array $params = []): self

src/Platform/Service.php

@@ -12,6 +12,9 @@ abstract class Service
 
     public const TYPE_WORKER = 'Worker';
 
+    /**
+     * @var array<string, Action>
+     */
     protected array $actions;
 
     protected string $type;
@@ -80,7 +83,7 @@ public function getAction(string $key): ?Action
     /**
      * Get Actions
      *
-     * @return array
+     * @return array<string, Action>
      */
     public function getActions(): array
     {

tests/Platform/TestActionCLI.php

@@ -18,7 +18,11 @@ public function __construct()
             });
     }
 
-    public function action($email, $list)
+    /**
+     * @param mixed $email
+     * @param mixed $list
+     */
+    public function action($email, $list): void
     {
         echo $email.'-'.implode('-', $list);
     }