Merge pull request #279 from opcodesio/json-resource-wrapping-behaviour

fix JsonResource::withoutWrapping usage spilling outside the package
opcodesio · Sep 22, 2023 · f565a70 · f565a70
2 parents 1bcc3cc + 1c8dfe8
commit f565a70
Show file tree

Hide file tree

Showing 9 changed files with 85 additions and 10 deletions.
diff --git a/routes/api.php b/routes/api.php
@@ -2,10 +2,14 @@
 
 use Illuminate\Support\Facades\Route;
 use Opcodes\LogViewer\Http\Middleware\ForwardRequestToHostMiddleware;
+use Opcodes\LogViewer\Http\Middleware\JsonResourceWithoutWrappingMiddleware;
 
 Route::get('hosts', 'HostsController@index')->name('log-viewer.hosts');
 
-Route::middleware(ForwardRequestToHostMiddleware::class)->group(function () {
+Route::middleware([
+    ForwardRequestToHostMiddleware::class,
+    JsonResourceWithoutWrappingMiddleware::class,
+])->group(function () {
     Route::get('folders', 'FoldersController@index')->name('log-viewer.folders');
     Route::get('folders/{folderIdentifier}/download', 'FoldersController@download')->name('log-viewer.folders.download');
     Route::post('folders/{folderIdentifier}/clear-cache', 'FoldersController@clearCache')->name('log-viewer.folders.clear-cache');

diff --git a/src/Http/Controllers/FilesController.php b/src/Http/Controllers/FilesController.php
@@ -3,7 +3,6 @@
 namespace Opcodes\LogViewer\Http\Controllers;
 
 use Illuminate\Http\Request;
-use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Support\Facades\Gate;
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\Http\Resources\LogFileResource;
@@ -12,8 +11,6 @@ class FilesController
 {
     public function index(Request $request)
     {
-        JsonResource::withoutWrapping();
-
         $files = LogViewer::getFiles();
 
         if ($request->query('direction', 'desc') === 'asc') {

diff --git a/src/Http/Controllers/FoldersController.php b/src/Http/Controllers/FoldersController.php
@@ -3,7 +3,6 @@
 namespace Opcodes\LogViewer\Http\Controllers;
 
 use Illuminate\Http\Request;
-use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Support\Facades\Gate;
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\Http\Resources\LogFolderResource;
@@ -13,8 +12,6 @@ class FoldersController
 {
     public function index(Request $request)
     {
-        JsonResource::withoutWrapping();
-
         $folders = LogViewer::getFilesGroupedByFolder();
 
         if ($request->query('direction', 'desc') === 'asc') {

diff --git a/src/Http/Middleware/JsonResourceWithoutWrappingMiddleware.php b/src/Http/Middleware/JsonResourceWithoutWrappingMiddleware.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Opcodes\LogViewer\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class JsonResourceWithoutWrappingMiddleware
+{
+    public function handle(Request $request, Closure $next)
+    {
+        $originalWrappingBehaviour = JsonResource::$wrap;
+
+        JsonResource::withoutWrapping();
+
+        $response = $next($request);
+
+        JsonResource::wrap($originalWrappingBehaviour);
+
+        return $response;
+    }
+}
diff --git a/src/LogFile.php b/src/LogFile.php
@@ -14,8 +14,8 @@
 
 class LogFile
 {
-    use Concerns\LogFile\HasMetadata;
     use Concerns\LogFile\CanCacheData;
+    use Concerns\LogFile\HasMetadata;
 
     public string $path;
     public string $name;

diff --git a/src/LogIndex.php b/src/LogIndex.php
@@ -8,11 +8,11 @@
 
 class LogIndex
 {
-    use Concerns\LogIndex\HasMetadata;
     use Concerns\LogIndex\CanCacheIndex;
     use Concerns\LogIndex\CanFilterIndex;
     use Concerns\LogIndex\CanIterateIndex;
     use Concerns\LogIndex\CanSplitIndexIntoChunks;
+    use Concerns\LogIndex\HasMetadata;
     use Concerns\LogIndex\PreservesIndexingProgress;
 
     const DEFAULT_CHUNK_SIZE = 50_000;

diff --git a/src/Readers/BaseLogReader.php b/src/Readers/BaseLogReader.php
@@ -9,8 +9,8 @@
 
 abstract class BaseLogReader
 {
-    use Concerns\LogReader\KeepsInstances;
     use Concerns\LogReader\KeepsFileHandle;
+    use Concerns\LogReader\KeepsInstances;
 
     protected LogFile $file;
 

diff --git a/tests/Feature/LogFilesControllerTest.php b/tests/Feature/LogFilesControllerTest.php
@@ -0,0 +1,32 @@
+<?php
+
+use function Pest\Laravel\getJson;
+
+beforeEach(function () {
+    config(['log-viewer.include_files' => ['*.log']]);
+});
+
+it('can get the log files', function () {
+    $files = generateLogFiles([
+        '1.one.log',
+        '2.two.log',
+        '3.three.log',
+    ], randomContent: true);
+
+    $response = getJson(route('log-viewer.files'));
+
+    expect($response->json())->not->toHaveKey('data');
+    $response->assertJsonCount(count($files))
+        ->assertJsonFragment([
+            'name' => $files[0]->name,
+            'size' => $files[0]->size(),
+        ])
+        ->assertJsonFragment([
+            'name' => $files[1]->name,
+            'size' => $files[1]->size(),
+        ])
+        ->assertJsonFragment([
+            'name' => $files[2]->name,
+            'size' => $files[2]->size(),
+        ]);
+});
diff --git a/tests/Feature/LogFoldersControllerTest.php b/tests/Feature/LogFoldersControllerTest.php
@@ -0,0 +1,22 @@
+<?php
+
+use function Pest\Laravel\getJson;
+
+beforeEach(function () {
+    config(['log-viewer.include_files' => ['*/**.log']]);
+});
+
+it('can get the log files', function () {
+    generateLogFiles([
+        'one/1.one.log',
+        'one/2.two.log',
+        'two/3.three.log',
+    ], randomContent: true);
+
+    $response = getJson(route('log-viewer.folders'));
+
+    expect($response->json())->not->toHaveKey('data');
+    $response->assertJsonCount(2)
+        ->assertJsonFragment(['clean_path' => 'root'.DIRECTORY_SEPARATOR.'one'])
+        ->assertJsonFragment(['clean_path' => 'root'.DIRECTORY_SEPARATOR.'two']);
+});