Typy issue
View on GitHubDodaj kategorię statusu workflow
category statusu workflow nie jest dowolnym tekstem — to sztywny,
trójwartościowy enum (todo/in_progress/done) współdzielony przez
workflow każdego typu issue, używany do grupowania kolorystycznego
statusów i jako zgrubny koszyk, na którym działają kolumny tablicy,
filtr statusu, liczniki na dashboardzie i automatyzacja zmiany statusu. Przećwiczony przykład: dodanie czwartego koszyka,
blocked, dla statusu w rodzaju "Blocked" albo "On Hold", który nie
jest tak naprawdę "w trakcie", ale też nie jest porzucony.
Jeśli chcesz tylko dodać kolejny status do workflow jednego typu issue — z użyciem trzech istniejących kategorii — nie dotykaj żadnego kodu, użyj Ustawienia → Issue Types → Manage workflow w samej aplikacji. Ten przewodnik dotyczy dodania samej nowej wartości kategorii.
Krok 1 — Rozszerz enum backendowy
Plik: app/Enums/WorkflowStatusCategory.php
<?php
namespace App\Enums;
enum WorkflowStatusCategory: string
{
case TODO = 'todo';
case IN_PROGRESS = 'in_progress';
case DONE = 'done';
case BLOCKED = 'blocked';
}
To jedyna zmiana na poziomie typów po stronie backendu:
App\Models\WorkflowStatus już rzutuje kolumnę category na ten enum
(protected $casts = ['category' => WorkflowStatusCategory::class] w
app/Models/WorkflowStatus.php), a App\Http\Controllers\WorkflowController
waliduje przychodzącą category przez
Rule::enum(WorkflowStatusCategory::class) (zarówno storeStatus(),
jak i updateStatus()) — nowy case jest akceptowany przez tę regułę
automatycznie, bez zmiany kontrolera.
Krok 2 — Zdecyduj, gdzie nowa kategoria musi być obsłużona
Status issue to wyłącznie jego status workflow (stara kolumna
issues.status open/in_progress/closed zniknęła), więc nic już nie
mapuje starej wartości na kategorię. To, co czyta kategorię:
IssueTypeService::statusForCategory()— zwraca pierwszy status typu o danej kategorii; używany przez import (mapowanie może nazwać kategorię) i działa dla nowego przypadku bez zmian.ChangeStatusAction— przyjmuje parametrcategorywalidowany przezWorkflowStatusCategory::tryFrom(), więc nowy przypadek jest akceptowany bez zmian.IssueRepository::applySearchAndFilters()i sortowanie postatus— filtr przyjmuje wartości kategorii, a sortowanie układa je przezCASE; dodaj'blocked'do tegoCASEwgetAllPaginated(), żeby sortował się tam, gdzie chcesz.
Status blocked użytkownik ustawia jawnie przez workflow_status_id;
kolumny statusów tablicy (STATUS_COLUMNS w IssueBoard.tsx) wymieniają
tylko trzy pierwotne kategorie, więc zdecyduj, czy nowa dostaje własną
kolumnę.
Krok 3 — Dodaj ją do listy opcji na frontendzie
Plik: resources/js/types/Workflow.ts
export type WorkflowStatusCategory = 'todo' | 'in_progress' | 'done' | 'blocked';
Plik: resources/js/Components/Organisms/WorkspaceSettingsContent/WorkspaceSettingsWorkflowModal.tsx
const CATEGORY_OPTIONS: { value: WorkflowStatusCategory; label: string }[] = [
{ value: 'todo', label: 'To Do' },
{ value: 'in_progress', label: 'In Progress' },
{ value: 'done', label: 'Done' },
{ value: 'blocked', label: 'Blocked' },
];
To wszystkie odwołania po stronie frontendu — CATEGORY_OPTIONS
napędza zarówno <select> kategorii formularza "add status", jak i
etykietę pokazywaną obok każdego istniejącego statusu w modalu.
WorkflowStatusBadge oraz sprawdzenie isClosed w IssueElement
(issue.workflowStatus.category === 'done') porównują tylko
konkretnie z 'done', więc nowa kategoria nie wymaga tam żadnej
zmiany.
Krok 4 — Testy
Plik: tests/Feature/Models/WorkflowStatusTest.php
Dodaj przypadek asertujący, że nowa wartość enuma przechodzi przez rzutowanie w obie strony, powielając istniejące asercje kategorii w tym pliku:
test('a workflow status can be created with the blocked category', function () {
$status = WorkflowStatus::factory()->create(['category' => WorkflowStatusCategory::BLOCKED]);
expect($status->category)->toBe(WorkflowStatusCategory::BLOCKED);
});
Plik: tests/Feature/WorkflowControllerTest.php
Dodaj przypadek potwierdzający, że kontroler akceptuje ją od początku
do końca, powielając 'an admin can add a status to an issue type workflow':
test('an admin can add a status with the blocked category', function () {
$project = Project::factory()->create();
$admin = User::factory()->create();
addProjectMember($project, $admin->id, 'admin');
$issueType = $project->issueTypes()->create(['name' => 'Bug', 'icon' => 'Bug', 'color' => '#f44336']);
$response = $this->actingAs($admin)->post("/projects/$project->id/issue-types/$issueType->id/statuses", [
'name' => 'Blocked',
'color' => '#ef4444',
'category' => 'blocked',
]);
$response->assertRedirect();
$this->assertDatabaseHas('workflow_statuses', ['issue_type_id' => $issueType->id, 'name' => 'Blocked', 'category' => 'blocked']);
});
Uruchom php artisan test --filter=WorkflowStatusTest i
php artisan test --filter=WorkflowControllerTest, a także
npx vitest run resources/js/Components/Organisms/WorkspaceSettingsContent/WorkspaceSettingsWorkflowModal.test.tsx,
przed zacommitowaniem.
