Merge pull request #99 from govigilant/feature/notification-channel-name

Allow naming of notification channels

Author: VincentBean

packages/notifications/database/migrations/2026_01_02_150000_add_name_to_notification_channels_table.php

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::table('notification_channels', function (Blueprint $table): void {
+            $table->string('name')->nullable()->after('channel');
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::table('notification_channels', function (Blueprint $table): void {
+            $table->dropColumn('name');
+        });
+    }
+};

packages/notifications/database/migrations/2026_01_02_151500_backfill_notification_channel_names.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Migrations\Migration;
+use Vigilant\Notifications\Channels\NotificationChannel;
+use Vigilant\Notifications\Models\Channel;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Model::unguarded(function (): void {
+            Channel::withoutEvents(function (): void {
+                Channel::withoutGlobalScopes()
+                    ->whereNull('name')
+                    ->chunkById(100, function ($channels): void {
+                        /** @var \Illuminate\Support\Collection<int, Channel> $channels */
+                        $channels->each(function (Channel $channel): void {
+                            $channelType = $channel->channel;
+
+                            if (! is_string($channelType) || ! class_exists($channelType) || ! is_subclass_of($channelType, NotificationChannel::class)) {
+                                return;
+                            }
+
+                            $channel->forceFill(['name' => $channelType::$name])->save();
+                        });
+                    });
+            });
+        });
+    }
+};

packages/notifications/resources/views/livewire/channels/form.blade.php

@@ -1,7 +1,7 @@
 <div>
     @if (!$inline)
         <x-slot name="header">
-            <x-page-header :title="$updating ? 'Edit Channel - ' . $channelModel->channel::$name : 'Add Channel'" :back="route('notifications.channels')">
+            <x-page-header :title="$updating ? 'Edit Channel - ' . $channelModel->title() : 'Add Channel'" :back="route('notifications.channels')">
                 @if($updating)
                     <x-frontend::page-header.actions>
                         <x-form.button class="bg-red" @click="$dispatch('open-delete-modal')">
@@ -35,6 +35,10 @@
                         @endforeach
                     </x-form.select>
 
+                    <x-form.text field="form.name" name="Internal Name"
+                        description="Give this channel a recognizable label for your team.">
+                    </x-form.text>
+
                     <h3 class="text-lg font-bold leading-7 sm:truncate sm:text-2xl sm:tracking-tight text-neutral-100">
                         {{ __('Configuration') }}</h3>
 
@@ -72,7 +76,7 @@
                                 </div>
                                 <div class="flex-1">
                                     <p class="text-sm text-base-300">
-                                        <span class="font-semibold text-base-100">{{ $channelModel->channel::$name }}</span>
+                                        <span class="font-semibold text-base-100">{{ $channelModel->title() }}</span>
                                     </p>
                                     <p class="text-sm text-base-400 mt-1">
                                         @lang('This action cannot be undone. All channel settings will be permanently deleted and notifications will no longer be sent to this channel.')

packages/notifications/src/Http/Livewire/ChannelForm.php

@@ -74,12 +74,13 @@ public function save(bool $redirect = true): void
 
         $this->validate();
 
+        $data = $this->form->all();
+        $data['name'] = blank($data['name'] ?? null) ? null : $data['name'];
+
         if ($this->channelModel->exists) {
-            $this->channelModel->update($this->form->all());
+            $this->channelModel->update($data);
         } else {
-            $this->channelModel = Channel::query()->create(
-                $this->form->all()
-            );
+            $this->channelModel = Channel::query()->create($data);
         }
 
         if ($this->inline) {

packages/notifications/src/Http/Livewire/Forms/CreateChannelForm.php

@@ -10,5 +10,8 @@ class CreateChannelForm extends Form
     #[Validate('required|max:255')]
     public string $channel = '';
 
+    #[Validate('nullable|string|max:255')]
+    public ?string $name = null;
+
     public array $settings = [];
 }

packages/notifications/src/Http/Livewire/Tables/ChannelTable.php

@@ -21,7 +21,12 @@ class ChannelTable extends BaseTable
     protected function columns(): array
     {
         return [
-            Column::make(__('Channel'), 'channel')
+            Column::make(__('Name'), 'name')
+                ->displayUsing(function (?string $name, Channel $channel): string {
+                    return $channel->title();
+                }),
+
+            Column::make(__('Channel Type'), 'channel')
                 ->displayUsing(function (string $channel) {
                     /** @var class-string<NotificationChannel> $channel */
 

packages/notifications/src/Models/Channel.php

@@ -9,12 +9,14 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Carbon;
 use Vigilant\Core\Scopes\TeamScope;
+use Vigilant\Notifications\Channels\NotificationChannel;
 use Vigilant\Notifications\Observers\ChannelObserver;
 
 /**
  * @property int $id
  * @property int $team_id
  * @property string $channel
+ * @property string|null $name
  * @property array $settings
  * @property ?Carbon $created_at
  * @property ?Carbon $updated_at
@@ -34,7 +36,18 @@ class Channel extends Model
 
     public function title(): string
     {
-        return $this->channel::$name;
+        if (filled($this->name)) {
+            return $this->name;
+        }
+
+        if (is_string($this->channel) && class_exists($this->channel) && is_subclass_of($this->channel, NotificationChannel::class)) {
+            /** @var class-string<NotificationChannel> $channel */
+            $channel = $this->channel;
+
+            return $channel::$name;
+        }
+
+        return (string) $this->channel;
     }
 
     public function history(): HasMany

packages/notifications/tests/Models/ChannelTest.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Vigilant\Notifications\Tests\Models;
+
+use PHPUnit\Framework\Attributes\Test;
+use Vigilant\Notifications\Channels\SlackChannel;
+use Vigilant\Notifications\Models\Channel;
+use Vigilant\Notifications\Tests\TestCase;
+
+class ChannelTest extends TestCase
+{
+    #[Test]
+    public function it_returns_the_internal_name_when_available(): void
+    {
+        $channel = Channel::withoutEvents(function () {
+            return Channel::query()->withoutGlobalScopes()->create([
+                'team_id' => 1,
+                'channel' => SlackChannel::class,
+                'name' => 'Primary Slack',
+                'settings' => [],
+            ]);
+        });
+
+        $this->assertSame('Primary Slack', $channel->title());
+    }
+
+    #[Test]
+    public function it_falls_back_to_the_channel_display_name(): void
+    {
+        $channel = Channel::withoutEvents(function () {
+            return Channel::query()->withoutGlobalScopes()->create([
+                'team_id' => 1,
+                'channel' => SlackChannel::class,
+                'settings' => [],
+            ]);
+        });
+
+        $this->assertSame(SlackChannel::$name, $channel->title());
+    }
+}