fix unhandled source control exceptions (#364)

2025-07-02 14:36:17 +00:00 · 2024-11-14 22:27:51 +01:00
parent 1dfd13583a
commit 1ca72d7ddd
10 changed files with 233 additions and 437 deletions
--- a/app/Models/GitHook.php
+++ b/app/Models/GitHook.php
@ -2,6 +2,7 @@

 namespace App\Models;

+use App\Exceptions\FailedToDestroyGitHook;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;

@ -55,6 +56,9 @@ public function deployHook(): void
        );
    }

+    /**
+     * @throws FailedToDestroyGitHook
+     */
    public function destroyHook(): void
    {
        $this->sourceControl->provider()->destroyHook($this->site->repository, $this->hook_id);
--- a/app/Models/Site.php
+++ b/app/Models/Site.php
@ -3,6 +3,7 @@
 namespace App\Models;

 use App\Enums\SiteStatus;
+use App\Exceptions\FailedToDestroyGitHook;
 use App\Exceptions\SourceControlIsNotConnected;
 use App\Exceptions\SSHError;
 use App\SiteTypes\SiteType;
@ -252,6 +253,7 @@ public function enableAutoDeployment(): void

    /**
     * @throws SourceControlIsNotConnected
+     * @throws FailedToDestroyGitHook
     */
    public function disableAutoDeployment(): void
    {
--- a/app/SiteTypes/AbstractSiteType.php
+++ b/app/SiteTypes/AbstractSiteType.php
@ -2,7 +2,7 @@

 namespace App\SiteTypes;

-use App\Exceptions\SourceControlIsNotConnected;
+use App\Exceptions\FailedToDeployGitKey;
 use App\Models\Site;

 abstract class AbstractSiteType implements SiteType
@ -21,7 +21,7 @@ protected function progress(int $percentage): void
    }

    /**
-     * @throws SourceControlIsNotConnected
+     * @throws FailedToDeployGitKey
     */
    protected function deployKey(): void
    {
--- a/app/SiteTypes/PHPSite.php
+++ b/app/SiteTypes/PHPSite.php
@ -3,7 +3,7 @@
 namespace App\SiteTypes;

 use App\Enums\SiteFeature;
-use App\Exceptions\SourceControlIsNotConnected;
+use App\Exceptions\FailedToDeployGitKey;
 use App\SSH\Composer\Composer;
 use App\SSH\Git\Git;
 use App\SSH\Services\Webserver\Webserver;
@ -72,7 +72,7 @@ public function data(array $input): array
    }

    /**
-     * @throws SourceControlIsNotConnected
+     * @throws FailedToDeployGitKey
     */
    public function install(): void
    {
--- a/app/SourceControlProviders/Bitbucket.php
+++ b/app/SourceControlProviders/Bitbucket.php
@ -39,8 +39,12 @@ public function data(): array

    public function connect(): bool
    {
-        $res = Http::withHeaders($this->getAuthenticationHeaders())
-            ->get($this->apiUrl.'/repositories');
+        try {
+            $res = Http::withHeaders($this->getAuthenticationHeaders())
+                ->get($this->apiUrl.'/repositories');
+        } catch (Exception) {
+            return false;
+        }

        return $res->successful();
    }
@ -68,18 +72,22 @@ public function fullRepoUrl(string $repo, string $key): string
     */
    public function deployHook(string $repo, array $events, string $secret): array
    {
-        $response = Http::withHeaders($this->getAuthenticationHeaders())
-            ->post($this->apiUrl."/repositories/$repo/hooks", [
-                'description' => 'deploy',
-                'url' => url('/api/git-hooks?secret='.$secret),
-                'events' => [
-                    'repo:'.implode(',', $events),
-                ],
-                'active' => true,
-            ]);
+        try {
+            $response = Http::withHeaders($this->getAuthenticationHeaders())
+                ->post($this->apiUrl."/repositories/$repo/hooks", [
+                    'description' => 'deploy',
+                    'url' => url('/api/git-hooks?secret='.$secret),
+                    'events' => [
+                        'repo:'.implode(',', $events),
+                    ],
+                    'active' => true,
+                ]);
+        } catch (Exception $e) {
+            throw new FailedToDeployGitHook($e->getMessage());
+        }

        if ($response->status() != 201) {
-            throw new FailedToDeployGitHook($response->json()['error']['message']);
+            throw new FailedToDeployGitHook($response->body());
        }

        return [
@ -94,11 +102,15 @@ public function deployHook(string $repo, array $events, string $secret): array
    public function destroyHook(string $repo, string $hookId): void
    {
        $hookId = urlencode($hookId);
-        $response = Http::withHeaders($this->getAuthenticationHeaders())
-            ->delete($this->apiUrl."/repositories/$repo/hooks/$hookId");
+        try {
+            $response = Http::withHeaders($this->getAuthenticationHeaders())
+                ->delete($this->apiUrl."/repositories/$repo/hooks/$hookId");
+        } catch (Exception $e) {
+            throw new FailedToDestroyGitHook($e->getMessage());
+        }

        if ($response->status() != 204) {
-            throw new FailedToDestroyGitHook('Error');
+            throw new FailedToDestroyGitHook($response->body());
        }
    }

@ -134,13 +146,17 @@ public function getLastCommit(string $repo, string $branch): ?array
     */
    public function deployKey(string $title, string $repo, string $key): void
    {
-        $res = Http::withHeaders($this->getAuthenticationHeaders())->post(
-            $this->apiUrl."/repositories/$repo/deploy-keys",
-            [
-                'label' => $title,
-                'key' => $key,
-            ]
-        );
+        try {
+            $res = Http::withHeaders($this->getAuthenticationHeaders())->post(
+                $this->apiUrl."/repositories/$repo/deploy-keys",
+                [
+                    'label' => $title,
+                    'key' => $key,
+                ]
+            );
+        } catch (Exception $e) {
+            throw new FailedToDeployGitKey($e->getMessage());
+        }

        if ($res->status() != 200) {
            throw new FailedToDeployGitKey($res->json()['error']['message']);
--- a/app/SourceControlProviders/Github.php
+++ b/app/SourceControlProviders/Github.php
@ -14,10 +14,14 @@ class Github extends AbstractSourceControlProvider

    public function connect(): bool
    {
-        $res = Http::withHeaders([
-            'Accept' => 'application/vnd.github.v3+json',
-            'Authorization' => 'Bearer '.$this->data()['token'],
-        ])->get($this->apiUrl.'/user/repos');
+        try {
+            $res = Http::withHeaders([
+                'Accept' => 'application/vnd.github.v3+json',
+                'Authorization' => 'Bearer '.$this->data()['token'],
+            ])->get($this->apiUrl.'/user/repos');
+        } catch (Exception) {
+            return false;
+        }

        return $res->successful();
    }
@ -52,21 +56,25 @@ public function fullRepoUrl(string $repo, string $key): string
     */
    public function deployHook(string $repo, array $events, string $secret): array
    {
-        $response = Http::withHeaders([
-            'Accept' => 'application/vnd.github.v3+json',
-            'Authorization' => 'Bearer '.$this->data()['token'],
-        ])->post($this->apiUrl."/repos/$repo/hooks", [
-            'name' => 'web',
-            'events' => $events,
-            'config' => [
-                'url' => url('/api/git-hooks?secret='.$secret),
-                'content_type' => 'json',
-            ],
-            'active' => true,
-        ]);
+        try {
+            $response = Http::withHeaders([
+                'Accept' => 'application/vnd.github.v3+json',
+                'Authorization' => 'Bearer '.$this->data()['token'],
+            ])->post($this->apiUrl."/repos/$repo/hooks", [
+                'name' => 'web',
+                'events' => $events,
+                'config' => [
+                    'url' => url('/api/git-hooks?secret='.$secret),
+                    'content_type' => 'json',
+                ],
+                'active' => true,
+            ]);
+        } catch (Exception $e) {
+            throw new FailedToDeployGitHook($e->getMessage());
+        }

        if ($response->status() != 201) {
-            throw new FailedToDeployGitHook(json_decode($response->body())->message);
+            throw new FailedToDeployGitHook($response->body());
        }

        return [
@ -80,13 +88,17 @@ public function deployHook(string $repo, array $events, string $secret): array
     */
    public function destroyHook(string $repo, string $hookId): void
    {
-        $response = Http::withHeaders([
-            'Accept' => 'application/vnd.github.v3+json',
-            'Authorization' => 'Bearer '.$this->data()['token'],
-        ])->delete($this->apiUrl."/repos/$repo/hooks/$hookId");
+        try {
+            $response = Http::withHeaders([
+                'Accept' => 'application/vnd.github.v3+json',
+                'Authorization' => 'Bearer '.$this->data()['token'],
+            ])->delete($this->apiUrl."/repos/$repo/hooks/$hookId");
+        } catch (Exception $e) {
+            throw new FailedToDestroyGitHook($e->getMessage());
+        }

        if ($response->status() != 204) {
-            throw new FailedToDestroyGitHook(json_decode($response->body())->message);
+            throw new FailedToDestroyGitHook($response->body());
        }
    }

@ -124,17 +136,21 @@ public function getLastCommit(string $repo, string $branch): ?array
     */
    public function deployKey(string $title, string $repo, string $key): void
    {
-        $response = Http::withToken($this->data()['token'])->post(
-            $this->apiUrl.'/repos/'.$repo.'/keys',
-            [
-                'title' => $title,
-                'key' => $key,
-                'read_only' => false,
-            ]
-        );
+        try {
+            $response = Http::withToken($this->data()['token'])->post(
+                $this->apiUrl.'/repos/'.$repo.'/keys',
+                [
+                    'title' => $title,
+                    'key' => $key,
+                    'read_only' => false,
+                ]
+            );
+        } catch (Exception $e) {
+            throw new FailedToDeployGitKey($e->getMessage());
+        }

        if ($response->status() != 201) {
-            throw new FailedToDeployGitKey(json_decode($response->body())->message);
+            throw new FailedToDeployGitKey($response->body());
        }
    }
 }
--- a/app/SourceControlProviders/Gitlab.php
+++ b/app/SourceControlProviders/Gitlab.php
@ -28,8 +28,12 @@ public function createRules(array $input): array

    public function connect(): bool
    {
-        $res = Http::withToken($this->data()['token'])
-            ->get($this->getApiUrl().'/projects');
+        try {
+            $res = Http::withToken($this->data()['token'])
+                ->get($this->getApiUrl().'/projects');
+        } catch (Exception) {
+            return false;
+        }

        return $res->successful();
    }
@ -61,27 +65,31 @@ public function fullRepoUrl(string $repo, string $key): string
    public function deployHook(string $repo, array $events, string $secret): array
    {
        $repository = urlencode($repo);
-        $response = Http::withToken($this->data()['token'])->post(
-            $this->getApiUrl().'/projects/'.$repository.'/hooks',
-            [
-                'description' => 'deploy',
-                'url' => url('/api/git-hooks?secret='.$secret),
-                'push_events' => in_array('push', $events),
-                'issues_events' => false,
-                'job_events' => false,
-                'merge_requests_events' => false,
-                'note_events' => false,
-                'pipeline_events' => false,
-                'tag_push_events' => false,
-                'wiki_page_events' => false,
-                'deployment_events' => false,
-                'confidential_note_events' => false,
-                'confidential_issues_events' => false,
-            ]
-        );
+        try {
+            $response = Http::withToken($this->data()['token'])->post(
+                $this->getApiUrl().'/projects/'.$repository.'/hooks',
+                [
+                    'description' => 'deploy',
+                    'url' => url('/api/git-hooks?secret='.$secret),
+                    'push_events' => in_array('push', $events),
+                    'issues_events' => false,
+                    'job_events' => false,
+                    'merge_requests_events' => false,
+                    'note_events' => false,
+                    'pipeline_events' => false,
+                    'tag_push_events' => false,
+                    'wiki_page_events' => false,
+                    'deployment_events' => false,
+                    'confidential_note_events' => false,
+                    'confidential_issues_events' => false,
+                ]
+            );
+        } catch (Exception $e) {
+            throw new FailedToDeployGitHook($e->getMessage());
+        }

        if ($response->status() != 201) {
-            throw new FailedToDeployGitHook(json_decode($response->body())->message);
+            throw new FailedToDeployGitHook($response->body());
        }

        return [
@ -96,12 +104,16 @@ public function deployHook(string $repo, array $events, string $secret): array
    public function destroyHook(string $repo, string $hookId): void
    {
        $repository = urlencode($repo);
-        $response = Http::withToken($this->data()['token'])->delete(
-            $this->getApiUrl().'/projects/'.$repository.'/hooks/'.$hookId
-        );
+        try {
+            $response = Http::withToken($this->data()['token'])->delete(
+                $this->getApiUrl().'/projects/'.$repository.'/hooks/'.$hookId
+            );
+        } catch (Exception $e) {
+            throw new FailedToDestroyGitHook($e->getMessage());
+        }

        if ($response->status() != 204) {
-            throw new FailedToDestroyGitHook(json_decode($response->body())->message);
+            throw new FailedToDestroyGitHook($response->body());
        }
    }

@ -138,17 +150,21 @@ public function getLastCommit(string $repo, string $branch): ?array
    public function deployKey(string $title, string $repo, string $key): void
    {
        $repository = urlencode($repo);
-        $response = Http::withToken($this->data()['token'])->post(
-            $this->getApiUrl().'/projects/'.$repository.'/deploy_keys',
-            [
-                'title' => $title,
-                'key' => $key,
-                'can_push' => true,
-            ]
-        );
+        try {
+            $response = Http::withToken($this->data()['token'])->post(
+                $this->getApiUrl().'/projects/'.$repository.'/deploy_keys',
+                [
+                    'title' => $title,
+                    'key' => $key,
+                    'can_push' => true,
+                ]
+            );
+        } catch (Exception $e) {
+            throw new FailedToDeployGitKey($e->getMessage());
+        }

        if ($response->status() != 201) {
-            throw new FailedToDeployGitKey(json_decode($response->body())->message);
+            throw new FailedToDeployGitKey($response->body());
        }
    }

--- a/app/SourceControlProviders/SourceControlProvider.php
+++ b/app/SourceControlProviders/SourceControlProvider.php
@ -2,6 +2,9 @@

 namespace App\SourceControlProviders;

+use App\Exceptions\FailedToDeployGitKey;
+use App\Exceptions\FailedToDestroyGitHook;
+
 interface SourceControlProvider
 {
    public function createRules(array $input): array;
@ -22,9 +25,15 @@ public function fullRepoUrl(string $repo, string $key): string;

    public function deployHook(string $repo, array $events, string $secret): array;

+    /**
+     * @throws FailedToDestroyGitHook
+     */
    public function destroyHook(string $repo, string $hookId): void;

    public function getLastCommit(string $repo, string $branch): ?array;

+    /**
+     * @throws FailedToDeployGitKey
+     */
    public function deployKey(string $title, string $repo, string $key): void;
 }