Add metadata support for incidents, schedules and components (#385)

Co-authored-by: Claude <noreply@anthropic.com>

Author: jbrooksuk

database/factories/ComponentFactory.php

@@ -66,10 +66,8 @@ public function disabled(): self
      */
     public function withMeta(): self
     {
-        return $this->state([
-            'meta' => [
-                'foo' => 'bar',
-            ],
-        ]);
+        return $this->afterCreating(function (Component $component) {
+            $component->meta()->create(['key' => 'foo', 'value' => 'bar']);
+        });
     }
 }

database/factories/ComponentGroupFactory.php

@@ -41,4 +41,14 @@ public function orderedBy(ResourceOrderColumnEnum $column, ?ResourceOrderDirecti
             'order_direction' => $column === ResourceOrderColumnEnum::Manual ? null : $direction,
         ]);
     }
+
+    /**
+     * Provide the component group with additional meta.
+     */
+    public function withMeta(): self
+    {
+        return $this->afterCreating(function (ComponentGroup $componentGroup) {
+            $componentGroup->meta()->create(['key' => 'foo', 'value' => 'bar']);
+        });
+    }
 }

database/factories/IncidentFactory.php

@@ -27,4 +27,14 @@ public function definition(): array
             'message' => fake()->paragraph,
         ];
     }
+
+    /**
+     * Provide the incident with additional meta.
+     */
+    public function withMeta(): self
+    {
+        return $this->afterCreating(function (Incident $incident) {
+            $incident->meta()->create(['key' => 'foo', 'value' => 'bar']);
+        });
+    }
 }

database/factories/ScheduleFactory.php

@@ -57,4 +57,14 @@ public function inThePast(): self
             'completed_at' => now()->subDays(30),
         ]);
     }
+
+    /**
+     * Provide the schedule with additional meta.
+     */
+    public function withMeta(): self
+    {
+        return $this->afterCreating(function (Schedule $schedule) {
+            $schedule->meta()->create(['key' => 'foo', 'value' => 'bar']);
+        });
+    }
 }

database/factories/SubscriberFactory.php

@@ -25,4 +25,14 @@ public function verified(): self
             'email_verified_at' => now(),
         ]);
     }
+
+    /**
+     * Provide the subscriber with additional meta.
+     */
+    public function withMeta(): self
+    {
+        return $this->afterCreating(function (Subscriber $subscriber) {
+            $subscriber->meta()->create(['key' => 'foo', 'value' => 'bar']);
+        });
+    }
 }

database/migrations/2026_07_11_000001_migrate_component_meta_to_meta_table.php

@@ -0,0 +1,98 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * The morph aliases written by the metadata feature this migration enables.
+     *
+     * Hardcoded rather than read from the runtime morph map so this migration
+     * stays stable as application code evolves.
+     *
+     * @var list<string>
+     */
+    private array $morphAliases = [
+        'component',
+        'component_group',
+        'incident',
+        'schedule',
+        'subscriber',
+    ];
+
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('meta', function (Blueprint $table) {
+            $table->text('value')->nullable()->change();
+        });
+
+        DB::table('components')
+            ->whereNotNull('meta')
+            ->orderBy('id')
+            ->each(function (object $component) {
+                $meta = json_decode($component->meta, true);
+
+                if (! is_array($meta)) {
+                    Log::warning('Skipping component meta that is not a key/value object during migration.', [
+                        'component_id' => $component->id,
+                        'meta' => $component->meta,
+                    ]);
+
+                    return;
+                }
+
+                $rows = collect($meta)->map(fn (mixed $value, int|string $key) => [
+                    'key' => (string) $key,
+                    'value' => json_encode($value),
+                    'meta_id' => $component->id,
+                    'meta_type' => 'component',
+                    'created_at' => now(),
+                    'updated_at' => now(),
+                ])->values()->all();
+
+                DB::table('meta')->insert($rows);
+            });
+
+        Schema::table('components', function (Blueprint $table) {
+            $table->dropColumn('meta');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('components', function (Blueprint $table) {
+            $table->longText('meta')->nullable()->default(null)->after('enabled');
+        });
+
+        DB::table('meta')
+            ->where('meta_type', 'component')
+            ->orderBy('meta_id')
+            ->get()
+            ->groupBy('meta_id')
+            ->each(function ($rows, $componentId) {
+                $meta = $rows->mapWithKeys(fn (object $row) => [
+                    $row->key => json_decode($row->value, true),
+                ])->all();
+
+                DB::table('components')
+                    ->where('id', $componentId)
+                    ->update(['meta' => json_encode($meta)]);
+            });
+
+        DB::table('meta')->whereIn('meta_type', $this->morphAliases)->delete();
+
+        Schema::table('meta', function (Blueprint $table) {
+            $table->string('value')->nullable(false)->change();
+        });
+    }
+};

database/seeders/DatabaseSeeder.php

@@ -39,6 +39,7 @@ public function run(): void
         DB::table('component_checks')->truncate();
         DB::table('component_groups')->truncate();
         DB::table('schedules')->truncate();
+        DB::table('meta')->truncate();
         DB::table('metrics')->truncate();
         DB::table('metric_points')->truncate();
         DB::table('updates')->truncate();

resources/lang/en/component_group.php

@@ -28,5 +28,6 @@
         'collapsed_label' => 'Collapsed',
         'order_column_label' => 'Component group order',
         'order_direction' => 'Order direction',
+        'meta_label' => 'Meta',
     ],
 ];

resources/lang/en/incident.php

@@ -57,6 +57,7 @@
         'notify_subscribers_label' => 'Notify subscribers of this incident.',
         'pin_incident_label' => 'Pin the incident to the top of the status page.',
         'guid_label' => 'Incident UUID',
+        'meta_label' => 'Meta',
         'add_component' => [
             'action_label' => 'Add component',
             'header' => 'Components',

resources/lang/en/schedule.php

@@ -30,6 +30,7 @@
         'completed_at_helper' => 'When the maintenance window is expected to end.',
         'notify_subscribers_label' => 'Notify subscribers of this maintenance.',
         'notifications_helper' => 'Email subscribers about this scheduled maintenance and its updates.',
+        'meta_label' => 'Meta',
         'add_component' => [
             'action_label' => 'Add component',
             'header' => 'Affected components',