feat: per-project workflow settings, statistics and "my work" home
Per-project settings (owners/admins, «Configuración» tab):
- Statuses with category (TODO, IN_PROGRESS, QA, DONE, CANCELLED), colour and
"requires reason"; configurable transitions; ticket types (icon, colour) and
areas. Defaults are the previous fixed values; projects created before keep
them without migration.
- Values are archived, never deleted: tickets, history and statistics keep
referring to them. Validated in the domain (ProjectSettingsChangedEvent).
- Releases, board, tracking and "my work" use categories, so custom statuses
keep working. Status changes carry name/category metadata for history.
- GraphQL: status/type/area are strings (breaking for clients sending enum
literals); Project.settings, updateProjectSettings, statusCategory,
myIssues(categories). REST: PUT /projects/{project}/settings, category filters.
- Read model: statusCategory on issues (backfilled at startup).
Statistics («Estadísticas» tab):
- New issue_timeline projection; pure functions compute created vs resolved,
cumulative flow, cycle/lead time (avg + p85), throughput per person, QA
pass/fail and release burnup. GraphQL Project.analytics(days),
Release.burnup; REST /projects/{project}/analytics, /releases/{id}/burnup.
- Web: SVG charts with validated light/dark palette, crosshair tooltip,
keyboard navigation, legend and data table.
Home "Mi trabajo": my open tickets across projects grouped by category (QA
failures first), tickets waiting for QA, upcoming releases and "Ir a…".
Tests: domain/application specs, e2e scenario for settings and analytics,
facade tests. Docs, READMEs, schema.gql/openapi.json and Word/PDF updated.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
166
libs/api/tracker/domain/src/lib/project/project-settings.spec.ts
Normal file
166
libs/api/tracker/domain/src/lib/project/project-settings.spec.ts
Normal file
@@ -0,0 +1,166 @@
|
||||
import {
|
||||
BusinessRuleError,
|
||||
ForbiddenError,
|
||||
ValidationError,
|
||||
} from '@task-stream/api/shared/domain';
|
||||
import { ProjectSettingsChangedEvent } from '../events/project-settings-changed.event';
|
||||
import { IssueStatusChangedEvent } from '../events/issue-status-changed.event';
|
||||
import { IssueFactory } from '../factories/issue.factory';
|
||||
import { ProjectFactory } from '../factories/project.factory';
|
||||
import { replay } from '../testing';
|
||||
import { Project } from './project';
|
||||
import { ProjectRole } from './project-role';
|
||||
import {
|
||||
defaultProjectSettings,
|
||||
ProjectSettings,
|
||||
StatusCategory,
|
||||
} from './project-settings';
|
||||
|
||||
const newProject = () => {
|
||||
const project = new ProjectFactory().create({
|
||||
key: 'WEB',
|
||||
name: 'Web',
|
||||
ownerId: 'owner',
|
||||
});
|
||||
project.addMember('owner', 'dev', ProjectRole.MEMBER);
|
||||
return project;
|
||||
};
|
||||
|
||||
/** Defaults plus a STAGING step between review and QA, and a SPIKE type. */
|
||||
const withStaging = (): ProjectSettings => {
|
||||
const settings = defaultProjectSettings();
|
||||
settings.statuses.splice(4, 0, {
|
||||
id: 'STAGING',
|
||||
name: 'En staging',
|
||||
category: StatusCategory.QA,
|
||||
color: 'teal',
|
||||
requiresReason: false,
|
||||
archived: false,
|
||||
});
|
||||
settings.transitions['IN_REVIEW'] = ['STAGING'];
|
||||
settings.transitions['STAGING'] = ['IN_QA', 'IN_PROGRESS'];
|
||||
settings.issueTypes.push({
|
||||
id: 'SPIKE',
|
||||
name: 'Spike',
|
||||
icon: 'light-bulb',
|
||||
color: 'teal',
|
||||
archived: false,
|
||||
});
|
||||
return settings;
|
||||
};
|
||||
|
||||
describe('Project settings', () => {
|
||||
it('starts with the default workflow, also when rebuilt from old events', () => {
|
||||
const project = newProject();
|
||||
expect(project.workflow.initialStatus()).toBe('BACKLOG');
|
||||
expect(project.workflow.canTransition('IN_QA', 'QA_FAILED')).toBe(true);
|
||||
|
||||
// Projects created before settings existed have no `settings` in their event.
|
||||
const { history } = replay(project, Project);
|
||||
delete (history[0].data as unknown as { project: { settings?: unknown } })
|
||||
.project.settings;
|
||||
const old = new Project(project.id);
|
||||
old.loadFromHistory(history);
|
||||
expect(old.settings).toEqual(defaultProjectSettings());
|
||||
});
|
||||
|
||||
it('lets owners and admins customise it, as an event that replays', () => {
|
||||
const project = newProject();
|
||||
project.updateSettings('owner', withStaging());
|
||||
|
||||
const event = project.getUncommittedEvents().at(-1);
|
||||
expect(event).toBeInstanceOf(ProjectSettingsChangedEvent);
|
||||
expect(project.workflow.allowedFrom('IN_REVIEW')).toEqual(['STAGING']);
|
||||
|
||||
const { rebuilt } = replay(project, Project);
|
||||
expect(rebuilt.workflow.status('STAGING')?.category).toBe(
|
||||
StatusCategory.QA,
|
||||
);
|
||||
expect(() => project.updateSettings('dev', withStaging())).toThrow(
|
||||
ForbiddenError,
|
||||
);
|
||||
});
|
||||
|
||||
it('archives values instead of deleting them', () => {
|
||||
const project = newProject();
|
||||
const settings = defaultProjectSettings();
|
||||
settings.areas = settings.areas.filter((a) => a.id !== 'MOBILE');
|
||||
expect(() => project.updateSettings('owner', settings)).toThrow(
|
||||
/archívalo/,
|
||||
);
|
||||
|
||||
const archived = defaultProjectSettings();
|
||||
archived.areas = archived.areas.map((a) =>
|
||||
a.id === 'MOBILE' ? { ...a, archived: true } : a,
|
||||
);
|
||||
project.updateSettings('owner', archived);
|
||||
expect(() => project.workflow.assertActiveArea('MOBILE')).toThrow(
|
||||
BusinessRuleError,
|
||||
);
|
||||
});
|
||||
|
||||
it('rejects settings that would break the board', () => {
|
||||
const project = newProject();
|
||||
const noStart = defaultProjectSettings();
|
||||
noStart.statuses
|
||||
.filter((s) => s.category === StatusCategory.TODO)
|
||||
.forEach((s) => (s.archived = true));
|
||||
expect(() => project.updateSettings('owner', noStart)).toThrow(
|
||||
ValidationError,
|
||||
);
|
||||
|
||||
const badTransition = defaultProjectSettings();
|
||||
badTransition.transitions['TODO'] = ['NOPE'];
|
||||
expect(() => project.updateSettings('owner', badTransition)).toThrow(
|
||||
/no existe/,
|
||||
);
|
||||
|
||||
const duplicate = defaultProjectSettings();
|
||||
duplicate.issueTypes.push({ ...duplicate.issueTypes[0] });
|
||||
expect(() => project.updateSettings('owner', duplicate)).toThrow(/id BUG/);
|
||||
});
|
||||
|
||||
it('drives tickets: types, transitions and names in the history', () => {
|
||||
const project = newProject();
|
||||
project.updateSettings('owner', withStaging());
|
||||
const workflow = project.workflow;
|
||||
const issue = new IssueFactory().create(
|
||||
{
|
||||
projectId: project.id,
|
||||
projectKey: 'WEB',
|
||||
number: 1,
|
||||
title: 'Investigar pagos',
|
||||
type: 'SPIKE',
|
||||
reporterId: 'dev',
|
||||
},
|
||||
workflow,
|
||||
);
|
||||
for (const to of ['TODO', 'IN_PROGRESS', 'IN_REVIEW', 'STAGING'])
|
||||
issue.changeStatus('dev', to, null, workflow);
|
||||
|
||||
const last = issue.getUncommittedEvents().at(-1) as IssueStatusChangedEvent;
|
||||
expect(last.meta).toEqual({
|
||||
fromName: 'En revisión',
|
||||
toName: 'En staging',
|
||||
fromCategory: StatusCategory.IN_PROGRESS,
|
||||
toCategory: StatusCategory.QA,
|
||||
});
|
||||
// The default IN_REVIEW → READY_FOR_QA was replaced by STAGING.
|
||||
expect(() =>
|
||||
issue.changeStatus('dev', 'READY_FOR_QA', null, workflow),
|
||||
).toThrow(BusinessRuleError);
|
||||
expect(() =>
|
||||
new IssueFactory().create(
|
||||
{
|
||||
projectId: project.id,
|
||||
projectKey: 'WEB',
|
||||
number: 2,
|
||||
title: 'x',
|
||||
type: 'EPIC',
|
||||
reporterId: 'dev',
|
||||
},
|
||||
workflow,
|
||||
),
|
||||
).toThrow(/Unknown ticket type/);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user