Custom middleware for repositories (#194)

* Custom middleware

* Apply fixes from StyleCI (#193)

Author: binaryk

src/Http/Controllers/ProfileAvatarController.php

@@ -25,6 +25,6 @@ public function __invoke(ProfileAvatarRequest $request)
 
         $user->{ProfileAvatarRequest::$userAvatarAttribute} = url($user->{ProfileAvatarRequest::$userAvatarAttribute});
 
-        return $this->response()->data($user);
+        return $this->response()->model($user);
     }
 }

src/Http/Controllers/ProfileController.php

@@ -15,6 +15,6 @@ public function __invoke(RestifyRequest $request)
             $user->{ProfileAvatarRequest::$userAvatarAttribute} = url($user->{ProfileAvatarRequest::$userAvatarAttribute});
         }
 
-        return $this->response()->data($user);
+        return $this->response()->model($user);
     }
 }

src/Http/Controllers/RepositoryIndexController.php

@@ -18,8 +18,6 @@ public function __invoke(RepositoryIndexRequest $request)
                 ->dump($e, $request->isDev());
         } catch (UnauthorizedException $e) {
             return $this->response()->forbidden()->addError($e->getMessage())->dump($e, $request->isDev());
-        } catch (\Throwable $e) {
-            return $this->response()->error()->dump($e, $request->isDev());
         }
     }
 }

src/Http/Requests/InteractWithRepositories.php

@@ -7,6 +7,7 @@
 use Binaryk\LaravelRestify\Repositories\Repository;
 use Binaryk\LaravelRestify\Restify;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Pipeline\Pipeline;
 
 /**
  * @author Eduard Lupacescu <[email protected]>
@@ -49,6 +50,11 @@ public function repository($key = null): ?Repository
                     'name' => $repository,
                 ]), 403);
             }
+
+            app(Pipeline::class)
+                ->send($this)
+                ->through($repository::collectMiddlewares()->toArray())
+                ->thenReturn();
         });
 
         return $repository::resolveWith($repository::newModel());

src/Http/Requests/RestifyRequest.php

@@ -2,7 +2,6 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-use Binaryk\LaravelRestify\Restify;
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Support\Facades\App;
 

src/Repositories/Repository.php

@@ -97,6 +97,13 @@ abstract class Repository implements RestifySearchable, JsonSerializable
      */
     public static $globalSearchResults = 5;
 
+    /**
+     * The list of middlewares for the current repository.
+     *
+     * @var array
+     */
+    public static $middlewares = [];
+
     /**
      * Get the underlying model instance for the resource.
      *
@@ -731,4 +738,9 @@ public function availableFilters(RestifyRequest $request)
         return collect($this->filter($this->filters($request)))->each(fn (Filter $filter) => $filter->authorizedToSee($request))
             ->values();
     }
+
+    public static function collectMiddlewares(): Collection
+    {
+        return collect(static::$middlewares);
+    }
 }

tests/Controllers/GlobalSearchControllerTest.php

@@ -58,7 +58,8 @@ public function test_global_search_filter_will_filter_with_index_query()
 
         $response = $this
             ->withoutExceptionHandling()
-            ->getJson('/restify-api/search?search=1');
+            ->getJson('/restify-api/search?search=1')
+            ->dump();
 
         $this->assertCount(1, $response->json('data'));
 

tests/Controllers/RepositoryMiddlewaresTest.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Controllers;
+
+use Binaryk\LaravelRestify\Restify;
+use Binaryk\LaravelRestify\Tests\Fixtures\Post\PostAbortMiddleware;
+use Binaryk\LaravelRestify\Tests\Fixtures\Post\PostWithCustomMiddlewareRepository;
+use Binaryk\LaravelRestify\Tests\IntegrationTest;
+use Mockery as m;
+
+class RepositoryMiddlewaresTest extends IntegrationTest
+{
+    protected function tearDown(): void
+    {
+        m::close();
+    }
+
+    public function test_repository_can_have_custom_middleware()
+    {
+        $middleware = m::mock(PostAbortMiddleware::class);
+
+        $nextParam = null;
+
+        $middleware
+            ->expects('handle')
+            ->once();
+
+        PostWithCustomMiddlewareRepository::$middlewares = [
+            $middleware,
+        ];
+
+        Restify::repositories([
+            PostWithCustomMiddlewareRepository::class,
+        ]);
+
+        $this->getJson('restify-api/post-with-middleware')
+            ->assertStatus(200);
+    }
+
+    public function test_request_fails_if_middleware_abort()
+    {
+        PostWithCustomMiddlewareRepository::$middlewares = [
+            PostAbortMiddleware::class,
+        ];
+
+        Restify::repositories([
+            PostWithCustomMiddlewareRepository::class,
+        ]);
+
+        $this->getJson('restify-api/post-with-middleware')
+            ->assertStatus(404);
+    }
+
+    public function test_foreign_repository_middleware_should_not_be_invoked()
+    {
+        $middleware = m::mock(PostAbortMiddleware::class);
+
+        $nextParam = null;
+
+        $middleware
+            ->expects('handle')
+            ->never();
+
+        PostWithCustomMiddlewareRepository::$middlewares = [
+            $middleware,
+        ];
+
+        Restify::repositories([
+            PostWithCustomMiddlewareRepository::class,
+        ]);
+
+        $this->getJson('restify-api/posts')
+            ->assertStatus(200);
+    }
+}

tests/Fixtures/Post/PostAbortMiddleware.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Fixtures\Post;
+
+use Illuminate\Http\Request;
+
+class PostAbortMiddleware
+{
+    public function handle(Request $request, $next)
+    {
+        abort(404);
+
+        $next($request);
+    }
+}

tests/Fixtures/Post/PostWithCustomMiddlewareRepository.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Fixtures\Post;
+
+use Binaryk\LaravelRestify\Fields\Field;
+use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
+use Binaryk\LaravelRestify\Repositories\Repository;
+
+class PostWithCustomMiddlewareRepository extends Repository
+{
+    public static $model = Post::class;
+
+    public static $middlewares = [
+        PostAbortMiddleware::class,
+    ];
+
+    public static $uriKey = 'post-with-middleware';
+
+    public function fields(RestifyRequest $request)
+    {
+        return [
+            Field::new('title'),
+        ];
+    }
+}