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(webhooks): clean up closed Bitbucket PRs after destination branch changes (#12008)

johandenhollandere02f932a34fb
diff --git a/app/Http/Controllers/Webhook/Bitbucket.php b/app/Http/Controllers/Webhook/Bitbucket.php
index e06a14e0bf..489de7e5c5 100644
--- a/app/Http/Controllers/Webhook/Bitbucket.php
+++ b/app/Http/Controllers/Webhook/Bitbucket.php
@@ -84,7 +84,11 @@ class Bitbucket extends Controller
$failure_key = $this->manualWebhookFailureRateLimitKey($request, 'bitbucket', $full_name, $branch);
// A redelivery of the same signed payload is one guess.
$failure_attempt = $this->manualWebhookSignedPayloadAttempt($request, $x_bitbucket_token);
- $applications = $this->manualWebhookApplications(Application::query()->where('git_branch', $branch), $full_name);
+ $applications = Application::query();
+ if ($x_bitbucket_event !== 'pullrequest:rejected' && $x_bitbucket_event !== 'pullrequest:fulfilled') {
+ $applications->where('git_branch', $branch);
+ }
+ $applications = $this->manualWebhookApplications($applications, $full_name);
if ($applications->isEmpty()) {
return $this->unauthenticatedManualWebhookResponse($failure_key, $failure_attempt);
}
diff --git a/tests/Feature/BitbucketPullRequestWebhookRoutingTest.php b/tests/Feature/BitbucketPullRequestWebhookRoutingTest.php
new file mode 100644
index 0000000000..f186c30c36
--- /dev/null
+++ b/tests/Feature/BitbucketPullRequestWebhookRoutingTest.php
@@ -0,0 +1,105 @@
+<?php
+
+use App\Actions\Application\CleanupPreviewDeployment;
+use App\Models\Application;
+use App\Models\ApplicationPreview;
+use App\Models\Environment;
+use App\Models\Project;
+use App\Models\Server;
+use App\Models\Team;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Queue;
+
+uses(RefreshDatabase::class);
+
+function createBitbucketPullRequestWebhookApplication(): Application
+{
+ $team = Team::factory()->create();
+ $project = Project::factory()->create(['team_id' => $team->id]);
+ $environment = Environment::factory()->create(['project_id' => $project->id]);
+ $server = Server::factory()->create(['team_id' => $team->id]);
+ $server->settings->update([
+ 'is_reachable' => true,
+ 'is_usable' => true,
+ 'force_disabled' => false,
+ ]);
+ $destination = $server->standaloneDockers()->firstOrFail();
+
+ return Application::create([
+ 'name' => 'bitbucket-pr-webhook-app',
+ 'git_repository' => 'https://bitbucket.org/test-org/test-repo',
+ 'git_branch' => 'main',
+ 'build_pack' => 'nixpacks',
+ 'ports_exposes' => '3000',
+ 'environment_id' => $environment->id,
+ 'destination_id' => $destination->id,
+ 'destination_type' => $destination->getMorphClass(),
+ ]);
+}
+
+function sendBitbucketPullRequestWebhook(Application $application, string $event, string $destinationBranch)
+{
+ $body = json_encode([
+ 'repository' => [
+ 'full_name' => 'test-org/test-repo',
+ 'uuid' => '{repository-uuid}',
+ ],
+ 'pullrequest' => [
+ 'id' => 42,
+ 'title' => 'Stacked change',
+ 'links' => ['html' => ['href' => 'https://bitbucket.org/test-org/test-repo/pull-requests/42']],
+ 'source' => [
+ 'branch' => ['name' => 'feature/child'],
+ 'commit' => ['hash' => 'abc1234def5678'],
+ 'repository' => ['uuid' => '{repository-uuid}'],
+ ],
+ 'destination' => [
+ 'branch' => ['name' => $destinationBranch],
+ 'repository' => ['uuid' => '{repository-uuid}'],
+ ],
+ ],
+ ], JSON_THROW_ON_ERROR);
+
+ return test()->call('POST', '/webhooks/source/bitbucket/events/manual', [], [], [], [
+ 'HTTP_X-Event-Key' => $event,
+ 'HTTP_X-Hub-Signature' => 'sha256='.hash_hmac('sha256', $body, $application->manual_webhook_secret_bitbucket),
+ 'CONTENT_TYPE' => 'application/json',
+ ], $body);
+}
+
+it('cleans up the preview of a closed pull request after the destination branch changes', function (string $event) {
+ $application = createBitbucketPullRequestWebhookApplication();
+ $preview = ApplicationPreview::create([
+ 'application_id' => $application->id,
+ 'pull_request_id' => 42,
+ 'pull_request_html_url' => 'https://bitbucket.org/test-org/test-repo/pull-requests/42',
+ 'git_type' => 'bitbucket',
+ ]);
+
+ CleanupPreviewDeployment::shouldRun()
+ ->once()
+ ->withArgs(fn (Application $cleanedApplication, int $pullRequestId, ApplicationPreview $cleanedPreview): bool => $cleanedApplication->is($application)
+ && $pullRequestId === 42
+ && $cleanedPreview->is($preview))
+ ->andReturn([
+ 'cancelled_deployments' => 0,
+ 'killed_containers' => 0,
+ 'status' => 'success',
+ ]);
+
+ $response = sendBitbucketPullRequestWebhook($application, $event, 'feature/parent');
+
+ $response->assertOk();
+ expect($response->getContent())->toContain('Preview deployment closed.');
+})->with(['pullrequest:fulfilled', 'pullrequest:rejected']);
+
+it('continues to filter opened pull requests by destination branch', function () {
+ Queue::fake();
+ $application = createBitbucketPullRequestWebhookApplication();
+ $application->settings->update(['is_preview_deployments_enabled' => true]);
+
+ $response = sendBitbucketPullRequestWebhook($application, 'pullrequest:created', 'feature/parent');
+
+ $response->assertOk();
+ expect(ApplicationPreview::where('application_id', $application->id)->exists())->toBeFalse();
+});