@shipfox/api-logs 5.0.0 → 7.1.0

package/src/presentation/routes/append-logs.ts

@@ -5,62 +5,66 @@ import {
   appendLogsResponseSchema,
   offsetGapResponseSchema,
 } from '@shipfox/api-logs-dto';
+import type {WorkflowsModuleClient} from '@shipfox/api-workflows-dto/inter-module';
 import {ClientError, defineRoute} from '@shipfox/node-fastify';
 import {z} from 'zod';
 import {appendLogs} from '#core/append-logs.js';
 import {LeaseStreamMismatchError, MalformedLogChunkError, OffsetGapError} from '#core/errors.js';
 
-export const appendLogsRoute = defineRoute({
-  method: 'POST',
-  path: '/steps/:stepId/logs',
-  description: 'Append a chunk of logs for a step attempt of the leased job.',
-  schema: {
-    params: z.object({stepId: z.string().uuid()}),
-    querystring: appendLogsQuerySchema,
-    response: {
-      200: appendLogsResponseSchema,
-      409: offsetGapResponseSchema,
+export function createAppendLogsRoute(workflows: WorkflowsModuleClient) {
+  return defineRoute({
+    method: 'POST',
+    path: '/steps/:stepId/logs',
+    description: 'Append a chunk of logs for a step attempt of the leased job.',
+    schema: {
+      params: z.object({stepId: z.string().uuid()}),
+      querystring: appendLogsQuerySchema,
+      response: {
+        200: appendLogsResponseSchema,
+        409: offsetGapResponseSchema,
+      },
     },
-  },
-  errorHandler: (error) => {
-    if (error instanceof OffsetGapError) {
-      throw new ClientError('Append offset is ahead of the committed length', 'offset-gap', {
-        status: 409,
-        details: {committed_length: error.committedLength},
-      });
-    }
-    if (error instanceof MalformedLogChunkError) {
-      throw new ClientError(error.message, 'malformed-log-chunk', {status: 400});
-    }
-    if (error instanceof LeaseStreamMismatchError) {
-      throw new ClientError(error.message, 'lease-stream-mismatch', {status: 403});
-    }
-    throw error;
-  },
-  handler: async (request) => {
-    const leasedJob = requireLeasedJobContext(request);
-    const {stepId} = request.params;
-    const {attempt, offset} = request.query;
+    errorHandler: (error) => {
+      if (error instanceof OffsetGapError) {
+        throw new ClientError('Append offset is ahead of the committed length', 'offset-gap', {
+          status: 409,
+          details: {committed_length: error.committedLength},
+        });
+      }
+      if (error instanceof MalformedLogChunkError) {
+        throw new ClientError(error.message, 'malformed-log-chunk', {status: 400});
+      }
+      if (error instanceof LeaseStreamMismatchError) {
+        throw new ClientError(error.message, 'lease-stream-mismatch', {status: 403});
+      }
+      throw error;
+    },
+    handler: async (request) => {
+      const leasedJob = requireLeasedJobContext(request);
+      const {stepId} = request.params;
+      const {attempt, offset} = request.query;
 
-    // The scoped lease proves membership in the dispatched step attempt; active-step
-    // completion remains governed by workflow/report state, not the log append route.
-    if (leasedJob.currentStepId !== stepId || leasedJob.currentStepAttempt !== attempt) {
-      throw new ClientError('Step not found for leased job execution', 'step-not-found', {
-        status: 404,
-      });
-    }
+      if (leasedJob.currentStepId !== stepId || leasedJob.currentStepAttempt !== attempt) {
+        throw new ClientError('Step not found for leased job execution', 'step-not-found', {
+          status: 404,
+        });
+      }
 
-    const result = await appendLogs({
-      jobId: leasedJob.jobId,
-      workspaceId: leasedJob.workspaceId,
-      projectId: leasedJob.projectId,
-      workflowRunAttemptId: leasedJob.workflowRunAttemptId,
-      stepId,
-      attempt,
-      offset,
-      body: (request.body as Buffer | undefined) ?? Buffer.alloc(0),
-    });
+      const result = await appendLogs(
+        {
+          jobId: leasedJob.jobId,
+          workspaceId: leasedJob.workspaceId,
+          projectId: leasedJob.projectId,
+          workflowRunAttemptId: leasedJob.workflowRunAttemptId,
+          stepId,
+          attempt,
+          offset,
+          body: (request.body as Buffer | undefined) ?? Buffer.alloc(0),
+        },
+        workflows,
+      );
 
-    return {committed_length: result.committedLength, capped: result.capped};
-  },
-});
+      return {committed_length: result.committedLength, capped: result.capped};
+    },
+  });
+}

package/src/presentation/routes/index.ts

@@ -1,27 +1,30 @@
 import {AUTH_LEASED_JOB, AUTH_USER} from '@shipfox/api-auth-context';
+import type {WorkflowsModuleClient} from '@shipfox/api-workflows-dto/inter-module';
 import {createRawBodyPlugin, type RouteGroup} from '@shipfox/node-fastify';
 import {config} from '#config.js';
-import {appendLogsRoute} from './append-logs.js';
+import {createAppendLogsRoute} from './append-logs.js';
 import {readLogsRoute} from './read-logs.js';
 
 // Keep the lease-authed append in its own Fastify scope so the raw NDJSON parser does not
 // disturb the JSON read route (or workflow routes). The body limit also bounds one-append
 // budget overshoot. The read route is session-authed and workspace-scoped via the row.
-export const logsRoutes: RouteGroup[] = [
-  {
-    prefix: '/runs/jobs/current',
-    auth: AUTH_LEASED_JOB,
-    plugins: [
-      createRawBodyPlugin({
-        contentType: 'application/x-ndjson',
-        bodyLimit: config.LOG_APPEND_BODY_LIMIT_BYTES,
-      }),
-    ],
-    routes: [appendLogsRoute],
-  },
-  {
-    prefix: '/steps',
-    auth: AUTH_USER,
-    routes: [readLogsRoute],
-  },
-];
+export function createLogsRoutes(workflows: WorkflowsModuleClient): RouteGroup[] {
+  return [
+    {
+      prefix: '/runs/jobs/current',
+      auth: AUTH_LEASED_JOB,
+      plugins: [
+        createRawBodyPlugin({
+          contentType: 'application/x-ndjson',
+          bodyLimit: config.LOG_APPEND_BODY_LIMIT_BYTES,
+        }),
+      ],
+      routes: [createAppendLogsRoute(workflows)],
+    },
+    {
+      prefix: '/steps',
+      auth: AUTH_USER,
+      routes: [readLogsRoute],
+    },
+  ];
+}

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

@@ -35,9 +35,10 @@ import {
   compactStreamActivity,
 } from '#temporal/activities/compact-stream.js';
 import {ndjsonBody, outputLine, recordLine} from '#test/fixtures/ndjson.js';
+import {createTestWorkflowsClient} from '#test/fixtures/workflows-client.js';
 import {findStream} from '#test/queries.js';
 import {onStepAttemptTerminated} from '../subscribers/on-step-attempt-terminated.js';
-import {logsRoutes} from './index.js';
+import {createLogsRoutes} from './index.js';
 
 // AUTH_USER stub: a `Bearer user` request is a member of whatever workspace it names in the
 // `x-test-workspace` header, so each test grants or withholds access against the arranged
@@ -159,7 +160,7 @@ describe('GET /steps/:stepId/attempts/:attempt/logs', () => {
   beforeAll(async () => {
     app = await createApp({
       auth: [fakeUserAuth, stubLeaseAuth],
-      routes: logsRoutes,
+      routes: createLogsRoutes(createTestWorkflowsClient()),
       swagger: false,
     });
     await app.ready();

package/src/temporal/activities/compact-stream.ts

@@ -1,3 +1,5 @@
+import {reportError} from '@shipfox/node-error-monitoring';
+import {logger} from '@shipfox/node-opentelemetry';
 import {Context} from '@temporalio/activity';
 import {compactedObjectKey, deleteObject, putCompactedObject} from '#api/object-storage.js';
 import {compactedGzipStream} from '#core/compaction.js';
@@ -79,7 +81,17 @@ async function compactStream(
     stats.lastSeq !== expected.maxSeq ||
     stats.uncompressedBytes !== expected.uncompressedBytes
   ) {
-    await deleteObject(uploadKey).catch(() => undefined);
+    await deleteObject(uploadKey).catch((error) => {
+      logger().error(
+        {err: error, streamId: stream.id, objectKey: uploadKey},
+        'Failed to delete invalid compacted log object',
+      );
+      reportError(error, {
+        boundary: 'logs.cleanup',
+        operation: 'delete-invalid-compaction-object',
+        extra: {streamId: stream.id, objectKey: uploadKey},
+      });
+    });
     throw new Error(
       `Compaction integrity check failed for stream ${stream.id}: streamed ${stats.chunkCount} chunks / ${stats.uncompressedBytes} bytes up to seq ${stats.lastSeq}, table holds ${expected.count} / ${expected.uncompressedBytes} bytes up to seq ${expected.maxSeq}`,
     );

package/src/temporal/activities/compaction-reconcile.ts

@@ -1,3 +1,4 @@
+import {reportError} from '@shipfox/node-error-monitoring';
 import {logger} from '@shipfox/node-opentelemetry';
 import {temporalClient} from '@shipfox/node-temporal';
 import {config} from '#config.js';
@@ -41,6 +42,7 @@ export async function compactionReconcileActivity(): Promise<{restarted: number;
         {err: error, streamId: stream.id},
         'Failed to re-drive stale stream compaction',
       );
+      reportError(error, {boundary: 'logs.maintenance', extra: {streamId: stream.id}});
     }
   }
 

package/test/env.ts

@@ -4,9 +4,7 @@ process.env.POSTGRES_USERNAME ??= 'shipfox';
 process.env.POSTGRES_PASSWORD ??= 'password';
 process.env.POSTGRES_DATABASE = 'api_test';
 process.env.POSTGRES_MAX_CONNECTIONS ??= '5';
-process.env.AUTH_JWT_SECRET = 'test-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.SECRETS_ENCRYPTION_KEK = 'ZmVkY2JhOTg3NjU0MzIxMGZlZGNiYTk4NzY1NDMyMTA=';
 
 // Small accrual budget so cap/budget tests use tiny payloads: base 100 bytes,

package/test/fixtures/lease-token.ts

@@ -1,8 +1,9 @@
 import {JOB_LEASE_TOKEN_AUDIENCE} from '@shipfox/api-auth-dto';
+import {jobLeaseTokenKey} from '@shipfox/node-auth-root-key';
 import {signHs256} from '@shipfox/node-jwt';
 
 // Matches test/env.ts; the lease-token auth method reads this same value from config.
-const SECRET = process.env.AUTH_JOB_LEASE_TOKEN_SECRET ?? 'test-lease-secret';
+const SECRET = jobLeaseTokenKey();
 
 export interface MintLeaseTokenParams {
   jobId: string;

package/test/fixtures/workflows-client.ts

@@ -0,0 +1,17 @@
+import {
+  type WorkflowsModuleClient,
+  workflowsInterModuleContract,
+} from '@shipfox/api-workflows-dto/inter-module';
+import {defineInterModulePresentation} from '@shipfox/inter-module';
+import {createFakeInterModuleClients} from '@shipfox/node-module/inter-module/testing';
+
+export function createTestWorkflowsClient(): WorkflowsModuleClient {
+  return createFakeInterModuleClients({
+    workflows: defineInterModulePresentation(workflowsInterModuleContract, {
+      startRunFromTrigger: vi.fn(),
+      deliverEventToJobListener: vi.fn(),
+      getStepLogContext: () => ({harness: 'pi' as const}),
+      getLeasedAgentToolContext: vi.fn(),
+    }),
+  }).workflows;
+}