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.

fix(previews): remove persistent volumes on deletion (#11455)

Andras Bacsai7fd678d90734
diff --git a/app/Models/ApplicationPreview.php b/app/Models/ApplicationPreview.php
index 6998211eea..0905242753 100644
--- a/app/Models/ApplicationPreview.php
+++ b/app/Models/ApplicationPreview.php
@@ -4,6 +4,7 @@ namespace App\Models;
use App\Support\ValidationPatterns;
use Illuminate\Database\Eloquent\SoftDeletes;
+use RuntimeException;
use Spatie\Url\Url;
class ApplicationPreview extends BaseModel
@@ -28,9 +29,9 @@ class ApplicationPreview extends BaseModel
'pull_request_id' => 'integer',
];
- protected static function booted()
+ protected static function booted(): void
{
- static::forceDeleting(function ($preview) {
+ static::forceDeleting(function (ApplicationPreview $preview): void {
$server = $preview->application->destination->server;
$application = $preview->application;
@@ -57,10 +58,19 @@ class ApplicationPreview extends BaseModel
});
} else {
// Regular application volume cleanup
- $persistentStorages = $preview->persistentStorages()->get() ?? collect();
- if ($persistentStorages->count() > 0) {
- foreach ($persistentStorages as $storage) {
- instant_remote_process(['docker volume rm -f '.escapeshellarg($storage->name)], $server, false);
+ $persistentStorages = $application->persistentStorages()
+ ->get()
+ ->filter(fn (LocalPersistentVolume $storage): bool => blank($storage->host_path)
+ && $storage->is_preview_suffix_enabled);
+
+ foreach ($persistentStorages as $storage) {
+ $volumeName = addPreviewDeploymentSuffix($storage->name, $preview->pull_request_id);
+ try {
+ instant_remote_process(['docker volume rm -f '.escapeshellarg($volumeName)], $server);
+ } catch (RuntimeException $exception) {
+ if (! preg_match('/\bvolume\b.*\bnot found\b/i', $exception->getMessage())) {
+ throw $exception;
+ }
}
}
}
diff --git a/tests/Feature/ApplicationPreviewVolumeCleanupTest.php b/tests/Feature/ApplicationPreviewVolumeCleanupTest.php
new file mode 100644
index 0000000000..7f59f689fc
--- /dev/null
+++ b/tests/Feature/ApplicationPreviewVolumeCleanupTest.php
@@ -0,0 +1,120 @@
+<?php
+
+use App\Models\Application;
+use App\Models\ApplicationPreview;
+use App\Models\Environment;
+use App\Models\InstanceSettings;
+use App\Models\PrivateKey;
+use App\Models\Project;
+use App\Models\Server;
+use App\Models\StandaloneDocker;
+use App\Models\Team;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Process;
+
+uses(RefreshDatabase::class);
+
+beforeEach(function () {
+ InstanceSettings::unguarded(fn () => InstanceSettings::firstOrCreate(['id' => 0]));
+
+ $team = Team::factory()->create();
+ $privateKey = PrivateKey::factory()->create(['team_id' => $team->id]);
+ $server = Server::factory()->create([
+ 'team_id' => $team->id,
+ 'private_key_id' => $privateKey->id,
+ 'user' => 'deploy',
+ ]);
+ $destination = StandaloneDocker::where('server_id', $server->id)->firstOrFail();
+ $project = Project::factory()->create(['team_id' => $team->id]);
+ $environment = $project->environments()->first()
+ ?? Environment::factory()->create(['project_id' => $project->id]);
+
+ $this->application = Application::factory()->create([
+ 'build_pack' => 'dockerfile',
+ 'environment_id' => $environment->id,
+ 'destination_id' => $destination->id,
+ 'destination_type' => $destination->getMorphClass(),
+ ]);
+ $this->preview = ApplicationPreview::create([
+ 'uuid' => 'preview-volume-cleanup-test',
+ 'application_id' => $this->application->id,
+ 'pull_request_id' => 42,
+ 'pull_request_html_url' => 'https://github.com/example/repository/pull/42',
+ ]);
+});
+
+it('deletes only named volumes that have the preview suffix enabled', function () {
+ $this->application->persistentStorages()->create([
+ 'name' => 'app-data',
+ 'mount_path' => '/data',
+ 'host_path' => null,
+ 'is_preview_suffix_enabled' => true,
+ ]);
+ $this->application->persistentStorages()->create([
+ 'name' => 'shared-cache',
+ 'mount_path' => '/cache',
+ 'host_path' => null,
+ 'is_preview_suffix_enabled' => false,
+ ]);
+ $this->application->persistentStorages()->create([
+ 'name' => 'seed-data',
+ 'mount_path' => '/seed',
+ 'host_path' => '/srv/seed',
+ 'is_preview_suffix_enabled' => true,
+ ]);
+ Process::fake(['*' => Process::result(output: '')]);
+
+ $this->preview->forceDelete();
+
+ Process::assertRanTimes(fn ($process) => str_contains($process->command, 'docker volume rm'), 1);
+ Process::assertRan(fn ($process) => str_contains($process->command, "docker volume rm -f 'app-data-pr-42'"));
+ Process::assertRan(fn ($process) => str_contains($process->command, "sudo docker volume rm -f 'app-data-pr-42'"));
+ Process::assertNotRan(fn ($process) => str_contains($process->command, 'shared-cache'));
+ Process::assertNotRan(fn ($process) => str_contains($process->command, 'seed-data'));
+});
+
+it('reports Docker volume removal failures and keeps the preview record', function () {
+ $this->application->persistentStorages()->create([
+ 'name' => 'app-data',
+ 'mount_path' => '/data',
+ 'host_path' => null,
+ 'is_preview_suffix_enabled' => true,
+ ]);
+ Process::fake(['*' => Process::result(errorOutput: 'volume is in use', exitCode: 1)]);
+
+ expect(fn () => $this->preview->forceDelete())
+ ->toThrow(RuntimeException::class, 'volume is in use');
+
+ expect(ApplicationPreview::find($this->preview->id))->not->toBeNull();
+});
+
+it('continues removing preview volumes when an earlier volume is already absent', function () {
+ $this->application->persistentStorages()->create([
+ 'name' => 'already-removed',
+ 'mount_path' => '/removed',
+ 'host_path' => null,
+ 'is_preview_suffix_enabled' => true,
+ ]);
+ $this->application->persistentStorages()->create([
+ 'name' => 'app-data',
+ 'mount_path' => '/data',
+ 'host_path' => null,
+ 'is_preview_suffix_enabled' => true,
+ ]);
+ Process::fake(function ($process) {
+ if (str_contains($process->command, "docker volume rm -f 'already-removed-pr-42'")) {
+ return Process::result(
+ errorOutput: 'Error response from daemon: volume already-removed-pr-42 not found',
+ exitCode: 1,
+ );
+ }
+
+ return Process::result(output: 'app-data-pr-42');
+ });
+
+ $this->preview->forceDelete();
+
+ Process::assertRan(fn ($process) => str_contains($process->command, "docker volume rm -f 'already-removed-pr-42'"));
+ Process::assertRan(fn ($process) => str_contains($process->command, "docker volume rm -f 'app-data-pr-42'"));
+ expect(ApplicationPreview::find($this->preview->id))->toBeNull();
+});