Merge pull request 'Add assignee changed notification event support' (#70) from koda/recreate-68-assignee-changed-notification into main
Reviewed-on: OpenSource/KanbanGit#70
This commit was merged in pull request #70.
This commit is contained in:
@@ -60,7 +60,7 @@ class BuildProjectNotificationSettingsPayload
|
|||||||
'value' => '$project_name',
|
'value' => '$project_name',
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
'description' => 'Origin status label for status moves; blank for ticket create.',
|
'description' => 'Origin status label for status moves; blank for ticket create and assignee changes.',
|
||||||
'value' => '$status_from',
|
'value' => '$status_from',
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
@@ -71,6 +71,14 @@ class BuildProjectNotificationSettingsPayload
|
|||||||
'description' => 'Actor name when the event has a known user.',
|
'description' => 'Actor name when the event has a known user.',
|
||||||
'value' => '$actor_name',
|
'value' => '$actor_name',
|
||||||
],
|
],
|
||||||
|
[
|
||||||
|
'description' => 'Previous assignee name when the event updates assignment; blank otherwise.',
|
||||||
|
'value' => '$assignee_from',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'description' => 'New assignee name when the event updates assignment; blank when unassigned.',
|
||||||
|
'value' => '$assignee_to',
|
||||||
|
],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,61 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\Notifications;
|
||||||
|
|
||||||
|
use App\Models\Project;
|
||||||
|
use App\Models\Ticket;
|
||||||
|
use App\Models\TicketStatus;
|
||||||
|
use App\Models\User;
|
||||||
|
use Carbon\CarbonImmutable;
|
||||||
|
|
||||||
|
class BuildTicketAssigneeChangedPayload
|
||||||
|
{
|
||||||
|
public function handle(
|
||||||
|
Project $project,
|
||||||
|
Ticket $ticket,
|
||||||
|
?User $actor,
|
||||||
|
?int $fromAssigneeId,
|
||||||
|
?string $fromAssigneeName,
|
||||||
|
?int $toAssigneeId,
|
||||||
|
?string $toAssigneeName,
|
||||||
|
CarbonImmutable $occurredAt,
|
||||||
|
): TicketAssigneeChangedPayload {
|
||||||
|
$ticket->loadMissing('ticketStatus.boardColumn');
|
||||||
|
|
||||||
|
return new TicketAssigneeChangedPayload(
|
||||||
|
projectId: $project->id,
|
||||||
|
projectKey: $project->key,
|
||||||
|
projectName: $project->name,
|
||||||
|
ticketId: $ticket->id,
|
||||||
|
ticketKey: $ticket->ticket_key,
|
||||||
|
ticketTitle: $ticket->title,
|
||||||
|
ticketUrl: route('projects.tickets.show', [$project, $ticket]),
|
||||||
|
actorId: $actor?->id,
|
||||||
|
actorName: $actor?->name,
|
||||||
|
fromStatusId: null,
|
||||||
|
fromStatusLabel: null,
|
||||||
|
toStatusId: $ticket->ticket_status_id,
|
||||||
|
toStatusLabel: $this->statusLabel($ticket->ticketStatus),
|
||||||
|
occurredAt: $occurredAt,
|
||||||
|
fromAssigneeId: $fromAssigneeId,
|
||||||
|
fromAssigneeName: $fromAssigneeName,
|
||||||
|
toAssigneeId: $toAssigneeId,
|
||||||
|
toAssigneeName: $toAssigneeName,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function statusLabel(?TicketStatus $ticketStatus): string
|
||||||
|
{
|
||||||
|
if ($ticketStatus === null) {
|
||||||
|
return 'Unknown status';
|
||||||
|
}
|
||||||
|
|
||||||
|
$ticketStatus->loadMissing('boardColumn');
|
||||||
|
|
||||||
|
if ($ticketStatus->boardColumn === null || $ticketStatus->boardColumn->name === $ticketStatus->name) {
|
||||||
|
return $ticketStatus->name;
|
||||||
|
}
|
||||||
|
|
||||||
|
return "{$ticketStatus->boardColumn->name} / {$ticketStatus->name}";
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -190,6 +190,10 @@ class MatchNotificationFilters
|
|||||||
$fromStatusLabel = property_exists($payload, 'fromStatusLabel') ? $payload->fromStatusLabel : null;
|
$fromStatusLabel = property_exists($payload, 'fromStatusLabel') ? $payload->fromStatusLabel : null;
|
||||||
$toStatusId = property_exists($payload, 'toStatusId') ? $payload->toStatusId : null;
|
$toStatusId = property_exists($payload, 'toStatusId') ? $payload->toStatusId : null;
|
||||||
$toStatusLabel = property_exists($payload, 'toStatusLabel') ? $payload->toStatusLabel : null;
|
$toStatusLabel = property_exists($payload, 'toStatusLabel') ? $payload->toStatusLabel : null;
|
||||||
|
$fromAssigneeId = property_exists($payload, 'fromAssigneeId') ? $payload->fromAssigneeId : null;
|
||||||
|
$fromAssigneeName = property_exists($payload, 'fromAssigneeName') ? $payload->fromAssigneeName : null;
|
||||||
|
$toAssigneeId = property_exists($payload, 'toAssigneeId') ? $payload->toAssigneeId : null;
|
||||||
|
$toAssigneeName = property_exists($payload, 'toAssigneeName') ? $payload->toAssigneeName : null;
|
||||||
|
|
||||||
return [
|
return [
|
||||||
'project' => [
|
'project' => [
|
||||||
@@ -207,6 +211,16 @@ class MatchNotificationFilters
|
|||||||
'id' => $actorId,
|
'id' => $actorId,
|
||||||
'name' => $actorName,
|
'name' => $actorName,
|
||||||
],
|
],
|
||||||
|
'assignee' => [
|
||||||
|
'from' => [
|
||||||
|
'id' => $fromAssigneeId,
|
||||||
|
'name' => $fromAssigneeName,
|
||||||
|
],
|
||||||
|
'to' => [
|
||||||
|
'id' => $toAssigneeId,
|
||||||
|
'name' => $toAssigneeName,
|
||||||
|
],
|
||||||
|
],
|
||||||
'status' => [
|
'status' => [
|
||||||
'from' => [
|
'from' => [
|
||||||
'id' => $fromStatusId,
|
'id' => $fromStatusId,
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\Notifications;
|
||||||
|
|
||||||
|
use App\Enums\NotificationEventType;
|
||||||
|
use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
|
||||||
|
use Illuminate\Foundation\Events\Dispatchable;
|
||||||
|
|
||||||
|
final readonly class TicketAssigneeChanged implements NotificationEvent, ShouldDispatchAfterCommit
|
||||||
|
{
|
||||||
|
use Dispatchable;
|
||||||
|
|
||||||
|
public function __construct(
|
||||||
|
public TicketAssigneeChangedPayload $payload,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
public function eventType(): NotificationEventType
|
||||||
|
{
|
||||||
|
return NotificationEventType::TicketAssigneeChanged;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function payload(): NotificationEventPayload
|
||||||
|
{
|
||||||
|
return $this->payload;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\Notifications;
|
||||||
|
|
||||||
|
use App\Enums\NotificationEventType;
|
||||||
|
use Carbon\CarbonImmutable;
|
||||||
|
|
||||||
|
final readonly class TicketAssigneeChangedPayload implements NotificationEventPayload
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
public int $projectId,
|
||||||
|
public string $projectKey,
|
||||||
|
public string $projectName,
|
||||||
|
public int $ticketId,
|
||||||
|
public string $ticketKey,
|
||||||
|
public string $ticketTitle,
|
||||||
|
public string $ticketUrl,
|
||||||
|
public ?int $actorId,
|
||||||
|
public ?string $actorName,
|
||||||
|
public ?int $fromStatusId,
|
||||||
|
public ?string $fromStatusLabel,
|
||||||
|
public int $toStatusId,
|
||||||
|
public string $toStatusLabel,
|
||||||
|
public CarbonImmutable $occurredAt,
|
||||||
|
public ?int $fromAssigneeId,
|
||||||
|
public ?string $fromAssigneeName,
|
||||||
|
public ?int $toAssigneeId,
|
||||||
|
public ?string $toAssigneeName,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
public function projectId(): int
|
||||||
|
{
|
||||||
|
return $this->projectId;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array<string, scalar|null>
|
||||||
|
*/
|
||||||
|
public function deliveryMetadata(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'project_key' => $this->projectKey,
|
||||||
|
'ticket_key' => $this->ticketKey,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array<string, string>
|
||||||
|
*/
|
||||||
|
public function discordTemplateVariables(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'$url' => $this->ticketUrl,
|
||||||
|
'$ticket_key' => $this->ticketKey,
|
||||||
|
'$ticket_title' => $this->ticketTitle,
|
||||||
|
'$project_name' => $this->projectName,
|
||||||
|
'$status_from' => $this->fromStatusLabel ?? '',
|
||||||
|
'$status_to' => $this->toStatusLabel,
|
||||||
|
'$actor_name' => $this->actorName ?? '',
|
||||||
|
'$assignee_from' => $this->fromAssigneeName ?? '',
|
||||||
|
'$assignee_to' => $this->toAssigneeName ?? '',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array{
|
||||||
|
* event_type: string,
|
||||||
|
* project: array{id: int, key: string, name: string},
|
||||||
|
* ticket: array{id: int, key: string, title: string},
|
||||||
|
* actor: array{id: int, name: string}|null,
|
||||||
|
* assignee: array{
|
||||||
|
* from: array{id: int, name: string}|null,
|
||||||
|
* to: array{id: int, name: string}|null
|
||||||
|
* },
|
||||||
|
* from: array{id: int, label: string}|null,
|
||||||
|
* to: array{id: int, label: string},
|
||||||
|
* ticket_url: string,
|
||||||
|
* occurred_at: string
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
public function toArray(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'event_type' => NotificationEventType::TicketAssigneeChanged->value,
|
||||||
|
'project' => [
|
||||||
|
'id' => $this->projectId,
|
||||||
|
'key' => $this->projectKey,
|
||||||
|
'name' => $this->projectName,
|
||||||
|
],
|
||||||
|
'ticket' => [
|
||||||
|
'id' => $this->ticketId,
|
||||||
|
'key' => $this->ticketKey,
|
||||||
|
'title' => $this->ticketTitle,
|
||||||
|
],
|
||||||
|
'actor' => $this->actorId === null || $this->actorName === null
|
||||||
|
? null
|
||||||
|
: [
|
||||||
|
'id' => $this->actorId,
|
||||||
|
'name' => $this->actorName,
|
||||||
|
],
|
||||||
|
'assignee' => [
|
||||||
|
'from' => $this->fromAssigneeId === null || $this->fromAssigneeName === null
|
||||||
|
? null
|
||||||
|
: [
|
||||||
|
'id' => $this->fromAssigneeId,
|
||||||
|
'name' => $this->fromAssigneeName,
|
||||||
|
],
|
||||||
|
'to' => $this->toAssigneeId === null || $this->toAssigneeName === null
|
||||||
|
? null
|
||||||
|
: [
|
||||||
|
'id' => $this->toAssigneeId,
|
||||||
|
'name' => $this->toAssigneeName,
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'from' => $this->fromStatusId === null || $this->fromStatusLabel === null
|
||||||
|
? null
|
||||||
|
: [
|
||||||
|
'id' => $this->fromStatusId,
|
||||||
|
'label' => $this->fromStatusLabel,
|
||||||
|
],
|
||||||
|
'to' => [
|
||||||
|
'id' => $this->toStatusId,
|
||||||
|
'label' => $this->toStatusLabel,
|
||||||
|
],
|
||||||
|
'ticket_url' => $this->ticketUrl,
|
||||||
|
'occurred_at' => $this->occurredAt->toISOString(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,12 +2,15 @@
|
|||||||
|
|
||||||
namespace App\Actions\Tickets;
|
namespace App\Actions\Tickets;
|
||||||
|
|
||||||
|
use App\Actions\Notifications\BuildTicketAssigneeChangedPayload;
|
||||||
|
use App\Actions\Notifications\TicketAssigneeChanged;
|
||||||
use App\Actions\Tickets\Support\AcceptanceCriteriaChecklistMapper;
|
use App\Actions\Tickets\Support\AcceptanceCriteriaChecklistMapper;
|
||||||
use App\Enums\TicketWorklogEntryType;
|
use App\Enums\TicketWorklogEntryType;
|
||||||
use App\Models\Ticket;
|
use App\Models\Ticket;
|
||||||
use App\Models\TicketFieldDefinition;
|
use App\Models\TicketFieldDefinition;
|
||||||
use App\Models\TicketFieldValue;
|
use App\Models\TicketFieldValue;
|
||||||
use App\Models\User;
|
use App\Models\User;
|
||||||
|
use Carbon\CarbonImmutable;
|
||||||
use Illuminate\Support\Arr;
|
use Illuminate\Support\Arr;
|
||||||
use Illuminate\Support\Collection;
|
use Illuminate\Support\Collection;
|
||||||
use Illuminate\Support\Facades\DB;
|
use Illuminate\Support\Facades\DB;
|
||||||
@@ -15,6 +18,7 @@ use Illuminate\Support\Facades\DB;
|
|||||||
class UpdateProjectTicket
|
class UpdateProjectTicket
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
|
private readonly BuildTicketAssigneeChangedPayload $buildTicketAssigneeChangedPayload,
|
||||||
private readonly CreateTicketWorklogEntry $createTicketWorklogEntry,
|
private readonly CreateTicketWorklogEntry $createTicketWorklogEntry,
|
||||||
private readonly SyncProjectTicketFieldValues $syncProjectTicketFieldValues,
|
private readonly SyncProjectTicketFieldValues $syncProjectTicketFieldValues,
|
||||||
) {}
|
) {}
|
||||||
@@ -68,6 +72,7 @@ class UpdateProjectTicket
|
|||||||
'parentTicket',
|
'parentTicket',
|
||||||
'project',
|
'project',
|
||||||
'ticketPriority',
|
'ticketPriority',
|
||||||
|
'ticketStatus.boardColumn',
|
||||||
'ticketType',
|
'ticketType',
|
||||||
]);
|
]);
|
||||||
|
|
||||||
@@ -90,6 +95,7 @@ class UpdateProjectTicket
|
|||||||
|
|
||||||
$changes = [];
|
$changes = [];
|
||||||
$summaryLabels = [];
|
$summaryLabels = [];
|
||||||
|
$assigneeChange = null;
|
||||||
|
|
||||||
$this->trackScalarChange(
|
$this->trackScalarChange(
|
||||||
$changes,
|
$changes,
|
||||||
@@ -167,13 +173,23 @@ class UpdateProjectTicket
|
|||||||
}
|
}
|
||||||
|
|
||||||
if ($ticket->assignee_user_id !== $ticketAttributes['assignee_user_id']) {
|
if ($ticket->assignee_user_id !== $ticketAttributes['assignee_user_id']) {
|
||||||
|
$toAssigneeId = $ticketAttributes['assignee_user_id'];
|
||||||
|
$toAssigneeName = $toAssigneeId === null
|
||||||
|
? null
|
||||||
|
: User::query()->find($toAssigneeId)?->name;
|
||||||
|
|
||||||
$changes['assignee'] = [
|
$changes['assignee'] = [
|
||||||
'from' => $ticket->assignee?->name,
|
'from' => $ticket->assignee?->name,
|
||||||
'to' => $ticketAttributes['assignee_user_id'] === null
|
'to' => $toAssigneeName,
|
||||||
? null
|
|
||||||
: User::query()->find($ticketAttributes['assignee_user_id'])?->name,
|
|
||||||
];
|
];
|
||||||
$summaryLabels[] = 'assignee';
|
$summaryLabels[] = 'assignee';
|
||||||
|
|
||||||
|
$assigneeChange = [
|
||||||
|
'from_id' => $ticket->assignee_user_id,
|
||||||
|
'from_name' => $ticket->assignee?->name,
|
||||||
|
'to_id' => $toAssigneeId,
|
||||||
|
'to_name' => $toAssigneeName,
|
||||||
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($ticket->author_user_id !== $ticketAttributes['author_user_id']) {
|
if ($ticket->author_user_id !== $ticketAttributes['author_user_id']) {
|
||||||
@@ -223,6 +239,21 @@ class UpdateProjectTicket
|
|||||||
$changes,
|
$changes,
|
||||||
);
|
);
|
||||||
|
|
||||||
|
if ($assigneeChange !== null) {
|
||||||
|
TicketAssigneeChanged::dispatch(
|
||||||
|
$this->buildTicketAssigneeChangedPayload->handle(
|
||||||
|
$ticket->project,
|
||||||
|
$ticket,
|
||||||
|
$actor,
|
||||||
|
$assigneeChange['from_id'],
|
||||||
|
$assigneeChange['from_name'],
|
||||||
|
$assigneeChange['to_id'],
|
||||||
|
$assigneeChange['to_name'],
|
||||||
|
CarbonImmutable::now(),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,12 +6,14 @@ enum NotificationEventType: string
|
|||||||
{
|
{
|
||||||
case TicketStatusChanged = 'ticket_status_changed';
|
case TicketStatusChanged = 'ticket_status_changed';
|
||||||
case TicketCreate = 'ticket_create';
|
case TicketCreate = 'ticket_create';
|
||||||
|
case TicketAssigneeChanged = 'ticket_assignee_changed';
|
||||||
|
|
||||||
public function label(): string
|
public function label(): string
|
||||||
{
|
{
|
||||||
return match ($this) {
|
return match ($this) {
|
||||||
self::TicketStatusChanged => 'Ticket status changed',
|
self::TicketStatusChanged => 'Ticket status changed',
|
||||||
self::TicketCreate => 'Ticket create',
|
self::TicketCreate => 'Ticket create',
|
||||||
|
self::TicketAssigneeChanged => 'Assignee changed',
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -13,6 +13,10 @@ enum NotificationFilterAttribute: string
|
|||||||
case TicketUrl = 'ticket.url';
|
case TicketUrl = 'ticket.url';
|
||||||
case ActorId = 'actor.id';
|
case ActorId = 'actor.id';
|
||||||
case ActorName = 'actor.name';
|
case ActorName = 'actor.name';
|
||||||
|
case AssigneeFromId = 'assignee.from.id';
|
||||||
|
case AssigneeFromName = 'assignee.from.name';
|
||||||
|
case AssigneeToId = 'assignee.to.id';
|
||||||
|
case AssigneeToName = 'assignee.to.name';
|
||||||
case StatusFromId = 'status.from.id';
|
case StatusFromId = 'status.from.id';
|
||||||
case StatusFromLabel = 'status.from.label';
|
case StatusFromLabel = 'status.from.label';
|
||||||
case StatusToId = 'status.to.id';
|
case StatusToId = 'status.to.id';
|
||||||
@@ -30,6 +34,10 @@ enum NotificationFilterAttribute: string
|
|||||||
self::TicketUrl => 'Ticket URL',
|
self::TicketUrl => 'Ticket URL',
|
||||||
self::ActorId => 'Actor ID',
|
self::ActorId => 'Actor ID',
|
||||||
self::ActorName => 'Actor name',
|
self::ActorName => 'Actor name',
|
||||||
|
self::AssigneeFromId => 'From assignee ID',
|
||||||
|
self::AssigneeFromName => 'From assignee name',
|
||||||
|
self::AssigneeToId => 'To assignee ID',
|
||||||
|
self::AssigneeToName => 'To assignee name',
|
||||||
self::StatusFromId => 'From status ID',
|
self::StatusFromId => 'From status ID',
|
||||||
self::StatusFromLabel => 'From status label',
|
self::StatusFromLabel => 'From status label',
|
||||||
self::StatusToId => 'To status ID',
|
self::StatusToId => 'To status ID',
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
namespace App\Providers;
|
namespace App\Providers;
|
||||||
|
|
||||||
use App\Actions\Notifications\QueueNotificationEventDeliveries;
|
use App\Actions\Notifications\QueueNotificationEventDeliveries;
|
||||||
|
use App\Actions\Notifications\TicketAssigneeChanged;
|
||||||
use App\Actions\Notifications\TicketCreated;
|
use App\Actions\Notifications\TicketCreated;
|
||||||
use App\Actions\Notifications\TicketStatusChanged;
|
use App\Actions\Notifications\TicketStatusChanged;
|
||||||
use App\Actions\Permissions\PermissionService;
|
use App\Actions\Permissions\PermissionService;
|
||||||
@@ -105,5 +106,10 @@ class AppServiceProvider extends ServiceProvider
|
|||||||
TicketCreated::class,
|
TicketCreated::class,
|
||||||
QueueNotificationEventDeliveries::class,
|
QueueNotificationEventDeliveries::class,
|
||||||
);
|
);
|
||||||
|
|
||||||
|
Event::listen(
|
||||||
|
TicketAssigneeChanged::class,
|
||||||
|
QueueNotificationEventDeliveries::class,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,8 +3,8 @@
|
|||||||
namespace Tests\Feature\Notifications;
|
namespace Tests\Feature\Notifications;
|
||||||
|
|
||||||
use App\Actions\Notifications\RenderDiscordMessageTemplate;
|
use App\Actions\Notifications\RenderDiscordMessageTemplate;
|
||||||
use App\Actions\Notifications\TicketStatusChanged;
|
use App\Actions\Notifications\TicketAssigneeChanged;
|
||||||
use App\Actions\Notifications\TicketStatusChangedPayload;
|
use App\Actions\Notifications\TicketAssigneeChangedPayload;
|
||||||
use Carbon\CarbonImmutable;
|
use Carbon\CarbonImmutable;
|
||||||
use PHPUnit\Framework\Attributes\DataProvider;
|
use PHPUnit\Framework\Attributes\DataProvider;
|
||||||
use Tests\TestCase;
|
use Tests\TestCase;
|
||||||
@@ -45,6 +45,14 @@ class RenderDiscordMessageTemplateTest extends TestCase
|
|||||||
'template' => '$actor_name',
|
'template' => '$actor_name',
|
||||||
'expected' => 'Erica Example',
|
'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);
|
$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,
|
projectId: 10,
|
||||||
projectKey: 'CORE',
|
projectKey: 'CORE',
|
||||||
projectName: 'Core Platform',
|
projectName: 'Core Platform',
|
||||||
@@ -89,6 +97,10 @@ class RenderDiscordMessageTemplateTest extends TestCase
|
|||||||
toStatusId: 2,
|
toStatusId: 2,
|
||||||
toStatusLabel: 'Doing',
|
toStatusLabel: 'Doing',
|
||||||
occurredAt: CarbonImmutable::parse('2026-04-24T09:15:30+00:00'),
|
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('channelOptions.0.value', NotificationChannel::Discord->value)
|
||||||
->where('eventTypeOptions.0.value', NotificationEventType::TicketStatusChanged->value)
|
->where('eventTypeOptions.0.value', NotificationEventType::TicketStatusChanged->value)
|
||||||
->where('eventTypeOptions.1.value', NotificationEventType::TicketCreate->value)
|
->where('eventTypeOptions.1.value', NotificationEventType::TicketCreate->value)
|
||||||
|
->where('eventTypeOptions.2.value', NotificationEventType::TicketAssigneeChanged->value)
|
||||||
->where('discordAllowedMentionOptions.0.value', 'everyone')
|
->where('discordAllowedMentionOptions.0.value', 'everyone')
|
||||||
->where('discordAllowedMentionOptions.2.value', 'users')
|
->where('discordAllowedMentionOptions.2.value', 'users')
|
||||||
->where('filterAttributeOptions.0.value', 'project.id')
|
->where('filterAttributeOptions.0.value', 'project.id')
|
||||||
->where('filterOperatorOptions.0.value', 'equals')
|
->where('filterOperatorOptions.0.value', 'equals')
|
||||||
->where('templateVariables.0.value', '$url')
|
->where('templateVariables.0.value', '$url')
|
||||||
->where('templateVariables.6.value', '$actor_name')
|
->where('templateVariables.6.value', '$actor_name')
|
||||||
|
->where('templateVariables.7.value', '$assignee_from')
|
||||||
|
->where('templateVariables.8.value', '$assignee_to')
|
||||||
->missing('notificationActions.0.delivery_url'),
|
->missing('notificationActions.0.delivery_url'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user