[Logger] New Component (#120)

Author: JoshuaEstes

.gitattributes

@@ -0,0 +1,4 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore

.gitignore

@@ -0,0 +1,3 @@
+composer.lock
+phpunit.xml
+vendor/

Context.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger;
+
+use SonsOfPHP\Contract\Logger\ContextInterface;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+class Context implements ContextInterface
+{
+    public function __construct(
+        private array $context = [],
+    ) {}
+
+    public function all(): array
+    {
+        return $this->context;
+    }
+
+    public function offsetExists(mixed $offset): bool
+    {
+        if (!is_string($offset)) {
+            throw new \InvalidArgumentException('Only strings are supported as keys');
+        }
+
+        return array_key_exists($offset, $this->context);
+    }
+
+    public function offsetGet(mixed $offset): mixed
+    {
+        if (!is_string($offset)) {
+            throw new \InvalidArgumentException('Only strings are supported as keys');
+        }
+
+        return $this->context[$offset] ?? null;
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        if (!is_string($offset)) {
+            throw new \InvalidArgumentException('Only strings are supported as keys');
+        }
+
+        if (is_object($value) && !$value instanceof \Stringable) {
+            throw new \InvalidArgumentException('Only Stringable Objects are supported');
+        }
+
+        $this->context[$offset] = $value;
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        if (!is_string($offset)) {
+            throw new \InvalidArgumentException('Only strings are supported as keys');
+        }
+
+        if ($this->offsetExists($offset)) {
+            unset($this->context[$offset]);
+        }
+    }
+
+    public function getIterator(): \Traversable
+    {
+        return new \ArrayIterator($this->context);
+    }
+}

Enricher/GroupIdEnricher.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+class GroupIdEnricher implements EnricherInterface
+{
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        $context = $record->getContext();
+        $context['group_id'] = getmygid();
+
+        return $record->withContext($context);
+    }
+}

Enricher/InodeEnricher.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+class InodeEnricher implements EnricherInterface
+{
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        $context = $record->getContext();
+        $context['inode'] = getmyinode();
+
+        return $record->withContext($context);
+    }
+}

Enricher/MaskContextValueEnricher.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * This enricher allows you to mask data in the context.
+ *
+ * Examples:
+ *   new MaskContextValue('credit_card_number');
+ *   new MaskContextValue('cvv');
+ *   new MaskContextValue(['credit_card_number', 'cvv', 'password'], '*');
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+class MaskContextValueEnricher implements EnricherInterface
+{
+    /**
+     * You can add a single key or you can add an array of keys.
+     *
+     * If you pass in an array for the key, it will search the context keys and
+     * mask the values if any are found.
+     *
+     * The mask value can be changed as well.
+     */
+    public function __construct(
+        private array|string $key,
+        private string $maskValue = '****',
+    ) {}
+
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        $context = $record->getContext();
+
+        $keys = $this->key;
+
+        if (!is_array($keys)) {
+            $keys = [$keys];
+        }
+
+        foreach ($keys as $key) {
+            if (isset($context[$key])) {
+                $context[$key] = $this->maskValue;
+            }
+        }
+
+        return $record->withContext($context);
+    }
+}

Enricher/NullEnricher.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * The handler that says, "fuck your message"
+ *
+ * @author Joshua Estes <[email protected]>
+ */
+class NullEnricher implements EnricherInterface
+{
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        return $record;
+    }
+}

Enricher/ProcessIdEnricher.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+class ProcessIdEnricher implements EnricherInterface
+{
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        $context = $record->getContext();
+        $context['process_id'] = getmypid();
+
+        return $record->withContext($context);
+    }
+}

Enricher/ScriptOwnerEnricher.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+class ScriptOwnerEnricher implements EnricherInterface
+{
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        $context = $record->getContext();
+        $context['script_owner'] = get_current_user();
+
+        return $record->withContext($context);
+    }
+}

Enricher/UserIdEnricher.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * @author Joshua Estes <[email protected]>
+ */
+class UserIdEnricher implements EnricherInterface
+{
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        $context = $record->getContext();
+        $context['user_id'] = getmyuid();
+
+        return $record->withContext($context);
+    }
+}