Skip to content

An open-source, self-hostable PaaS alternative to Vercel, Heroku & Netlify that lets you easily deploy static sites, databases, full-stack applications and 360+ one-click services on your own servers.

7.3 KB
Raw Blame
<?php

namespace App\Services;

use App\Models\Environment;
use App\Models\Project;
use App\Models\ResourceLink;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;

/**
 * Builds the project canvas: every resource of the project's environments, one zone per server,
 * grouped by environment. Cards keep the positions and links saved on their environment canvas;
 * admins change them through the environment canvas endpoints of each card.
 */
class ProjectCanvas
{
    public function __construct(private EnvironmentCanvas $canvas, private ServerCanvas $servers) {}

    /**
     * The canvas of every project of a team: one zone per project, cards grouped by environment.
     *
     * @return array{title: string, title_link: string, can_edit: bool, can_move: false, can_move_groups: bool, can_move_zones: bool, layout: 'server', zones: array<int, array<string, mixed>>, nodes: array<int, array<string, mixed>>, links: array<int, array<string, mixed>>, positions: array{}}
     */
    public function teamPayload(int $teamId, bool $canReadSensitive, bool $canEdit = false): array
    {
        $projects = Project::query()->where('team_id', $teamId)->orderBy('name')->get(['id', 'uuid', 'name', 'team_id', 'canvas_position']);
        $environments = Environment::query()->whereIn('project_id', $projects->pluck('id'))
            ->orderBy('id')
            ->get(['id', 'uuid', 'name', 'project_id']);
        $resources = $this->servers->loadResources($environments->pluck('id'));
        $links = ResourceLink::query()->whereIn('environment_id', $environments->pluck('id'))->orderBy('id')->get();
        $graph = $this->canvas->graph($resources, $links, $canReadSensitive);

        $grouping = $resources->map(fn (Model $resource) => [
            'zone' => $resource->environment->project->uuid,
            'extra_zones' => [],
            'context' => $resource->environment->name,
            'context_link' => route('project.resource.index', ['project_uuid' => $resource->environment->project->uuid, 'environment_uuid' => $resource->environment->uuid]),
            ...$this->owner($resource),
        ]);

        return [
            'title' => 'Projects',
            'title_link' => route('project.index'),
            'can_edit' => $canEdit,
            // Environment groups and cards keep their environment canvas arrangement.
            'can_move' => false,
            // Admins move groups and cards here; the canvas saves them on their environment canvas.
            'can_move_groups' => $canEdit,
            // Admins move the project zones; each project saves its place (zone.position).
            'can_move_zones' => $canEdit,
            // Same grouped layout as the server canvas, with projects as the zones.
            'layout' => 'server',
            'zones' => $projects->map(fn (Project $project) => [
                'id' => $project->uuid,
                'name' => $project->name,
                'icon' => 'projects',
                'link' => route('project.show', ['project_uuid' => $project->uuid]),
                'position' => $this->canvas->zonePosition($project->canvas_position),
            ])->values()->all(),
            'nodes' => collect($graph['nodes'])->map(fn (array $node) => [...$node, ...$grouping->get($node['id'])])
                ->concat($projects->flatMap(fn (Project $project) => $this->emptyNodes($project, $environments->where('project_id', $project->id), $resources, $project->uuid, $canEdit)))
                ->values()->all(),
            'links' => $graph['links'],
            'positions' => [],
        ];
    }

    /**
     * @return array{title: string, title_link: string, can_edit: bool, can_move: false, can_move_groups: bool, layout: 'server', zones: array<int, array<string, mixed>>, nodes: array<int, array<string, mixed>>, links: array<int, array<string, mixed>>, positions: array{}}
     */
    public function payload(Project $project, bool $canReadSensitive, bool $canEdit = false): array
    {
        $environments = $project->environments()->orderBy('id')->get(['id', 'uuid', 'name', 'project_id']);
        $resources = $this->servers->loadResources($environments->pluck('id'));
        $links = ResourceLink::query()->whereIn('environment_id', $environments->pluck('id'))->orderBy('id')->get();
        $graph = $this->canvas->graph($resources, $links, $canReadSensitive);

        $context = $resources->map(fn (Model $resource) => [
            'context' => $resource->environment->name,
            'context_link' => route('project.resource.index', ['project_uuid' => $project->uuid, 'environment_uuid' => $resource->environment->uuid]),
            ...$this->owner($resource),
        ]);
        $nodes = collect($graph['nodes'])->map(fn (array $node) => [...$node, ...$context->get($node['id'])]);
        // Placeholder cards sit on the server of the project's other environments.
        $zone = $this->canvas->projectZones($nodes, $graph['zones'][0]['id'] ?? EnvironmentCanvas::EMPTY_ZONE)($project);
        $empty = $this->emptyNodes($project, $environments, $resources, $zone, $canEdit);

        return [
            'title' => $project->name,
            'title_link' => route('project.show', ['project_uuid' => $project->uuid]),
            'can_edit' => $canEdit,
            'can_move' => false,
            // Admins move groups and cards here; the canvas saves them on their environment canvas.
            'can_move_groups' => $canEdit,
            // Groups cards by environment inside each server zone, like the server canvas.
            'layout' => 'server',
            'zones' => $empty->isNotEmpty() && $zone === EnvironmentCanvas::EMPTY_ZONE ? [...$graph['zones'], $this->canvas->emptyZone()] : $graph['zones'],
            'nodes' => $nodes->concat($empty)->values()->all(),
            'links' => $graph['links'],
            'positions' => [],
        ];
    }

    /**
     * Placeholder cards of the project's environments without resources, or one for the project when it has no environments.
     *
     * @param  Collection<int, Environment>  $environments  environments of the project
     * @param  Collection<string, Model>  $resources
     * @return Collection<int, array<string, mixed>>
     */
    private function emptyNodes(Project $project, Collection $environments, Collection $resources, string $zone, bool $canAdd): Collection
    {
        if ($environments->isEmpty()) {
            return collect([$this->canvas->emptyNode($project, null, $zone, 'No environments')]);
        }

        $used = $resources->pluck('environment_id')->flip();

        return $environments
            ->reject(fn (Environment $environment) => $used->has($environment->id))
            ->map(fn (Environment $environment) => $this->canvas->emptyNode($project, $environment, $zone, $environment->name, $canAdd))
            ->values();
    }

    /**
     * Project and environment of a card: the canvas saves links on that environment canvas.
     *
     * @return array{project: array{uuid: string, name: string}, environment: array{uuid: string, name: string}}
     */
    private function owner(Model $resource): array
    {
        return [
            'project' => ['uuid' => $resource->environment->project->uuid, 'name' => $resource->environment->project->name],
            'environment' => ['uuid' => $resource->environment->uuid, 'name' => $resource->environment->name],
        ];
    }
}