Merge pull request 'Add assignee changed notification event support' (#70) from koda/recreate-68-assignee-changed-notification into main

Reviewed-on: OpenSource/KanbanGit#70
2026-05-22 12:38:05 +00:00
parent 4e4acbdee6 eb58853ee0
commit 2bb74c20e1
12 changed files with 651 additions and 8 deletions
@@ -3,8 +3,8 @@
 namespace Tests\Feature\Notifications;

 use App\Actions\Notifications\RenderDiscordMessageTemplate;
-use App\Actions\Notifications\TicketStatusChanged;
-use App\Actions\Notifications\TicketStatusChangedPayload;
+use App\Actions\Notifications\TicketAssigneeChanged;
+use App\Actions\Notifications\TicketAssigneeChangedPayload;
 use Carbon\CarbonImmutable;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Tests\TestCase;
@@ -45,6 +45,14 @@ class RenderDiscordMessageTemplateTest extends TestCase
                'template' => '$actor_name',
                'expected' => 'Erica Example',
            ],
+            'assignee_from' => [
+                'template' => '$assignee_from',
+                'expected' => 'Alex Analyst',
+            ],
+            'assignee_to' => [
+                'template' => '$assignee_to',
+                'expected' => 'Priya Planner',
+            ],
        ];
    }

@@ -72,9 +80,9 @@ class RenderDiscordMessageTemplateTest extends TestCase
        $this->assertSame('[CORE-42] $unknown moved to Doing', $renderedMessage);
    }

-    private function event(): TicketStatusChanged
+    private function event(): TicketAssigneeChanged
    {
-        return new TicketStatusChanged(new TicketStatusChangedPayload(
+        return new TicketAssigneeChanged(new TicketAssigneeChangedPayload(
            projectId: 10,
            projectKey: 'CORE',
            projectName: 'Core Platform',
@@ -89,6 +97,10 @@ class RenderDiscordMessageTemplateTest extends TestCase
            toStatusId: 2,
            toStatusLabel: 'Doing',
            occurredAt: CarbonImmutable::parse('2026-04-24T09:15:30+00:00'),
+            fromAssigneeId: 11,
+            fromAssigneeName: 'Alex Analyst',
+            toAssigneeId: 12,
+            toAssigneeName: 'Priya Planner',
        ));
    }
 }
@@ -0,0 +1,343 @@
+<?php
+
+namespace Tests\Feature\Notifications;
+
+use App\Actions\Notifications\DeliverNotificationAction;
+use App\Actions\Notifications\TicketAssigneeChangedPayload;
+use App\Actions\ProjectTicketMetadata\InitializeProjectTicketMetadata;
+use App\Actions\Tickets\Support\AcceptanceCriteriaChecklistMapper;
+use App\Enums\NotificationDeliveryStatus;
+use App\Enums\NotificationEventType;
+use App\Models\NotificationAction;
+use App\Models\Project;
+use App\Models\Ticket;
+use App\Models\TicketPriority;
+use App\Models\TicketStatus;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Queue;
+use Tests\TestCase;
+
+class TicketAssigneeChangedNotificationDispatchTest extends TestCase
+{
+    use RefreshDatabase;
+
+    /**
+     * Ensure assignee changes queue deliveries only for enabled matching actions in the ticket project.
+     */
+    public function test_assignee_changes_queue_delivery_jobs_for_enabled_matching_actions(): void
+    {
+        Queue::fake();
+
+        $actor = User::factory()->create([
+            'name' => 'Erica Example',
+        ]);
+        $fromAssignee = User::factory()->create([
+            'name' => 'Alex Analyst',
+        ]);
+        $toAssignee = User::factory()->create([
+            'name' => 'Priya Planner',
+        ]);
+        $project = Project::factory()->create([
+            'key' => 'CORE',
+            'name' => 'Core Platform',
+        ]);
+        $otherProject = Project::factory()->create();
+
+        app(InitializeProjectTicketMetadata::class)->handle($project);
+        app(InitializeProjectTicketMetadata::class)->handle($otherProject);
+
+        $backlogStatus = $this->backlogStatus($project);
+        $ticket = $this->createTicket(
+            $project,
+            $backlogStatus,
+            'Fix webhook dispatch',
+            $fromAssignee,
+        );
+
+        $webhookAction = NotificationAction::factory()
+            ->webhook()
+            ->for($project)
+            ->create([
+                'name' => 'Primary webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+            ]);
+        $discordAction = NotificationAction::factory()
+            ->discord()
+            ->for($project)
+            ->create([
+                'name' => 'Discord alerts',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+            ]);
+        $disabledAction = NotificationAction::factory()
+            ->disabled()
+            ->for($project)
+            ->create([
+                'name' => 'Disabled webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+            ]);
+        $statusChangedAction = NotificationAction::factory()
+            ->for($project)
+            ->create([
+                'name' => 'Status changed webhook',
+                'event_type' => NotificationEventType::TicketStatusChanged,
+            ]);
+        $filterEqualsAction = NotificationAction::factory()
+            ->webhook()
+            ->for($project)
+            ->create([
+                'name' => 'Filtered to assignee webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+                'filters' => [
+                    [
+                        'attribute' => 'assignee.to.id',
+                        'operator' => 'equals',
+                        'value' => (string) $toAssignee->id,
+                    ],
+                ],
+            ]);
+        $filterExistsAction = NotificationAction::factory()
+            ->webhook()
+            ->for($project)
+            ->create([
+                'name' => 'Filtered from assignee exists webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+                'filters' => [
+                    [
+                        'attribute' => 'assignee.from.id',
+                        'operator' => 'exists',
+                        'value' => null,
+                    ],
+                ],
+            ]);
+        $filterNotExistsAction = NotificationAction::factory()
+            ->webhook()
+            ->for($project)
+            ->create([
+                'name' => 'Filtered from assignee not exists webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+                'filters' => [
+                    [
+                        'attribute' => 'assignee.from.id',
+                        'operator' => 'not_exists',
+                        'value' => null,
+                    ],
+                ],
+            ]);
+        $filterInAction = NotificationAction::factory()
+            ->webhook()
+            ->for($project)
+            ->create([
+                'name' => 'Filtered in assignee webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+                'filters' => [
+                    [
+                        'attribute' => 'assignee.to.name',
+                        'operator' => 'in',
+                        'value' => ['Priya Planner', 'Someone Else'],
+                    ],
+                ],
+            ]);
+        $foreignProjectAction = NotificationAction::factory()
+            ->for($otherProject)
+            ->create([
+                'name' => 'Foreign webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+            ]);
+
+        $this->syncProjectPermissions($project, $actor, ['edit', 'view']);
+
+        $this->actingAs($actor)
+            ->patch(route('projects.tickets.update', [$project, $ticket]), $this->updatePayload($ticket, [
+                'assignee_user_id' => $toAssignee->id,
+            ]))
+            ->assertRedirect(route('projects.tickets.show', [$project, $ticket]))
+            ->assertSessionHas('status', 'CORE-1 was updated.');
+
+        Queue::assertPushed(DeliverNotificationAction::class, 5);
+        Queue::assertPushed(DeliverNotificationAction::class, function (DeliverNotificationAction $job) use ($actor, $backlogStatus, $fromAssignee, $project, $ticket, $toAssignee, $webhookAction): bool {
+            $payload = $job->event->payload();
+
+            return $job->notificationActionId === $webhookAction->id
+                && $payload instanceof TicketAssigneeChangedPayload
+                && $payload->projectId === $project->id
+                && $payload->projectKey === 'CORE'
+                && $payload->projectName === 'Core Platform'
+                && $payload->ticketId === $ticket->id
+                && $payload->ticketKey === 'CORE-1'
+                && $payload->ticketTitle === 'Fix webhook dispatch'
+                && $payload->ticketUrl === route('projects.tickets.show', [$project, $ticket])
+                && $payload->actorId === $actor->id
+                && $payload->actorName === 'Erica Example'
+                && $payload->fromStatusId === null
+                && $payload->fromStatusLabel === null
+                && $payload->toStatusId === $backlogStatus->id
+                && $payload->toStatusLabel === 'Backlog'
+                && $payload->fromAssigneeId === $fromAssignee->id
+                && $payload->fromAssigneeName === 'Alex Analyst'
+                && $payload->toAssigneeId === $toAssignee->id
+                && $payload->toAssigneeName === 'Priya Planner'
+                && $payload->toArray()['event_type'] === NotificationEventType::TicketAssigneeChanged->value
+                && $job->notificationDeliveryLogId !== null;
+        });
+        Queue::assertPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $discordAction->id
+            && $job->event->eventType() === NotificationEventType::TicketAssigneeChanged
+            && $job->notificationDeliveryLogId !== null);
+        Queue::assertPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $filterEqualsAction->id
+            && $job->event->eventType() === NotificationEventType::TicketAssigneeChanged
+            && $job->notificationDeliveryLogId !== null);
+        Queue::assertPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $filterExistsAction->id
+            && $job->event->eventType() === NotificationEventType::TicketAssigneeChanged
+            && $job->notificationDeliveryLogId !== null);
+        Queue::assertPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $filterInAction->id
+            && $job->event->eventType() === NotificationEventType::TicketAssigneeChanged
+            && $job->notificationDeliveryLogId !== null);
+        Queue::assertNotPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $disabledAction->id);
+        Queue::assertNotPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $statusChangedAction->id);
+        Queue::assertNotPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $filterNotExistsAction->id);
+        Queue::assertNotPushed(DeliverNotificationAction::class, fn (DeliverNotificationAction $job): bool => $job->notificationActionId === $foreignProjectAction->id);
+
+        $this->assertDatabaseCount('notification_delivery_logs', 5);
+        $this->assertDatabaseHas('notification_delivery_logs', [
+            'notification_action_id' => $webhookAction->id,
+            'delivery_status' => NotificationDeliveryStatus::Pending->value,
+            'event_type' => NotificationEventType::TicketAssigneeChanged->value,
+            'attempt_count' => 0,
+            'http_status' => null,
+        ]);
+        $this->assertDatabaseHas('notification_delivery_logs', [
+            'notification_action_id' => $discordAction->id,
+            'delivery_status' => NotificationDeliveryStatus::Pending->value,
+            'event_type' => NotificationEventType::TicketAssigneeChanged->value,
+            'attempt_count' => 0,
+            'http_status' => null,
+        ]);
+        $this->assertDatabaseHas('notification_delivery_logs', [
+            'notification_action_id' => $filterEqualsAction->id,
+            'delivery_status' => NotificationDeliveryStatus::Pending->value,
+            'event_type' => NotificationEventType::TicketAssigneeChanged->value,
+            'attempt_count' => 0,
+            'http_status' => null,
+        ]);
+        $this->assertDatabaseHas('notification_delivery_logs', [
+            'notification_action_id' => $filterExistsAction->id,
+            'delivery_status' => NotificationDeliveryStatus::Pending->value,
+            'event_type' => NotificationEventType::TicketAssigneeChanged->value,
+            'attempt_count' => 0,
+            'http_status' => null,
+        ]);
+        $this->assertDatabaseHas('notification_delivery_logs', [
+            'notification_action_id' => $filterInAction->id,
+            'delivery_status' => NotificationDeliveryStatus::Pending->value,
+            'event_type' => NotificationEventType::TicketAssigneeChanged->value,
+            'attempt_count' => 0,
+            'http_status' => null,
+        ]);
+
+        $this->assertDatabaseHas('ticket_worklog_entries', [
+            'ticket_id' => $ticket->id,
+            'actor_id' => $actor->id,
+            'entry_type' => 'updated',
+            'summary' => 'Updated assignee.',
+        ]);
+    }
+
+    /**
+     * Ensure no-op assignee updates keep their response behavior and do not queue deliveries.
+     */
+    public function test_no_op_assignee_updates_do_not_queue_notification_deliveries(): void
+    {
+        Queue::fake();
+
+        $actor = User::factory()->create();
+        $assignee = User::factory()->create();
+        $project = Project::factory()->create([
+            'key' => 'CORE',
+        ]);
+
+        app(InitializeProjectTicketMetadata::class)->handle($project);
+
+        $backlogStatus = $this->backlogStatus($project);
+        $ticket = $this->createTicket(
+            $project,
+            $backlogStatus,
+            'Keep the same assignee',
+            $assignee,
+        );
+
+        NotificationAction::factory()
+            ->for($project)
+            ->create([
+                'name' => 'Assignee webhook',
+                'event_type' => NotificationEventType::TicketAssigneeChanged,
+            ]);
+
+        $this->syncProjectPermissions($project, $actor, ['edit', 'view']);
+
+        $this->actingAs($actor)
+            ->patch(route('projects.tickets.update', [$project, $ticket]), $this->updatePayload($ticket, [
+                'assignee_user_id' => $assignee->id,
+            ]))
+            ->assertRedirect(route('projects.tickets.show', [$project, $ticket]))
+            ->assertSessionHas('status', 'No ticket changes were detected.');
+
+        Queue::assertNothingPushed();
+        $this->assertDatabaseCount('notification_delivery_logs', 0);
+        $this->assertDatabaseCount('ticket_worklog_entries', 0);
+    }
+
+    private function backlogStatus(Project $project): TicketStatus
+    {
+        return $project->ticketStatuses()
+            ->whereNull('board_column_id')
+            ->firstOrFail();
+    }
+
+    private function createTicket(
+        Project $project,
+        TicketStatus $ticketStatus,
+        string $title,
+        ?User $assignee = null,
+    ): Ticket {
+        $priority = TicketPriority::factory()->for($project)->create([
+            'name' => 'High',
+            'position' => 2,
+        ]);
+
+        return Ticket::factory()->create([
+            'assignee_user_id' => $assignee?->id,
+            'project_id' => $project->id,
+            'sequence_number' => 1,
+            'ticket_key' => 'CORE-1',
+            'ticket_priority_id' => $priority->id,
+            'ticket_status_id' => $ticketStatus->id,
+            'ticket_type_id' => $project->ticketTypes()->firstOrFail()->id,
+            'title' => $title,
+        ]);
+    }
+
+    /**
+     * @param  array<string, mixed>  $overrides
+     * @return array<string, mixed>
+     */
+    private function updatePayload(Ticket $ticket, array $overrides = []): array
+    {
+        return [
+            'acceptance_criteria' => AcceptanceCriteriaChecklistMapper::fromModels(
+                $ticket->acceptanceCriteria()->get(),
+            ),
+            'assignee_user_id' => $ticket->assignee_user_id,
+            'author_user_id' => $ticket->author_user_id,
+            'blocked_comment' => $ticket->blocked_comment,
+            'description' => $ticket->description,
+            'field_values' => [],
+            'is_blocked' => $ticket->is_blocked,
+            'parent_ticket_id' => $ticket->parent_ticket_id,
+            'story_points' => $ticket->story_points,
+            'ticket_priority_id' => $ticket->ticket_priority_id,
+            'ticket_type_id' => $ticket->ticket_type_id,
+            'title' => $ticket->title,
+            ...$overrides,
+        ];
+    }
+}
@@ -63,12 +63,15 @@ class ProjectNotificationSettingsControllerTest extends TestCase
                ->where('channelOptions.0.value', NotificationChannel::Discord->value)
                ->where('eventTypeOptions.0.value', NotificationEventType::TicketStatusChanged->value)
                ->where('eventTypeOptions.1.value', NotificationEventType::TicketCreate->value)
+                ->where('eventTypeOptions.2.value', NotificationEventType::TicketAssigneeChanged->value)
                ->where('discordAllowedMentionOptions.0.value', 'everyone')
                ->where('discordAllowedMentionOptions.2.value', 'users')
                ->where('filterAttributeOptions.0.value', 'project.id')
                ->where('filterOperatorOptions.0.value', 'equals')
                ->where('templateVariables.0.value', '$url')
                ->where('templateVariables.6.value', '$actor_name')
+                ->where('templateVariables.7.value', '$assignee_from')
+                ->where('templateVariables.8.value', '$assignee_to')
                ->missing('notificationActions.0.delivery_url'),
            );
    }