Merge pull request #257 from opcodesio/hide-unknown-log-files

hide unknown logs from the UI & API calls

Author: arukompas

config/log-viewer.php

@@ -160,6 +160,18 @@
         // 'my_secret.log'
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Hide unknown files.
+    |--------------------------------------------------------------------------
+    | The include/exclude options above might catch files which are not
+    | logs supported by Log Viewer. In that case, you can hide them
+    | from the UI and API calls by setting this to true.
+    |
+    */
+
+    'hide_unknown_files' => true,
+
     /*
     |--------------------------------------------------------------------------
     |  Shorter stack trace filters.

src/LogViewerService.php

@@ -101,6 +101,12 @@ public function getFiles(): LogFileCollection
                 ->unique()
                 ->map(fn ($filePath) => new $fileClass($filePath))
                 ->values();
+
+            if (config('log-viewer.hide_unknown_files', true)) {
+                $this->_cachedFiles = $this->_cachedFiles->filter(function (LogFile $file) {
+                    return ! $file->type()->isUnknown();
+                });
+            }
         }
 
         return $this->_cachedFiles;

src/Logs/LogType.php

@@ -56,4 +56,9 @@ public function logClass(): ?string
     {
         return app(LogTypeRegistrar::class)->getClass($this->value);
     }
+
+    public function isUnknown(): bool
+    {
+        return $this->value === static::DEFAULT;
+    }
 }

tests/Feature/ClearingFileCacheTest.php

@@ -7,6 +7,7 @@
 use function PHPUnit\Framework\assertNotSame;
 
 beforeEach(function () {
+    config(['log-viewer.hide_unknown_files' => false]);
     generateLogFiles(['laravel.log', 'other.log']);
     $this->file = LogViewer::getFile('laravel.log');
     $this->otherFile = LogViewer::getFile('other.log');

tests/Feature/LogViewerTest.php

@@ -5,7 +5,7 @@
 use function PHPUnit\Framework\assertNotContains;
 
 beforeEach(function () {
-    generateLogFiles(['laravel.log', 'other.log']);
+    generateLogFiles(['laravel.log', 'other.log'], randomContent: true, type: 'laravel');
 });
 
 it('properly includes log files', function () {
@@ -23,3 +23,14 @@
     assertContains('laravel.log', $fileNames);
     assertNotContains('other.log', $fileNames);
 });
+
+it('hides unknown log files', function () {
+    config()->set('log-viewer.hide_unknown_files', true);
+    $unknownFile = generateLogFile('unknown.log', content: 'unknown log content');
+
+    $fileNames = LogViewer::getFiles()->map->name;
+
+    assertNotContains($unknownFile->name, $fileNames);
+    assertContains('laravel.log', $fileNames);
+    assertContains('other.log', $fileNames);
+});

tests/Unit/FilePathsTest.php

@@ -3,6 +3,11 @@
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\LogViewerService;
 
+beforeEach(function () {
+    // irrelevant option for these tests, so let's show all files.
+    config(['log-viewer.hide_unknown_files' => false]);
+});
+
 test('handles square brackets in the logs path', function ($folderPath) {
     // Get the original path inside which we'll create a dummy folder with square brackets
     $originalBasePath = LogViewer::basePathForLogs();