[Feature] Allow dependency injection in the serving hook

Allows a developer to type-hint dependencies in their server's
`serving` method, so that any dependencies can be injected.

See #44

Author: lindyhopchris

CHANGELOG.md

@@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file. This projec
   full details on how to apply this to resource schemas, refer to the new *Soft Deleting* chapter in the documentation.
 - Multi-resource models are now supported. This allows developers to represent a single model class as multiple
   different JSON:API resource types within an API. Refer to documentation for details of how to implement.
+- Developers can now type-hint dependencies in their server's `serving()` method.
 
 ## [1.0.0-alpha.4] - 2021-02-27
 

src/Http/Middleware/BootJsonApi.php

@@ -22,10 +22,10 @@
 use Closure;
 use Illuminate\Contracts\Container\Container as IlluminateContainer;
 use Illuminate\Http\Request;
-use Illuminate\Pagination\AbstractPaginator;
 use LaravelJsonApi\Contracts\Routing\Route as RouteContract;
 use LaravelJsonApi\Contracts\Server\Repository;
 use LaravelJsonApi\Contracts\Server\Server;
+use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Laravel\Routing\Route;
 
 class BootJsonApi
@@ -63,6 +63,10 @@ public function __construct(IlluminateContainer $container, Repository $servers)
      */
     public function handle($request, Closure $next, string $name)
     {
+        /**
+         * When handling a HTTP request, both the JSON:API server and
+         * request classes can be singletons bound into the container.
+         */
         $this->container->instance(
             Server::class,
             $server = $this->servers->server($name)
@@ -73,25 +77,29 @@ public function handle($request, Closure $next, string $name)
             $route = new Route($this->container, $server, $request->route())
         );
 
-        $server->serving();
+        /**
+         * Before we do anything, we must ensure the server is set up to
+         * handle a HTTP request. We do that by invoking the `serving()`
+         * hook on the server instance.
+         */
+        if (method_exists($server, 'serving')) {
+            $this->container->call([$server, 'serving']);
+        }
+
+        /**
+         * Once the server is set up, we can substitute bindings. This must
+         * happen after the `serving` hook, in case that hook has added any
+         * Eloquent scopes.
+         */
         $route->substituteBindings();
-        $this->bindPageResolver();
 
-        return $next($request);
-    }
+        /**
+         * We will also override the Laravel page resolver, as we know this is
+         * a JSON:API request, and the specification would have the page number
+         * nested under the `page` query parameter.
+         */
+        PagePagination::bindPageResolver();
 
-    /**
-     * Override the page resolver to read the page parameter from the JSON API request.
-     *
-     * @return void
-     */
-    protected function bindPageResolver(): void
-    {
-        /** Override the current page resolution */
-        AbstractPaginator::currentPageResolver(static function ($pageName) {
-            $pagination = \request()->query($pageName);
-
-            return $pagination['number'] ?? null;
-        });
+        return $next($request);
     }
 }