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.

19.5 KB
Raw Blame
<?php

namespace App\Services\Dns;

use App\Enums\ManagedDnsDeletionResult;
use App\Jobs\ReleaseRemovedDnsHostnamesJob;
use App\Models\Application;
use App\Models\ApplicationPreview;
use App\Models\ManagedDnsRecord;
use App\Models\ManagedDnsRecordReference;
use App\Models\ServiceApplication;
use Illuminate\Contracts\Cache\LockTimeoutException;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;
use Throwable;

/**
 * Releases resource references to managed DNS records and deletes a provider record only when
 * Coolify owns it, no resource references it and no application, preview or service application
 * (in any team) still uses its hostname.
 */
class ManagedDnsRecordCleanup
{
    /**
     * A record without references is released only after this time, so a record that was just created is never touched.
     */
    public const ORPHAN_GRACE_MINUTES = 60;

    public function __construct(
        private CloudflareDnsProvider $provider,
        private ManagedDnsHostnameLock $hostnameLock,
    ) {}

    /**
     * Hostnames the resource used before a domain change (from hostnamesOf()) and no longer uses now.
     *
     * @param  array<int, string>  $previousHostnames
     * @return array<int, string>
     */
    public function removedHostnames(Model $resource, array $previousHostnames): array
    {
        $current = $this->hostnamesOf($resource->fresh() ?? $resource);

        return collect($previousHostnames)
            ->map(fn (string $hostname): string => $this->normalizeHostname($hostname))
            ->reject(fn (string $hostname): bool => in_array($hostname, $current, true))
            ->unique()
            ->values()
            ->all();
    }

    /**
     * Releases every hostname that the resource no longer uses after a domain edit. The same rules as for a removed
     * domain apply: records still used by another live resource stay, and only owned records are deleted.
     *
     * @param  array<int, string>  $previousHostnames
     */
    public function releaseRemovedHostnames(Model $resource, array $previousHostnames, int $teamId, bool $deleteRecord = true): ?ManagedDnsDeletionResult
    {
        $worst = null;
        foreach ($this->removedHostnames($resource, $previousHostnames) as $hostname) {
            $worst = $this->worseResult($worst, $this->releaseHostname($resource, $hostname, $teamId, $deleteRecord));
        }

        return $worst;
    }

    /**
     * Queues the release of hostnames the resource no longer uses after a domain edit (API and other non-interactive
     * paths). Nothing is queued when the resource references no managed record for a removed hostname.
     *
     * @param  array<int, string>  $previousHostnames
     */
    public function queueReleaseOfRemovedHostnames(Model $resource, array $previousHostnames, int $teamId): void
    {
        $removed = $this->removedHostnames($resource, $previousHostnames);
        if ($removed === []) {
            return;
        }

        $referenced = ManagedDnsRecord::query()
            ->where('team_id', $teamId)
            ->whereIn('name', $removed)
            ->whereHas('references', fn (Builder $query) => $this->whereResourceKeys($query, [[$resource->getMorphClass(), $resource->getKey()]]))
            ->exists();
        if (! $referenced) {
            return;
        }

        ReleaseRemovedDnsHostnamesJob::dispatch($resource->getMorphClass(), $resource->getKey(), $teamId, $removed)->afterCommit();
    }

    /**
     * Releases the resource's reference after one of its URLs was removed.
     * Nothing is released while the resource still uses the hostname through another URL.
     */
    public function releaseHostname(Model $resource, string $hostname, int $teamId, bool $deleteRecord = true): ?ManagedDnsDeletionResult
    {
        $hostname = $this->normalizeHostname($hostname);
        $current = $resource->fresh() ?? $resource;
        if (in_array($hostname, $this->hostnamesOf($current), true)) {
            return null;
        }

        $keys = [[$resource->getMorphClass(), $resource->getKey()]];
        $records = ManagedDnsRecord::query()
            ->where('team_id', $teamId)
            ->where('name', $hostname)
            ->whereHas('references', fn (Builder $query) => $this->whereResourceKeys($query, $keys))
            ->get();

        $worst = null;
        foreach ($records as $record) {
            $worst = $this->worseResult($worst, $this->release($record, $keys, $deleteRecord, $resource));
        }

        return $worst;
    }

    /**
     * Releases every reference of a deleted resource (and, for applications, of their previews).
     * Never throws; returns false when a provider call failed and the release should be retried.
     */
    public function releaseResource(string $resourceType, int|string $resourceId): bool
    {
        $keys = $this->resourceKeys($resourceType, $resourceId);
        $records = ManagedDnsRecord::query()
            ->whereHas('references', fn (Builder $query) => $this->whereResourceKeys($query, $keys))
            ->get();

        $successful = true;
        foreach ($records as $record) {
            try {
                if ($this->release($record, $keys, true)?->shouldRetry()) {
                    $successful = false;
                }
            } catch (Throwable $e) {
                $successful = false;
                Log::warning('Managed DNS record cleanup failed after resource deletion.', [
                    'managed_dns_record_id' => $record->id,
                    'hostname' => $record->name,
                    'error' => $e->getMessage(),
                ]);
            }
        }

        return $successful;
    }

    /**
     * Stops tracking the records of these resources without touching the provider. Used when another Coolify
     * instance takes over the resources: their records still serve live traffic there. A record that another
     * resource of this instance still uses keeps that resource's references.
     *
     * @param  iterable<int, Model>  $resources
     */
    public function forgetResources(iterable $resources): void
    {
        $keys = collect($resources)
            ->flatMap(fn (Model $resource) => $this->resourceKeys($resource->getMorphClass(), $resource->getKey()))
            ->all();
        if ($keys === []) {
            return;
        }

        $records = ManagedDnsRecord::query()
            ->whereHas('references', fn (Builder $query) => $this->whereResourceKeys($query, $keys))
            ->get();

        foreach ($records as $record) {
            $this->deleteReferences($record, $keys);
            if (! $record->references()->exists()) {
                $this->forget($record, 'The resource was transferred to another Coolify instance, which uses the record now.', 'info');
            }
        }
    }

    /**
     * Keeps the records of resources that another Coolify instance manages now, for a later take back, but marks
     * them not owned, so this instance never changes or deletes them at the provider. A record that another
     * resource of this instance also uses only loses the references of these resources.
     *
     * @param  iterable<int, Model>  $resources
     * @return list<int> ids of the records that were owned before
     */
    public function parkResources(iterable $resources): array
    {
        $keys = collect($resources)
            ->flatMap(fn (Model $resource) => $this->resourceKeys($resource->getMorphClass(), $resource->getKey()))
            ->all();
        if ($keys === []) {
            return [];
        }

        $parked = [];
        $records = ManagedDnsRecord::query()
            ->whereHas('references', fn (Builder $query) => $this->whereResourceKeys($query, $keys))
            ->get();
        foreach ($records as $record) {
            $sharedWithOthers = $record->references()->whereNot(fn (Builder $query) => $this->whereResourceKeys($query, $keys))->exists();
            if ($sharedWithOthers) {
                $this->deleteReferences($record, $keys);

                continue;
            }
            if ($record->owned) {
                $record->update(['owned' => false]);
                $parked[] = $record->id;
            }
        }

        return $parked;
    }

    /**
     * Releases orphaned records: records whose references all point to deleted (or soft-deleted) resources, and
     * records without references that are older than the grace period. Records with a live reference are not touched.
     * Each orphan goes through release(), so a hostname that a live resource uses again keeps its record, and
     * Busy or Failed records stay for the next run. Never throws.
     *
     * @return array<string, int> Number of records per outcome (a ManagedDnsDeletionResult value, "kept" or "forgotten").
     */
    public function releaseOrphanedRecords(): array
    {
        $counts = [];
        $cutoff = now()->subMinutes(self::ORPHAN_GRACE_MINUTES);

        ManagedDnsRecord::query()
            ->where(fn (Builder $query) => $query->has('references')->orWhere('created_at', '<=', $cutoff))
            ->with('references.resource')
            ->chunkById(100, function (Collection $records) use (&$counts): void {
                foreach ($records as $record) {
                    if ($record->references->contains(fn (ManagedDnsRecordReference $reference): bool => $reference->resource !== null)) {
                        continue;
                    }

                    $outcome = $this->releaseOrphanedRecord($record);
                    $counts[$outcome] = ($counts[$outcome] ?? 0) + 1;
                }
            });

        return $counts;
    }

    private function releaseOrphanedRecord(ManagedDnsRecord $record): string
    {
        try {
            $result = $this->release($record, [], true);
        } catch (Throwable $e) {
            Log::warning('Managed DNS orphaned record cleanup failed.', [
                'managed_dns_record_id' => $record->id,
                'hostname' => $record->name,
                'error' => $e->getMessage(),
            ]);

            return ManagedDnsDeletionResult::Failed->value;
        }

        if ($result !== null) {
            return $result->value;
        }

        return ManagedDnsRecord::query()->whereKey($record->getKey())->exists() ? 'kept' : 'forgotten';
    }

    /**
     * Runs under the hostname lock, so a concurrent create or reference for the same hostname either finishes before
     * the usage re-check or starts after the record is gone. When the lock is not free in time, nothing changes and
     * Busy is returned so the caller can retry.
     *
     * @param  array<int, array{0: string, 1: int|string}>  $releasingKeys
     * @param  Model|null  $contextResource  The releasing resource of a hostname release; it keeps the record when it uses the hostname again.
     */
    public function release(ManagedDnsRecord $record, array $releasingKeys, bool $deleteRecord, ?Model $contextResource = null): ?ManagedDnsDeletionResult
    {
        try {
            return $this->hostnameLock->run(
                (int) $record->team_id,
                $record->name,
                fn (): ?ManagedDnsDeletionResult => $this->releaseLocked($record, $releasingKeys, $deleteRecord, $contextResource),
            );
        } catch (LockTimeoutException) {
            $this->auditSkipped($record, 'hostname_busy');

            return ManagedDnsDeletionResult::Busy;
        }
    }

    /**
     * @param  array<int, array{0: string, 1: int|string}>  $releasingKeys
     */
    private function releaseLocked(ManagedDnsRecord $record, array $releasingKeys, bool $deleteRecord, ?Model $contextResource): ?ManagedDnsDeletionResult
    {
        $record = $record->fresh();
        if ($record === null) {
            return null;
        }
        if ($contextResource !== null && in_array($record->name, $this->hostnamesOf($contextResource->fresh() ?? $contextResource), true)) {
            return null;
        }

        $releasing = collect($releasingKeys)->map(fn (array $key): string => $key[0].'|'.$key[1]);
        $otherReferences = $record->references()->get()
            ->reject(fn (ManagedDnsRecordReference $reference): bool => $releasing->contains($reference->resource_type.'|'.$reference->resource_id));

        $liveReferences = $otherReferences->filter(function (ManagedDnsRecordReference $reference): bool {
            if ($reference->resource !== null) {
                return true;
            }
            $reference->delete();

            return false;
        });
        if ($liveReferences->isNotEmpty()) {
            $this->deleteReferences($record, $releasingKeys);

            return null;
        }

        $users = $this->resourcesUsingHostname($record->name, $releasing->all());
        if ($users->isNotEmpty()) {
            $sameTeamUsers = $users->filter(fn (Model $user): bool => $this->teamIdOf($user) === (int) $record->team_id);
            if ($sameTeamUsers->isEmpty()) {
                $this->forget($record, 'hostname_used_by_another_team');

                return null;
            }
            $sameTeamUsers->each(fn (Model $user) => $record->addReference($user));
            $this->deleteReferences($record, $releasingKeys);

            return null;
        }

        if (! $record->owned || ! $deleteRecord) {
            $this->forget($record, $record->owned ? 'kept_by_user' : 'not_owned', 'info');

            return $record->owned ? null : ManagedDnsDeletionResult::NotOwned;
        }

        $result = $this->provider->deleteRecord($record, $contextResource);
        if ($result === ManagedDnsDeletionResult::ChangedExternally) {
            $this->forget($record, 'remote_record_changed');
        } elseif ($result === ManagedDnsDeletionResult::Failed) {
            $this->auditSkipped($record, 'provider_unavailable');
        }

        return $result;
    }

    /**
     * Live applications, previews and service applications (any team) that use the hostname, except the given resource keys.
     *
     * @param  array<int, string>  $exceptKeys  "morph-class|id" keys
     * @return Collection<int, Model>
     */
    public function resourcesUsingHostname(string $hostname, array $exceptKeys = []): Collection
    {
        $hostname = $this->normalizeHostname($hostname);
        $pattern = '%'.$hostname.'%';
        $matchesFqdnOrCompose = fn (Builder $query) => $query->where(fn (Builder $query) => $query
            ->whereRaw('LOWER(fqdn) LIKE ?', [$pattern])
            ->orWhereRaw('LOWER(docker_compose_domains) LIKE ?', [$pattern]));

        return collect()
            ->concat(Application::query()->where($matchesFqdnOrCompose)->get())
            ->concat(ApplicationPreview::query()->where($matchesFqdnOrCompose)->get())
            ->concat(ServiceApplication::query()->whereRaw('LOWER(fqdn) LIKE ?', [$pattern])->get())
            ->reject(fn (Model $resource): bool => in_array($resource->getMorphClass().'|'.$resource->getKey(), $exceptKeys, true))
            ->filter(fn (Model $resource): bool => in_array($hostname, $this->hostnamesOf($resource), true))
            ->values();
    }

    /**
     * @return array<int, string>
     */
    public function hostnamesOf(Model $resource): array
    {
        $attributes = $resource->getAttributes();
        $values = $this->splitUrls($attributes['fqdn'] ?? null);

        $composeDomains = json_decode((string) ($attributes['docker_compose_domains'] ?? ''), true);
        if (is_array($composeDomains)) {
            foreach ($composeDomains as $service) {
                $domain = is_array($service) ? ($service['domain'] ?? null) : null;
                array_push($values, ...$this->splitUrls(is_string($domain) ? $domain : null));
            }
        }

        return collect($values)
            ->map(fn (string $url) => parse_url(str_contains($url, '://') ? $url : 'http://'.$url, PHP_URL_HOST))
            ->filter(fn ($host): bool => is_string($host) && $host !== '')
            ->map(fn (string $host): string => $this->normalizeHostname($host))
            ->unique()
            ->values()
            ->all();
    }

    private function worseResult(?ManagedDnsDeletionResult $current, ?ManagedDnsDeletionResult $next): ?ManagedDnsDeletionResult
    {
        $rank = fn (?ManagedDnsDeletionResult $result): int => match ($result) {
            ManagedDnsDeletionResult::Failed => 3,
            ManagedDnsDeletionResult::Busy => 2,
            ManagedDnsDeletionResult::ChangedExternally => 1,
            default => 0,
        };

        return $rank($next) > $rank($current) ? $next : $current;
    }

    private function teamIdOf(Model $resource): ?int
    {
        $teamId = match (true) {
            $resource instanceof ApplicationPreview => data_get($resource, 'application.environment.project.team_id'),
            $resource instanceof ServiceApplication => data_get($resource, 'service.environment.project.team_id'),
            default => data_get($resource, 'environment.project.team_id'),
        };

        return $teamId === null ? null : (int) $teamId;
    }

    /**
     * @return array<int, array{0: string, 1: int|string}>
     */
    private function resourceKeys(string $resourceType, int|string $resourceId): array
    {
        $keys = [[$resourceType, $resourceId]];
        if ($resourceType === (new Application)->getMorphClass()) {
            $previewType = (new ApplicationPreview)->getMorphClass();
            ApplicationPreview::withTrashed()->where('application_id', $resourceId)->pluck('id')
                ->each(function ($previewId) use (&$keys, $previewType): void {
                    $keys[] = [$previewType, $previewId];
                });
        }

        return $keys;
    }

    /**
     * @param  array<int, array{0: string, 1: int|string}>  $keys
     */
    private function whereResourceKeys(Builder $query, array $keys): Builder
    {
        return $query->where(function (Builder $query) use ($keys): void {
            foreach ($keys as [$type, $id]) {
                $query->orWhere(fn (Builder $query) => $query->where('resource_type', $type)->where('resource_id', $id));
            }
        });
    }

    /**
     * @param  array<int, array{0: string, 1: int|string}>  $keys
     */
    private function deleteReferences(ManagedDnsRecord $record, array $keys): void
    {
        // An empty nested where adds no constraint and would delete every reference of the record.
        if ($keys === []) {
            return;
        }

        $this->whereResourceKeys($record->references()->getQuery(), $keys)->delete();
    }

    /**
     * Stops tracking the record without touching the provider.
     */
    private function forget(ManagedDnsRecord $record, string $reason, string $level = 'warning'): void
    {
        $record->delete();
        $this->auditSkipped($record, $reason, $level);
    }

    private function auditSkipped(ManagedDnsRecord $record, string $reason, string $level = 'warning'): void
    {
        $source = auth()->check() ? 'ui' : 'system';
        auditLog("{$source}.dns_record.delete_skipped", [
            'team_id' => $record->team_id,
            'hostname' => $record->name,
            'provider' => 'cloudflare',
            'reason' => $reason,
        ], $level);
    }

    /**
     * @return array<int, string>
     */
    private function splitUrls(?string $value): array
    {
        if (blank($value)) {
            return [];
        }

        return collect(explode(',', $value))->map(fn ($url) => trim((string) $url))->filter()->values()->all();
    }

    private function normalizeHostname(string $hostname): string
    {
        return strtolower(rtrim($hostname, '.'));
    }
}