Skip to content

fix: re-sync SSH deploy keys when updating site source control #1083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
urufudev wants to merge 6 commits into
base: 3.x
Choose a base branch
from
Open

fix: re-sync SSH deploy keys when updating site source control #1083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64937c7
fix: re-sync SSH deploy keys when updating site source control
urufudev May 11, 2026
7d9b0b9
fix: unsetRelation to avoid cached sourceControl after update
urufudev May 13, 2026
b2d80a9
test: add test coverage for deploy key re-sync on source control update
urufudev May 13, 2026
a9ffcee
fix: validate new source control before deleting old deploy key
urufudev May 15, 2026
80206af
Merge branch '3.x' into fix/ssh-key-resync-on-source-control-update
saeedvaziry May 20, 2026
aa7abdc
style
saeedvaziry May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions app/Actions/Site/UpdateSourceControl.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
use App\Exceptions\RepositoryPermissionDenied;
use App\Exceptions\SourceControlIsNotConnected;
use App\Models\Site;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException;
use Throwable;

class UpdateSourceControl
{
Expand All @@ -27,6 +29,8 @@ public function update(Site $site, array $input): void
])->validate();

$site->source_control_id = $input['source_control'];
$site->unsetRelation('sourceControl');

try {
if ($site->sourceControl) {
$site->sourceControl->getRepo($site->repository);
Expand All @@ -44,6 +48,42 @@ public function update(Site $site, array $input): void
'repository' => 'Repository not found',
]);
}

try {
if ($site->sourceControl && isset($site->type_data['deploy_key_id'])) {
$site->unsetRelation('sourceControl');
$site->source_control_id = $site->getOriginal('source_control_id');
$site->unsetRelation('sourceControl');
$site->sourceControl->provider()->deleteDeployKey(
$site->type_data['deploy_key_id'],
$site->repository,
);
}
} catch (Throwable $e) {
Log::warning('Failed to delete previous deploy key during source control update', [
'site' => $site->id,
'error' => $e->getMessage(),
]);
}

$site->source_control_id = $input['source_control'];
$site->unsetRelation('sourceControl');
$site->save();

if ($site->ssh_key && $site->repository) {
try {
$keyId = $site->sourceControl->provider()->deployKey(
$site->getDeployKeyName(),
$site->repository,
$site->ssh_key
);
$site->jsonUpdate('type_data', 'deploy_key_id', $keyId);
} catch (Throwable $e) {
Log::warning('Failed to re-deploy SSH key after source control update', [
'site' => $site->id,
'error' => $e->getMessage(),
]);
}
}
}
}
115 changes: 107 additions & 8 deletions tests/Feature/SitesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ public function test_create_site(array $inputs): void
SSH::fake();

Http::fake([
'https://api.github.com/repos/*' => Http::response([
], 201),
'https://api.github.com/repos/*' => Http::response([], 201),
]);

if (isset($inputs['database']) && isset($inputs['database_user'])) {
Expand Down Expand Up @@ -102,8 +101,7 @@ public function test_create_site_failed_due_to_source_control(int $status): void
SSH::fake();

Http::fake([
'https://api.github.com/repos/*' => Http::response([
], $status),
'https://api.github.com/repos/*' => Http::response([], $status),
]);

$this->actingAs($this->user);
Expand Down Expand Up @@ -192,8 +190,7 @@ public function test_update_source_control(): void
$this->actingAs($this->user);

Http::fake([
'https://api.github.com/repos/*' => Http::response([
], 201),
'https://api.github.com/repos/*' => Http::response([], 201),
]);

/** @var SourceControl $sourceControl */
Expand All @@ -214,15 +211,117 @@ public function test_update_source_control(): void
$this->assertEquals($sourceControl->id, $this->site->source_control_id);
}

public function test_update_source_control_deletes_old_deploy_key(): void
{
SSH::fake();

$this->actingAs($this->user);

Http::fake([
'https://api.github.com/repos/*/keys/*' => Http::response([], 204),
'https://api.github.com/repos/*' => Http::response(['id' => 99], 201),
]);

/** @var SourceControl $newSourceControl */
$newSourceControl = SourceControl::factory()->create([
'provider' => Github::id(),
]);

$this->site->type_data = array_merge($this->site->type_data ?? [], [
'deploy_key_id' => '123456',
]);
$this->site->save();

$this->patch(route('site-settings.update-source-control', [
'server' => $this->server->id,
'site' => $this->site,
]), [
'source_control' => $newSourceControl->id,
])
->assertSessionDoesntHaveErrors();

Http::assertSent(function ($request) {
return str_contains($request->url(), '/keys/123456')
&& $request->method() === 'DELETE';
});
}

public function test_update_source_control_registers_new_deploy_key(): void
{
SSH::fake();

$this->actingAs($this->user);

Http::fake([
'https://api.github.com/repos/*/keys' => Http::response(['id' => 99999], 201),
'https://api.github.com/repos/*' => Http::response([], 200),
]);

/** @var SourceControl $newSourceControl */
$newSourceControl = SourceControl::factory()->create([
'provider' => Github::id(),
]);

$this->site->ssh_key = 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC test@test';
$this->site->save();

$this->patch(route('site-settings.update-source-control', [
'server' => $this->server->id,
'site' => $this->site,
]), [
'source_control' => $newSourceControl->id,
])
->assertSessionDoesntHaveErrors();

$this->site->refresh();

$this->assertEquals(99999, $this->site->type_data['deploy_key_id']);
}

public function test_update_source_control_succeeds_even_if_old_deploy_key_deletion_fails(): void
{
SSH::fake();

$this->actingAs($this->user);

Http::fake([
'https://api.github.com/repos/*/keys/*' => Http::response([
'message' => 'Bad credentials',
], 401),
'https://api.github.com/repos/*' => Http::response(['id' => 77777], 201),
]);

/** @var SourceControl $newSourceControl */
$newSourceControl = SourceControl::factory()->create([
'provider' => Github::id(),
]);

$this->site->type_data = array_merge($this->site->type_data ?? [], [
'deploy_key_id' => '123456',
]);
$this->site->ssh_key = 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC test@test';
$this->site->save();

$this->patch(route('site-settings.update-source-control', [
'server' => $this->server->id,
'site' => $this->site,
]), [
'source_control' => $newSourceControl->id,
])
->assertSessionDoesntHaveErrors();

$this->site->refresh();
$this->assertEquals($newSourceControl->id, $this->site->source_control_id);
}

public function test_failed_to_update_source_control(): void
{
SSH::fake();

$this->actingAs($this->user);

Http::fake([
'https://api.github.com/repos/*' => Http::response([
], 404),
'https://api.github.com/repos/*' => Http::response([], 404),
]);

/** @var SourceControl $sourceControl */
Expand Down
Loading