chore: add strict_types throughout codebase

vanguardbackup · Jun 24, 2024 · e829503 · e829503
1 parent 73257fb
commit e829503
Show file tree

Hide file tree

Showing 105 changed files with 276 additions and 17 deletions.
diff --git a/app/Actions/BackupDestinations/CheckS3Connection.php b/app/Actions/BackupDestinations/CheckS3Connection.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Actions\BackupDestinations;
 
 use App\Events\BackupDestinationConnectionCheck;

diff --git a/app/Actions/RemoteServer/CheckRemoteServerConnection.php b/app/Actions/RemoteServer/CheckRemoteServerConnection.php
@@ -1,11 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Actions\RemoteServer;
 
 use App\Events\RemoteServerConnectivityStatusChanged;
 use App\Models\RemoteServer;
 use Exception;
 use Illuminate\Support\Facades\Log;
+use phpseclib3\Crypt\Common\PrivateKey;
 use phpseclib3\Crypt\PublicKeyLoader;
 use phpseclib3\Net\SSH2;
 use RuntimeException;
@@ -56,7 +59,7 @@ private function checkServerConnection(array $data, ?RemoteServer $remoteServer
         }
 
         try {
-            // Load the private key
+            /** @var PrivateKey $key */
             $key = PublicKeyLoader::load(get_ssh_private_key(), config('app.ssh.passphrase'));
 
             $ssh = new SSH2($data['host'], $data['port']);
@@ -81,7 +84,7 @@ private function checkServerConnection(array $data, ?RemoteServer $remoteServer
 
             Log::debug('[Server Connection Check] Successfully connected to remote server');
 
-            if ($remoteServer) {
+            if ($remoteServer instanceof \App\Models\RemoteServer) {
                 Log::debug('[Server Connection Check] Dispatching RemoteServerConnectivityStatusChanged event (result: ' . $remoteServer->connectivity_status . ')', ['remote_server' => $remoteServer]);
                 RemoteServerConnectivityStatusChanged::dispatch($remoteServer, $remoteServer->connectivity_status);
             }
@@ -97,7 +100,7 @@ private function checkServerConnection(array $data, ?RemoteServer $remoteServer
                 'connectivity_status' => RemoteServer::STATUS_OFFLINE,
             ]);
 
-            if ($remoteServer) {
+            if ($remoteServer instanceof \App\Models\RemoteServer) {
                 Log::debug('[Server Connection Check] Dispatching RemoteServerConnectivityStatusChanged event (result: ' . $remoteServer->connectivity_status . ')', ['remote_server' => $remoteServer]);
                 RemoteServerConnectivityStatusChanged::dispatch($remoteServer, $remoteServer->connectivity_status);
             }

diff --git a/app/Actions/RemoteServer/RemoveSSHKey.php b/app/Actions/RemoteServer/RemoveSSHKey.php
@@ -1,12 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Actions\RemoteServer;
 
 use App\Mail\RemoteServers\FailedToRemoveKey;
 use App\Mail\RemoteServers\SuccessfullyRemovedKey;
 use App\Models\RemoteServer;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Mail;
+use phpseclib3\Crypt\Common\PrivateKey;
 use phpseclib3\Crypt\PublicKeyLoader;
 use phpseclib3\Net\SSH2;
 use RuntimeException;
@@ -17,6 +20,7 @@ public function handle(RemoteServer $remoteServer): void
     {
         Log::info('Removing SSH key from server.', ['server_id' => $remoteServer->id]);
 
+        /** @var PrivateKey $key */
         $key = PublicKeyLoader::load(get_ssh_private_key(), config('app.ssh.passphrase'));
 
         try {

diff --git a/app/Console/Commands/CheckVersion.php b/app/Console/Commands/CheckVersion.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use Exception;

diff --git a/app/Console/Commands/EncryptDatabasePasswordsCommand.php b/app/Console/Commands/EncryptDatabasePasswordsCommand.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use App\Models\RemoteServer;

diff --git a/app/Console/Commands/EnsureConnectionToBackupDestinationsCommand.php b/app/Console/Commands/EnsureConnectionToBackupDestinationsCommand.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use App\Jobs\CheckBackupDestinationsS3ConnectionJob;

diff --git a/app/Console/Commands/ExecuteScheduledBackupTasksCommand.php b/app/Console/Commands/ExecuteScheduledBackupTasksCommand.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use App\Models\BackupTask;

diff --git a/app/Console/Commands/GenerateSSHKeyCommand.php b/app/Console/Commands/GenerateSSHKeyCommand.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use Illuminate\Console\Command;

diff --git a/app/Console/Commands/ResetInoperativeBackupTasksCommand.php b/app/Console/Commands/ResetInoperativeBackupTasksCommand.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use App\Models\BackupTask;

diff --git a/app/Console/Commands/ValidateS3ConnectionCommand.php b/app/Console/Commands/ValidateS3ConnectionCommand.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use App\Actions\BackupDestinations\CheckS3Connection;

diff --git a/app/Console/Commands/VerifyConnectionToRemoteServersCommand.php b/app/Console/Commands/VerifyConnectionToRemoteServersCommand.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console\Commands;
 
 use App\Jobs\CheckRemoteServerConnectionJob;

diff --git a/app/Events/BackupDestinationConnectionCheck.php b/app/Events/BackupDestinationConnectionCheck.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Events;
 
 use App\Models\BackupDestination;

diff --git a/app/Events/BackupTaskStatusChanged.php b/app/Events/BackupTaskStatusChanged.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Events;
 
 use App\Models\BackupTask;

diff --git a/app/Events/CreatedBackupTaskLog.php b/app/Events/CreatedBackupTaskLog.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Events;
 
 use App\Models\BackupTask;

diff --git a/app/Events/RemoteServerConnectivityStatusChanged.php b/app/Events/RemoteServerConnectivityStatusChanged.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Events;
 
 use App\Models\RemoteServer;

diff --git a/app/Events/StreamBackupTaskLogEvent.php b/app/Events/StreamBackupTaskLogEvent.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Events;
 
 use App\Models\BackupTask;

diff --git a/app/Exceptions/BackupTaskRuntimeException.php b/app/Exceptions/BackupTaskRuntimeException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Exception;

diff --git a/app/Exceptions/BackupTaskZipException.php b/app/Exceptions/BackupTaskZipException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Exception;

diff --git a/app/Exceptions/DatabaseDumpException.php b/app/Exceptions/DatabaseDumpException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Exception;

diff --git a/app/Exceptions/S3ConnectionException.php b/app/Exceptions/S3ConnectionException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Exception;

diff --git a/app/Exceptions/SFTPConnectionException.php b/app/Exceptions/SFTPConnectionException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Exception;

diff --git a/app/Exceptions/TaskBackupFileRotationException.php b/app/Exceptions/TaskBackupFileRotationException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Exception;

diff --git a/app/Facades/Greeting.php b/app/Facades/Greeting.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Facades;
 
 use App\Services\GreetingService;

diff --git a/app/Http/Controllers/Auth/GitHubSocialiteController.php b/app/Http/Controllers/Auth/GitHubSocialiteController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers\Auth;
 
 use App\Http\Controllers\Controller;
@@ -39,11 +41,11 @@ public function handleProviderCallback(): RedirectResponse
         try {
             $githubUser = Socialite::driver('github')->user();
 
-            if ($user = $this->findUserByGitHubId($githubUser->getId())) {
+            if (($user = $this->findUserByGitHubId($githubUser->getId())) instanceof \App\Models\User) {
                 return $this->loginAndRedirect($user, 'Found GH ID associated with this user, logging them in.');
             }
 
-            if ($user = $this->findUserByEmailAndUpdateGitHubId($githubUser)) {
+            if (($user = $this->findUserByEmailAndUpdateGitHubId($githubUser)) instanceof \App\Models\User) {
                 return $this->loginAndRedirect($user, 'Adding the user\'s GH ID to their account.');
             }
 

diff --git a/app/Http/Controllers/Auth/VerifyEmailController.php b/app/Http/Controllers/Auth/VerifyEmailController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers\Auth;
 
 use App\Http\Controllers\Controller;

diff --git a/app/Http/Controllers/BackupDestinations/EditController.php b/app/Http/Controllers/BackupDestinations/EditController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers\BackupDestinations;
 
 use App\Http\Controllers\Controller;

diff --git a/app/Http/Controllers/BackupTasks/EditController.php b/app/Http/Controllers/BackupTasks/EditController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers\BackupTasks;
 
 use App\Http\Controllers\Controller;

diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers;
 
 abstract class Controller

diff --git a/app/Http/Controllers/OverviewController.php b/app/Http/Controllers/OverviewController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers;
 
 use App\Models\BackupTask;

diff --git a/app/Http/Controllers/RemoteServers/EditController.php b/app/Http/Controllers/RemoteServers/EditController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers\RemoteServers;
 
 use App\Http\Controllers\Controller;

diff --git a/app/Http/Controllers/Tags/EditController.php b/app/Http/Controllers/Tags/EditController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers\Tags;
 
 use App\Http\Controllers\Controller;

diff --git a/app/Jobs/BackupTasks/SendDiscordNotificationJob.php b/app/Jobs/BackupTasks/SendDiscordNotificationJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs\BackupTasks;
 
 use App\Models\BackupTask;

diff --git a/app/Jobs/BackupTasks/SendSlackNotificationJob.php b/app/Jobs/BackupTasks/SendSlackNotificationJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs\BackupTasks;
 
 use App\Models\BackupTask;

diff --git a/app/Jobs/CheckBackupDestinationsS3ConnectionJob.php b/app/Jobs/CheckBackupDestinationsS3ConnectionJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs;
 
 use App\Actions\BackupDestinations\CheckS3Connection;

diff --git a/app/Jobs/CheckRemoteServerConnectionJob.php b/app/Jobs/CheckRemoteServerConnectionJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs;
 
 use App\Actions\RemoteServer\CheckRemoteServerConnection;

diff --git a/app/Jobs/RemoteServers/RemoveSSHKeyJob.php b/app/Jobs/RemoteServers/RemoveSSHKeyJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs\RemoteServers;
 
 use App\Actions\RemoteServer\RemoveSSHKey;

diff --git a/app/Jobs/RemoteServers/RemoveServerJob.php b/app/Jobs/RemoteServers/RemoveServerJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs\RemoteServers;
 
 use App\Models\RemoteServer;

diff --git a/app/Jobs/RunDatabaseBackupTaskJob.php b/app/Jobs/RunDatabaseBackupTaskJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs;
 
 use App\Services\Backup\Tasks\DatabaseBackup;

diff --git a/app/Jobs/RunFileBackupTaskJob.php b/app/Jobs/RunFileBackupTaskJob.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Jobs;
 
 use App\Services\Backup\Tasks\FileBackup;

diff --git a/app/Livewire/Actions/Logout.php b/app/Livewire/Actions/Logout.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Livewire\Actions;
 
 use Illuminate\Support\Facades\Auth;

diff --git a/app/Livewire/BackupDestinations/CheckConnectionButton.php b/app/Livewire/BackupDestinations/CheckConnectionButton.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Livewire\BackupDestinations;
 
 use App\Models\BackupDestination;

diff --git a/app/Livewire/BackupDestinations/CreateBackupDestinationForm.php b/app/Livewire/BackupDestinations/CreateBackupDestinationForm.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Livewire\BackupDestinations;
 
 use App\Models\BackupDestination;