@shipfox/api-workflows 12.4.0 → 12.5.0

package/src/presentation/subscribers/on-failure-annotations.test.ts

@@ -230,7 +230,12 @@ describe('failure annotations', () => {
   });
 
   it('projects a job failure from the current execution origin', async () => {
-    const payload = jobTerminatedPayload({status: 'failed'});
+    const payload = jobTerminatedPayload({
+      status: 'failed',
+      statusReason: 'output_too_large',
+      statusReasonMessage:
+        'Job output "payload" exceeds the per-value size limit of 16384 bytes (measured 16385 bytes; overshoot 1 bytes).',
+    });
     dbMocks.getJobScope.mockResolvedValue({
       workspaceId: '44444444-4444-4444-8444-444444444444',
       projectId: '55555555-5555-4555-8555-555555555555',
@@ -264,6 +269,47 @@ describe('failure annotations', () => {
         }),
       }),
     );
+    expect(replaceOrRemoveAnnotation).toHaveBeenCalledWith(
+      expect.objectContaining({
+        annotation: expect.objectContaining({
+          body: expect.stringContaining('measured 16385 bytes; overshoot 1 bytes'),
+        }),
+      }),
+    );
+  });
+
+  it('projects an output-invalid job failure with its status message', async () => {
+    const payload = jobTerminatedPayload({
+      statusReason: 'output_invalid',
+      statusReasonMessage: 'Job output "payload" cannot be persisted as JSON: undefined.',
+    });
+    dbMocks.getJobScope.mockResolvedValue({
+      workspaceId: '44444444-4444-4444-8444-444444444444',
+      projectId: '55555555-5555-4555-8555-555555555555',
+      triggerReference: null,
+    });
+    dbMocks.getWorkflowRunAttemptById.mockResolvedValue({attempt: 3});
+    dbMocks.getJobExecutionFailureOrigin.mockResolvedValue({
+      jobExecutionId: payload.jobExecutionId,
+      stepId: '77777777-7777-4777-8777-777777777777',
+      stepName: 'Run tests',
+      stepStatus: 'succeeded',
+      stepAttempt: 1,
+      stepError: null,
+      attemptStatus: 'succeeded',
+      attemptError: null,
+      attemptExitCode: 0,
+    });
+
+    await onJobTerminatedFailureAnnotation(annotations)(payload);
+
+    expect(replaceOrRemoveAnnotation).toHaveBeenCalledWith(
+      expect.objectContaining({
+        annotation: expect.objectContaining({
+          body: expect.stringContaining('Job output "payload" cannot be persisted as JSON'),
+        }),
+      }),
+    );
   });
 
   it('projects a condition evaluation error from a skipped job', async () => {

package/src/presentation/subscribers/on-failure-annotations.ts

@@ -16,7 +16,13 @@ import {
 } from '#db/index.js';
 import {recordWorkflowFailureAnnotationFailed} from '#metrics/instance.js';
 
-const JOB_FAILURE_ANNOTATION_REASONS = new Set(['timed_out', 'runner_lost', 'condition_errored']);
+const JOB_FAILURE_ANNOTATION_REASONS = new Set([
+  'timed_out',
+  'runner_lost',
+  'condition_errored',
+  'output_too_large',
+  'output_invalid',
+]);
 
 export function onStepAttemptTerminatedFailureAnnotation(
   annotations: AnnotationsInterModuleClient,
@@ -123,7 +129,7 @@ export function onJobTerminatedFailureAnnotation(annotations: AnnotationsInterMo
         },
         context: failureContext('job', payload.jobId),
         failed: true,
-        body: jobFailureBody(payload.statusReason, origin),
+        body: jobFailureBody(payload.statusReason, payload.statusReasonMessage, origin),
       });
     } catch (error) {
       recordFailureAnnotationFailure(error, 'lookup', {jobId: payload.jobId});
@@ -200,6 +206,7 @@ function stepFailureBody(
 
 function jobFailureBody(
   reason: string | null,
+  statusReasonMessage: string | null | undefined,
   origin: {
     stepName: string;
     attemptStatus: string | null;
@@ -220,6 +227,7 @@ function jobFailureBody(
     '',
     progress,
     `Reason: \`${reason ?? 'unknown'}\``,
+    statusReasonMessage ? `Failure: ${statusReasonMessage}` : null,
     message ? `Failure: ${message}` : null,
     exitCode,
   ]

package/test/helpers/workflow-runs.ts

@@ -132,6 +132,7 @@ export async function jobTerminatedEvents(jobId: string) {
         workflowRunId: string;
         status: string;
         statusReason: string | null;
+        statusReasonMessage?: string | null;
       },
   );
 }