@shipfox/client-workflows 15.0.0 → 17.0.0

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

@@ -1,2 +1,9 @@
+export {RunAnnotationCountChip} from './run-annotation-count-chip.js';
+export {annotationElementId, RunAnnotationItem} from './run-annotation-item.js';
+export {
+  type DerivedRunAnnotation,
+  RunAnnotationList,
+  type RunAnnotationListQuery,
+} from './run-annotation-list.js';
 export {RunAnnotationSummaryLine} from './run-annotation-summary-line.js';
 export {RunAnnotationsEmpty} from './run-annotations-empty.js';

package/src/components/workflow-run-tabs/run-annotation-count-chip.tsx

@@ -0,0 +1,63 @@
+import {Icon} from '@shipfox/react-ui/icon';
+import {cn} from '@shipfox/react-ui/utils';
+import {Link} from '@tanstack/react-router';
+import {highestRunAnnotationSeverity, type RunAnnotationSummary} from '#core/run-annotation.js';
+import {type WorkflowRunsSearch, workflowRunSearchParams} from '#routes/inputs.js';
+import {SEVERITY_CHIP_TONE, SEVERITY_ICON} from './severity-visuals.js';
+
+export interface RunAnnotationCountChipProps {
+  summary: RunAnnotationSummary | undefined;
+  workspaceSlug: string;
+  projectSlug: string;
+  workflowRunId: string;
+  runAttempt?: number | undefined;
+  /** Scopes the destination list to one job. */
+  jobId?: string | undefined;
+}
+
+/**
+ * A bounded reference into the run's Annotations section: a count, its highest severity, and one
+ * link. Never a body, so an annotation is rendered exactly once per page.
+ */
+export function RunAnnotationCountChip({
+  summary,
+  workspaceSlug,
+  projectSlug,
+  workflowRunId,
+  runAttempt,
+  jobId,
+}: RunAnnotationCountChipProps) {
+  if (!summary || summary.total === 0) return null;
+
+  const severity = highestRunAnnotationSeverity(summary);
+  const count = `${summary.total}${summary.truncated ? '+' : ''}`;
+  const label = `${count} ${summary.total === 1 && !summary.truncated ? 'annotation' : 'annotations'}`;
+  const accessibleLabel = severity
+    ? `View ${label}, highest severity ${severity}`
+    : `View ${label}`;
+  const search: WorkflowRunsSearch = {tab: 'annotations', ...(runAttempt ? {runAttempt} : {})};
+  if (jobId) search.jobId = jobId;
+
+  return (
+    <Link
+      to="/w/$workspaceSlug/p/$projectSlug/runs/$workflowRunId"
+      params={{workspaceSlug, projectSlug, workflowRunId}}
+      search={workflowRunSearchParams(search, search) as never}
+      aria-label={accessibleLabel}
+      className={cn(
+        'inline-flex h-20 shrink-0 items-center gap-tight rounded-4 border px-tight font-code text-xs leading-16 tabular-nums outline-none transition-colors hover:bg-background-neutral-hover focus-visible:shadow-border-interactive-with-active',
+        // The chip stays 20px optically so it sits level with the duration metadata beside it;
+        // the hit area grows to the 44px minimum only where the pointer is coarse.
+        '[@media(pointer:coarse)]:h-44 [@media(pointer:coarse)]:px-[10px]',
+        severity ? SEVERITY_CHIP_TONE[severity] : 'border-border-neutral-base',
+      )}
+    >
+      <Icon
+        name={severity ? SEVERITY_ICON[severity] : 'fileTextLine'}
+        size={12}
+        aria-hidden="true"
+      />
+      <span className="text-foreground-neutral-base">{count}</span>
+    </Link>
+  );
+}

package/src/components/workflow-run-tabs/run-annotation-item.tsx

@@ -0,0 +1,123 @@
+import {AnnotationCard} from '@shipfox/client-ui';
+import {Button} from '@shipfox/react-ui/button';
+import {Icon} from '@shipfox/react-ui/icon';
+import {Text} from '@shipfox/react-ui/typography';
+import {cn} from '@shipfox/react-ui/utils';
+import {Link} from '@tanstack/react-router';
+import {useEffect, useRef} from 'react';
+import type {RunAnnotationEntry} from '#core/run-annotation.js';
+import {workflowJobSearchParams} from '#routes/inputs.js';
+
+export interface RunAnnotationItemProps {
+  entry: RunAnnotationEntry;
+  workspaceSlug?: string | undefined;
+  projectSlug?: string | undefined;
+  workflowRunId: string;
+  runAttempt?: number | undefined;
+  /** Deep-link target from `?annotation=`, which takes focus rather than only being scrolled to. */
+  selected?: boolean | undefined;
+}
+
+/**
+ * One annotation, and the only place in the product that renders an annotation body.
+ *
+ * The title is the annotation's `context`, which is what the emitting step named the block.
+ * Everything below it exists so a reader can get from a diagnostic back to its cause.
+ */
+export function RunAnnotationItem({
+  entry,
+  workspaceSlug,
+  projectSlug,
+  workflowRunId,
+  runAttempt,
+  selected = false,
+}: RunAnnotationItemProps) {
+  const {annotation, origin} = entry;
+  const canLink = Boolean(origin && workspaceSlug && projectSlug);
+  const itemRef = useRef<HTMLLIElement>(null);
+  const focusedRef = useRef(false);
+
+  useEffect(() => {
+    if (!selected) {
+      focusedRef.current = false;
+      return;
+    }
+    if (focusedRef.current) return;
+
+    // A deep link that only scrolls leaves a keyboard or screen-reader user at the document
+    // start while the page moves under them.
+    focusedRef.current = true;
+    itemRef.current?.focus({preventScroll: true});
+    itemRef.current?.scrollIntoView({block: 'nearest'});
+  }, [selected]);
+
+  return (
+    <li
+      ref={itemRef}
+      tabIndex={-1}
+      aria-current={selected ? 'true' : undefined}
+      className={cn(
+        'rounded-8 outline-none focus-visible:shadow-border-interactive-with-active',
+        selected && 'shadow-border-interactive-with-active',
+      )}
+    >
+      <AnnotationCard
+        id={annotationElementId(annotation.id)}
+        style={annotation.style}
+        title={annotation.context}
+        titleAs="h3"
+        provenance={<RunAnnotationProvenance entry={entry} />}
+        body={annotation.body}
+        action={
+          canLink && origin ? (
+            <Button
+              asChild
+              size="xs"
+              variant="transparent"
+              className="[@media(pointer:coarse)]:min-h-44"
+            >
+              <Link
+                to="/w/$workspaceSlug/p/$projectSlug/runs/$workflowRunId/jobs/$jobId"
+                params={{
+                  workspaceSlug: workspaceSlug ?? '',
+                  projectSlug: projectSlug ?? '',
+                  workflowRunId,
+                  jobId: origin.jobId,
+                }}
+                search={
+                  workflowJobSearchParams({
+                    jobExecutionId: origin.jobExecutionId,
+                    stepId: origin.stepId,
+                    stepAttemptId: origin.stepAttemptId,
+                    runAttempt,
+                  }) as never
+                }
+              >
+                Open step
+                <Icon name="arrowRightLine" size={12} aria-hidden="true" />
+              </Link>
+            </Button>
+          ) : null
+        }
+      />
+    </li>
+  );
+}
+
+/** `job · execution #2 · run tests · attempt 1`, dropping any part the run no longer resolves. */
+function RunAnnotationProvenance({entry}: {entry: RunAnnotationEntry}) {
+  const parts = [entry.jobName, entry.executionLabel, entry.stepLabel, entry.attemptLabel].filter(
+    (part): part is string => Boolean(part),
+  );
+
+  return (
+    <Text as="p" size="xs" className="min-w-0 break-words font-code text-foreground-neutral-subtle">
+      {parts.join(' · ')}
+    </Text>
+  );
+}
+
+/** Stable element id so `?annotation=<id>` can scroll to and highlight one annotation. */
+export function annotationElementId(annotationId: string): string {
+  return `run-annotation-${annotationId}`;
+}

package/src/components/workflow-run-tabs/run-annotation-list.tsx

@@ -0,0 +1,273 @@
+import {AnnotationCard, QueryLoadError, type QueryLoadErrorQuery} from '@shipfox/client-ui';
+import {Button} from '@shipfox/react-ui/button';
+import {Callout} from '@shipfox/react-ui/callout';
+import {EmptyState} from '@shipfox/react-ui/empty-state';
+import {Skeleton} from '@shipfox/react-ui/skeleton';
+import {Text} from '@shipfox/react-ui/typography';
+import {useState} from 'react';
+import type {RunAnnotationEntry, RunAnnotationStyle} from '#core/run-annotation.js';
+import {RunAnnotationItem} from './run-annotation-item.js';
+import {RunAnnotationsEmpty} from './run-annotations-empty.js';
+
+export interface RunAnnotationListQuery extends QueryLoadErrorQuery {
+  isPending: boolean;
+  hasNextPage: boolean;
+  isFetchingNextPage: boolean;
+  fetchNextPage: () => unknown;
+}
+
+export interface RunAnnotationListProps {
+  query: RunAnnotationListQuery;
+  entries: RunAnnotationEntry[] | undefined;
+  /** Synthetic terminal-job diagnostics for jobs that never created an execution record. */
+  derivedAnnotations?: readonly DerivedRunAnnotation[] | undefined;
+  workflowRunId: string;
+  workspaceSlug?: string | undefined;
+  projectSlug?: string | undefined;
+  runAttempt?: number | undefined;
+  /** Name of the job the list is filtered to, used only for empty-state copy. */
+  filteredJobName?: string | undefined;
+  /** Active severity filter, named in the empty state so the reader knows what to clear. */
+  filteredSeverity?: string | undefined;
+  filtered: boolean;
+  onClearFilters?: (() => void) | undefined;
+  /** Annotation id from `?annotation=`, which the matching card scrolls to and focuses. */
+  selectedAnnotationId?: string | undefined;
+}
+
+export interface DerivedRunAnnotation {
+  id: string;
+  style: RunAnnotationStyle;
+  body: string;
+}
+
+/**
+ * How many annotations render at once.
+ *
+ * A page holds up to 500 rows and each one mounts a Markdown pipeline, so the fetch budget is
+ * not a render budget. The window grows on demand and the server page only loads once the
+ * reader has actually seen everything already fetched.
+ */
+const RENDER_WINDOW = 25;
+
+/**
+ * The annotations list.
+ *
+ * Loading, empty, error, and stale are four distinct renderings on purpose: coalescing a failed
+ * fetch into an empty result tells a reader their run is clean when the truth is unknown.
+ */
+export function RunAnnotationList({
+  query,
+  entries,
+  derivedAnnotations = [],
+  workflowRunId,
+  workspaceSlug,
+  projectSlug,
+  runAttempt,
+  filteredJobName,
+  filteredSeverity,
+  filtered,
+  onClearFilters,
+  selectedAnnotationId,
+}: RunAnnotationListProps) {
+  const [visibleCount, setVisibleCount] = useState(RENDER_WINDOW);
+
+  // A deep-linked annotation past the window would otherwise be unreachable: it is in the data,
+  // absent from the DOM, and nothing on screen says so.
+  const selectedIndex = selectedAnnotationId
+    ? (entries?.findIndex((entry) => entry.annotation.id === selectedAnnotationId) ?? -1)
+    : -1;
+  const renderCount = Math.max(visibleCount, selectedIndex + 1);
+
+  if (query.isPending) return <RunAnnotationListSkeleton />;
+
+  if (query.isError && entries === undefined) {
+    return <QueryLoadError query={query} subject="annotations" icon="fileDamageLine" />;
+  }
+
+  if (entries === undefined) return <RunAnnotationListSkeleton />;
+
+  const visible = entries.slice(0, renderCount);
+  const hiddenCount = entries.length - visible.length;
+  const hasContent = entries.length > 0 || derivedAnnotations.length > 0;
+
+  return (
+    <div className="flex min-w-0 flex-col gap-cluster">
+      {query.isError ? <RunAnnotationStaleError query={query} /> : null}
+
+      {!hasContent ? (
+        filtered ? (
+          <RunAnnotationsFilteredEmpty
+            jobName={filteredJobName}
+            severity={filteredSeverity}
+            incomplete={query.hasNextPage}
+            onClearFilters={onClearFilters}
+          />
+        ) : (
+          <RunAnnotationsEmpty />
+        )
+      ) : (
+        <ol className="flex min-w-0 flex-col gap-cluster">
+          {visible.map((entry) => (
+            <RunAnnotationItem
+              key={entry.annotation.id}
+              entry={entry}
+              workspaceSlug={workspaceSlug}
+              projectSlug={projectSlug}
+              workflowRunId={workflowRunId}
+              runAttempt={runAttempt}
+              selected={entry.annotation.id === selectedAnnotationId}
+            />
+          ))}
+          {derivedAnnotations.map((annotation) => (
+            <li key={annotation.id}>
+              <AnnotationCard style={annotation.style} body={annotation.body} />
+            </li>
+          ))}
+        </ol>
+      )}
+
+      {hiddenCount > 0 ? (
+        <Button
+          type="button"
+          size="sm"
+          variant="secondary"
+          className="self-start [@media(pointer:coarse)]:min-h-44"
+          onClick={() => setVisibleCount((current) => current + RENDER_WINDOW)}
+        >
+          Show {Math.min(hiddenCount, RENDER_WINDOW)} more of {entries.length}
+        </Button>
+      ) : query.hasNextPage ? (
+        <Button
+          type="button"
+          size="sm"
+          variant="secondary"
+          className="self-start [@media(pointer:coarse)]:min-h-44"
+          isLoading={query.isFetchingNextPage}
+          onClick={() => {
+            void query.fetchNextPage();
+          }}
+        >
+          Load more annotations
+        </Button>
+      ) : null}
+    </div>
+  );
+}
+
+/**
+ * Names the filters that are actually active.
+ *
+ * Blaming severity for a job-only filter sends the reader to change the wrong control, which
+ * is worse than saying nothing.
+ */
+function filteredEmptyDescription({
+  jobName,
+  severity,
+  incomplete,
+}: {
+  jobName: string | undefined;
+  severity: string | undefined;
+  incomplete: boolean;
+}): string {
+  if (incomplete) {
+    if (jobName && severity) {
+      return `None of the loaded annotations are from ${jobName} at ${severity} severity. Load more annotations to continue searching.`;
+    }
+    if (jobName) {
+      return `None of the loaded annotations are from ${jobName}. Load more annotations to continue searching.`;
+    }
+    if (severity) {
+      return `None of the loaded annotations are at ${severity} severity. Load more annotations to continue searching.`;
+    }
+    return 'None of the loaded annotations match the current filters. Load more annotations to continue searching.';
+  }
+  if (jobName && severity) {
+    return `This run has annotations, but none from ${jobName} at ${severity} severity.`;
+  }
+  if (jobName) return `This run has annotations, but none from ${jobName}.`;
+  if (severity) return `This run has annotations, but none at ${severity} severity.`;
+  return 'This run has annotations, but none match the current filters.';
+}
+
+function RunAnnotationsFilteredEmpty({
+  jobName,
+  severity,
+  incomplete,
+  onClearFilters,
+}: {
+  jobName: string | undefined;
+  severity: string | undefined;
+  incomplete: boolean;
+  onClearFilters: (() => void) | undefined;
+}) {
+  return (
+    <div className="flex flex-col items-center gap-cluster">
+      <EmptyState
+        icon="fileDamageLine"
+        title={incomplete ? 'No matches in loaded annotations' : 'No matching annotations'}
+        description={filteredEmptyDescription({jobName, severity, incomplete})}
+      />
+      {onClearFilters ? (
+        <Button
+          type="button"
+          size="sm"
+          variant="secondary"
+          className="[@media(pointer:coarse)]:min-h-44"
+          onClick={onClearFilters}
+        >
+          Clear filters
+        </Button>
+      ) : null}
+    </div>
+  );
+}
+
+/**
+ * A failed poll keeps the annotations already on screen and marks them stale rather than
+ * clearing. Polite rather than assertive: the poll runs every 4s and a flapping API would
+ * otherwise interrupt a screen reader on every cycle.
+ */
+function RunAnnotationStaleError({query}: {query: QueryLoadErrorQuery}) {
+  return (
+    <Callout role="status" aria-live="polite" type="error">
+      <div className="flex w-full items-center justify-between gap-inline">
+        <Text size="xs">Could not refresh annotations.</Text>
+        <Button
+          type="button"
+          size="2xs"
+          variant="secondary"
+          className="[@media(pointer:coarse)]:min-h-44"
+          isLoading={query.isFetching}
+          onClick={() => {
+            void query.refetch();
+          }}
+        >
+          Retry
+        </Button>
+      </div>
+    </Callout>
+  );
+}
+
+const ANNOTATION_SKELETON_ROWS = ['first', 'second', 'third'];
+
+function RunAnnotationListSkeleton() {
+  return (
+    <section aria-label="Loading annotations" className="flex flex-col gap-cluster">
+      {ANNOTATION_SKELETON_ROWS.map((row) => (
+        <div
+          key={row}
+          className="flex gap-cluster rounded-8 border border-border-neutral-base bg-background-components-base px-[12px] py-[8px]"
+        >
+          <Skeleton className="h-40 w-4 rounded-full" />
+          <div className="flex min-w-0 flex-1 flex-col gap-inline">
+            <Skeleton className="h-20 w-160 rounded-4" />
+            <Skeleton className="h-16 w-240 rounded-4" />
+            <Skeleton className="h-40 w-full rounded-4" />
+          </div>
+        </div>
+      ))}
+    </section>
+  );
+}

package/src/components/workflow-run-tabs/run-annotation-summary-line.test.tsx

@@ -7,7 +7,7 @@ import {
   RouterProvider,
 } from '@tanstack/react-router';
 import {act, render, screen} from '@testing-library/react';
-import type {RunAnnotationSummary} from '#core/workflow-run-tabs.js';
+import type {RunAnnotationSummary} from '#core/run-annotation.js';
 import type {WorkflowRunsSearch} from '#routes/inputs.js';
 import {RunAnnotationSummaryLine} from './run-annotation-summary-line.js';
 
@@ -17,8 +17,12 @@ const ANNOTATION_SUMMARY: RunAnnotationSummary = {
   warning: 1,
   info: 2,
   success: 0,
+  truncated: false,
 };
 
+const INFO_OR_SUCCESS_PATTERN = /info|success/;
+const SHOW_ALL_PATTERN = /Show all/;
+
 describe('RunAnnotationSummaryLine', () => {
   test('links the severity breakdown into the Annotations panel', async () => {
     await renderSummaryLine();
@@ -30,6 +34,66 @@ describe('RunAnnotationSummaryLine', () => {
     );
   });
 
+  test('renders every count at one type scale', async () => {
+    // The severity counts previously bypassed `Text` and inherited the ambient 14px, so they
+    // rendered a step larger and heavier than the total they sit beside.
+    await renderSummaryLine();
+
+    const total = screen.getByText('5 annotations');
+    const errors = screen.getByText('2 errors');
+
+    expect(total).toHaveClass('text-xs', 'font-display');
+    expect(errors).toHaveClass('text-xs', 'font-display');
+    expect(errors).not.toHaveClass('text-foreground-highlight-interactive');
+  });
+
+  test('distinguishes severities by glyph rather than by label colour', async () => {
+    const {container} = await renderSummaryLine();
+
+    const tones = [...container.querySelectorAll('svg')].map((glyph) =>
+      glyph.getAttribute('class'),
+    );
+
+    expect(tones.some((tone) => tone?.includes('text-tag-error-icon'))).toBe(true);
+    expect(tones.some((tone) => tone?.includes('text-tag-warning-icon'))).toBe(true);
+  });
+
+  test('names only the severities that need attention', async () => {
+    await renderSummaryLine();
+
+    expect(screen.getByRole('link', {name: '2 errors'})).toBeInTheDocument();
+    expect(screen.getByRole('link', {name: '1 warning'})).toBeInTheDocument();
+    // The 2 info annotations are inside the total; naming them again would give a clean
+    // result the same weight and the same accent as a failure.
+    expect(screen.queryByRole('link', {name: '2 infos'})).not.toBeInTheDocument();
+    expect(screen.queryByText(INFO_OR_SUCCESS_PATTERN)).not.toBeInTheDocument();
+  });
+
+  test('turns the total into the way out of an active severity filter', async () => {
+    await renderSummaryLine({severity: 'error'});
+
+    expect(screen.getByRole('link', {name: 'Show all 5 annotations'})).toHaveAttribute(
+      'href',
+      '/w/acme/p/project/runs/run-1?tab=annotations',
+    );
+  });
+
+  test('leaves the total as plain text when no severity filter is active', async () => {
+    await renderSummaryLine();
+
+    expect(screen.queryByRole('link', {name: SHOW_ALL_PATTERN})).not.toBeInTheDocument();
+  });
+
+  test('falls back to the bare total when nothing needs attention', async () => {
+    await renderSummaryLine(
+      {},
+      {total: 3, error: 0, warning: 0, info: 3, success: 0, truncated: false},
+    );
+
+    expect(screen.getByText('3 annotations')).toBeInTheDocument();
+    expect(screen.queryByRole('link')).not.toBeInTheDocument();
+  });
+
   test('clears a stale annotation when linking to a severity', async () => {
     await renderSummaryLine({annotation: 'annotation-old'});
 
@@ -38,16 +102,26 @@ describe('RunAnnotationSummaryLine', () => {
       '/w/acme/p/project/runs/run-1?tab=annotations&severity=error',
     );
   });
+
+  test('marks a truncated read as a lower bound', async () => {
+    await renderSummaryLine({}, {...ANNOTATION_SUMMARY, truncated: true});
+
+    expect(screen.getByText('5+ annotations')).toBeInTheDocument();
+    expect(screen.getByRole('link', {name: '2+ errors'})).toBeInTheDocument();
+  });
 });
 
-async function renderSummaryLine(search: WorkflowRunsSearch = {}) {
+async function renderSummaryLine(
+  search: WorkflowRunsSearch = {},
+  summary: RunAnnotationSummary = ANNOTATION_SUMMARY,
+) {
   const rootRoute = createRootRoute({component: Outlet});
   const runRoute = createRoute({
     getParentRoute: () => rootRoute,
     path: '/w/$workspaceSlug/p/$projectSlug/runs/$workflowRunId',
     component: () => (
       <RunAnnotationSummaryLine
-        summary={ANNOTATION_SUMMARY}
+        summary={summary}
         workspaceSlug="acme"
         projectSlug="project"
         workflowRunId="run-1"