Cleanup and Doc

Author: rxcod9

.github/workflows/docker-build.yml

@@ -1,12 +1,10 @@
 name: Docker Build & Push
 
 on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
+  workflow_run:
+    workflows: ["run-tests"]
+    types:
+      - completed
   workflow_dispatch: # manual trigger
 
 jobs:

.github/workflows/run-tests.yml

@@ -4,7 +4,7 @@ on:
     push:
     pull_request:
     schedule:
-        - cron: '0 0 * * *'
+        - cron: "0 0 * * *"
 
 jobs:
     run-tests:
@@ -14,39 +14,79 @@ jobs:
             matrix:
                 php: [8.4]
 
-        name: P${{ matrix.php }}
+        name: PHP ${{ matrix.php }}
 
         steps:
+            # --------------------------
+            # Update APT for runtime & build dependencies
+            # --------------------------
             - name: Update apt
               run: sudo apt-get update --fix-missing
 
+            # --------------------------
+            # Checkout code
+            # --------------------------
             - name: Checkout code
               uses: actions/checkout@v4
 
+            # --------------------------
+            # Setup PHP with all extensions
+            # --------------------------
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
                   php-version: ${{ matrix.php }}
-                  extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+                  extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, pdo_mysql, bcmath, soap, intl, gd, exif, iconv, imagick, sockets, opcache, redis, xdebug
                   coverage: none
-                  tools: composer, cs2pr # cs2pr converts phpcs/phpstan results into PR annotations
+                  tools: composer, cs2pr
 
+            # --------------------------
+            # Install runtime & build dependencies from Dockerfile
+            # --------------------------
+            - name: Install required system libraries
+              run: |
+                  sudo apt-get install -y git unzip libzip-dev libssl-dev libcurl4-openssl-dev \
+                  libnghttp2-dev libsqlite3-dev libpq-dev libbrotli-dev libc-ares-dev supervisor \
+                  autoconf build-essential pkg-config \
+                  && sudo rm -rf /var/lib/apt/lists/*
+
+            # --------------------------
+            # Cache Composer dependencies
+            # --------------------------
+            - name: Cache Composer
+              uses: actions/cache@v3
+              with:
+                  path: ~/.composer/cache
+                  key: composer-${{ matrix.php }}-${{ hashFiles('composer.lock') }}
+
+            # --------------------------
+            # Install PHP dependencies
+            # --------------------------
+            - name: Install dependencies
+              run: composer install --no-dev --optimize-autoloader --prefer-dist
+
+            # --------------------------
+            # Setup Problem Matchers
+            # --------------------------
             - name: Setup Problem Matches
               run: |
                   echo "::add-matcher::${{ runner.tool_cache }}/php.json"
                   echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
-            - name: Install dependencies
-              run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
-
+            # --------------------------
+            # Run PHP code quality checks
+            # --------------------------
             - name: Run PHPCS
               run: vendor/bin/phpcs ./src --encoding=utf-8 --standard=phpcs.xml --runtime-set testVersion 8.4 --parallel=1 --report=checkstyle | cs2pr
 
             - name: Run PHPMD
               run: vendor/bin/phpmd ./src text phpmd.xml | cs2pr
 
             - name: Run PHPStan
-              run: vendor/bin/phpstan analyse --configuration=phpstan.neon --memory-limit=-1 --error-format=checkstyle| cs2pr
+              run: vendor/bin/phpstan analyse --configuration=phpstan.neon --memory-limit=-1 --error-format=checkstyle | cs2pr
 
+            # --------------------------
+            # Execute PHPUnit tests
+            # --------------------------
             - name: Execute tests
               run: vendor/bin/phpunit

.php-cs-fixer.php

@@ -82,4 +82,6 @@
         // Misc spacing & braces
         'no_extra_blank_lines' => ['tokens' => ['extra','curly_brace_block','square_brace_block','parenthesis_brace_block','throw','use','return']],
         'braces' => ['allow_single_line_closure' => true,'position_after_functions_and_oop_constructs' => 'same'],
+        // disable only the new_expression_parentheses fixer
+        'new_expression_parentheses' => false,
     ]);

Dockerfile

@@ -1,27 +1,22 @@
 # Dockerfile for PHP Swoole CRUD Microservice
 #
 # This Dockerfile builds a PHP 8.4 CLI image with Swoole, Redis, Xdebug, Opcache, and other required extensions.
-# It uses a multi-stage build to compile Swoole and extensions, then creates a lightweight runtime image.
+# It uses a multi-stage build to compile Swoole and extensions, then creates a runtime image with all extensions included.
 #
-# Stages:
-#   1. build: Compiles Swoole and PHP extensions, installs Composer.
-#   2. runtime: Copies compiled extensions and Composer, installs runtime dependencies, and sets up the app.
+# Supervisor is used to run the PHP process and manage restarts.
 #
 # Exposes ports for Swoole HTTP servers.
 #
 # Usage:
 #   docker build -t php-swoole-crud-microservice .
 #   docker run -p 9501:9501 php-swoole-crud-microservice
 
-# ================= Build Stage =================
-FROM php:8.4-cli AS build
+# ================= Base Stage =================
+# Contains common runtime dependencies
+FROM php:8.4-cli AS base
 
-# --- System dependencies ---
-# Installs build tools and libraries required for compiling Swoole and PHP extensions.
-# Includes nghttp2 and zlib to ensure HTTP/2 and compression support are built in automatically.
+# --- Runtime system dependencies ---
 RUN apt-get update && apt-get install -y \
-    autoconf \
-    build-essential \
     git \
     libbrotli-dev \
     libc-ares-dev \
@@ -31,104 +26,81 @@ RUN apt-get update && apt-get install -y \
     libsqlite3-dev \
     libssl-dev \
     libzip-dev \
-    pkg-config \
+    supervisor \
     unzip \
-    zlib1g-dev \
     && rm -rf /var/lib/apt/lists/*
 
-RUN docker-php-ext-install sockets opcache
+# Create supervisor log directory
+RUN mkdir -p /var/log/supervisor
+
+# ================= Build Stage =================
+FROM base AS build
 
-# --- Build Swoole from source with required features ---
-# Deprecated options removed; HTTP/2, zlib, mysqlnd auto-enabled if dependencies are present.
+# --- Build-only dependencies ---
+RUN apt-get update && apt-get install -y \
+    autoconf \
+    build-essential \
+    pkg-config \
+    && rm -rf /var/lib/apt/lists/*
+
+# --- PHP extensions ---
+RUN docker-php-ext-install sockets opcache pdo pdo_mysql pdo_sqlite
+
+# --- Build Swoole from source with caching ---
 ARG SWOOLE_VERSION=6.0.0
-RUN git clone -b v${SWOOLE_VERSION} https://github.com/swoole/swoole-src.git /usr/src/swoole \
+RUN --mount=type=cache,target=/tmp/swoole-build \
+    git clone -b v${SWOOLE_VERSION} https://github.com/swoole/swoole-src.git /usr/src/swoole \
  && cd /usr/src/swoole \
  && phpize \
- && ./configure \
-    --enable-openssl \
-    --enable-sockets \
-    --enable-swoole-curl \
-    --enable-cares \
-    --enable-mysqlnd \
+ && ./configure --enable-openssl --enable-sockets --enable-swoole-curl --enable-cares --enable-mysqlnd \
  && make -j$(nproc) && make install \
  && docker-php-ext-enable swoole opcache
 
-# --- PHP extensions ---
-# Installs PDO extensions for MySQL and SQLite.
-RUN docker-php-ext-install pdo pdo_mysql pdo_sqlite
-
-# In build stage
-# RUN git clone https://github.com/OpenSwoole/mysql.git /usr/src/openswoole-mysql \
-#     && cd /usr/src/openswoole-mysql \
-#     && phpize \
-#     && ./configure \
-#     && make -j$(nproc) \
-#     && make install \
-#     && docker-php-ext-enable openswoole_mysql
-
-# --- phpredis extension ---
-# Installs and enables phpredis via PECL.
-RUN pecl install redis \
- && docker-php-ext-enable redis
-
-# --- Xdebug extension ---
-# Installs and enables Xdebug for debugging.
-RUN pecl install xdebug \
-    && docker-php-ext-enable xdebug
+# --- PECL extensions with caching ---
+RUN --mount=type=cache,target=/tmp/pecl \
+    pecl install redis xdebug \
+ && docker-php-ext-enable redis xdebug
 
 # --- Composer ---
-# Copies Composer binary from official Composer image.
 COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
 
-# ================= Runtime Stage =================
-FROM php:8.4-cli
+# --- Set working directory ---
+WORKDIR /app
 
-# --- Runtime system dependencies ---
-# Installs only the libraries required at runtime.
-RUN apt-get update && apt-get install -y \
-    git \
-    libbrotli-dev \
-    libc-ares-dev \
-    libcurl4-openssl-dev \
-    libnghttp2-dev \
-    libpq-dev \
-    libsqlite3-dev \
-    libssl-dev \
-    libzip-dev \
-    pkg-config \
-    unzip \
-    zlib1g-dev \
-    && rm -rf /var/lib/apt/lists/*
+# --- Copy only composer files first for caching ---
+COPY composer.json composer.lock* ./
 
-# --- Copy compiled PHP extensions and Composer ---
-COPY --from=build /usr/local/lib/php/extensions/ /usr/local/lib/php/extensions/
-COPY --from=build /usr/local/etc/php/conf.d/ /usr/local/etc/php/conf.d/
-COPY --from=build /usr/bin/composer /usr/bin/composer
+# --- Install application dependencies with caching ---
+RUN --mount=type=cache,target=/root/.composer/cache \
+    composer install --no-dev --optimize-autoloader --prefer-dist
+
+# --- Ensure logs directory exists ---
+RUN mkdir -p /app/logs
+
+# ================= Runtime Stage =================
+FROM base AS runtime
 
 # --- Set working directory ---
 WORKDIR /app
 
-# --- Composer install ---
-# Copies composer.json and optionally composer.lock, then installs dependencies.
-COPY composer.json ./
-RUN if [ -f composer.lock ]; then \
-      cp composer.lock composer.lock && \
-      composer install --no-dev --optimize-autoloader || true; \
-    fi
+# --- Copy compiled PHP extensions and Composer/vendor from build stage ---
+COPY --from=build /usr/local/lib/php/extensions/ /usr/local/lib/php/extensions/
+COPY --from=build /usr/local/etc/php/conf.d/ /usr/local/etc/php/conf.d/
+COPY --from=build /app/vendor /app/vendor
+# COPY --from=build /app /app
 
 # --- PHP configuration ---
-# Copies custom PHP configuration including opcache tuning.
 COPY docker/php/php.ini /usr/local/etc/php/conf.d/zz-preload.ini
 COPY docker/php/opcache.ini /usr/local/etc/php/conf.d/opcache.ini
 
-# --- Copy application source code ---
-COPY . .
+# --- Supervisor configuration ---
+COPY docker/supervisord.conf /etc/supervisor/conf.d/swoole.conf
 
-# --- Ensure logs directory exists ---
-RUN mkdir -p /app/logs
+# --- Copy all application source code in a single step ---
+COPY . .
 
 # --- Expose Swoole HTTP and custom ports ---
 EXPOSE 9501 9310 9502
 
 # --- Default command ---
-CMD ["php","public/index.php"]
+CMD ["/usr/bin/supervisord", "-c", "/etc/supervisor/conf.d/swoole.conf"]