@shipfox/annotations 12.0.0 → 12.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/annotations",
   "license": "MIT",
-  "version": "12.0.0",
+  "version": "12.3.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -20,13 +20,13 @@
   "dependencies": {
     "drizzle-orm": "^0.45.2",
     "zod": "^4.4.3",
-    "@shipfox/annotations-dto": "12.0.0",
-    "@shipfox/api-auth-context": "12.0.0",
+    "@shipfox/annotations-dto": "12.3.0",
+    "@shipfox/api-auth-context": "12.2.0",
     "@shipfox/config": "1.2.4",
     "@shipfox/inter-module": "0.2.3",
     "@shipfox/node-drizzle": "0.3.5",
-    "@shipfox/node-fastify": "0.4.1",
-    "@shipfox/node-module": "1.0.5",
+    "@shipfox/node-fastify": "0.4.2",
+    "@shipfox/node-module": "1.0.6",
     "@shipfox/node-postgres": "0.5.0"
   },
   "imports": {

package/src/db/annotations.ts

@@ -1,5 +1,5 @@
 import {type AnnotationStyleDto, READ_ANNOTATIONS_MAX_LIMIT} from '@shipfox/annotations-dto';
-import {and, asc, eq, gt, inArray, or, type SQL, sql} from 'drizzle-orm';
+import {and, asc, count, eq, gt, inArray, or, type SQL, sql} from 'drizzle-orm';
 import type {Annotation} from '#core/entities/annotation.js';
 import {db} from './db.js';
 import {annotations, toAnnotation} from './schema/annotations.js';
@@ -61,6 +61,89 @@ export async function listAnnotationsForRunAttempt(
   };
 }
 
+export interface AnnotationSummary {
+  total: number;
+  error: number;
+  warning: number;
+  info: number;
+  success: number;
+  stepCounts: Array<{
+    originStepId: string;
+    originStepAttempt: number;
+    total: number;
+  }>;
+}
+
+export interface SummarizeAnnotationsForRunAttemptParams {
+  workflowRunId: string;
+  workflowRunAttempt: number;
+  workspaceIds: readonly string[];
+  jobExecutionId?: string | undefined;
+}
+
+/** Count annotation styles without reading any annotation bodies. */
+export async function summarizeAnnotationsForRunAttempt(
+  params: SummarizeAnnotationsForRunAttemptParams,
+): Promise<AnnotationSummary> {
+  const summary: AnnotationSummary = {
+    total: 0,
+    error: 0,
+    warning: 0,
+    info: 0,
+    success: 0,
+    stepCounts: [],
+  };
+  if (params.workspaceIds.length === 0) return summary;
+
+  const conditions: SQL[] = [
+    eq(annotations.workflowRunId, params.workflowRunId),
+    eq(annotations.workflowRunAttempt, params.workflowRunAttempt),
+    inArray(annotations.workspaceId, [...params.workspaceIds]),
+  ];
+  if (params.jobExecutionId) {
+    conditions.push(eq(annotations.jobExecutionId, params.jobExecutionId));
+  }
+
+  const {rows, stepRows} = await db().transaction(async (tx) => {
+    // Both aggregates must observe the same committed state. READ COMMITTED would allow a
+    // concurrent annotation write between these selects, producing contradictory totals.
+    await tx.execute(sql`set transaction isolation level repeatable read, read only`);
+
+    const rows = await tx
+      .select({style: annotations.style, count: count()})
+      .from(annotations)
+      .where(and(...conditions))
+      .groupBy(annotations.style);
+
+    const stepRows = await tx
+      .select({
+        originStepId: annotations.originStepId,
+        originStepAttempt: annotations.originStepAttempt,
+        total: count(),
+      })
+      .from(annotations)
+      .where(and(...conditions))
+      .groupBy(annotations.originStepId, annotations.originStepAttempt)
+      .orderBy(asc(annotations.originStepId), asc(annotations.originStepAttempt));
+
+    return {rows, stepRows};
+  });
+
+  for (const row of rows) {
+    const value = Number(row.count);
+    summary.total += value;
+    if (row.style !== 'default') summary[row.style] += value;
+  }
+
+  summary.stepCounts = stepRows.map((row) => ({
+    originStepId: row.originStepId,
+    originStepAttempt: row.originStepAttempt,
+    total: Number(row.total),
+  }));
+
+  return summary;
+}
+
 export interface StoredAnnotation {
   id: string;
   context: string;

package/src/db/index.ts

@@ -3,5 +3,13 @@ import {fileURLToPath} from 'node:url';
 
 export const migrationsPath = resolve(dirname(fileURLToPath(import.meta.url)), '../../drizzle');
 
-export type {ListAnnotationsForRunAttemptParams} from './annotations.js';
-export {DEFAULT_ANNOTATIONS_READ_LIMIT, listAnnotationsForRunAttempt} from './annotations.js';
+export type {
+  AnnotationSummary,
+  ListAnnotationsForRunAttemptParams,
+  SummarizeAnnotationsForRunAttemptParams,
+} from './annotations.js';
+export {
+  DEFAULT_ANNOTATIONS_READ_LIMIT,
+  listAnnotationsForRunAttempt,
+  summarizeAnnotationsForRunAttempt,
+} from './annotations.js';

package/src/presentation/routes/index.ts

@@ -1,5 +1,6 @@
 import {AUTH_LEASED_JOB, AUTH_USER} from '@shipfox/api-auth-context';
 import type {RouteGroup} from '@shipfox/node-fastify';
+import {readAnnotationSummaryRoute} from './read-annotation-summary.js';
 import {readAnnotationsRoute} from './read-annotations.js';
 import {writeAnnotationsRoute} from './write-annotations.js';
 
@@ -7,7 +8,7 @@ export const annotationsRoutes: RouteGroup[] = [
   {
     prefix: '/annotations',
     auth: AUTH_USER,
-    routes: [readAnnotationsRoute],
+    routes: [readAnnotationSummaryRoute, readAnnotationsRoute],
   },
   {
     prefix: '/runs/jobs/current',

package/src/presentation/routes/read-annotation-summary.ts

@@ -0,0 +1,50 @@
+import {
+  annotationSummaryResponseSchema,
+  readAnnotationsQuerySchema,
+} from '@shipfox/annotations-dto';
+import {requireUserContext} from '@shipfox/api-auth-context';
+import {defineRoute} from '@shipfox/node-fastify';
+import {summarizeAnnotationsForRunAttempt} from '#db/index.js';
+
+export const readAnnotationSummaryRoute = defineRoute({
+  method: 'GET',
+  path: '/summary',
+  description: 'Read annotation counts for a workflow run attempt.',
+  schema: {
+    querystring: readAnnotationsQuerySchema.omit({cursor: true, limit: true}),
+    response: {
+      200: annotationSummaryResponseSchema,
+    },
+  },
+  handler: async (request) => {
+    const user = requireUserContext(request);
+    const {
+      workflow_run_id: workflowRunId,
+      attempt,
+      job_execution_id: jobExecutionId,
+    } = request.query;
+    const workspaceIds = user.memberships
+      .filter((membership) => membership.workspaceStatus === 'active')
+      .map((membership) => membership.workspaceId);
+
+    const summary = await summarizeAnnotationsForRunAttempt({
+      workflowRunId,
+      workflowRunAttempt: attempt,
+      workspaceIds,
+      jobExecutionId,
+    });
+
+    return {
+      total: summary.total,
+      error: summary.error,
+      warning: summary.warning,
+      info: summary.info,
+      success: summary.success,
+      step_counts: summary.stepCounts.map((step) => ({
+        origin_step_id: step.originStepId,
+        origin_step_attempt: step.originStepAttempt,
+        total: step.total,
+      })),
+    };
+  },
+});

package/src/presentation/routes/read-annotations.test.ts

@@ -2,6 +2,7 @@ import {AUTH_USER, buildUserContext, setUserContext} from '@shipfox/api-auth-con
 import {type AuthMethod, ClientError, closeApp, createApp} from '@shipfox/node-fastify';
 import type {FastifyRequest} from 'fastify';
 import {annotationFactory} from '#test/index.js';
+import {readAnnotationSummaryRoute} from './read-annotation-summary.js';
 import {readAnnotationsRoute} from './read-annotations.js';
 
 const fakeUserAuth: AuthMethod = {
@@ -42,7 +43,13 @@ describe('GET /annotations', () => {
   beforeAll(async () => {
     app = await createApp({
       auth: [fakeUserAuth],
-      routes: [{prefix: '/annotations', auth: AUTH_USER, routes: [readAnnotationsRoute]}],
+      routes: [
+        {
+          prefix: '/annotations',
+          auth: AUTH_USER,
+          routes: [readAnnotationSummaryRoute, readAnnotationsRoute],
+        },
+      ],
       swagger: false,
     });
     await app.ready();
@@ -136,6 +143,54 @@ describe('GET /annotations', () => {
     expect(res.json()).toEqual({annotations: [], has_more: false, next_cursor: null});
   });
 
+  it('returns complete style counts without loading annotation bodies', async () => {
+    const workspaceId = crypto.randomUUID();
+    const workflowRunId = crypto.randomUUID();
+    const firstStepId = '11111111-1111-4111-8111-111111111111';
+    const secondStepId = '22222222-2222-4222-8222-222222222222';
+    await annotationFactory.create({
+      workspaceId,
+      workflowRunId,
+      originStepId: firstStepId,
+      context: 'default',
+      style: 'default',
+    });
+    await annotationFactory.create({
+      workspaceId,
+      workflowRunId,
+      originStepId: firstStepId,
+      context: 'error',
+      style: 'error',
+    });
+    await annotationFactory.create({
+      workspaceId,
+      workflowRunId,
+      originStepId: secondStepId,
+      originStepAttempt: 2,
+      context: 'warning',
+      style: 'warning',
+    });
+
+    const res = await app.inject({
+      method: 'GET',
+      url: `/annotations/summary?workflow_run_id=${workflowRunId}&attempt=1`,
+      headers: {authorization: 'Bearer user', 'x-test-workspaces': workspaceId},
+    });
+
+    expect(res.statusCode).toBe(200);
+    expect(res.json()).toEqual({
+      total: 3,
+      error: 1,
+      warning: 1,
+      info: 0,
+      success: 0,
+      step_counts: [
+        {origin_step_id: firstStepId, origin_step_attempt: 1, total: 2},
+        {origin_step_id: secondStepId, origin_step_attempt: 2, total: 1},
+      ],
+    });
+  });
+
   it('returns an empty list for annotations outside the user workspaces', async () => {
     const workflowRunId = crypto.randomUUID();
     await annotationFactory.create({workflowRunId, workspaceId: crypto.randomUUID()});