Add endpoint to get all nodes meeting memory & disk requirements for a server; closes pterodactyl#1012

Author: DaneEveritt

app/Http/Controllers/Api/Application/Nodes/NodeDeploymentController.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Pterodactyl\Http\Controllers\Api\Application\Nodes;
+
+use Pterodactyl\Services\Deployment\FindViableNodesService;
+use Pterodactyl\Transformers\Api\Application\NodeTransformer;
+use Pterodactyl\Http\Controllers\Api\Application\ApplicationApiController;
+use Pterodactyl\Http\Requests\Api\Application\Nodes\GetDeployableNodesRequest;
+
+class NodeDeploymentController extends ApplicationApiController
+{
+    /**
+     * @var \Pterodactyl\Services\Deployment\FindViableNodesService
+     */
+    private $viableNodesService;
+
+    /**
+     * NodeDeploymentController constructor.
+     *
+     * @param \Pterodactyl\Services\Deployment\FindViableNodesService $viableNodesService
+     */
+    public function __construct(FindViableNodesService $viableNodesService)
+    {
+        parent::__construct();
+
+        $this->viableNodesService = $viableNodesService;
+    }
+
+    /**
+     * Finds any nodes that are available using the given deployment criteria. This works
+     * similarly to the server creation process, but allows you to pass the deployment object
+     * to this endpoint and get back a list of all Nodes satisfying the requirements.
+     *
+     * @param \Pterodactyl\Http\Requests\Api\Application\Nodes\GetDeployableNodesRequest $request
+     * @return array
+     *
+     * @throws \Pterodactyl\Exceptions\Service\Deployment\NoViableNodeException
+     */
+    public function __invoke(GetDeployableNodesRequest $request): array
+    {
+        $data = $request->validated();
+        $nodes = $this->viableNodesService->setLocations($data['location_ids'] ?? [])
+            ->setMemory($data['memory'])
+            ->setDisk($data['disk'])
+            ->handle($request->input('page') ?? 0);
+
+        return $this->fractal->collection($nodes)
+            ->transformWith($this->getTransformer(NodeTransformer::class))
+            ->toArray();
+    }
+}

app/Http/Requests/Api/Application/Nodes/GetDeployableNodesRequest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Pterodactyl\Http\Requests\Api\Application\Nodes;
+
+class GetDeployableNodesRequest extends GetNodesRequest
+{
+    /**
+     * @return string[]
+     */
+    public function rules(): array
+    {
+        return [
+            'page' => 'integer',
+            'memory' => 'required|integer|min:0',
+            'disk' => 'required|integer|min:0',
+            'location_ids' => 'array',
+            'location_ids.*' => 'integer',
+        ];
+    }
+}

app/Services/Deployment/FindViableNodesService.php

@@ -77,10 +77,15 @@ public function setMemory(int $memory): self
      * are tossed out, as are any nodes marked as non-public, meaning automatic
      * deployments should not be done against them.
      *
-     * @return \Pterodactyl\Models\Node[]|\Illuminate\Support\Collection
+     * @param int|null $page If provided the results will be paginated by returning
+     *                       up to 50 nodes at a time starting at the provided page.
+     *                       If "null" is provided as the value no pagination will
+     *                       be used.
+     * @return \Illuminate\Support\Collection|\Illuminate\Contracts\Pagination\LengthAwarePaginator
+     *
      * @throws \Pterodactyl\Exceptions\Service\Deployment\NoViableNodeException
      */
-    public function handle()
+    public function handle(int $page = null)
     {
         Assert::integer($this->disk, 'Disk space must be an int, got %s');
         Assert::integer($this->memory, 'Memory usage must be an int, got %s');
@@ -97,9 +102,13 @@ public function handle()
 
         $results = $query->groupBy('nodes.id')
             ->havingRaw('(IFNULL(SUM(servers.memory), 0) + ?) <= (nodes.memory * (1 + (nodes.memory_overallocate / 100)))', [$this->memory])
-            ->havingRaw('(IFNULL(SUM(servers.disk), 0) + ?) <= (nodes.disk * (1 + (nodes.disk_overallocate / 100)))', [$this->disk])
-            ->get()
-            ->toBase();
+            ->havingRaw('(IFNULL(SUM(servers.disk), 0) + ?) <= (nodes.disk * (1 + (nodes.disk_overallocate / 100)))', [$this->disk]);
+
+        if (! is_null($page)) {
+            $results = $results->paginate(50, ['*'], 'page', $page);
+        } else {
+            $results = $results->get()->toBase();
+        }
 
         if ($results->isEmpty()) {
             throw new NoViableNodeException(trans('exceptions.deployment.no_viable_nodes'));

app/Services/Servers/ServerCreationService.php

@@ -197,6 +197,7 @@ public function handle(array $data, DeploymentObject $deployment = null): Server
      */
     private function configureDeployment(array $data, DeploymentObject $deployment): Allocation
     {
+        /** @var \Illuminate\Support\Collection $nodes */
         $nodes = $this->findViableNodesService->setLocations($deployment->getLocations())
             ->setDisk(Arr::get($data, 'disk'))
             ->setMemory(Arr::get($data, 'memory'))

routes/api-application.php

@@ -32,6 +32,7 @@
 */
 Route::group(['prefix' => '/nodes'], function () {
     Route::get('/', 'Nodes\NodeController@index')->name('api.application.nodes');
+    Route::get('/deployable', 'Nodes\NodeDeploymentController');
     Route::get('/{node}', 'Nodes\NodeController@view')->name('api.application.nodes.view');
     Route::get('/{node}/configuration', 'Nodes\NodeConfigurationController');