ability to change root prefix; change to "log_sorting_order" which makes more sense;

Author: arukompas

config/log-viewer.php

@@ -268,8 +268,8 @@
         // Order to sort the folders. Other options: `Ascending`, `Descending`
         'folder_sorting_order' => SortingOrder::Descending,
 
-        // Order to sort the files. Other options: `Ascending`, `Descending`
-        'file_sorting_order' => SortingOrder::Descending,
+        // Order to sort the logs. Other options: `Ascending`, `Descending`
+        'log_sorting_order' => SortingOrder::Descending,
 
         // Number of results per page. Must be one of the above `per_page_options` values
         'per_page' => 25,
@@ -281,4 +281,16 @@
         'shorter_stack_traces' => false,
 
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Root folder prefix
+    |--------------------------------------------------------------------------
+    | The prefix for log files inside Laravel's `storage/logs` folder.
+    | Log Viewer does not show the full path to these files in the UI, 
+    | but only the filename prefixed with this value.
+    |
+    */
+
+    'root_folder_prefix' => 'root',
 ];

public/app.js

@@ -1,5 +1,5 @@
 {
-    "/app.js": "/app.js?id=601a9335bbd07ad6070f9d7da29cd3cb",
+    "/app.js": "/app.js?id=aad92fca2262c03653db52125757e99d",
     "/app.css": "/app.css?id=5593a0331dd40729ff41e32a6035d872",
     "/img/log-viewer-128.png": "/img/log-viewer-128.png?id=d576c6d2e16074d3f064e60fe4f35166",
     "/img/log-viewer-32.png": "/img/log-viewer-32.png?id=f8ec67d10f996aa8baf00df3b61eea6d",

public/mix-manifest.json

@@ -98,8 +98,8 @@
                     <ChevronRightIcon :class="[fileStore.isOpen(folder) ? 'rotate-90' : '', 'transition duration-100']" />
                   </span>
                   <span class="file-name">
-                    <span v-if="String(folder.clean_path || '').startsWith('root')">
-                      <span class="text-gray-500 dark:text-gray-400">root</span>{{ String(folder.clean_path).substring(4) }}
+                    <span v-if="String(folder.clean_path || '').startsWith(rootFolderPrefix)">
+                      <span class="text-gray-500 dark:text-gray-400">{{ rootFolderPrefix }}</span>{{ String(folder.clean_path).substring(rootFolderPrefix.length) }}
                     </span>
                     <span v-else>{{ folder.clean_path }}</span>
                   </span>
@@ -255,6 +255,8 @@ const selectFile = (fileIdentifier) => {
   }
 };
 
+const rootFolderPrefix = window.LogViewer?.root_folder_prefix || 'root';
+
 onMounted(async () => {
   hostStore.selectHost(route.query.host || null);
 });

resources/js/components/FileList.vue

@@ -37,8 +37,8 @@ export const useLogViewerStore = defineStore({
       ? useLocalStorage('logViewerResultsPerPage', window.LogViewer?.defaults?.per_page ?? 25) 
       : (window.LogViewer?.defaults?.per_page ?? 25),
     direction: shouldUseLocalStorage
-      ? useLocalStorage('logViewerDirection', window.LogViewer?.defaults?.file_sorting_order || 'desc') 
-      : (window.LogViewer?.defaults?.file_sorting_order || 'desc'),
+      ? useLocalStorage('logViewerDirection', window.LogViewer?.defaults?.log_sorting_order || 'desc') 
+      : (window.LogViewer?.defaults?.log_sorting_order || 'desc'),
     helpSlideOverOpen: false,
 
     // Log data

resources/js/stores/logViewer.js

@@ -3,6 +3,7 @@
 namespace Opcodes\LogViewer\Http\Controllers;
 
 use Opcodes\LogViewer\Facades\LogViewer;
+use Opcodes\LogViewer\LogFolder;
 use Opcodes\LogViewer\Utils\Utils;
 
 class IndexController
@@ -30,11 +31,12 @@ public function __invoke()
                 'per_page_options' => config('log-viewer.per_page_options') ?? [10, 25, 50, 100, 250, 500],
                 'defaults' => [
                     'use_local_storage' => config('log-viewer.defaults.use_local_storage'),
-                    'file_sorting_order' => config('log-viewer.defaults.file_sorting_order'),
+                    'log_sorting_order' => config('log-viewer.defaults.log_sorting_order'),
                     'per_page' => config('log-viewer.defaults.per_page'),
                     'theme' => config('log-viewer.defaults.theme'),
                     'shorter_stack_traces' => config('log-viewer.defaults.shorter_stack_traces'),
                 ],
+                'root_folder_prefix' => LogFolder::rootPrefix(),
             ],
         ]);
     }

src/Http/Controllers/IndexController.php

@@ -11,6 +11,7 @@ class LogFolder
 {
     public string $identifier;
     protected mixed $files;
+    protected static string $rootPrefix;
 
     public function __construct(
         public string $path,
@@ -38,15 +39,27 @@ public function isRoot(): bool
             || $this->path === rtrim(LogViewer::basePathForLogs(), DIRECTORY_SEPARATOR);
     }
 
+    /**
+     * Returns the prefix string used to represent the root folder.
+     */
+    public static function rootPrefix(): string
+    {
+        if (! isset(self::$rootPrefix)) {
+            self::$rootPrefix = config('log-viewer.root_folder_prefix', 'root');
+        }
+
+        return self::$rootPrefix;
+    }
+
     public function cleanPath(): string
     {
         if ($this->isRoot()) {
-            return 'root';
+            return self::rootPrefix();
         }
 
         $folder = $this->path;
 
-        $folder = str_replace(LogViewer::basePathForLogs(), 'root'.DIRECTORY_SEPARATOR, $folder);
+        $folder = str_replace(LogViewer::basePathForLogs(), self::rootPrefix().DIRECTORY_SEPARATOR, $folder);
 
         if ($unixHomePath = getenv('HOME')) {
             $folder = str_replace($unixHomePath, '~', $folder);

src/LogFolder.php

@@ -29,7 +29,7 @@ function assertCannotDownloadFolder(string $folderName): void
     generateLogFiles([$fileName = 'laravel.log']);
     $folder = LogViewer::getFolder('');
 
-    assertCanDownloadFolder($folder->identifier, 'root.zip');
+    assertCanDownloadFolder($folder->identifier, LogFolder::rootPrefix().'.zip');
 });
 
 test('cannot download a folder that\'s not found', function () {
@@ -47,7 +47,7 @@ function assertCannotDownloadFolder(string $folderName): void
     // now let's allow access again
     Gate::define('downloadLogFolder', fn (mixed $user) => true);
 
-    assertCanDownloadFolder($folder->identifier, 'root.zip');
+    assertCanDownloadFolder($folder->identifier, LogFolder::rootPrefix().'.zip');
 });
 
 test('"downloadLogFolder" gate is supplied with a log folder object', function () {
@@ -63,7 +63,7 @@ function assertCannotDownloadFolder(string $folderName): void
         return true;
     });
 
-    assertCanDownloadFolder($expectedFolder->identifier, 'root.zip');
+    assertCanDownloadFolder($expectedFolder->identifier, LogFolder::rootPrefix().'.zip');
 
     expect($gateChecked)->toBeTrue();
 });

tests/Feature/Authorization/CanDownloadFoldersTest.php

@@ -2,6 +2,7 @@
 
 use Opcodes\LogViewer\Enums\FolderSortingMethod;
 use Opcodes\LogViewer\Enums\SortingOrder;
+use Opcodes\LogViewer\LogFolder;
 
 use function Pest\Laravel\getJson;
 
@@ -23,8 +24,8 @@
 
     expect($response->json())->not->toHaveKey('data');
     $response->assertJsonCount(2)
-        ->assertJsonFragment(['clean_path' => 'root'.DIRECTORY_SEPARATOR.'one'])
-        ->assertJsonFragment(['clean_path' => 'root'.DIRECTORY_SEPARATOR.'two']);
+        ->assertJsonFragment(['clean_path' => LogFolder::rootPrefix().DIRECTORY_SEPARATOR.'one'])
+        ->assertJsonFragment(['clean_path' => LogFolder::rootPrefix().DIRECTORY_SEPARATOR.'two']);
 });
 
 it('folders are sorted alphabetically descending when configured', function () {
@@ -44,8 +45,8 @@
     $folders = $response->json();
     // Should be sorted: 'root', 'alpha', 'one', 'two'
     $response->assertJsonCount(4);
-    expect($folders[0]['clean_path'])->toBe('root');
-    expect($folders[1]['clean_path'])->toBe('root'.DIRECTORY_SEPARATOR.'alpha');
-    expect($folders[2]['clean_path'])->toBe('root'.DIRECTORY_SEPARATOR.'one');
-    expect($folders[3]['clean_path'])->toBe('root'.DIRECTORY_SEPARATOR.'two');
+    expect($folders[0]['clean_path'])->toBe(LogFolder::rootPrefix());
+    expect($folders[1]['clean_path'])->toBe(LogFolder::rootPrefix().DIRECTORY_SEPARATOR.'alpha');
+    expect($folders[2]['clean_path'])->toBe(LogFolder::rootPrefix().DIRECTORY_SEPARATOR.'one');
+    expect($folders[3]['clean_path'])->toBe(LogFolder::rootPrefix().DIRECTORY_SEPARATOR.'two');
 });

tests/Feature/LogFoldersControllerTest.php

@@ -123,7 +123,7 @@
 });
 
 test('LogFolderCollection can sort its folders alphabetically ascending, with root always on top', function () {
-    $rootFolder = Mockery::mock(new LogFolder('', []))->allows(['isRoot' => true, 'cleanPath' => 'root']);
+    $rootFolder = Mockery::mock(new LogFolder('', []))->allows(['isRoot' => true, 'cleanPath' => LogFolder::rootPrefix()]);
     $bFolder = Mockery::mock(new LogFolder('b', []))->allows(['isRoot' => false, 'cleanPath' => 'b']);
     $aFolder = Mockery::mock(new LogFolder('a', []))->allows(['isRoot' => false, 'cleanPath' => 'a']);
     $zFolder = Mockery::mock(new LogFolder('z', []))->allows(['isRoot' => false, 'cleanPath' => 'z']);
@@ -138,7 +138,7 @@
 });
 
 test('LogFolderCollection can sort its folders alphabetically descending, with root always on top', function () {
-    $rootFolder = Mockery::mock(new LogFolder('', []))->allows(['isRoot' => true, 'cleanPath' => 'root']);
+    $rootFolder = Mockery::mock(new LogFolder('', []))->allows(['isRoot' => true, 'cleanPath' => LogFolder::rootPrefix()]);
     $bFolder = Mockery::mock(new LogFolder('b', []))->allows(['isRoot' => false, 'cleanPath' => 'b']);
     $aFolder = Mockery::mock(new LogFolder('a', []))->allows(['isRoot' => false, 'cleanPath' => 'a']);
     $zFolder = Mockery::mock(new LogFolder('z', []))->allows(['isRoot' => false, 'cleanPath' => 'z']);