@shipfox/client-workflows 14.0.1 → 16.0.0

package/src/components/workflow-run-tabs/run-annotations.stories.tsx

@@ -0,0 +1,293 @@
+import type {Meta, StoryObj} from '@storybook/react';
+import type {ReactNode} from 'react';
+import {
+  buildRunAnnotationList,
+  type RunAnnotationRecord,
+  type RunAnnotationStyle,
+  summarizeRunAnnotations,
+} from '#core/run-annotation.js';
+import type {Job} from '#core/workflow-run.js';
+import {
+  workflowJob,
+  workflowJobExecutionDto,
+  workflowStepAttemptDto,
+  workflowStepDto,
+} from '#test/fixtures/workflow-run.js';
+import {RunAnnotationCountChip} from './run-annotation-count-chip.js';
+import {RunAnnotationList, type RunAnnotationListQuery} from './run-annotation-list.js';
+import {RunAnnotationSummaryLine} from './run-annotation-summary-line.js';
+
+const WORKSPACE_SLUG = 'acme';
+const PROJECT_SLUG = 'platform';
+const RUN_ID = '11111111-1111-4111-8111-111111111111';
+const BUILD_JOB_ID = '44444444-4444-4444-8444-00000000000b';
+const TEST_JOB_ID = '44444444-4444-4444-8444-00000000000c';
+const BUILD_EXECUTION_ID = '77777777-7777-4777-8777-00000000000b';
+const TEST_EXECUTION_ID = '77777777-7777-4777-8777-00000000000c';
+const BUILD_STEP_ID = '55555555-5555-4555-8555-00000000000b';
+const TEST_STEP_ID = '55555555-5555-4555-8555-00000000000c';
+const BUILD_ATTEMPT_ID = '66666666-6666-4666-8666-00000000000b';
+const TEST_ATTEMPT_ID = '66666666-6666-4666-8666-00000000000c';
+
+const LONG_BODY = [
+  '### Failing specs',
+  '',
+  ...Array.from(
+    {length: 40},
+    (_unused, index) => `- \`packages/web/src/route-${index}.test.ts\` expected 200, received 503`,
+  ),
+].join('\n');
+
+const meta = {
+  title: 'Workflows/RunAnnotations',
+  parameters: {
+    layout: 'fullscreen',
+  },
+} satisfies Meta;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+export const Playground: Story = {
+  render: () => {
+    const annotations = [
+      annotation({
+        id: 'a1',
+        context: 'smoke check',
+        style: 'error',
+        sequence: 3,
+        body: 'Task nine failed the smoke check against `https://preview.example.com`.\n\n```sh\ncurl -sSf https://preview.example.com/healthz\n```',
+      }),
+      annotation({
+        id: 'a2',
+        context: 'flaky tests',
+        style: 'warning',
+        sequence: 1,
+        jobId: TEST_JOB_ID,
+        jobExecutionId: TEST_EXECUTION_ID,
+        originStepId: TEST_STEP_ID,
+        body: '2 specs retried before passing.\n\n| Spec | Retries |\n| --- | --- |\n| `checkout.spec.ts` | 1 |\n| `billing.spec.ts` | 2 |',
+      }),
+      annotation({
+        id: 'a3',
+        context: 'deploy',
+        style: 'success',
+        sequence: 2,
+        body: 'Deployed **v42** to staging: [preview](https://preview.example.com)',
+      }),
+      annotation({
+        id: 'a4',
+        context: 'coverage',
+        style: 'info',
+        sequence: 4,
+        body: 'Line coverage held at 87.4%.',
+      }),
+    ];
+
+    return <AnnotationsFrame annotations={annotations} />;
+  },
+};
+
+export const BoundedBody: Story = {
+  // The only story in this package that earns a second Argos mode. The clamp's fade is the one
+  // gradient in the client, and it blends a surface token that flips with the theme, so a
+  // dark-only capture would never catch it breaking on a light card.
+  parameters: {
+    argos: {modes: {dark: {theme: 'dark'}, light: {theme: 'light'}}},
+  },
+  render: () => (
+    <AnnotationsFrame
+      annotations={[
+        annotation({id: 'long', context: 'test results', style: 'error', body: LONG_BODY}),
+      ]}
+    />
+  ),
+};
+
+export const DataStates: Story = {
+  render: () => {
+    const loaded = [annotation({id: 'a1', context: 'deploy', style: 'success'})];
+    return (
+      <div className="grid max-w-[1120px] gap-16 p-16 md:grid-cols-2">
+        <StateExample label="Loading">
+          <AnnotationsList annotations={[]} query={storyQuery({isPending: true})} />
+        </StateExample>
+        <StateExample label="Empty">
+          <AnnotationsList annotations={[]} />
+        </StateExample>
+        <StateExample label="Error">
+          <AnnotationsList
+            annotations={[]}
+            query={storyQuery({isError: true, data: undefined, error: new Error('Storybook')})}
+          />
+        </StateExample>
+        <StateExample label="Stale">
+          <AnnotationsList
+            annotations={loaded}
+            query={storyQuery({isError: true, error: new Error('Storybook')})}
+          />
+        </StateExample>
+        <StateExample label="Filtered miss">
+          <AnnotationsList annotations={[]} filtered filteredJobName="build" />
+        </StateExample>
+        <StateExample label="Truncated counts">
+          <RunAnnotationSummaryLine
+            summary={{...summarizeRunAnnotations(loaded), total: 500, error: 12, truncated: true}}
+            workspaceSlug={WORKSPACE_SLUG}
+            projectSlug={PROJECT_SLUG}
+            workflowRunId={RUN_ID}
+          />
+        </StateExample>
+      </div>
+    );
+  },
+};
+
+export const CountChips: Story = {
+  render: () => (
+    <div className="flex max-w-[1120px] flex-wrap items-center gap-12 p-16">
+      {(['error', 'warning', 'info', 'success'] as const).map((style) => (
+        <RunAnnotationCountChip
+          key={style}
+          summary={summarizeRunAnnotations([annotation({id: style, context: style, style})])}
+          workspaceSlug={WORKSPACE_SLUG}
+          projectSlug={PROJECT_SLUG}
+          workflowRunId={RUN_ID}
+          jobId={BUILD_JOB_ID}
+        />
+      ))}
+      <RunAnnotationCountChip
+        summary={{total: 500, error: 12, warning: 3, info: 0, success: 0, truncated: true}}
+        workspaceSlug={WORKSPACE_SLUG}
+        projectSlug={PROJECT_SLUG}
+        workflowRunId={RUN_ID}
+      />
+    </div>
+  ),
+};
+
+function AnnotationsFrame({annotations}: {annotations: RunAnnotationRecord[]}) {
+  return (
+    <div className="min-h-screen bg-background-neutral-base py-16">
+      <div className="mx-auto flex w-full max-w-[1120px] flex-col gap-16 px-24">
+        <RunAnnotationSummaryLine
+          summary={summarizeRunAnnotations(annotations)}
+          workspaceSlug={WORKSPACE_SLUG}
+          projectSlug={PROJECT_SLUG}
+          workflowRunId={RUN_ID}
+        />
+        <AnnotationsList annotations={annotations} />
+      </div>
+    </div>
+  );
+}
+
+function AnnotationsList({
+  annotations,
+  query = storyQuery(),
+  filtered = false,
+  filteredJobName,
+}: {
+  annotations: RunAnnotationRecord[];
+  query?: RunAnnotationListQuery;
+  filtered?: boolean;
+  filteredJobName?: string;
+}) {
+  return (
+    <RunAnnotationList
+      query={query}
+      entries={query.data === undefined ? undefined : buildRunAnnotationList({annotations, jobs})}
+      workspaceSlug={WORKSPACE_SLUG}
+      projectSlug={PROJECT_SLUG}
+      workflowRunId={RUN_ID}
+      runAttempt={1}
+      filtered={filtered}
+      filteredJobName={filteredJobName}
+      onClearFilters={() => undefined}
+    />
+  );
+}
+
+function StateExample({label, children}: {label: string; children: ReactNode}) {
+  return (
+    <div className="flex flex-col gap-8">
+      <span className="text-xs font-medium text-foreground-neutral-muted">{label}</span>
+      {children}
+    </div>
+  );
+}
+
+function storyQuery(overrides: Partial<RunAnnotationListQuery> = {}): RunAnnotationListQuery {
+  return {
+    isPending: false,
+    isError: false,
+    isFetching: false,
+    data: {pages: []},
+    error: null,
+    refetch: () => undefined,
+    hasNextPage: false,
+    isFetchingNextPage: false,
+    fetchNextPage: () => undefined,
+    ...overrides,
+  };
+}
+
+function annotation(
+  overrides: Partial<RunAnnotationRecord> & {id: string; style: RunAnnotationStyle},
+): RunAnnotationRecord {
+  return {
+    jobId: BUILD_JOB_ID,
+    jobExecutionId: BUILD_EXECUTION_ID,
+    originStepId: BUILD_STEP_ID,
+    originStepAttempt: 1,
+    context: 'default',
+    sequence: 1,
+    body: 'Body',
+    ...overrides,
+  };
+}
+
+const jobs: Job[] = [
+  workflowJob({
+    id: BUILD_JOB_ID,
+    key: 'build',
+    name: 'build',
+    position: 0,
+    job_executions: [
+      workflowJobExecutionDto({
+        id: BUILD_EXECUTION_ID,
+        job_id: BUILD_JOB_ID,
+        steps: [
+          workflowStepDto({
+            id: BUILD_STEP_ID,
+            name: 'run smoke checks',
+            attempts: [
+              workflowStepAttemptDto({id: BUILD_ATTEMPT_ID, step_id: BUILD_STEP_ID, attempt: 1}),
+            ],
+          }),
+        ],
+      }),
+    ],
+  }),
+  workflowJob({
+    id: TEST_JOB_ID,
+    key: 'test',
+    name: 'test',
+    position: 1,
+    job_executions: [
+      workflowJobExecutionDto({
+        id: TEST_EXECUTION_ID,
+        job_id: TEST_JOB_ID,
+        steps: [
+          workflowStepDto({
+            id: TEST_STEP_ID,
+            name: 'vitest',
+            attempts: [
+              workflowStepAttemptDto({id: TEST_ATTEMPT_ID, step_id: TEST_STEP_ID, attempt: 1}),
+            ],
+          }),
+        ],
+      }),
+    ],
+  }),
+];

package/src/components/workflow-run-tabs/severity-visuals.ts

@@ -0,0 +1,37 @@
+import type {IconName} from '@shipfox/react-ui/icon';
+import type {RunAnnotationSeverity} from '#core/run-annotation.js';
+
+/**
+ * The glyph vocabulary for annotation severity, shared by every count surface.
+ *
+ * Deliberately the same marks the `Callout` uses on the cards themselves, so the glyph beside
+ * `1 error` in the summary is the glyph on the error card below it.
+ */
+export const SEVERITY_ICON: Record<RunAnnotationSeverity, IconName> = {
+  error: 'closeCircleFill',
+  warning: 'errorWarningFill',
+  info: 'info',
+  success: 'checkboxCircleFill',
+};
+
+/**
+ * Severity tone lives in the glyph, never in the label.
+ *
+ * Coloring the text would make severity compete with the brand accent, which this system
+ * reserves for links, focus, and "you are here". Shape plus tone in a 12px mark distinguishes
+ * an error from a warning without either of them shouting.
+ */
+export const SEVERITY_ICON_TONE: Record<RunAnnotationSeverity, string> = {
+  error: 'text-tag-error-icon',
+  warning: 'text-tag-warning-icon',
+  info: 'text-tag-blue-icon',
+  success: 'text-tag-success-icon',
+};
+
+/** Hairline tone for a bordered count chip, matching the glyph it sits beside. */
+export const SEVERITY_CHIP_TONE: Record<RunAnnotationSeverity, string> = {
+  error: 'border-tag-error-border text-tag-error-icon',
+  warning: 'border-tag-warning-border text-tag-warning-icon',
+  info: 'border-tag-blue-border text-tag-blue-icon',
+  success: 'border-tag-success-border text-tag-success-icon',
+};

package/src/components/workflow-run-view/index.ts

@@ -1,2 +1 @@
-export {JobCard} from './job-card.js';
 export {WorkflowRunView} from './workflow-run-view.js';

package/src/components/workflow-run-view/run-workspace-nav.test.tsx

@@ -0,0 +1,286 @@
+import {act, screen, within} from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import {useState} from 'react';
+import {
+  workflowJobDto,
+  workflowJobExecutionDto,
+  workflowRunDetail,
+} from '#test/fixtures/workflow-run.js';
+import {renderWithRouter} from '#test/render.js';
+import {RunWorkspaceNav} from './run-workspace-nav.js';
+
+const RUN_ID = '66666666-6666-4666-8666-666666666666';
+const CURRENT_JOB_ID = '88888888-8888-4888-8888-888888888888';
+const BUILD_LINK_PATTERN = /build/;
+const DEPLOY_LINK_PATTERN = /deploy/;
+const NOW = Date.parse('2026-06-26T12:00:00.000Z');
+
+describe('RunWorkspaceNav', () => {
+  beforeEach(() => {
+    Object.defineProperty(HTMLElement.prototype, 'scrollIntoView', {
+      configurable: true,
+      value: vi.fn(),
+    });
+  });
+
+  afterEach(() => {
+    vi.useRealTimers();
+  });
+
+  test('announces the annotation count with its unit and marks a truncated read', async () => {
+    const run = workflowRunDetail({
+      id: RUN_ID,
+      jobs: [workflowJobDto({id: CURRENT_JOB_ID, name: 'build', position: 0})],
+    });
+
+    renderWithRouter(
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+        annotationSummary={{
+          total: 500,
+          error: 12,
+          warning: 3,
+          info: 0,
+          success: 0,
+          truncated: true,
+        }}
+      />,
+    );
+
+    expect(await screen.findByRole('link', {name: 'Annotations, 500 or more'})).toBeVisible();
+  });
+
+  test('omits the annotation count until the read resolves', async () => {
+    const run = workflowRunDetail({
+      id: RUN_ID,
+      jobs: [workflowJobDto({id: CURRENT_JOB_ID, name: 'build', position: 0})],
+    });
+
+    renderWithRouter(
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+      />,
+    );
+
+    expect(await screen.findByRole('link', {name: 'Annotations'})).toBeVisible();
+  });
+
+  test('shows the complete run hierarchy and marks the current job', async () => {
+    const run = workflowRunDetail({
+      id: RUN_ID,
+      jobs: [
+        workflowJobDto({id: 'job-deploy', name: 'deploy', position: 2, status: 'failed'}),
+        workflowJobDto({id: CURRENT_JOB_ID, name: 'build', position: 1, status: 'running'}),
+        workflowJobDto({id: 'job-setup', name: 'setup', position: 0, status: 'succeeded'}),
+      ],
+    });
+
+    renderWithRouter(
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+        currentJobId={CURRENT_JOB_ID}
+        jobSearch={{runAttempt: 2}}
+      />,
+    );
+
+    expect(await screen.findByRole('link', {name: 'Summary'})).toBeInTheDocument();
+    expect(screen.getByRole('heading', {name: 'Jobs'})).toBeInTheDocument();
+    expect(screen.getByRole('heading', {name: 'Run details'})).toBeInTheDocument();
+    expect(screen.getByRole('link', {name: 'Annotations'})).toBeInTheDocument();
+    expect(screen.getByRole('link', {name: 'Source'})).toBeInTheDocument();
+
+    const jobs = screen.getByRole('heading', {name: 'Jobs'}).closest('section');
+    if (!jobs) throw new Error('Missing jobs section');
+    expect(
+      within(jobs)
+        .getAllByRole('link')
+        .map((link) => link.textContent?.trim()),
+    ).toEqual([
+      expect.stringContaining('setup'),
+      expect.stringContaining('build'),
+      expect.stringContaining('deploy'),
+    ]);
+
+    const current = within(jobs).getByRole('link', {name: BUILD_LINK_PATTERN});
+    expect(current).toHaveAttribute('aria-current', 'page');
+    expect(current).toHaveAttribute(
+      'href',
+      expect.stringContaining(`/runs/${RUN_ID}/jobs/${CURRENT_JOB_ID}`),
+    );
+    expect(current).not.toHaveAttribute('href', expect.stringContaining('tab='));
+    expect(current).toHaveAttribute('href', expect.stringContaining('runAttempt=%222%22'));
+  });
+
+  test('keeps the job index visible for a single-job run', async () => {
+    const run = workflowRunDetail({
+      id: RUN_ID,
+      jobs: [workflowJobDto({id: CURRENT_JOB_ID, name: 'build', status: 'succeeded'})],
+    });
+
+    renderWithRouter(
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+      />,
+    );
+
+    expect(await screen.findByRole('heading', {name: 'Jobs'})).toBeInTheDocument();
+    expect(screen.getByRole('link', {name: BUILD_LINK_PATTERN})).toBeInTheDocument();
+    expect(screen.getByRole('link', {name: 'Summary'})).toHaveAttribute('aria-current', 'page');
+  });
+
+  test('scrolls the current job into view when the mobile rail opens', async () => {
+    const user = userEvent.setup();
+    const scrollIntoView = vi.fn();
+    Object.defineProperty(HTMLElement.prototype, 'scrollIntoView', {
+      configurable: true,
+      value: scrollIntoView,
+    });
+    const run = workflowRunDetail({
+      id: RUN_ID,
+      jobs: [workflowJobDto({id: CURRENT_JOB_ID, name: 'build', status: 'running'})],
+    });
+
+    renderWithRouter(
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+        currentJobId={CURRENT_JOB_ID}
+      />,
+    );
+
+    await screen.findByRole('link', {name: BUILD_LINK_PATTERN});
+    await user.click(await screen.findByRole('button', {name: 'Toggle run navigation'}));
+
+    expect(scrollIntoView).toHaveBeenCalledTimes(2);
+  });
+
+  test('closes the mobile rail after navigating to a job', async () => {
+    const user = userEvent.setup();
+    const run = workflowRunDetail({
+      id: RUN_ID,
+      jobs: [
+        workflowJobDto({id: CURRENT_JOB_ID, name: 'build', status: 'running'}),
+        workflowJobDto({id: 'job-deploy', name: 'deploy', position: 1, status: 'succeeded'}),
+      ],
+    });
+
+    renderWithRouter(
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+        currentJobId={CURRENT_JOB_ID}
+      />,
+    );
+
+    const trigger = await screen.findByRole('button', {name: 'Toggle run navigation'});
+    await user.click(trigger);
+    expect(trigger).toHaveAttribute('aria-expanded', 'true');
+
+    await user.click(screen.getByRole('link', {name: DEPLOY_LINK_PATTERN}));
+
+    expect(trigger).toHaveAttribute('aria-expanded', 'false');
+  });
+
+  test('scrolls once when the active job changes while the rail is open', async () => {
+    const user = userEvent.setup();
+    const scrollIntoView = vi.fn();
+    Object.defineProperty(HTMLElement.prototype, 'scrollIntoView', {
+      configurable: true,
+      value: scrollIntoView,
+    });
+    const firstJob = workflowJobDto({id: CURRENT_JOB_ID, name: 'build', status: 'running'});
+    const secondJob = workflowJobDto({
+      id: 'job-deploy',
+      name: 'deploy',
+      position: 1,
+      status: 'running',
+    });
+    const initialRun = workflowRunDetail({id: RUN_ID, jobs: [firstJob, secondJob]});
+    renderWithRouter(<ActiveJobHarness run={initialRun} />);
+
+    await screen.findByRole('link', {name: BUILD_LINK_PATTERN});
+    await user.click(await screen.findByRole('button', {name: 'Toggle run navigation'}));
+    const callsBeforeJobChange = scrollIntoView.mock.calls.length;
+
+    await user.click(screen.getByRole('button', {name: 'Activate deploy'}));
+
+    expect(scrollIntoView).toHaveBeenCalledTimes(callsBeforeJobChange + 1);
+  });
+
+  test('updates live job durations on the ticker cadence', async () => {
+    vi.useFakeTimers({shouldAdvanceTime: true});
+    vi.setSystemTime(NOW);
+    const run = workflowRunDetail({
+      id: RUN_ID,
+      jobs: [
+        workflowJobDto({
+          id: CURRENT_JOB_ID,
+          name: 'build',
+          status: 'running',
+          job_executions: [
+            workflowJobExecutionDto({
+              job_id: CURRENT_JOB_ID,
+              status: 'running',
+              queued_at: '2026-06-26T11:54:00.000Z',
+              started_at: '2026-06-26T11:57:46.000Z',
+            }),
+          ],
+        }),
+      ],
+    });
+
+    renderWithRouter(
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+        currentJobId={CURRENT_JOB_ID}
+      />,
+    );
+
+    const jobLink = await screen.findByRole('link', {name: BUILD_LINK_PATTERN});
+    expect(jobLink).toHaveTextContent('2m 14s');
+
+    act(() => {
+      vi.advanceTimersByTime(1000);
+    });
+
+    expect(jobLink).toHaveTextContent('2m 15s');
+  });
+});
+
+function ActiveJobHarness({run}: {run: ReturnType<typeof workflowRunDetail>}) {
+  const [currentJobId, setCurrentJobId] = useState(CURRENT_JOB_ID);
+
+  return (
+    <>
+      <RunWorkspaceNav
+        workspaceSlug="acme"
+        projectSlug="project"
+        run={run}
+        activeSection="summary"
+        currentJobId={currentJobId}
+      />
+      <button type="button" onClick={() => setCurrentJobId('job-deploy')}>
+        Activate deploy
+      </button>
+    </>
+  );
+}