Fix: log in gitignore

aidan-casey · aidan-casey · commit 5191d6157610 · 2025-04-29T10:34:03.000-04:00
diff --git a/.github/workflows/coding-conventions.yml b/.github/workflows/coding-conventions.yml
@@ -23,6 +23,12 @@ jobs:
           composer update --prefer-dist --no-interaction
           composer mago:install-binary
 
+      - name: Check Files
+        run: |
+          cat composer.json
+          ls -l packages/
+          ls -l packages/log
+
       - name: Run Mago 
         run: |
           ./vendor/bin/mago fmt --dry-run
diff --git a/.gitignore b/.gitignore
@@ -17,6 +17,7 @@ tempest.log
 public/static
 tests/Unit/Log
 log/
+!packages/log
 node_modules
 dist
 profile/
diff --git a/packages/log/.gitattributes b/packages/log/.gitattributes
@@ -0,0 +1,10 @@
+# Exclude build/test files from the release
+.github/                  export-ignore
+tests/                    export-ignore
+.gitattributes            export-ignore
+.gitignore                export-ignore
+phpunit.xml               export-ignore
+README.md                 export-ignore
+
+# Configure diff output for .php and .phar files.
+*.php diff=php
diff --git a/packages/log/LICENCE.md b/packages/log/LICENCE.md
@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brent Roose brendt@stitcher.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/log/composer.json b/packages/log/composer.json
@@ -0,0 +1,22 @@
+{
+    "name": "tempest/log",
+    "description": "A component for logging handling.",
+    "license": "MIT",
+    "minimum-stability": "dev",
+    "require": {
+        "php": "^8.4",
+        "monolog/monolog": "^3.7.0",
+        "psr/log": "^3.0.0",
+        "tempest/container": "dev-main"
+    },
+    "autoload": {
+        "psr-4": {
+            "Tempest\\Log\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tempest\\Log\\Tests\\": "tests"
+        }
+    }
+}
diff --git a/packages/log/phpunit.xml b/packages/log/phpunit.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
+    <testsuites>
+        <testsuite name="Tempest Log">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <source restrictNotices="true" restrictWarnings="true" ignoreIndirectDeprecations="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>
diff --git a/packages/log/src/Channels/AppendLogChannel.php b/packages/log/src/Channels/AppendLogChannel.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Log\Channels;
+
+use Monolog\Handler\StreamHandler;
+use Monolog\Level;
+use Monolog\Processor\PsrLogMessageProcessor;
+use Tempest\Log\LogChannel;
+
+final readonly class AppendLogChannel implements LogChannel
+{
+    public function __construct(
+        private string $path,
+        private bool $bubble = true,
+        private ?int $filePermission = null,
+        private bool $useLocking = false,
+    ) {}
+
+    public function getHandlers(Level $level): array
+    {
+        return [
+            new StreamHandler(
+                stream: $this->path,
+                level: $level,
+                bubble: $this->bubble,
+                filePermission: $this->filePermission,
+                useLocking: $this->useLocking,
+            ),
+        ];
+    }
+
+    public function getProcessors(): array
+    {
+        return [
+            new PsrLogMessageProcessor(),
+        ];
+    }
+
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+}
diff --git a/packages/log/src/Channels/DailyLogChannel.php b/packages/log/src/Channels/DailyLogChannel.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Log\Channels;
+
+use Monolog\Level;
+use Monolog\Processor\PsrLogMessageProcessor;
+use Tempest\Log\FileHandlers\RotatingFileHandler;
+use Tempest\Log\LogChannel;
+
+final readonly class DailyLogChannel implements LogChannel
+{
+    public function __construct(
+        private string $path,
+        private int $maxFiles = 31,
+        private bool $bubble = true,
+        private ?int $filePermission = null,
+        private bool $useLocking = false,
+    ) {}
+
+    public function getHandlers(Level $level): array
+    {
+        return [
+            new RotatingFileHandler(
+                filename: $this->path,
+                maxFiles: $this->maxFiles,
+                level: $level,
+                bubble: $this->bubble,
+                filePermission: $this->filePermission,
+                useLocking: $this->useLocking,
+                dateFormat: RotatingFileHandler::FILE_PER_DAY,
+            ),
+        ];
+    }
+
+    public function getProcessors(): array
+    {
+        return [
+            new PsrLogMessageProcessor(),
+        ];
+    }
+}
diff --git a/packages/log/src/Channels/WeeklyLogChannel.php b/packages/log/src/Channels/WeeklyLogChannel.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Log\Channels;
+
+use Monolog\Level;
+use Monolog\Processor\PsrLogMessageProcessor;
+use Tempest\Log\FileHandlers\RotatingFileHandler;
+use Tempest\Log\LogChannel;
+
+final readonly class WeeklyLogChannel implements LogChannel
+{
+    public function __construct(
+        private string $path,
+        private int $maxFiles = 5,
+        private bool $bubble = true,
+        private ?int $filePermission = null,
+        private bool $useLocking = false,
+    ) {}
+
+    public function getHandlers(Level $level): array
+    {
+        return [
+            new RotatingFileHandler(
+                filename: $this->path,
+                maxFiles: $this->maxFiles,
+                level: $level,
+                bubble: $this->bubble,
+                filePermission: $this->filePermission,
+                useLocking: $this->useLocking,
+                dateFormat: RotatingFileHandler::FILE_PER_WEEK,
+            ),
+        ];
+    }
+
+    public function getProcessors(): array
+    {
+        return [
+            new PsrLogMessageProcessor(),
+        ];
+    }
+}
diff --git a/packages/log/src/Config/logs.config.php b/packages/log/src/Config/logs.config.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Config;
+
+use Tempest\Log\LogConfig;
+
+use function Tempest\env;
+
+return new LogConfig(
+    debugLogPath: env('DEBUG_LOG_PATH'),
+    serverLogPath: env('SERVER_LOG_PATH'),
+);
diff --git a/packages/log/src/FileHandlers/RotatingFileHandler.php b/packages/log/src/FileHandlers/RotatingFileHandler.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Log\FileHandlers;
+
+use DateTimeImmutable;
+use InvalidArgumentException;
+use Monolog\Handler\RotatingFileHandler as MonoRotatingFileHandler;
+
+final class RotatingFileHandler extends MonoRotatingFileHandler
+{
+    public const string FILE_PER_WEEK = 'Y-W';
+
+    protected function setDateFormat(string $dateFormat): void
+    {
+        if (preg_match('{^[Yy](([/_.-]?m([/_.-]?d)?)|([/_.-]?W))?$}', $dateFormat) === 0) {
+            throw new InvalidArgumentException(
+                'Invalid date format - format must be one of ' .
+                    'RotatingFileHandler::FILE_PER_DAY ("Y-m-d"), RotatingFileHandler::FILE_PER_WEEK ("Y-W"), ' .
+                    'RotatingFileHandler::FILE_PER_MONTH ("Y-m") or RotatingFileHandler::FILE_PER_YEAR ("Y"), ' .
+                    'or you can set one of the date formats using slashes, underscores and/or dots instead of dashes.',
+            );
+        }
+
+        $this->dateFormat = $dateFormat;
+    }
+
+    protected function getNextRotation(): DateTimeImmutable
+    {
+        return match (str_replace(['/', '_', '.'], '-', $this->dateFormat)) {
+            self::FILE_PER_WEEK => new DateTimeImmutable('first day of next week')->setTime(0, 0, 0),
+            self::FILE_PER_MONTH => new DateTimeImmutable('first day of next month')->setTime(0, 0, 0),
+            self::FILE_PER_YEAR => new DateTimeImmutable('first day of January next year')->setTime(0, 0, 0),
+            default => new DateTimeImmutable('tomorrow')->setTime(0, 0, 0),
+        };
+    }
+}
diff --git a/packages/log/src/GenericLogger.php b/packages/log/src/GenericLogger.php
@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Log;
+
+use Monolog\Level as MonologLogLevel;
+use Monolog\Logger as Monolog;
+use Psr\Log\LogLevel as PsrLogLevel;
+use Stringable;
+use Tempest\EventBus\EventBus;
+
+final class GenericLogger implements Logger
+{
+    /** @var array<int, Monolog> */
+    private array $drivers = [];
+
+    public function __construct(
+        private readonly LogConfig $logConfig,
+        private readonly EventBus $eventBus,
+    ) {}
+
+    public function emergency(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::EMERGENCY, $message, $context);
+    }
+
+    public function alert(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::ALERT, $message, $context);
+    }
+
+    public function critical(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::CRITICAL, $message, $context);
+    }
+
+    public function error(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::ERROR, $message, $context);
+    }
+
+    public function warning(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::WARNING, $message, $context);
+    }
+
+    public function notice(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::NOTICE, $message, $context);
+    }
+
+    public function info(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::INFO, $message, $context);
+    }
+
+    public function debug(Stringable|string $message, array $context = []): void
+    {
+        $this->log(LogLevel::DEBUG, $message, $context);
+    }
+
+    /** @param MonologLogLevel|LogLevel|string $level */
+    public function log($level, Stringable|string $message, array $context = []): void
+    {
+        if (! ($level instanceof MonologLogLevel)) {
+            $level = match ($level) {
+                LogLevel::EMERGENCY, PsrLogLevel::EMERGENCY => MonologLogLevel::Emergency,
+                LogLevel::ALERT, PsrLogLevel::ALERT => MonologLogLevel::Alert,
+                LogLevel::CRITICAL, PsrLogLevel::CRITICAL => MonologLogLevel::Critical,
+                LogLevel::ERROR, PsrLogLevel::ERROR => MonologLogLevel::Error,
+                LogLevel::WARNING, PsrLogLevel::WARNING => MonologLogLevel::Warning,
+                LogLevel::NOTICE, PsrLogLevel::NOTICE => MonologLogLevel::Notice,
+                LogLevel::INFO, PsrLogLevel::INFO => MonologLogLevel::Info,
+                LogLevel::DEBUG, PsrLogLevel::DEBUG => MonologLogLevel::Debug,
+                default => MonologLogLevel::Info,
+            };
+        }
+
+        $this->writeLog($level, $message, $context);
+
+        $this->eventBus->dispatch(new MessageLogged(LogLevel::fromMonolog($level), $message, $context));
+    }
+
+    private function writeLog(MonologLogLevel $level, string $message, array $context): void
+    {
+        foreach ($this->logConfig->channels as $channel) {
+            $this->resolveDriver($channel, $level)->log($level, $message, $context);
+        }
+    }
+
+    private function resolveDriver(LogChannel $channel, MonologLogLevel $level): Monolog
+    {
+        if (! isset($this->drivers[spl_object_id($channel)])) {
+            $this->drivers[spl_object_id($channel)] = new Monolog(
+                name: $this->logConfig->prefix,
+                handlers: $channel->getHandlers($level),
+                processors: $channel->getProcessors(),
+            );
+        }
+
+        return $this->drivers[spl_object_id($channel)];
+    }
+}
diff --git a/packages/log/src/LogChannel.php b/packages/log/src/LogChannel.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Log;
+
+use Monolog\Handler\HandlerInterface;
+use Monolog\Level;
+use Monolog\Processor\ProcessorInterface;
+
+interface LogChannel
+{
+    /**
+     * @return array<array-key, HandlerInterface>
+     */
+    public function getHandlers(Level $level): array;
+
+    /**
+     * @return array<array-key, ProcessorInterface>
+     */
+    public function getProcessors(): array;
+}
diff --git a/packages/log/src/LogConfig.php b/packages/log/src/LogConfig.php
diff --git a/packages/log/src/LogLevel.php b/packages/log/src/LogLevel.php
diff --git a/packages/log/src/Logger.php b/packages/log/src/Logger.php
diff --git a/packages/log/src/LoggerInitializer.php b/packages/log/src/LoggerInitializer.php
diff --git a/packages/log/src/MessageLogged.php b/packages/log/src/MessageLogged.php
diff --git a/packages/log/tests/LogLevelTest.php b/packages/log/tests/LogLevelTest.php
