Merge pull request #41 from utopia-php/feat-mask-fields

feat: mask fields

Author: christyjacob4

src/Logger/Log.php

@@ -82,6 +82,11 @@ class Log
      */
     protected array $breadcrumbs = [];
 
+    /**
+     * @var array<string> (optional)
+     */
+    protected array $masked = [];
+
     /**
      * Log constructor.
      */
@@ -299,7 +304,7 @@ public function addTag(string $key, string $value): void
      */
     public function getTags(): array
     {
-        return $this->tags;
+        return $this->mask($this->tags);
     }
 
     /**
@@ -321,7 +326,7 @@ public function addExtra(string $key, mixed $value): void
      */
     public function getExtra(): array
     {
-        return $this->extra;
+        return $this->mask($this->extra);
     }
 
     /**
@@ -365,4 +370,39 @@ public function getBreadcrumbs(): array
     {
         return $this->breadcrumbs;
     }
+
+    /**
+     * Set masked fields, which will be replaced by asterisks
+     *
+     * @param  array<string>  $masked
+     * @return void
+     */
+    public function setMasked(array $masked): void
+    {
+        $this->masked = $masked;
+    }
+
+    /**
+     * @template T
+     *
+     * @param  array<string, T>  $data
+     * @return array<string, T|string>
+     */
+    private function mask(array $data): array
+    {
+        $masked = [];
+
+        foreach ($data as $key => $value) {
+            if (is_string($value) && in_array($key, $this->masked, true)) {
+                $masked[$key] = str_repeat('*', strlen($value));
+            } elseif (is_array($value)) {
+                $maskedValue = $this->mask($value); /** @var T $maskedValue */
+                $masked[$key] = $maskedValue;
+            } else {
+                $masked[$key] = $value;
+            }
+        }
+
+        return $masked;
+    }
 }

tests/unit/LogTest.php

@@ -72,4 +72,31 @@ public function testLog(): void
         self::assertEquals('DELETE /api/v1/database/abcd1234/efgh5678', $log->getBreadcrumbs()[0]->getMessage());
         self::assertEquals($timestamp, $log->getBreadcrumbs()[0]->getTimestamp());
     }
+
+    public function testLogMasked(): void
+    {
+        $log = new Log();
+
+        $log->addTag('password', '123456');
+        $log->addExtra('name', 'John Doe');
+
+        self::assertEquals(['password' => '123456'], $log->getTags());
+        self::assertEquals(['name' => 'John Doe'], $log->getExtra());
+
+        $log->setMasked(['password', 'name']);
+
+        self::assertEquals(['password' => '******'], $log->getTags());
+        self::assertEquals(['name' => '********'], $log->getExtra());
+
+        // test nested array
+        $log->addExtra('user', ['password' => 'abc']);
+
+        self::assertEquals(['password' => '***'], $log->getExtra()['user']);
+
+        // test remove mask
+        $log->setMasked([]);
+
+        self::assertEquals(['password' => '123456'], $log->getTags());
+        self::assertEquals(['name' => 'John Doe', 'user' => ['password' => 'abc']], $log->getExtra());
+    }
 }