forked from farhoodlabs/paperclip
df425fde96
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - Operators use issue detail pages and child issue lists to understand multi-step execution plans. > - Ordered sub-issues currently read like a flat table, so dependency chains and current next steps are harder to scan. > - The branch work adds a workflow-oriented presentation for child issues without changing the single-assignee task model. > - This pull request makes ordered sub-issues read more like a progress checklist while preserving normal issue list controls. > - The benefit is that operators can see completed steps, active work, blocked follow-ups, and dependency order at a glance. ## What Changed - Added workflow sorting utilities and tests for dependency-aware child issue ordering. - Added sub-issue progress summary, checklist numbering, current-step affordances, blocker context, and done-state de-emphasis in the issue list UI. - Wired issue detail sub-issue panels to use the workflow sort/progress checklist presentation. - Updated issue service behavior/tests for child issue ordering inputs used by the UI. - Added a Storybook visual review fixture and screenshot helper for the sub-issue workflow checklist surface. ## Verification - `pnpm run preflight:workspace-links && pnpm exec vitest run server/src/__tests__/issues-service.test.ts ui/src/components/IssueRow.test.tsx ui/src/components/IssuesList.test.tsx ui/src/pages/IssueDetail.test.tsx ui/src/lib/issue-detail-subissues.test.ts ui/src/lib/workflow-sort.test.ts` - Result: 6 test files passed, 55 tests passed, 34 embedded Postgres issue-service tests skipped because `@embedded-postgres/darwin-x64` is unavailable on this host. - Visual review: generated Storybook screenshots from the existing local Storybook server on port 6006 with `node scripts/screenshot-subissues.mjs /tmp/pap-2189-subissues-screens http://localhost:6006`. - Screenshot artifacts: - Desktop dark:  - Desktop light:  - Mobile dark:  - Mobile light:  - Local Storybook note: starting a second Storybook process selected port 6008 because 6006 was occupied, then Vite failed with an esbuild host/binary version mismatch (`0.25.12` host vs `0.27.3` binary). The already-running Storybook server on 6006 served the fixture successfully for screenshots. ## Risks - Medium UI risk: the issue list now has additional sub-issue-specific visual states, so dense lists should be checked for spacing and scanability. - Low ordering risk: workflow sorting is covered by focused unit tests, but unusual dependency topologies may still need reviewer attention. - No migration risk: this PR does not add database migrations or touch `pnpm-lock.yaml`. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, GPT-5 coding agent, tool-enabled shell/git/GitHub workflow. Context window is runtime-provided and not exposed in this environment. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
282 lines
7.9 KiB
TypeScript
282 lines
7.9 KiB
TypeScript
import type { Meta, StoryObj } from "@storybook/react-vite";
|
|
import { useState } from "react";
|
|
import type { Issue } from "@paperclipai/shared";
|
|
import { useQueryClient } from "@tanstack/react-query";
|
|
import { IssuesList } from "@/components/IssuesList";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import {
|
|
createIssue,
|
|
storybookAgents,
|
|
storybookAuthSession,
|
|
storybookCompanies,
|
|
storybookIssueLabels,
|
|
storybookProjects,
|
|
} from "../fixtures/paperclipData";
|
|
|
|
const companyId = "company-storybook";
|
|
const parentId = "issue-pap-1953";
|
|
|
|
type BlockerRef = NonNullable<Issue["blockedBy"]>[number];
|
|
|
|
function child(overrides: Partial<Issue>): Issue {
|
|
return createIssue({
|
|
parentId,
|
|
projectId: storybookProjects[0]!.id,
|
|
projectWorkspaceId: storybookProjects[0]!.workspaces[0]?.id ?? null,
|
|
goalId: null,
|
|
blockedBy: [],
|
|
blocks: [],
|
|
labelIds: [],
|
|
labels: [],
|
|
...overrides,
|
|
});
|
|
}
|
|
|
|
const blockerRef = (issue: Issue): BlockerRef => ({
|
|
id: issue.id,
|
|
identifier: issue.identifier,
|
|
title: issue.title,
|
|
status: issue.status,
|
|
priority: issue.priority,
|
|
assigneeAgentId: issue.assigneeAgentId,
|
|
assigneeUserId: issue.assigneeUserId,
|
|
});
|
|
|
|
const baseCreatedAt = new Date("2026-04-10T12:00:00.000Z").getTime();
|
|
const createdAt = (offsetMinutes: number) =>
|
|
new Date(baseCreatedAt + offsetMinutes * 60_000);
|
|
|
|
// Mirrors the PAP-1953 topology called out in the PAP-2189 plan:
|
|
// 1954 Scoping (done) — root
|
|
// 1955 Security scoping (done) — root
|
|
// 1960 Phase 1 (done) → 1961 Phase 2 (done)
|
|
// 1962 Phase 3 (done) → 1963 Phase 4 (done)
|
|
// → 1964 Phase 5 (in_progress)
|
|
// → 1965 Phase 6 (blocked)
|
|
// → 1966 Phase 7 (blocked)
|
|
|
|
const scoping = child({
|
|
id: "issue-pap-1954",
|
|
identifier: "PAP-1954",
|
|
issueNumber: 1954,
|
|
title: "Scoping review",
|
|
status: "done",
|
|
priority: "medium",
|
|
completedAt: createdAt(120),
|
|
createdAt: createdAt(0),
|
|
});
|
|
|
|
const security = child({
|
|
id: "issue-pap-1955",
|
|
identifier: "PAP-1955",
|
|
issueNumber: 1955,
|
|
title: "Security scoping",
|
|
status: "done",
|
|
priority: "medium",
|
|
completedAt: createdAt(180),
|
|
createdAt: createdAt(10),
|
|
});
|
|
|
|
const phase1 = child({
|
|
id: "issue-pap-1960",
|
|
identifier: "PAP-1960",
|
|
issueNumber: 1960,
|
|
title: "Phase 1 — groundwork",
|
|
status: "done",
|
|
priority: "medium",
|
|
completedAt: createdAt(600),
|
|
createdAt: createdAt(20),
|
|
});
|
|
|
|
const phase2 = child({
|
|
id: "issue-pap-1961",
|
|
identifier: "PAP-1961",
|
|
issueNumber: 1961,
|
|
title: "Phase 2 — integration",
|
|
status: "done",
|
|
priority: "medium",
|
|
completedAt: createdAt(720),
|
|
createdAt: createdAt(30),
|
|
blockedBy: [blockerRef(phase1)],
|
|
});
|
|
|
|
const phase3 = child({
|
|
id: "issue-pap-1962",
|
|
identifier: "PAP-1962",
|
|
issueNumber: 1962,
|
|
title: "Phase 3 — data model",
|
|
status: "done",
|
|
priority: "medium",
|
|
completedAt: createdAt(800),
|
|
createdAt: createdAt(40),
|
|
});
|
|
|
|
const phase4 = child({
|
|
id: "issue-pap-1963",
|
|
identifier: "PAP-1963",
|
|
issueNumber: 1963,
|
|
title: "Phase 4 — API surface",
|
|
status: "done",
|
|
priority: "medium",
|
|
completedAt: createdAt(900),
|
|
createdAt: createdAt(50),
|
|
blockedBy: [blockerRef(phase3)],
|
|
});
|
|
|
|
const phase5 = child({
|
|
id: "issue-pap-1964",
|
|
identifier: "PAP-1964",
|
|
issueNumber: 1964,
|
|
title: "Phase 5 — UI polish",
|
|
status: "in_progress",
|
|
priority: "high",
|
|
createdAt: createdAt(60),
|
|
blockedBy: [blockerRef(phase4)],
|
|
});
|
|
|
|
const phase6 = child({
|
|
id: "issue-pap-1965",
|
|
identifier: "PAP-1965",
|
|
issueNumber: 1965,
|
|
title: "Phase 6 — telemetry wiring",
|
|
status: "blocked",
|
|
priority: "medium",
|
|
createdAt: createdAt(70),
|
|
blockedBy: [blockerRef(phase5)],
|
|
});
|
|
|
|
const phase7 = child({
|
|
id: "issue-pap-1966",
|
|
identifier: "PAP-1966",
|
|
issueNumber: 1966,
|
|
title: "Phase 7 — rollout",
|
|
status: "blocked",
|
|
priority: "medium",
|
|
createdAt: createdAt(80),
|
|
blockedBy: [blockerRef(phase6)],
|
|
});
|
|
|
|
const subIssues: Issue[] = [
|
|
scoping,
|
|
security,
|
|
phase1,
|
|
phase2,
|
|
phase3,
|
|
phase4,
|
|
phase5,
|
|
phase6,
|
|
phase7,
|
|
];
|
|
|
|
const viewStateKey = "storybook:sub-issues-workflow:list";
|
|
const scopedKey = `${viewStateKey}:${companyId}`;
|
|
|
|
function hydrateQueries(client: ReturnType<typeof useQueryClient>) {
|
|
client.setQueryData(queryKeys.companies.all, storybookCompanies);
|
|
client.setQueryData(queryKeys.auth.session, storybookAuthSession);
|
|
client.setQueryData(queryKeys.agents.list(companyId), storybookAgents);
|
|
client.setQueryData(queryKeys.projects.list(companyId), storybookProjects);
|
|
client.setQueryData(queryKeys.issues.labels(companyId), storybookIssueLabels);
|
|
client.setQueryData(queryKeys.issues.list(companyId), subIssues);
|
|
client.setQueryData(queryKeys.access.companyUserDirectory(companyId), {
|
|
users: [
|
|
{
|
|
principalId: "user-board",
|
|
status: "active",
|
|
user: {
|
|
id: "user-board",
|
|
email: "riley@paperclip.local",
|
|
name: "Riley Board",
|
|
image: null,
|
|
},
|
|
},
|
|
],
|
|
});
|
|
client.setQueryData(queryKeys.instance.experimentalSettings, {
|
|
enableIsolatedWorkspaces: true,
|
|
enableRoutineTriggers: true,
|
|
});
|
|
}
|
|
|
|
function Hydrated({ children }: { children: React.ReactNode }) {
|
|
const queryClient = useQueryClient();
|
|
const [ready] = useState(() => {
|
|
hydrateQueries(queryClient);
|
|
if (typeof window !== "undefined") {
|
|
window.localStorage.removeItem(scopedKey);
|
|
window.localStorage.removeItem(`${scopedKey}:issue-columns`);
|
|
}
|
|
return true;
|
|
});
|
|
return ready ? children : null;
|
|
}
|
|
|
|
function SubIssuesWorkflowPanel() {
|
|
return (
|
|
<div className="paperclip-story">
|
|
<main className="paperclip-story__inner">
|
|
<div className="mx-auto max-w-5xl space-y-5">
|
|
<header className="space-y-1">
|
|
<div className="paperclip-story__label">Issue Detail · Sub-issues</div>
|
|
<h1 className="text-2xl font-semibold tracking-tight">
|
|
Workflow-sorted sub-issues with checklist affordances
|
|
</h1>
|
|
<p className="max-w-3xl text-sm text-muted-foreground">
|
|
Fixture mirrors the PAP-1953 topology called out in the PAP-2189
|
|
plan: two standalone scoping items, a Phase 1→2 pair, and a long
|
|
Phase 3→4→5→6→7 chain. The panel renders with
|
|
<code className="mx-1 rounded bg-muted px-1 py-0.5 font-mono text-xs">
|
|
defaultSortField="workflow"
|
|
</code>
|
|
and
|
|
<code className="mx-1 rounded bg-muted px-1 py-0.5 font-mono text-xs">
|
|
showProgressSummary
|
|
</code>
|
|
so reviewers see the full checklist surface in isolation.
|
|
</p>
|
|
</header>
|
|
<div className="rounded-lg border border-border bg-background p-5">
|
|
<IssuesList
|
|
issues={subIssues}
|
|
agents={storybookAgents}
|
|
projects={storybookProjects}
|
|
viewStateKey={viewStateKey}
|
|
defaultSortField="workflow"
|
|
showProgressSummary
|
|
onUpdateIssue={() => undefined}
|
|
createIssueLabel="Sub-issue"
|
|
/>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
const meta = {
|
|
title: "UX Labs/Sub-issues Workflow Checklist",
|
|
component: SubIssuesWorkflowPanel,
|
|
parameters: {
|
|
layout: "fullscreen",
|
|
docs: {
|
|
description: {
|
|
component:
|
|
"Review surface for the PAP-2189 checklist-style sub-issues work. Renders the IssuesList component with the Sub-issues panel props so the progress strip, workflow sort, step gutter, current marker, done de-emphasis, and blocker chips are all visible against a PAP-1953-like topology.",
|
|
},
|
|
},
|
|
},
|
|
decorators: [
|
|
(StoryRender) => (
|
|
<Hydrated>
|
|
<StoryRender />
|
|
</Hydrated>
|
|
),
|
|
],
|
|
} satisfies Meta<typeof SubIssuesWorkflowPanel>;
|
|
|
|
export default meta;
|
|
|
|
type Story = StoryObj<typeof meta>;
|
|
|
|
export const Default: Story = {};
|