Add search expressions (#26)

Author: frankdekker

README.md

@@ -84,4 +84,5 @@ By default, the application is available at: `{APP_URL}/log-viewer`.
 - [Disabling the default monolog configuration](docs/disabling-default-monolog-configuration.md)
 - [Adding additional log files](docs/adding-additional-log-files.md)
 - [Configuring the back home url](docs/configuring-the-back-home-route.md)
+- [Advanced search queries](docs/search-queries.md)
 - [Full configuration reference](docs/configuration-reference.md)

docs/advanced-search-queries.md

@@ -0,0 +1,39 @@
+# Searching logs
+
+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.                     |
+| `exclude:<word>`,`exclude:"<words>"` | `-`   | Exclude the specific sentence from the results. Can be specified multiple times |
+
+## Example
+
+Search all log entries between `2020-01-01` and `2020-01-31`, excluding all entries that contain the word `"Controller"` and must
+include `"Exception"`.
+
+```text
+before:2020-01-31 after:2020-01-01 exclude:Controller "Failed to read"
+```
+
+### In shorthand
+
+```text
+b:2020-01-31 a:2020-01-01 -:Controller "Failed to read"
+```
+
+### Multiple exclusions
+
+```text
+before:2020-01-31 after:2020-01-01 exclude:Controller exclude:404
+```
+
+### Handling whitespace
+
+If you want to search for a sentence that contains whitespace, you can use double quotes to indicate that the words should be treated as a single
+word.
+
+```text
+before:"2020-01-31 23:59:59" after:"2020-01-01 00:00:00" exclude:"new IndexController" "Failed to read"
+```

frontend/src/router/index.ts

@@ -1,3 +1,4 @@
+import ErrorView from '@/views/ErrorView.vue';
 import FileNotFoundView from '@/views/FileNotFoundView.vue';
 import HomeView from '@/views/HomeView.vue'
 import LogView from '@/views/LogView.vue';
@@ -21,6 +22,11 @@ function router(baseUri: string) {
                 path: '/404',
                 name: 'file-not-found',
                 component: FileNotFoundView
+            },
+            {
+                path: '/5XX',
+                name: 'error',
+                component: ErrorView
             }
         ]
     });

frontend/src/stores/log_records.ts

@@ -37,8 +37,14 @@ export const useLogRecordStore = defineStore('log_records', () => {
             const response = await axios.get<LogRecords>('/api/logs', {params: params});
             records.value  = response.data;
         } catch (e) {
+            if (e instanceof AxiosError && e.response?.status === 400) {
+                throw new Error('bad-request');
+            }
             if (e instanceof AxiosError && e.response?.status === 404) {
-                throw e;
+                throw new Error('file-not-found');
+            }
+            if (e instanceof AxiosError && [500, 501, 502, 503, 504].includes(Number(e.response?.status))) {
+                throw new Error('error');
             }
             console.error(e);
             records.value = defaultData;

frontend/src/views/ErrorView.vue

@@ -0,0 +1,21 @@
+<template>
+    <div class="failure">
+        <div class="alert alert-danger label">
+            An error occurred while reading the log file.
+        </div>
+    </div>
+</template>
+
+<style scoped>
+.failure {
+    position: relative;
+
+    .label {
+        position: absolute;
+        top: 50%;
+        left: 50%;
+        transform: translate(-50%, -50%);
+    }
+}
+</style>
+<script setup lang="ts"></script>

frontend/src/views/LogView.vue

@@ -14,13 +14,14 @@ const router         = useRouter();
 const route          = useRoute();
 const logRecordStore = useLogRecordStore();
 
-const file     = ref('');
-const query    = ref('');
-const levels   = ref<Checklist>({choices: {}, selected: []});
-const channels = ref<Checklist>({choices: {}, selected: []});
-const perPage  = ref('50');
-const sort     = ref('desc');
-const offset   = ref(0);
+const file       = ref('');
+const query      = ref('');
+const levels     = ref<Checklist>({choices: {}, selected: []});
+const channels   = ref<Checklist>({choices: {}, selected: []});
+const perPage    = ref('50');
+const sort       = ref('desc');
+const offset     = ref(0);
+const badRequest = ref(false);
 
 const navigate = () => {
     const fileOffset = offset.value > 0 && logRecordStore.records.paginator?.direction !== sort.value ? 0 : offset.value;
@@ -38,13 +39,21 @@ const navigate = () => {
 }
 
 const load = () => {
+    badRequest.value = false;
     logRecordStore
         .fetch(file.value, levels.value.selected, channels.value.selected, sort.value, perPage.value, query.value, offset.value)
         .then(() => {
             levels.value   = logRecordStore.records.levels;
             channels.value = logRecordStore.records.channels;
         })
-        .catch(() => router.push({name: 'file-not-found'}));
+        .catch((error: Error) => {
+            if (error.message === 'bad-request') {
+                badRequest.value = true;
+                return;
+            }
+
+            router.push({name: error.message});
+        });
 }
 
 onMounted(() => {
@@ -68,6 +77,7 @@ onMounted(() => {
             <div class="flex-grow-1 input-group">
                 <input type="text"
                        class="form-control"
+                       :class="{'is-invalid': badRequest}"
                        placeholder="Search log entries"
                        aria-label="Search log entries"
                        aria-describedby="button-search"

package-lock.json

@@ -3,12 +3,15 @@
 
 namespace FD\LogViewer\Controller;
 
+use Exception;
 use FD\LogViewer\Service\File\LogFileService;
 use FD\LogViewer\Service\File\LogQueryDtoFactory;
 use FD\LogViewer\Service\File\LogRecordsOutputProvider;
+use FD\LogViewer\Service\Parser\InvalidDateTimeException;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 class LogRecordsController extends AbstractController
@@ -20,10 +23,18 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @throws Exception
+     */
     public function __invoke(Request $request): JsonResponse
     {
-        $logQuery = $this->queryDtoFactory->create($request);
-        $file     = $this->fileService->findFileByIdentifier($logQuery->fileIdentifier);
+        try {
+            $logQuery = $this->queryDtoFactory->create($request);
+        } catch (InvalidDateTimeException $exception) {
+            throw new BadRequestHttpException('Invalid date.', $exception);
+        }
+
+        $file = $this->fileService->findFileByIdentifier($logQuery->fileIdentifier);
         if ($file === null) {
             throw new NotFoundHttpException(sprintf('Log file with id `%s` not found.', $logQuery->fileIdentifier));
         }

src/Controller/LogRecordsController.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace FD\LogViewer\Entity\Expression;
+
+use DateTimeImmutable;
+
+class DateAfterTerm implements TermInterface
+{
+    /**
+     * @codeCoverageIgnore Simple DTO
+     */
+    public function __construct(public readonly DateTimeImmutable $date)
+    {
+    }
+}

src/Entity/Expression/DateAfterTerm.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace FD\LogViewer\Entity\Expression;
+
+use DateTimeImmutable;
+
+class DateBeforeTerm implements TermInterface
+{
+    /**
+     * @codeCoverageIgnore Simple DTO
+     */
+    public function __construct(public readonly DateTimeImmutable $date)
+    {
+    }
+}