Add support for searching context and extra (#43)

frankdekker · web-flow · commit 2919173a5079 · 2024-02-05T23:44:10.000+01:00
diff --git a/docs/advanced-search-queries.md b/docs/advanced-search-queries.md
@@ -2,18 +2,20 @@
 
 The search query allows for more fine-grained control over the search results. The following operators are supported:
 
-| Operator                             | Short | Description                                                                     |
-|--------------------------------------|-------|---------------------------------------------------------------------------------|
-| `before:<date>`,`before:"<date>"`    | `b`   | Show all logs messages that occur before the specified date.                    |
-| `after:<date>`,`after:"<date>"`      | `a`   | Show all logs messages that occur after the specified date.                     |
-| `severity:<pipe-separated-string>`   | `s`   | Show all logs messages that match the given severity/severities.                |
-| `channel:<pipe-separated-string>`    | `c`   | Show all logs messages that match the given channel(s).                         |
-| `after:<date>`,`after:"<date>"`      | `a`   | Show all logs messages that occur after the specified date.                     |
-| `exclude:<word>`,`exclude:"<words>"` | `-`   | Exclude the specific sentence from the results. Can be specified multiple times |
+| Operator                                    | Short | Description                                                                     |
+|---------------------------------------------|-------|---------------------------------------------------------------------------------|
+| `before:<date>`,`before:"<date>"`           | `b`   | Show all logs messages that occur before the specified date.                    |
+| `after:<date>`,`after:"<date>"`             | `a`   | Show all logs messages that occur after the specified date.                     |
+| `severity:<pipe-separated-string>`          | `s`   | Show all logs messages that match the given severity/severities.                |
+| `channel:<pipe-separated-string>`           | `c`   | Show all logs messages that match the given channel(s).                         |
+| `after:<date>`,`after:"<date>"`             | `a`   | Show all logs messages that occur after the specified date.                     |
+| `exclude:<word>`,`exclude:"<words>"`        | `-`   | Exclude the specific sentence from the results. Can be specified multiple times |
+| `context:<string>`, `context:<key>=<value>` |       | Show all logs messages that match the given context.                            |
+| `extra:<string>`, `extra:<key>=<value>`     |       | Show all logs messages that match the given extra.                              |
 
 ## Example
 
-Search all log entries between `2020-01-01` and `2020-01-31`, for severity `warning` or `error`, in channel `app` 
+Search all log entries between `2020-01-01` and `2020-01-31`, for severity `warning` or `error`, in channel `app`
 excluding all entries that contain the word `"Controller"` and must include `"Exception"`.
 
 ```text
@@ -40,3 +42,18 @@ word.
 ```text
 before:"2020-01-31 23:59:59" after:"2020-01-01 00:00:00" exclude:"new IndexController" "Failed to read"
 ```
+
+### Searching context or extra
+
+Matches if at least one of the array values contains the given string:
+```text
+context:foo
+extra:bar
+```
+
+### Searching specific array key-values in context or extra:
+```text 
+context:userId=123
+context:request.uri=/api/v1/users
+extra:trace_id=12345ab
+```
diff --git a/src/Entity/Expression/KeyValueTerm.php b/src/Entity/Expression/KeyValueTerm.php
@@ -0,0 +1,19 @@
+<?php
+declare(strict_types=1);
+
+namespace FD\LogViewer\Entity\Expression;
+
+class KeyValueTerm implements TermInterface
+{
+    public const TYPE_CONTEXT = 'context';
+    public const TYPE_EXTRA   = 'extra';
+
+    /**
+     * @codeCoverageIgnore Simple DTO
+     * @param self::TYPE_*  $type
+     * @param string[]|null $keys
+     */
+    public function __construct(public readonly string $type, public readonly ?array $keys, public readonly string $value)
+    {
+    }
+}
diff --git a/src/Reader/String/StringReader.php b/src/Reader/String/StringReader.php
@@ -15,7 +15,7 @@ public function __construct(private readonly string $string)
         $this->length = strlen($this->string);
     }
 
-    public function get(): string
+    public function char(): string
     {
         return $this->string[$this->position];
     }
@@ -48,7 +48,7 @@ public function read(string $string): bool
      */
     public function skip(array $chars): self
     {
-        while ($this->eol() === false && in_array($this->get(), $chars, true)) {
+        while ($this->eol() === false && in_array($this->char(), $chars, true)) {
             $this->next();
         }
 
@@ -72,6 +72,7 @@ public function next(int $skip = 1): self
 
     /**
      * True if the end of line is reached
+     * @phpstan-impure
      */
     public function eol(): bool
     {
diff --git a/src/Resources/config/services.php b/src/Resources/config/services.php
@@ -31,11 +31,13 @@
 use FD\LogViewer\Service\Matcher\ChannelTermMatcher;
 use FD\LogViewer\Service\Matcher\DateAfterTermMatcher;
 use FD\LogViewer\Service\Matcher\DateBeforeTermMatcher;
+use FD\LogViewer\Service\Matcher\KeyValueMatcher;
 use FD\LogViewer\Service\Matcher\LogRecordMatcher;
 use FD\LogViewer\Service\Matcher\SeverityTermMatcher;
 use FD\LogViewer\Service\Matcher\WordTermMatcher;
 use FD\LogViewer\Service\Parser\DateParser;
 use FD\LogViewer\Service\Parser\ExpressionParser;
+use FD\LogViewer\Service\Parser\KeyValueParser;
 use FD\LogViewer\Service\Parser\QuotedStringParser;
 use FD\LogViewer\Service\Parser\StringParser;
 use FD\LogViewer\Service\Parser\TermParser;
@@ -46,6 +48,7 @@
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 use function Symfony\Component\DependencyInjection\Loader\Configurator\inline_service;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_iterator;
 
 return static function (ContainerConfigurator $container): void {
@@ -72,17 +75,20 @@
     $services->set(JsonManifestAssetLoader::class)
         ->arg('$manifestPath', '%kernel.project_dir%/public/bundles/fdlogviewer/.vite/manifest.json');
 
+    $services->set(StringParser::class)
+        ->arg('$quotedStringParser', inline_service(QuotedStringParser::class))
+        ->arg('$wordParser', inline_service(WordParser::class));
     $services->set(ExpressionParser::class)
         ->arg(
             '$termParser',
             inline_service(TermParser::class)
-                ->arg(
-                    '$stringParser',
-                    inline_service(StringParser::class)
-                        ->arg('$quotedStringParser', inline_service(QuotedStringParser::class))
-                        ->arg('$wordParser', inline_service(WordParser::class))
+                ->args(
+                    [
+                        service(StringParser::class),
+                        inline_service(DateParser::class),
+                        inline_service(KeyValueParser::class)->args([service(StringParser::class)])
+                    ]
                 )
-                ->arg('$dateParser', inline_service(DateParser::class))
         );
 
     $services->set(FinderFactory::class);
@@ -110,6 +116,7 @@
     $services->set(DateAfterTermMatcher::class)->tag('fd.symfony.log.viewer.term_matcher');
     $services->set(SeverityTermMatcher::class)->tag('fd.symfony.log.viewer.term_matcher');
     $services->set(ChannelTermMatcher::class)->tag('fd.symfony.log.viewer.term_matcher');
+    $services->set(KeyValueMatcher::class)->tag('fd.symfony.log.viewer.term_matcher');
     $services->set(WordTermMatcher::class)->tag('fd.symfony.log.viewer.term_matcher');
     $services->set(LogRecordMatcher::class)->arg('$termMatchers', tagged_iterator('fd.symfony.log.viewer.term_matcher'));
 };
diff --git a/src/Service/Matcher/KeyValueMatcher.php b/src/Service/Matcher/KeyValueMatcher.php
@@ -0,0 +1,67 @@
+<?php
+declare(strict_types=1);
+
+namespace FD\LogViewer\Service\Matcher;
+
+use FD\LogViewer\Entity\Expression\KeyValueTerm;
+use FD\LogViewer\Entity\Expression\TermInterface;
+use FD\LogViewer\Entity\Index\LogRecord;
+
+/**
+ * @implements TermMatcherInterface<KeyValueTerm>
+ */
+class KeyValueMatcher implements TermMatcherInterface
+{
+    public function supports(TermInterface $term): bool
+    {
+        return $term instanceof KeyValueTerm;
+    }
+
+    public function matches(TermInterface $term, LogRecord $record): bool
+    {
+        $data = $term->type === KeyValueTerm::TYPE_CONTEXT ? $record->context : $record->extra;
+
+        return $term->keys === null ? $this->matchValue($term->value, $data) : $this->matchKeysValue($term->keys, $term->value, $data);
+    }
+
+    /**
+     * @param string|array<int|string, mixed> $data
+     */
+    private function matchValue(string $term, string|array $data): bool
+    {
+        if (is_string($data)) {
+            return stripos($data, $term) !== false;
+        }
+
+        $match = false;
+        array_walk_recursive(
+            $data,
+            function ($value) use (&$match, $term) {
+                $match = $match || stripos((string)$value, $term) !== false;
+            }
+        );
+
+        return $match;
+    }
+
+    /**
+     * @param string[]                        $keys
+     * @param string|array<int|string, mixed> $data
+     */
+    private function matchKeysValue(array $keys, string $term, string|array $data): bool
+    {
+        if (is_string($data)) {
+            return stripos($data, $term) !== false;
+        }
+
+        $value = $data;
+        foreach ($keys as $key) {
+            if (is_array($value) === false || isset($value[$key]) === false) {
+                return false;
+            }
+            $value = $value[$key];
+        }
+
+        return is_scalar($value) && stripos((string)$value, $term) !== false;
+    }
+}
diff --git a/src/Service/Parser/ExpressionParser.php b/src/Service/Parser/ExpressionParser.php
@@ -9,11 +9,13 @@
 /**
  * BNF:
  * <expression> ::= <term> | <term> <expression>
- * <term> ::= <date-term> | <exclude-term> | <severity-term> | <channel-term> <string>
+ * <term> ::= <date-term> | <exclude-term> | <severity-term> | <channel-term> <string> | <context-term> | <extra-term>
  * <date-term> ::= before:<string> | af
  * <severity-term> ::= severity:<string>
  * <channel-term> ::= channel:<string>
  * <exclude-term> ::= exclude:<string>
+ * <context-term> ::= context:<string> | context:<key>=<string>
+ * <extra-term> ::= extra:<string> | extra:<key>=<string>
  * <string> ::= "<characters without unescaped double quote>" | '<characters without unescaped quote>' | <characters-without-space>
  */
 class ExpressionParser
diff --git a/src/Service/Parser/KeyValueParser.php b/src/Service/Parser/KeyValueParser.php
@@ -0,0 +1,46 @@
+<?php
+declare(strict_types=1);
+
+namespace FD\LogViewer\Service\Parser;
+
+use FD\LogViewer\Entity\Expression\KeyValueTerm;
+use FD\LogViewer\Reader\String\StringReader;
+
+class KeyValueParser
+{
+    public function __construct(private readonly StringParser $stringParser)
+    {
+    }
+
+    /**
+     * @phpstan-param KeyValueTerm::TYPE_* $type
+     */
+    public function parse(string $type, StringReader $string): KeyValueTerm
+    {
+        $value = $this->stringParser->parse($string, ['.', '=']);
+        if ($string->eol()) {
+            return new KeyValueTerm($type, null, $value);
+        }
+
+        $keys = [$value];
+        if ($string->char() === '.') {
+            while ($string->eol() === false && $string->char() === '.') {
+                $string->next();
+                $keys[] = $this->stringParser->parse($string, ['.', '=']);
+            }
+
+            if ($string->char() !== '=') {
+                return new KeyValueTerm($type, null, implode('.', $keys));
+            }
+        }
+
+        if ($string->char() === '=') {
+            // skip =
+            $string->next();
+
+            return new KeyValueTerm($type, $keys, $this->stringParser->parse($string));
+        }
+
+        return new KeyValueTerm($type, null, $value);
+    }
+}
diff --git a/src/Service/Parser/QuotedStringParser.php b/src/Service/Parser/QuotedStringParser.php
@@ -15,7 +15,7 @@ public function parse(StringReader $string, string $quote, string $escapeChar):
         $result  = '';
         $escaped = false;
         for (; $string->eol() === false; $string->next()) {
-            $char = $string->get();
+            $char = $string->char();
 
             // skip the escape character
             if ($char === $escapeChar && $escaped === false) {
diff --git a/src/Service/Parser/StringParser.php b/src/Service/Parser/StringParser.php
@@ -11,12 +11,15 @@ public function __construct(private readonly QuotedStringParser $quotedStringPar
     {
     }
 
-    public function parse(StringReader $string): string
+    /**
+     * @param string[] $stopAt
+     */
+    public function parse(StringReader $string, array $stopAt = []): string
     {
-        if (in_array($string->get(), ['"', "'"], true)) {
-            return $this->quotedStringParser->parse($string, $string->get(), '\\');
+        if ($string->eol() === false && in_array($string->char(), ['"', "'"], true)) {
+            return $this->quotedStringParser->parse($string, $string->char(), '\\');
         }
 
-        return $this->wordParser->parse($string);
+        return $this->wordParser->parse($string, $stopAt);
     }
 }
diff --git a/src/Service/Parser/TermParser.php b/src/Service/Parser/TermParser.php
@@ -6,6 +6,7 @@
 use FD\LogViewer\Entity\Expression\ChannelTerm;
 use FD\LogViewer\Entity\Expression\DateAfterTerm;
 use FD\LogViewer\Entity\Expression\DateBeforeTerm;
+use FD\LogViewer\Entity\Expression\KeyValueTerm;
 use FD\LogViewer\Entity\Expression\SeverityTerm;
 use FD\LogViewer\Entity\Expression\TermInterface;
 use FD\LogViewer\Entity\Expression\WordTerm;
@@ -19,8 +20,11 @@
  */
 class TermParser
 {
-    public function __construct(private readonly StringParser $stringParser, private readonly DateParser $dateParser)
-    {
+    public function __construct(
+        private readonly StringParser $stringParser,
+        private readonly DateParser $dateParser,
+        private readonly KeyValueParser $keyValueParser
+    ) {
     }
 
     /**
@@ -50,6 +54,14 @@ public function parse(StringReader $string): TermInterface
             return new WordTerm($this->stringParser->parse($string), WordTerm::TYPE_EXCLUDE);
         }
 
+        if ($string->read('context:')) {
+            return $this->keyValueParser->parse(KeyValueTerm::TYPE_CONTEXT, $string);
+        }
+
+        if ($string->read('extra:')) {
+            return $this->keyValueParser->parse(KeyValueTerm::TYPE_EXTRA, $string);
+        }
+
         return new WordTerm($this->stringParser->parse($string), WordTerm::TYPE_INCLUDE);
     }
 }
diff --git a/src/Service/Parser/WordParser.php b/src/Service/Parser/WordParser.php
@@ -9,12 +9,15 @@ class WordParser
 {
     public const WHITESPACE = [' ' => true, "\t" => true, "\n" => true, "\r" => true];
 
-    public function parse(StringReader $string): string
+    /**
+     * @param string[] $stopAt
+     */
+    public function parse(StringReader $string, array $stopAt = []): string
     {
         $result = '';
         for (; $string->eol() === false; $string->next()) {
-            $char = $string->get();
-            if (isset(self::WHITESPACE[$char])) {
+            $char = $string->char();
+            if (isset(self::WHITESPACE[$char]) || in_array($char, $stopAt, true)) {
                 break;
             }
             $result .= $char;
diff --git a/tests/Integration/Service/Parser/ExpressionParserTest.php b/tests/Integration/Service/Parser/ExpressionParserTest.php
diff --git a/tests/Integration/Service/Parser/KeyValueParserTest.php b/tests/Integration/Service/Parser/KeyValueParserTest.php
diff --git a/tests/Unit/Reader/String/StringReaderTest.php b/tests/Unit/Reader/String/StringReaderTest.php
diff --git a/tests/Unit/Service/Matcher/KeyValueMatcherTest.php b/tests/Unit/Service/Matcher/KeyValueMatcherTest.php
diff --git a/tests/Unit/Service/Parser/TermParserTest.php b/tests/Unit/Service/Parser/TermParserTest.php

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public function __construct(private readonly string $string)`
`15`	`15`	`$this->length = strlen($this->string);`
`16`	`16`	`}`
`17`	`17`
`18`		`- public function get(): string`
	`18`	`+ public function char(): string`
`19`	`19`	`{`
`20`	`20`	`return $this->string[$this->position];`
`21`	`21`	`}`
`@@ -48,7 +48,7 @@ public function read(string $string): bool`
`48`	`48`	`*/`
`49`	`49`	`public function skip(array $chars): self`
`50`	`50`	`{`
`51`		`- while ($this->eol() === false && in_array($this->get(), $chars, true)) {`
	`51`	`+ while ($this->eol() === false && in_array($this->char(), $chars, true)) {`
`52`	`52`	`$this->next();`
`53`	`53`	`}`
`54`	`54`
`@@ -72,6 +72,7 @@ public function next(int $skip = 1): self`
`72`	`72`
`73`	`73`	`/**`
`74`	`74`	`* True if the end of line is reached`
	`75`	`+ * @phpstan-impure`
`75`	`76`	`*/`
`76`	`77`	`public function eol(): bool`
`77`	`78`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,12 +11,15 @@ public function __construct(private readonly QuotedStringParser $quotedStringPar`
`11`	`11`	`{`
`12`	`12`	`}`
`13`	`13`
`14`		`- public function parse(StringReader $string): string`
	`14`	`+ /**`
	`15`	`+ * @param string[] $stopAt`
	`16`	`+ */`
	`17`	`+ public function parse(StringReader $string, array $stopAt = []): string`
`15`	`18`	`{`
`16`		`- if (in_array($string->get(), ['"', "'"], true)) {`
`17`		`- return $this->quotedStringParser->parse($string, $string->get(), '\\');`
	`19`	`+ if ($string->eol() === false && in_array($string->char(), ['"', "'"], true)) {`
	`20`	`+ return $this->quotedStringParser->parse($string, $string->char(), '\\');`
`18`	`21`	`}`
`19`	`22`
`20`		`- return $this->wordParser->parse($string);`
	`23`	`+ return $this->wordParser->parse($string, $stopAt);`
`21`	`24`	`}`
`22`	`25`	`}`