Paginate server results when viewing a node, closes pterodactyl#1404

Author: DaneEveritt

CHANGELOG.md

@@ -16,6 +16,9 @@ a server through the API.
 * The `PATCH` endpoint for `/api/applications/servers/{server}/build` now accepts an array called `limits` to match
 the response from the server `GET` endpoint.
 
+### Added
+* The server listing for a node is now paginated to 25 servers per page to improve performance on large nodes.
+
 ## v0.7.12 (Derelict Dermodactylus)
 ### Fixed
 * Fixes an issue with the locations API endpoint referencing an invalid namespace.

app/Contracts/Repository/NodeRepositoryInterface.php

@@ -55,16 +55,6 @@ public function loadLocationAndServerCount(Node $node, bool $refresh = false): N
      */
     public function loadNodeAllocations(Node $node, bool $refresh = false): Node;
 
-    /**
-     * Return a node with all of the servers attached to that node.
-     *
-     * @param int $id
-     * @return \Pterodactyl\Models\Node
-     *
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
-     */
-    public function getNodeServers(int $id): Node;
-
     /**
      * Return a collection of nodes for all locations to use in server creation UI.
      *

app/Contracts/Repository/ServerRepositoryInterface.php

@@ -152,4 +152,14 @@ public function isUniqueUuidCombo(string $uuid, string $short): bool;
      * @return int
      */
     public function getSuspendedServersCount(): int;
+
+    /**
+     * Returns all of the servers that exist for a given node in a paginated response.
+     *
+     * @param int $node
+     * @param int $limit
+     *
+     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
+    public function loadAllServersForNode(int $node, int $limit): LengthAwarePaginator;
 }

app/Http/Controllers/Admin/NodesController.php

@@ -24,6 +24,7 @@
 use Pterodactyl\Services\Helpers\SoftwareVersionService;
 use Pterodactyl\Http\Requests\Admin\Node\NodeFormRequest;
 use Pterodactyl\Contracts\Repository\NodeRepositoryInterface;
+use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
 use Pterodactyl\Http\Requests\Admin\Node\AllocationFormRequest;
 use Pterodactyl\Services\Allocations\AllocationDeletionService;
 use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
@@ -32,6 +33,11 @@
 
 class NodesController extends Controller
 {
+    /**
+     * @var \Pterodactyl\Services\Allocations\AllocationDeletionService
+     */
+    protected $allocationDeletionService;
+
     /**
      * @var \Prologue\Alerts\AlertsMessageBag
      */
@@ -72,6 +78,11 @@ class NodesController extends Controller
      */
     protected $repository;
 
+    /**
+     * @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
+     */
+    protected $serverRepository;
+
     /**
      * @var \Pterodactyl\Services\Nodes\NodeUpdateService
      */
@@ -81,10 +92,6 @@ class NodesController extends Controller
      * @var \Pterodactyl\Services\Helpers\SoftwareVersionService
      */
     protected $versionService;
-    /**
-     * @var \Pterodactyl\Services\Allocations\AllocationDeletionService
-     */
-    private $allocationDeletionService;
 
     /**
      * NodesController constructor.
@@ -98,6 +105,7 @@ class NodesController extends Controller
      * @param \Pterodactyl\Services\Nodes\NodeDeletionService                 $deletionService
      * @param \Pterodactyl\Contracts\Repository\LocationRepositoryInterface   $locationRepository
      * @param \Pterodactyl\Contracts\Repository\NodeRepositoryInterface       $repository
+     * @param \Pterodactyl\Contracts\Repository\ServerRepositoryInterface     $serverRepository
      * @param \Pterodactyl\Services\Nodes\NodeUpdateService                   $updateService
      * @param \Pterodactyl\Services\Helpers\SoftwareVersionService            $versionService
      */
@@ -111,6 +119,7 @@ public function __construct(
         NodeDeletionService $deletionService,
         LocationRepositoryInterface $locationRepository,
         NodeRepositoryInterface $repository,
+        ServerRepositoryInterface $serverRepository,
         NodeUpdateService $updateService,
         SoftwareVersionService $versionService
     ) {
@@ -123,6 +132,7 @@ public function __construct(
         $this->deletionService = $deletionService;
         $this->locationRepository = $locationRepository;
         $this->repository = $repository;
+        $this->serverRepository = $serverRepository;
         $this->updateService = $updateService;
         $this->versionService = $versionService;
     }
@@ -178,8 +188,6 @@ public function store(NodeFormRequest $request)
      *
      * @param \Pterodactyl\Models\Node $node
      * @return \Illuminate\View\View
-     *
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function viewIndex(Node $node)
     {
@@ -235,19 +243,17 @@ public function viewAllocation(Node $node)
     /**
      * Shows the server listing page for a specific node.
      *
-     * @param int $node
+     * @param \Pterodactyl\Models\Node $node
      * @return \Illuminate\View\View
-     *
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function viewServers($node)
+    public function viewServers(Node $node)
     {
-        $node = $this->repository->getNodeServers($node);
+        $servers = $this->serverRepository->loadAllServersForNode($node->id, 25);
         Javascript::put([
             'node' => collect($node->makeVisible('daemonSecret'))->only(['scheme', 'fqdn', 'daemonListen', 'daemonSecret']),
         ]);
 
-        return view('admin.nodes.view.servers', ['node' => $node]);
+        return view('admin.nodes.view.servers', ['node' => $node, 'servers' => $servers]);
     }
 
     /**

app/Repositories/Eloquent/NodeRepository.php

@@ -6,10 +6,8 @@
 use Pterodactyl\Models\Node;
 use Illuminate\Support\Collection;
 use Pterodactyl\Repositories\Concerns\Searchable;
-use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Pterodactyl\Contracts\Repository\NodeRepositoryInterface;
-use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
 
 class NodeRepository extends EloquentRepository implements NodeRepositoryInterface
 {
@@ -140,25 +138,6 @@ public function loadNodeAllocations(Node $node, bool $refresh = false): Node
         return $node;
     }
 
-    /**
-     * Return a node with all of the servers attached to that node.
-     *
-     * @param int $id
-     * @return \Pterodactyl\Models\Node
-     *
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
-     */
-    public function getNodeServers(int $id): Node
-    {
-        try {
-            return $this->getBuilder()->with([
-                'servers.user', 'servers.nest', 'servers.egg',
-            ])->findOrFail($id, $this->getColumns());
-        } catch (ModelNotFoundException $exception) {
-            throw new RecordNotFoundException;
-        }
-    }
-
     /**
      * Return a collection of nodes for all locations to use in server creation UI.
      *

app/Repositories/Eloquent/ServerRepository.php

@@ -2,6 +2,7 @@
 
 namespace Pterodactyl\Repositories\Eloquent;
 
+use Pterodactyl\Models\Node;
 use Pterodactyl\Models\User;
 use Webmozart\Assert\Assert;
 use Pterodactyl\Models\Server;
@@ -338,4 +339,20 @@ public function getSuspendedServersCount(): int
     {
         return $this->getBuilder()->where('suspended', true)->count();
     }
+
+    /**
+     * Returns all of the servers that exist for a given node in a paginated response.
+     *
+     * @param int $node
+     * @param int $limit
+     *
+     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
+    public function loadAllServersForNode(int $node, int $limit): LengthAwarePaginator
+    {
+        return $this->getBuilder()
+            ->with(['user', 'nest', 'egg'])
+            ->where('node_id', '=', $node)
+            ->paginate($limit);
+    }
 }

resources/themes/pterodactyl/admin/nodes/view/servers.blade.php

@@ -51,7 +51,7 @@
                         <th class="text-center">CPU</th>
                         <th class="text-center">Status</th>
                     </tr>
-                    @foreach($node->servers as $server)
+                    @foreach($servers as $server)
                         <tr data-server="{{ $server->uuid }}">
                             <td><code>{{ $server->uuidShort }}</code></td>
                             <td><a href="{{ route('admin.servers.view', $server->id) }}">{{ $server->name }}</a></td>
@@ -64,6 +64,11 @@
                         </tr>
                     @endforeach
                 </table>
+                @if($servers->hasPages())
+                    <div class="box-footer with-border">
+                        <div class="col-md-12 text-center">{!! $servers->render() !!}</div>
+                    </div>
+                @endif
             </div>
         </div>
     </div>