Initial work on the install command to save app settings

Author: AlexJump24

composer.json

@@ -29,6 +29,7 @@
         "illuminate/events": "^11.0",
         "illuminate/queue": "^11.0",
         "illuminate/support": "^11.0",
+        "laravel/prompts": "^0.1",
         "nesbot/carbon": "^2.70",
         "spatie/laravel-query-builder": "^5.5",
         "spatie/laravel-settings": "^3.2",

database/migrations/2024_01_22_205110_create_default_settings.php

@@ -12,8 +12,16 @@ public function up(): void
     {
         // Cachet settings...
         rescue(fn () => $this->migrator->add('app.install_id', Str::random(40)));
-        rescue(fn () => $this->migrator->add('app.name', 'Cachet'));
-        rescue(fn () => $this->migrator->add('app.domain'));
+        rescue(fn () => $this->migrator->add('app.name', 'Cachet V3'));
+        rescue(fn () => $this->migrator->add('app.domain', <<<'ABOUT'
+        Cachet is a **beautiful** and **powerful** open-source status page system.
+        
+        To access the [dashboard](/dashboard), use the following credentials:
+        - `[email protected]`
+        - `test123`
+        
+        Please [consider sponsoring](https://github.com/cachethq/cachet?sponsor=1) the continued development of Cachet.
+        ABOUT));
         rescue(fn () => $this->migrator->add('app.about'));
         rescue(fn () => $this->migrator->add('app.timezone', 'UTC'));
         rescue(fn () => $this->migrator->add('app.locale', 'en'));

database/seeders/DatabaseSeeder.php

@@ -161,27 +161,6 @@ public function run(): void
             'engine' => IncidentTemplateEngineEnum::twig,
         ]);
 
-        $appSettings = app(AppSettings::class);
-        $appSettings->name = 'Cachet v3.x Demo';
-        $appSettings->about = <<<'ABOUT'
-Cachet is a **beautiful** and **powerful** open-source status page system.
-
-To access the [dashboard](/dashboard), use the following credentials:
-- `[email protected]`
-- `test123`
-
-Please [consider sponsoring](https://github.com/cachethq/cachet?sponsor=1) the continued development of Cachet.
-ABOUT;
-        $appSettings->show_support = true;
-        $appSettings->timezone = 'UTC';
-        $appSettings->show_timezone = false;
-        $appSettings->only_disrupted_days = false;
-        $appSettings->incident_days = 7;
-        $appSettings->refresh_rate = null;
-        $appSettings->dashboard_login_link = true;
-        $appSettings->major_outage_threshold = 25;
-        $appSettings->save();
-
         $customizationSettings = app(CustomizationSettings::class);
         $customizationSettings->header = <<<'HTML'
 <script src="https://cdn.usefathom.com/script.js" data-site="NQKCLYJJ" defer></script>

src/CachetCoreServiceProvider.php

@@ -151,6 +151,7 @@ private function registerCommands(): void
     {
         if ($this->app->runningInConsole()) {
             $this->commands([
+                Commands\InstallCommand::class,
                 Commands\SendBeaconCommand::class,
                 Commands\VersionCommand::class,
             ]);

src/Commands/InstallCommand.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Cachet\Commands;
+
+use Cachet\Settings\AppSettings;
+use Cachet\Settings\Attributes\Description;
+use Illuminate\Console\Command;
+use Illuminate\Support\Sleep;
+use ReflectionClass;
+use ReflectionProperty;
+use function Laravel\Prompts\confirm;
+use function Laravel\Prompts\info;
+use function Laravel\Prompts\text;
+
+
+class InstallCommand extends Command
+{
+    protected $name = 'cachet:install';
+
+    protected $description = 'Install Cachet';
+
+    public function handle(AppSettings $settings)
+    {
+        info('Welcome to the Cachet installer!');
+
+        Sleep::for(2)->seconds();
+
+        if (confirm('Do you want to configure Cachet before installing?', true)) {
+            info('Configuring Cachet...');
+            $this->configureDatabaseSettings($settings);
+        }
+
+        info('Installing Cachet...');
+
+        info('Cachet has been installed successfully!');
+
+        return Command::SUCCESS;
+    }
+
+    protected function configureDatabaseSettings(AppSettings $settings): void
+    {
+        collect(
+            (new ReflectionClass($settings))->getProperties(ReflectionProperty::IS_PUBLIC)
+        )
+            ->filter(fn (ReflectionProperty $property) => array_key_exists($property->getName(), $settings->installable()) )
+            ->each(function (ReflectionProperty $property) use ($settings) {
+                $description = $property->getAttributes(Description::class)[0]->getArguments()[0];
+                $value = match($property->getType()?->getName()) {
+                    'bool' => confirm($description ?? $property->getName()),
+                    default => text($description ?? $property->getName(), default: $property->getDefaultValue() ?? '', required: true),
+                };
+
+                $settings->{$property->getName()} = $value;
+            })
+            ->pluck('name');
+
+        $settings->save();
+    }
+}

src/Settings/AppSettings.php

@@ -2,34 +2,54 @@
 
 namespace Cachet\Settings;
 
+use Cachet\Settings\Attributes\Description;
+use Illuminate\Support\Arr;
 use Spatie\LaravelSettings\Settings;
 
 class AppSettings extends Settings
 {
+    #[Description('The unique install ID of the application for telemetry.')]
     public string $install_id;
 
+    #[Description('What is the name of your application?')]
     public ?string $name = 'Cachet';
 
+    #[Description('What is your application about?')]
     public ?string $about;
 
+    #[Description('Do you want to show support for Cachet?')]
     public bool $show_support = true;
 
+    #[Description('What timezone is is the application located in?')]
     public string $timezone = 'UTC';
 
+    #[Description('Would you like to show your timezone on the status page?')]
     public bool $show_timezone = false;
 
+    #[Description('Would you like to only show the days with disruption?')]
     public bool $only_disrupted_days = false;
 
+    #[Description('How many incident days should be shown in the timeline?')]
     public int $incident_days = 7;
 
+    #[Description('After how many seconds should the status page automatically refresh?')]
     public ?int $refresh_rate;
 
+    #[Description('Should the dashboard login link be shown?')]
     public bool $dashboard_login_link = true;
 
+    #[Description('Major outage threshold %')]
     public int $major_outage_threshold = 25;
 
     public static function group(): string
     {
         return 'app';
     }
+
+    public function installable(): array
+    {
+        return Arr::except(get_class_vars(__CLASS__), [
+            'install_id',
+        ]);
+    }
 }

src/Settings/Attributes/Description.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Cachet\Settings\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final class Description
+{
+    public function __construct(private string $description) {}
+}

testbench.yaml

@@ -24,6 +24,7 @@ workbench:
     - migrate:refresh:
         --seed: true
         --seeder: Cachet\Database\Seeders\DatabaseSeeder
+    - cachet:install
   assets:
     - query-builder-config
     - cachet-assets

tests/Unit/Commands/InstallCommandTest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Tests\Unit\Commands;
+
+use Cachet\Settings\AppSettings;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+
+uses(RefreshDatabase::class);
+
+it('runs install command successfully without configuration', function () {
+    $this->artisan('cachet:install')
+        ->expectsOutputToContain('Welcome to the Cachet installer!')
+        ->expectsConfirmation('Do you want to configure Cachet before installing?', 'no')
+        ->expectsOutputToContain('Installing Cachet...')
+        ->expectsOutputToContain('Cachet has been installed successfully!')
+        ->assertSuccessful();
+});
+
+it('updates app settings when configuration is passed', function () {
+    $this->artisan('cachet:install')
+        ->expectsOutputToContain('Welcome to the Cachet installer!')
+        ->expectsConfirmation('Do you want to configure Cachet before installing?', 'yes')
+        ->expectsOutputToContain('Configuring Cachet...')
+        ->expectsQuestion('What is the name of your application?', 'Laravel Envoyer')
+        ->expectsQuestion('What is your application about?', 'Zero downtime deployment tool.')
+        ->expectsConfirmation('Do you want to show support for Cachet?', 'yes')
+        ->expectsQuestion('What timezone is is the application located in?', 'America/New_York')
+        ->expectsConfirmation('Would you like to show your timezone on the status page?', 'yes')
+        ->expectsConfirmation('Would you like to only show the days with disruption?', 'yes')
+        ->expectsQuestion('How many incident days should be shown in the timeline?', 14)
+        ->expectsQuestion('After how many seconds should the status page automatically refresh?', 10)
+        ->expectsConfirmation('Should the dashboard login link be shown?', 'no')
+        ->expectsQuestion('Major outage threshold %', 50)
+        ->expectsOutputToContain('Installing Cachet...')
+        ->expectsOutputToContain('Cachet has been installed successfully!')
+        ->assertSuccessful();
+
+    $settings = app(AppSettings::class);
+    expect($settings->name)->toBe('Laravel Envoyer')
+        ->and($settings->about)->toBe('Zero downtime deployment tool.')
+        ->and($settings->show_support)->toBeTrue()
+        ->and($settings->timezone)->toBe('America/New_York')
+        ->and($settings->show_timezone)->toBeTrue()
+        ->and($settings->only_disrupted_days)->toBeTrue()
+        ->and($settings->incident_days)->toBe(14)
+        ->and($settings->refresh_rate)->toBe(10)
+        ->and($settings->dashboard_login_link)->toBeFalse()
+        ->and($settings->major_outage_threshold)->toBe(50);
+});