Modernize codebase with PHP 8.1+ features

config/sidecar.php

@@ -46,7 +46,7 @@
      * The default architecture your function runs on.
      * Available options are: x86_64, arm64
      */
-    'architecture' => env('SIDECAR_ARCH', Architecture::X86_64),
+    'architecture' => env('SIDECAR_ARCH', Architecture::X86_64->value),
 
     /*
      * The base path for your package files. If you e.g. keep

src/Architecture.php

@@ -1,10 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Hammerstone\Sidecar;
 
-abstract class Architecture
+enum Architecture: string
 {
-    public const X86_64 = 'x86_64';
-
-    public const ARM_64 = 'arm64';
+    case X86_64 = 'x86_64';
+    case ARM_64 = 'arm64';
 }

src/ArchitectureConstants.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hammerstone\Sidecar;
+
+/**
+ * @deprecated Use the Architecture enum instead. This class will be removed in a future version.
+ */
+abstract class ArchitectureConstants
+{
+    /** @deprecated Use Architecture::X86_64 instead */
+    public const X86_64 = Architecture::X86_64->value;
+
+    /** @deprecated Use Architecture::ARM_64 instead */
+    public const ARM_64 = Architecture::ARM_64->value;
+}

src/Clients/CloudWatchLogsClient.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */

src/Clients/Configurations/AwsClientConfiguration.php

@@ -1,12 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Hammerstone\Sidecar\Clients\Configurations;
 
 use Hammerstone\Sidecar\Contracts\AwsClientConfiguration as AwsClientConfigurationContract;
 
 class AwsClientConfiguration implements AwsClientConfigurationContract
 {
-    public function getConfiguration()
+    public function getConfiguration(): array
     {
         $config = [
             'version' => 'latest',

src/Clients/LambdaClient.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */

src/Clients/S3Client.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Hammerstone\Sidecar\Clients;
 
 use Aws\S3\S3Client as BaseClient;

src/Commands/Actions/BaseAction.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */
@@ -10,26 +12,14 @@
 
 abstract class BaseAction
 {
-    /**
-     * @var Configure
-     */
-    public $command;
-
-    /**
-     * @var string
-     */
-    public $region;
-
-    public function __construct($region, Configure $command)
-    {
-        $this->region = $region;
-
-        $this->command = $command;
-    }
+    public function __construct(
+        public ?string $region,
+        public Configure $command
+    ) {}
 
-    abstract public function invoke();
+    abstract public function invoke(): mixed;
 
-    protected function progress($message)
+    protected function progress(string $message): void
     {
         $this->command->text("==> $message");
     }

src/Commands/Actions/CreateBucket.php

@@ -1,31 +1,25 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */
 
 namespace Hammerstone\Sidecar\Commands\Actions;
 
 use Aws\S3\S3Client;
+use Exception;
 use Illuminate\Support\Str;
 use Throwable;
 
 class CreateBucket extends BaseAction
 {
-    /**
-     * @var S3Client
-     */
-    protected $client;
-
-    /**
-     * @var string
-     */
-    protected $bucket;
-
-    /**
-     * @return string
-     */
-    public function invoke()
+    protected S3Client $client;
+
+    protected string $bucket;
+
+    public function invoke(): string
     {
         $this->client = $this->command->client(S3Client::class);
 

src/Commands/Actions/CreateDeploymentUser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */
@@ -12,15 +14,9 @@
 
 class CreateDeploymentUser extends BaseAction
 {
-    /**
-     * @var IamClient
-     */
-    protected $client;
-
-    /**
-     * @return array
-     */
-    public function invoke()
+    protected IamClient $client;
+
+    public function invoke(): array
     {
         $this->client = $this->command->client(IamClient::class);
 

src/Commands/Actions/CreateExecutionRole.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */
@@ -12,12 +14,9 @@
 
 class CreateExecutionRole extends BaseAction
 {
-    /**
-     * @var IamClient
-     */
-    protected $client;
+    protected IamClient $client;
 
-    public function invoke()
+    public function invoke(): string
     {
         $this->progress('Creating an execution role for your functions...');
 

src/Commands/Actions/DestroyAdminKeys.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */
@@ -11,23 +13,23 @@
 
 class DestroyAdminKeys extends BaseAction
 {
-    public $key;
+    public ?string $key = null;
 
-    public function setKey($key)
+    public function setKey(string $key): static
     {
         $this->key = $key;
 
         return $this;
     }
 
-    public function invoke()
+    public function invoke(): mixed
     {
         $client = $this->command->client(IamClient::class);
 
         try {
             $user = $client->getUser();
         } catch (Throwable $e) {
-            return;
+            return null;
         }
 
         $name = $user['User']['UserName'];
@@ -52,7 +54,7 @@ public function invoke()
         if (!$this->command->confirm($question, $default = $isSidecar)) {
             $this->progress('Not deleting keys');
 
-            return;
+            return null;
         }
 
         $this->progress('Deleting admin keys...');
@@ -67,5 +69,7 @@ public function invoke()
         }
 
         $this->progress('Admin keys deleted');
+
+        return null;
     }
 }

src/Commands/Actions/DetermineRegion.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */
@@ -8,23 +10,15 @@
 
 use Aws\S3\S3Client;
 use Illuminate\Support\Facades\File;
+use Throwable;
 
 class DetermineRegion extends BaseAction
 {
-    /**
-     * @var S3Client
-     */
-    protected $client;
-
-    /**
-     * @var bool
-     */
-    protected $isVapor;
-
-    /**
-     * @return string
-     */
-    public function invoke()
+    protected S3Client $client;
+
+    protected bool $isVapor = false;
+
+    public function invoke(): string
     {
         $region = config('sidecar.aws_region');
 

src/Commands/Activate.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aaron@hammerstone.dev>
  */

src/Commands/Configure.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aaron@hammerstone.dev>
  */
@@ -17,39 +19,17 @@
 
 class Configure extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
     protected $signature = 'sidecar:configure';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Interactively configure your Sidecar AWS environment variables';
 
-    /**
-     * @var string
-     */
-    protected $key;
+    protected ?string $key = null;
 
-    /**
-     * @var string
-     */
-    protected $secret;
+    protected ?string $secret = null;
 
-    /**
-     * @var string
-     */
-    protected $region;
+    protected ?string $region = null;
 
-    /**
-     * @var int
-     */
-    protected $width = 75;
+    protected int $width = 75;
 
     /**
      * @throws Exception

src/Commands/Deploy.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aaron@hammerstone.dev>
  */

src/Commands/EnvironmentAwareCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
  */
@@ -22,7 +24,7 @@ public function __construct()
         $this->getDefinition()->addOptions(Parser::parse($environment)[2]);
     }
 
-    public function overrideEnvironment()
+    public function overrideEnvironment(): void
     {
         if ($environment = $this->option('env')) {
             Sidecar::overrideEnvironment($environment);

src/Commands/Install.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @author Aaron Francis <aaron@hammerstone.dev>
  */