@shipfox/annotations 5.0.0 → 7.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/annotations",
   "license": "MIT",
-  "version": "5.0.0",
+  "version": "7.1.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -24,33 +24,20 @@
   "dependencies": {
     "drizzle-orm": "^0.45.2",
     "zod": "^4.4.3",
-    "@shipfox/annotations-dto": "5.0.0",
-    "@shipfox/api-auth-context": "5.0.0",
+    "@shipfox/annotations-dto": "6.0.0",
+    "@shipfox/api-auth-context": "7.1.0",
     "@shipfox/config": "1.2.2",
-    "@shipfox/node-drizzle": "0.3.1",
-    "@shipfox/node-fastify": "0.2.3",
-    "@shipfox/node-module": "0.3.2",
+    "@shipfox/inter-module": "0.2.0",
+    "@shipfox/node-drizzle": "0.3.2",
+    "@shipfox/node-fastify": "0.3.0",
+    "@shipfox/node-module": "0.5.0",
     "@shipfox/node-postgres": "0.4.2"
   },
-  "devDependencies": {
-    "@types/pg": "^8.15.5",
-    "drizzle-kit": "^0.31.10",
-    "fastify": "^5.3.3",
-    "fastify-type-provider-zod": "^6.0.0",
-    "fishery": "^2.4.0",
-    "@shipfox/api-auth": "5.0.0",
-    "@shipfox/api-auth-dto": "5.0.0",
-    "@shipfox/biome": "1.8.2",
-    "@shipfox/node-jwt": "0.2.1",
-    "@shipfox/swc": "1.2.6",
-    "@shipfox/ts-config": "1.3.8",
-    "@shipfox/typescript": "1.1.7",
-    "@shipfox/vitest": "1.2.3"
-  },
   "scripts": {
     "build": "shipfox-swc",
     "check": "shipfox-biome-check",
     "check:fix": "shipfox-biome-check --write",
+    "depcruise": "shipfox-depcruise",
     "test": "shipfox-vitest-run",
     "test:watch": "shipfox-vitest-watch",
     "type": "shipfox-tsc-check",

package/src/index.ts

@@ -1,17 +1,12 @@
 import type {ShipfoxModule} from '@shipfox/node-module';
 import {db} from '#db/db.js';
 import {migrationsPath} from '#db/index.js';
+import {createAnnotationsInterModulePresentation} from '#presentation/inter-module.js';
 import {annotationsRoutes} from '#presentation/routes/index.js';
 
-export {
-  AnnotationBodyTooLargeError,
-  AnnotationCountLimitExceededError,
-  AnnotationTotalBytesLimitExceededError,
-} from '#core/errors.js';
-export {type WriteAnnotationsParams, writeAnnotations} from '#core/write-annotations.js';
-
 export const annotationsModule: ShipfoxModule = {
   name: 'annotations',
   database: {db, migrationsPath},
   routes: annotationsRoutes,
+  interModulePresentations: [createAnnotationsInterModulePresentation()],
 };

package/src/presentation/inter-module.test.ts

@@ -0,0 +1,84 @@
+import {annotationsInterModuleContract} from '@shipfox/annotations-dto/inter-module';
+import {isInterModuleKnownError} from '@shipfox/inter-module';
+import {eq} from 'drizzle-orm';
+import {
+  AnnotationBodyTooLargeError,
+  AnnotationCountLimitExceededError,
+  AnnotationTotalBytesLimitExceededError,
+} from '#core/errors.js';
+import {db} from '#db/db.js';
+import {annotations} from '#db/schema/annotations.js';
+import {
+  createAnnotationsInterModulePresentation,
+  toReplaceOrRemoveAnnotationKnownError,
+} from './inter-module.js';
+
+function input() {
+  return {
+    workspaceId: crypto.randomUUID(),
+    projectId: crypto.randomUUID(),
+    workflowRunId: crypto.randomUUID(),
+    workflowRunAttempt: 1,
+    workflowRunAttemptId: crypto.randomUUID(),
+    jobId: crypto.randomUUID(),
+    jobExecutionId: crypto.randomUUID(),
+    originStepId: crypto.randomUUID(),
+    originStepAttempt: 1,
+    context: 'agent-tool-capability:step',
+  };
+}
+
+describe('Annotations inter-module presentation', () => {
+  test('replaces and removes a warning annotation through PostgreSQL', async () => {
+    const presentation = createAnnotationsInterModulePresentation();
+    const target = input();
+    const handlerContext = {signal: new AbortController().signal};
+
+    await presentation.handlers.replaceOrRemoveAnnotation(
+      {
+        ...target,
+        annotation: {op: 'replace', style: 'warning', body: 'Missing tool'},
+      },
+      handlerContext,
+    );
+    const afterReplace = await db()
+      .select()
+      .from(annotations)
+      .where(eq(annotations.jobExecutionId, target.jobExecutionId));
+
+    await presentation.handlers.replaceOrRemoveAnnotation(
+      {
+        ...target,
+        annotation: {op: 'remove'},
+      },
+      handlerContext,
+    );
+    const afterRemove = await db()
+      .select()
+      .from(annotations)
+      .where(eq(annotations.jobExecutionId, target.jobExecutionId));
+
+    expect(afterReplace).toHaveLength(1);
+    expect(afterReplace[0]).toMatchObject({
+      context: target.context,
+      style: 'warning',
+      body: 'Missing tool',
+    });
+    expect(afterRemove).toEqual([]);
+  });
+
+  test.each([
+    ['annotation-body-too-large', () => new AnnotationBodyTooLargeError(10)],
+    ['annotation-count-limit-exceeded', () => new AnnotationCountLimitExceededError(10)],
+    ['annotation-total-bytes-limit-exceeded', () => new AnnotationTotalBytesLimitExceededError(10)],
+  ] as const)('maps %s to the published contract error', (code, createError) => {
+    const result = toReplaceOrRemoveAnnotationKnownError(createError());
+
+    expect(
+      isInterModuleKnownError(
+        annotationsInterModuleContract.methods.replaceOrRemoveAnnotation,
+        result,
+      ) && result.code,
+    ).toBe(code);
+  });
+});

package/src/presentation/inter-module.ts

@@ -0,0 +1,55 @@
+import {annotationsInterModuleContract} from '@shipfox/annotations-dto/inter-module';
+import {
+  createInterModuleKnownError,
+  defineInterModulePresentation,
+  type InterModulePresentation,
+} from '@shipfox/inter-module';
+import {
+  AnnotationBodyTooLargeError,
+  AnnotationCountLimitExceededError,
+  AnnotationTotalBytesLimitExceededError,
+} from '#core/errors.js';
+import {writeAnnotations} from '#core/write-annotations.js';
+
+export function createAnnotationsInterModulePresentation(): InterModulePresentation<
+  typeof annotationsInterModuleContract
+> {
+  return defineInterModulePresentation(annotationsInterModuleContract, {
+    replaceOrRemoveAnnotation: async (input) => {
+      try {
+        const {annotation, context, ...target} = input;
+        await writeAnnotations({
+          ...target,
+          operations: [
+            annotation.op === 'remove'
+              ? {context, style: 'warning', op: 'remove'}
+              : {context, ...annotation},
+          ],
+        });
+        return {};
+      } catch (error) {
+        throw toReplaceOrRemoveAnnotationKnownError(error);
+      }
+    },
+  });
+}
+
+export function toReplaceOrRemoveAnnotationKnownError(error: unknown): unknown {
+  const method = annotationsInterModuleContract.methods.replaceOrRemoveAnnotation;
+  if (error instanceof AnnotationBodyTooLargeError) {
+    return createInterModuleKnownError(method, 'annotation-body-too-large', {
+      maxBytes: error.maxBytes,
+    });
+  }
+  if (error instanceof AnnotationCountLimitExceededError) {
+    return createInterModuleKnownError(method, 'annotation-count-limit-exceeded', {
+      maxAnnotations: error.maxAnnotations,
+    });
+  }
+  if (error instanceof AnnotationTotalBytesLimitExceededError) {
+    return createInterModuleKnownError(method, 'annotation-total-bytes-limit-exceeded', {
+      maxBytes: error.maxBytes,
+    });
+  }
+  return error;
+}

package/test/env.ts

@@ -1,5 +1,3 @@
 process.env.DATABASE_URL ??= 'postgres://shipfox:shipfox@127.0.0.1:5432/api_test';
-process.env.AUTH_JWT_SECRET = 'test-jwt-secret';
-process.env.AUTH_JOB_LEASE_TOKEN_SECRET = 'test-lease-secret';
-process.env.AUTH_RUNNER_SESSION_TOKEN_SECRET = 'test-runner-session-secret';
+process.env.AUTH_ROOT_KEY = 'MDEyMzQ1Njc4OWFiY2RlZjAxMjM0NTY3ODlhYmNkZWY=';
 process.env.TZ = 'UTC';

package/test/fixtures/lease-token.ts

@@ -1,7 +1,8 @@
 import {JOB_LEASE_TOKEN_AUDIENCE} from '@shipfox/api-auth-dto';
+import {jobLeaseTokenKey} from '@shipfox/node-auth-root-key';
 import {signHs256} from '@shipfox/node-jwt';
 
-const SECRET = process.env.AUTH_JOB_LEASE_TOKEN_SECRET ?? 'test-lease-secret';
+const SECRET = jobLeaseTokenKey();
 
 export interface MintLeaseTokenParams {
   jobId: string;