V3 monolog 3

.github/workflows/docker/docker-compose.yml

@@ -26,7 +26,8 @@ services:
     php81:
         container_name: wonolog-php-81
         build:
-            context: ./php81
+            context: .
+            dockerfile: ./php81/Dockerfile
         depends_on:
             - db
         environment:
@@ -36,7 +37,8 @@ services:
     php82:
         container_name: wonolog-php-82
         build:
-            context: ./php82
+            context: .
+            dockerfile: ./php82/Dockerfile
         depends_on:
             - db
         environment:

.github/workflows/docker/php81/Dockerfile

@@ -10,4 +10,6 @@ RUN chmod +x /usr/bin/install-composer.sh && /usr/bin/install-composer.sh && mv
 COPY wait-for.sh /usr/bin/wait-for.sh
 RUN chmod +x /usr/bin/wait-for.sh
 
+RUN git config --global --add safe.directory /var/www/html
+
 WORKDIR /var/www/html

.github/workflows/docker/php82/Dockerfile

@@ -10,4 +10,6 @@ RUN chmod +x /usr/bin/install-composer.sh && /usr/bin/install-composer.sh && mv
 COPY wait-for.sh /usr/bin/wait-for.sh
 RUN chmod +x /usr/bin/wait-for.sh
 
+RUN git config --global --add safe.directory /var/www/html
+
 WORKDIR /var/www/html

.github/workflows/php-integration-tests.yml

@@ -23,6 +23,7 @@ jobs:
             fail-fast: false
             matrix:
                 php-service: [ '81', '82' ]
+                dependency-versions: [ 'lowest', 'highest' ]
         steps:
             -   name: Checkout
                 uses: actions/checkout@v3
@@ -34,4 +35,6 @@ jobs:
 
             -   name: Run integration tests
                 working-directory: .github/workflows/docker
-                run: docker compose run --rm php${{ matrix.php-service }} sh -c "wait-for.sh wonolog-db:3306 -t 15 -- composer update && composer tests:integration"
+                run: |
+                    COMPOSER_DEPENDENCY_VERSIONS=${{ matrix.dependency-versions == 'lowest' && '--prefer-lowest' || '' }}
+                    docker compose run --rm php${{ matrix.php-service }} sh -c "wait-for.sh wonolog-db:3306 -t 15 -- composer update $COMPOSER_DEPENDENCY_VERSIONS && composer tests:integration"

.github/workflows/php-static-analysis.yml

@@ -33,6 +33,7 @@ jobs:
         strategy:
             matrix:
                 php-version: ["8.1", "8.2", "8.3", "8.4"]
+                dependency-versions: ['highest', 'lowest']
         with:
             PHP_VERSION: ${{ matrix.php-version }}
 
@@ -44,9 +45,12 @@ jobs:
 
     static-code-analysis-php:
         if: ${{ (github.event_name != 'workflow_dispatch') || ((github.event.inputs.jobs == 'Run all') || (github.event.inputs.jobs == 'Run static analysis only')) }}
-        uses: inpsyde/reusable-workflows/.github/workflows/static-analysis-php.yml@main
+        uses: inpsyde/reusable-workflows/.github/workflows/static-analysis-php.yml@support_dependency_versions_in_static_analysis
         strategy:
             matrix:
                 php-version: ["8.1", "8.2", "8.3", "8.4"]
+                dependency-versions: ["lowest", "highest"]
         with:
             PHP_VERSION: ${{ matrix.php-version }}
+            PHPSTAN_ARGS: "--no-progress --memory-limit=1G"
+            DEPENDENCY_VERSIONS: ${{ matrix.dependency-versions }}

composer.json

@@ -41,7 +41,7 @@
         "php": ">=8.1 < 8.5",
         "psr/log": "^2.0||^3.0",
         "wecodemore/wordpress-early-hook": "^1.3.0",
-        "monolog/monolog": "^2.3.5"
+        "monolog/monolog": "^2.0||^3.0"
     },
     "require-dev": {
         "brain/monkey": "^2.6.1",

phpstan.neon.dist

@@ -13,6 +13,9 @@ parameters:
     paths:
         - src
     treatPhpDocTypesAsCertain: false
+    reportUnmatchedIgnoredErrors: false
     ignoreErrors:
         - '#Class PHPMailer not found.#'
         - '#Access to property \$\w+ on an unknown class PHPMailer#'
+        - '#has invalid return type Monolog\\LogRecord#'
+        - '#Instantiated class Monolog\\LogRecord not found#'

src/Configurator.php

@@ -813,7 +813,9 @@ protected function shouldSetup(): bool
 
         // We use WONOLOG_DISABLE instead of WONOLOG_ENABLE so that enabled is the default.
         $disabled = getenv('WONOLOG_DISABLE');
-        defined('WONOLOG_DISABLE') and $disabled = WONOLOG_DISABLE;
+        if (defined('WONOLOG_DISABLE')) {
+            $disabled = WONOLOG_DISABLE;
+        }
 
         /**
          * Filters whether to completely disable Wonolog.

src/DefaultHandler/FileHandler.php

@@ -13,6 +13,7 @@
 
 namespace Inpsyde\Wonolog\DefaultHandler;
 
+use Inpsyde\Wonolog\Levels;
 use Inpsyde\Wonolog\LogLevel;
 use Inpsyde\Wonolog\Processor;
 use Monolog\Formatter\FormatterInterface;
@@ -22,7 +23,7 @@
 use Monolog\Handler\NullHandler;
 use Monolog\Handler\ProcessableHandlerInterface;
 use Monolog\Handler\StreamHandler;
-use Monolog\Logger;
+use Monolog\LogRecord;
 use Monolog\ResettableInterface;
 
 class FileHandler implements
@@ -164,36 +165,37 @@ public function disableBuffering(): FileHandler
     }
 
     /**
-     * @param array $record
+     * @param array|LogRecord $record
      * @return bool
      *
      * @psalm-suppress MixedArgumentTypeCoercion
+     * @phpstan-ignore-next-line
      */
-    public function handle(array $record): bool
+    public function handle(array|LogRecord $record): bool
     {
         $this->ensureHandler();
-
         return $this->handler->handle($record);
     }
 
     /**
-     * @param array $record
+     * @param array|LogRecord $record
      * @return bool
      *
      * @psalm-suppress MixedArgumentTypeCoercion
+     * @phpstan-ignore-next-line
      */
-    public function isHandling(array $record): bool
+    public function isHandling(array|LogRecord $record): bool
     {
         $this->ensureHandler();
-
         return $this->handler->isHandling($record);
     }
 
     /**
-     * @param array<array> $records
+     * @param array<array>|array<LogRecord> $records
      * @return void
      *
      * @psalm-suppress MixedArgumentTypeCoercion
+     * @phpstan-ignore-next-line
      */
     public function handleBatch(array $records): void
     {
@@ -230,7 +232,7 @@ public function pushProcessor(callable $callback): HandlerInterface
     }
 
     /**
-     * @return callable(array):array
+     * @return callable(array):array | callable(LogRecord):LogRecord
      *
      * @psalm-suppress MixedReturnTypeCoercion
      * @psalm-suppress LessSpecificImplementedReturnType
@@ -278,7 +280,8 @@ public function getFormatter(): FormatterInterface
         /** @var FormatterInterface|null $noopFormatter */
         static $noopFormatter;
 
-        return $noopFormatter ?? $noopFormatter = new PassthroughFormatter();
+        return $noopFormatter
+            ?? $noopFormatter = new PassthroughFormatter();
     }
 
     /**
@@ -336,12 +339,12 @@ private function ensureHandler(): void
         if ($this->handler) {
             return;
         }
-
         try {
             $this->logFilePath = $this->logFilePath();
             $level = $this->minLevel ?? LogLevel::defaultMinLevel();
             if (!$level) {
-                $level = Logger::DEBUG;
+                /** @phpstan-ignore-next-line classConstant.deprecated */
+                $level = Levels::DEBUG;
             }
             $streamBuffer = $this->buffering || $this->bubble;
             $handler = new StreamHandler($this->logFilePath, $level, $streamBuffer, null, true);

src/DefaultHandler/PassthroughFormatter.php

@@ -5,14 +5,16 @@
 namespace Inpsyde\Wonolog\DefaultHandler;
 
 use Monolog\Formatter\FormatterInterface;
+use Monolog\LogRecord;
 
 class PassthroughFormatter implements FormatterInterface
 {
     /**
-     * @param array $record
+     * @param array|LogRecord $record
      * @return array
+     * @phpstan-ignore-next-line
      */
-    public function format(array $record): array
+    public function format(array|LogRecord $record): array|LogRecord
     {
         return $record;
     }

src/Levels.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Inpsyde\Wonolog;
+
+/**
+ * This is a copy of the Logger class in Monolog v2
+ */
+class Levels
+{
+    /**
+     * Detailed debug information
+     */
+    public const DEBUG = 100;
+
+    /**
+     * Interesting events
+     *
+     * Examples: User logs in, SQL logs.
+     */
+    public const INFO = 200;
+
+    /**
+     * Uncommon events
+     */
+    public const NOTICE = 250;
+
+    /**
+     * Exceptional occurrences that are not errors
+     *
+     * Examples: Use of deprecated APIs, poor use of an API,
+     * undesirable things that are not necessarily wrong.
+     */
+    public const WARNING = 300;
+
+    /**
+     * Runtime errors
+     */
+    public const ERROR = 400;
+
+    /**
+     * Critical conditions
+     *
+     * Example: Application component unavailable, unexpected exception.
+     */
+    public const CRITICAL = 500;
+
+    /**
+     * Action must be taken immediately
+     *
+     * Example: Entire website down, database unavailable, etc.
+     * This should trigger the SMS alerts and wake you up.
+     */
+    public const ALERT = 550;
+
+    /**
+     * Urgent alert.
+     */
+    public const EMERGENCY = 600;
+
+    /**
+     * This is a static variable and not a constant to serve as an extension point for custom levels
+     *
+     * @var array<int, string> $levels Logging levels with the levels as key
+     *
+     * @phpstan-var array<int, string> $levels Logging levels with the levels as key
+     */
+    protected static array $levels = [
+        self::DEBUG => 'DEBUG',
+        self::INFO => 'INFO',
+        self::NOTICE => 'NOTICE',
+        self::WARNING => 'WARNING',
+        self::ERROR => 'ERROR',
+        self::CRITICAL => 'CRITICAL',
+        self::ALERT => 'ALERT',
+        self::EMERGENCY => 'EMERGENCY',
+    ];
+
+    /**
+     * @return array<string, int>
+     */
+    public static function allLevels(): array
+    {
+        return array_flip(static::$levels);
+    }
+}

src/LogActionUpdater.php

@@ -48,7 +48,6 @@ public function update(LogData $log): void
         ) {
             return;
         }
-
         try {
             $context = $this->parseContext($log);
             $this->channels

src/LogLevel.php

@@ -4,22 +4,28 @@
 
 namespace Inpsyde\Wonolog;
 
-use Monolog\Logger;
-
 /**
  * Utility object used to build default min logging level based WordPress and environment settings.
  * It also has a method to check the validity of a value as level identifier.
  */
 abstract class LogLevel
 {
-    public const DEBUG = Logger::DEBUG;
-    public const INFO = Logger::INFO;
-    public const NOTICE = Logger::NOTICE;
-    public const WARNING = Logger::WARNING;
-    public const ERROR = Logger::ERROR;
-    public const CRITICAL = Logger::CRITICAL;
-    public const ALERT = Logger::ALERT;
-    public const EMERGENCY = Logger::EMERGENCY;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const DEBUG = Levels::DEBUG;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const INFO = Levels::INFO;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const NOTICE = Levels::NOTICE;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const WARNING = Levels::WARNING;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const ERROR = Levels::ERROR;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const CRITICAL = Levels::CRITICAL;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const ALERT = Levels::ALERT;
+    /** @phpstan-ignore-next-line classConstant.deprecated */
+    public const EMERGENCY = Levels::EMERGENCY;
 
     private static ?int $minLevel = null;
 
@@ -33,7 +39,7 @@ abstract class LogLevel
      */
     final public static function allLevels(): array
     {
-        return Logger::getLevels();
+        return Levels::allLevels();
     }
 
     /**
@@ -57,7 +63,8 @@ final public static function defaultMinLevel(): int
         // If no valid level is defined via env var, then let's resort to WP constants.
         if (!$minLevel) {
             $const = defined('WP_DEBUG_LOG') ? 'WP_DEBUG_LOG' : 'WP_DEBUG';
-            $minLevel = (defined($const) && constant($const)) ? Logger::DEBUG : Logger::WARNING;
+            /** @phpstan-ignore-next-line classConstant.deprecated */
+            $minLevel = (defined($const) && constant($const)) ? Levels::DEBUG : Levels::WARNING;
         }
 
         self::$minLevel = $minLevel;

src/MonologUtils.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Inpsyde\Wonolog;
+
+use Monolog\Logger;
+
+class MonologUtils
+{
+    public static function version(): int
+    {
+        return Logger::API;
+    }
+}