Add: URI Mask config para Hyperf 3.0.x (#24)

WIP

Author: celosauro

src/Aspect/HttpClientMetricAspect.php

@@ -44,10 +44,10 @@ public function process(ProceedingJoinPoint $proceedingJoinPoint)
         $method = strtoupper($arguments['keys']['method'] ?? '');
         $uri = $arguments['keys']['uri'] ?? '';
         $host = $base_uri === null ? (parse_url($uri, PHP_URL_HOST) ?? '') : $base_uri->getHost();
-
+        $uriMask = $this->getUriMask($instance);
         $uri = $this->shouldIgnoreUri($instance)
             ? '<IGNORED>'
-            : SupportUri::sanitize(parse_url($uri, PHP_URL_PATH) ?? '/');
+            : SupportUri::sanitize(parse_url($uri, PHP_URL_PATH) ?? '/', $uriMask);
 
         $labels = [
             'uri' => $uri,
@@ -99,4 +99,15 @@ private function onRejected(Timer $timer, array $labels): callable
             return Create::rejectionFor($exception);
         };
     }
+
+    public function getUriMask(Client $instance): array
+    {
+        $uriMask = $instance->getConfig('uri_mask');
+
+        if (is_array($uriMask) === false) {
+            return [];
+        }
+
+        return $uriMask;
+    }
 }

src/Support/Uri.php

@@ -13,21 +13,31 @@
 
 final class Uri
 {
-    public static function sanitize(string $uri): string
+    public static function sanitize(string $uri, array $uriMask = []): string
     {
         return preg_replace(
-            [
-                '/\/(?<=\/)([A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12})(?=\/)?/i',
-                '/\/(?<=\/)([A-Z]{3}-?\d[0-9A-Z]\d{2})(?=\/)?/i',
-                '/\/(?<=\/)[0-9A-F]{16,24}(?=\/)?/i',
-                '/\/(?<=\/)\d+(?=\/)?/',
-            ],
-            [
-                '/<UUID>',
-                '/<LICENSE-PLATE>',
-                '/<OID>',
-                '/<NUMBER>',
-            ],
+            array_merge(
+                array_keys($uriMask),
+                [
+                    '/\/(?<=\/)[ED]\d{8}\d{12}[0-9a-zA-Z]{11}(?=\/)?/',
+                    '/\/(?<=\/)[a-f0-9]{40}(?=\/)?/i',
+                    '/\/(?<=\/)([A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12})(?=\/)?/i',
+                    '/\/(?<=\/)([A-Z]{3}-?\d[0-9A-Z]\d{2})(?=\/)?/i',
+                    '/\/(?<=\/)[0-9A-F]{16,24}(?=\/)?/i',
+                    '/\/(?<=\/)\d+(?=\/)?/',
+                ],
+            ),
+            array_merge(
+                array_values($uriMask),
+                [
+                    '/<E2E-ID>',
+                    '/<SHA1>',
+                    '/<UUID>',
+                    '/<LICENSE-PLATE>',
+                    '/<OID>',
+                    '/<NUMBER>',
+                ],
+            ),
             '/' . ltrim($uri, '/'),
         );
     }

tests/Cases/UriTest.php

@@ -90,4 +90,20 @@ public function testAddsInitialSlash(): void
         self::assertSame('/v1/test', Uri::sanitize('v1/test'));
         self::assertSame('/v1/test/', Uri::sanitize('v1/test/'));
     }
+
+    public function testWithMaskParams(): void
+    {
+        $uriMask = [
+            '/\/[a-f0-9]{64}/i' => '/<SHA256-ID>',
+        ];
+
+        self::assertSame('/v1/test', Uri::sanitize('/v1/test', $uriMask));
+        self::assertSame('/v2/test/<SHA256-ID>', Uri::sanitize('/v2/test/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7', $uriMask));
+        self::assertSame('/v3/test/<SHA256-ID>/bar', Uri::sanitize('/v3/test/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/bar', $uriMask));
+        self::assertSame('/v4/test/<SHA256-ID>/bar/<SHA256-ID>/', Uri::sanitize('/v4/test/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/bar/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/', $uriMask));
+        self::assertSame('/v5/test/<SHA256-ID>/<SHA256-ID>', Uri::sanitize('/v5/test/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7', $uriMask));
+        self::assertSame('/v6/test/<SHA256-ID>/<SHA256-ID>/', Uri::sanitize('/v6/test/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/', $uriMask));
+        self::assertSame('/v7/test/<SHA256-ID>/<SHA256-ID>/<SHA256-ID>', Uri::sanitize('/v7/test/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7', $uriMask));
+        self::assertSame('/v8/test/<SHA256-ID>/<SHA256-ID>/<SHA256-ID>/', Uri::sanitize('/v8/test/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/54cf575c04fdef4667094b6fc4fab8014dd3fa53576b644ec399452c43b5e7f7/', $uriMask));
+    }
 }