Getting the runtime up to scratch

.github/workflows/ci.yml

@@ -17,8 +17,6 @@ jobs:
           - "lowest"
           - "highest"
         php-version:
-          - "8.1"
-          - "8.2"
           - "8.3"
         operating-system:
           - "ubuntu-latest"

composer.json

@@ -27,7 +27,6 @@
   "require": {
     "php": "^8.3",
     "juststeveking/php-sdk": "^3.0",
-    "treblle/cloudevent-php": "dev-main",
     "thecodingmachine/safe": "^2.5"
   },
   "require-dev": {

phpunit.xml

@@ -3,6 +3,7 @@
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          colors="true"
+         cacheResult="false"
 >
     <testsuites>
         <testsuite name="Test Suite">

pint.json

@@ -14,7 +14,7 @@
     "declare_parentheses": true,
     "declare_strict_types": true,
     "explicit_string_variable": true,
-    "final_class": true,
+    "final_class": false,
     "fully_qualified_strict_types": true,
     "global_namespace_import": {
       "import_classes": true,

src/Contracts/MaskingEngineContract.php

@@ -6,5 +6,5 @@
 
 interface MaskingEngineContract
 {
-    public function mask(array $payload): array;
+    public function mask(array $payload, string $type = 'body'): array;
 }

src/DataObjects/Config.php

@@ -4,18 +4,24 @@
 
 namespace Treblle\Runtime\DataObjects;
 
+/**
+ * @package Treblle Runtime
+ * @author Steve McDougall <[email protected]>
+ */
 final readonly class Config
 {
     /**
      * @param string $api_key
      * @param string $project_id
      * @param array<int,string> $ignored_environments
      * @param array<string,mixed> $masking
+     * @param array<int,string> $headers
      */
     public function __construct(
         public string $api_key,
         public string $project_id,
         public array $ignored_environments,
         public array $masking,
+        public array $headers,
     ) {}
 }

src/Factories/ConfigFactory.php

@@ -14,6 +14,7 @@ final class ConfigFactory
      *     project_id:string,
      *     ignored_environments:array<int,string>,
      *     masking:array<string,mixed>,
+     *     headers:array<int,string>,
      * } $config
      * @return Config
      */
@@ -24,6 +25,7 @@ public static function make(array $config): Config
             project_id: $config['project_id'],
             ignored_environments: $config['ignored_environments'],
             masking: $config['masking'],
+            headers: $config['headers'],
         );
     }
 }

src/Masking/MaskingEngine.php

@@ -15,9 +15,32 @@ public function __construct(
         private Config $config,
     ) {}
 
-    public function mask(array $payload): array
+    public function mask(array $payload, string $type = 'body'): array
     {
-        return $this->maskArray($payload, []);
+        if ('body' === $type) {
+            return $this->maskArray($payload, []);
+        }
+
+        if('headers' === $type) {
+            return $this->maskHeaders($payload);
+        }
+
+        return $payload;
+    }
+
+    private function maskHeaders(array $payload): array
+    {
+        $data = [];
+
+        foreach ($payload as $key => $value) {
+            if (in_array($key, $this->config->headers)) {
+                $data[$key] = (new StringMatcher())->input((string) $value)->mask();
+            } else {
+                $data[$key] = $value;
+            }
+        }
+
+        return $data;
     }
 
     private function maskArray(array $data, array $path): array
@@ -49,18 +72,23 @@ private function shouldMask(string $dotNotationKey): bool
                 return true;
             }
         }
+
         return false;
     }
 
     private function getMaskerClass(string $dotNotationKey): string
     {
+        /**
+         * @var string $pattern
+         * @var string $maskerClass
+         */
         foreach ($this->config->masking as $pattern => $maskerClass) {
             $regex = $this->convertPatternToRegex($pattern);
             if (preg_match($regex, $dotNotationKey)) {
                 return $maskerClass;
             }
         }
-        throw new \RuntimeException("No masker class found for key: $dotNotationKey");
+        throw new RuntimeException("No masker class found for key: {$dotNotationKey}");
     }
 
     private function convertPatternToRegex(string $pattern): string

src/Masking/StringMatcher.php

@@ -8,7 +8,7 @@
 
 class StringMatcher implements MasksInput
 {
-    private string $pattern;
+    protected string $pattern;
 
     protected string $input;