From 12ad920360c33df71d42ae855ac9bc2c8bfd510a Mon Sep 17 00:00:00 2001
From: nicktrn <55853254+nicktrn@users.noreply.github.com>
Date: Thu, 17 Oct 2024 18:05:02 +0100
Subject: [PATCH] separate SIGTERM from maybe OOM errors

---
 packages/core/src/v3/errors.ts         | 50 ++++++++++++++++++++++----
 packages/core/src/v3/schemas/common.ts |  2 ++
 2 files changed, 46 insertions(+), 6 deletions(-)

diff --git a/packages/core/src/v3/errors.ts b/packages/core/src/v3/errors.ts
index f63f48b99..e06e97a90 100644
--- a/packages/core/src/v3/errors.ts
+++ b/packages/core/src/v3/errors.ts
@@ -331,6 +331,14 @@ const prettyInternalErrors: Partial<
       href: links.docs.machines.home,
     },
   },
+  TASK_PROCESS_SIGTERM: {
+    message:
+      "Your task exited after receiving SIGTERM but we don't know why. If this keeps happening, please get in touch so we can investigate.",
+    link: {
+      name: "Contact us",
+      href: links.site.contact,
+    },
+  },
 };
 
 type EnhanceError<T extends TaskRunError | ExceptionEventProperties> = T & {
@@ -342,6 +350,14 @@ export function taskRunErrorEnhancer(error: TaskRunError): EnhanceError<TaskRunE
     case "BUILT_IN_ERROR": {
       if (error.name === "UnexpectedExitError") {
         if (error.message.startsWith("Unexpected exit with code -1")) {
+          if (error.message.includes("SIGTERM")) {
+            return {
+              type: "INTERNAL_ERROR",
+              code: TaskRunErrorCodes.TASK_PROCESS_SIGTERM,
+              ...prettyInternalErrors.TASK_PROCESS_SIGTERM,
+            };
+          }
+
           return {
             type: "INTERNAL_ERROR",
             code: TaskRunErrorCodes.TASK_PROCESS_MAYBE_OOM_KILLED,
@@ -359,6 +375,14 @@ export function taskRunErrorEnhancer(error: TaskRunError): EnhanceError<TaskRunE
     }
     case "INTERNAL_ERROR": {
       if (error.code === TaskRunErrorCodes.TASK_PROCESS_EXITED_WITH_NON_ZERO_CODE) {
+        if (error.message?.includes("SIGTERM")) {
+          return {
+            type: "INTERNAL_ERROR",
+            code: TaskRunErrorCodes.TASK_PROCESS_SIGTERM,
+            ...prettyInternalErrors.TASK_PROCESS_SIGTERM,
+          };
+        }
+
         return {
           type: "INTERNAL_ERROR",
           code: TaskRunErrorCodes.TASK_PROCESS_MAYBE_OOM_KILLED,
@@ -396,7 +420,8 @@ export function exceptionEventEnhancer(
       break;
     }
     case TaskRunErrorCodes.TASK_PROCESS_MAYBE_OOM_KILLED:
-    case TaskRunErrorCodes.TASK_PROCESS_OOM_KILLED: {
+    case TaskRunErrorCodes.TASK_PROCESS_OOM_KILLED:
+    case TaskRunErrorCodes.TASK_PROCESS_SIGTERM: {
       return {
         ...exception,
         ...prettyInternalErrors[exception.type],
@@ -411,16 +436,23 @@ export function internalErrorFromUnexpectedExit(
   error: UnexpectedExitError,
   dockerMode = true
 ): TaskRunInternalError {
+  const internalError = {
+    type: "INTERNAL_ERROR",
+    code: TaskRunErrorCodes.TASK_PROCESS_EXITED_WITH_NON_ZERO_CODE,
+    message: `Process exited with code ${error.code} after signal ${error.signal}.`,
+    stackTrace: error.stderr,
+  } satisfies TaskRunInternalError;
+
   if (error.code === 137) {
     if (dockerMode) {
       return {
-        type: "INTERNAL_ERROR",
+        ...internalError,
         code: TaskRunErrorCodes.TASK_PROCESS_OOM_KILLED,
       };
     } else {
       // Note: containerState reason and message could be checked to clarify the error, maybe the task monitor should be allowed to override these
       return {
-        type: "INTERNAL_ERROR",
+        ...internalError,
         code: TaskRunErrorCodes.TASK_PROCESS_MAYBE_OOM_KILLED,
       };
     }
@@ -428,15 +460,21 @@ export function internalErrorFromUnexpectedExit(
 
   if (error.stderr?.includes("OOMErrorHandler")) {
     return {
-      type: "INTERNAL_ERROR",
+      ...internalError,
       code: TaskRunErrorCodes.TASK_PROCESS_OOM_KILLED,
     };
   }
 
+  if (error.signal === "SIGTERM") {
+    return {
+      ...internalError,
+      code: TaskRunErrorCodes.TASK_PROCESS_SIGTERM,
+    };
+  }
+
   return {
-    type: "INTERNAL_ERROR",
+    ...internalError,
     code: TaskRunErrorCodes.TASK_PROCESS_EXITED_WITH_NON_ZERO_CODE,
-    message: `Process exited with code ${error.code} after signal ${error.signal}.`,
   };
 }
 
diff --git a/packages/core/src/v3/schemas/common.ts b/packages/core/src/v3/schemas/common.ts
index c7e2bd8f7..f05ea7067 100644
--- a/packages/core/src/v3/schemas/common.ts
+++ b/packages/core/src/v3/schemas/common.ts
@@ -87,6 +87,7 @@ export const TaskRunErrorCodes = {
   TASK_EXECUTION_ABORTED: "TASK_EXECUTION_ABORTED",
   TASK_PROCESS_EXITED_WITH_NON_ZERO_CODE: "TASK_PROCESS_EXITED_WITH_NON_ZERO_CODE",
   TASK_PROCESS_SIGKILL_TIMEOUT: "TASK_PROCESS_SIGKILL_TIMEOUT",
+  TASK_PROCESS_SIGTERM: "TASK_PROCESS_SIGTERM",
   TASK_PROCESS_OOM_KILLED: "TASK_PROCESS_OOM_KILLED",
   TASK_PROCESS_MAYBE_OOM_KILLED: "TASK_PROCESS_MAYBE_OOM_KILLED",
   TASK_RUN_CANCELLED: "TASK_RUN_CANCELLED",
@@ -112,6 +113,7 @@ export const TaskRunInternalError = z.object({
     "TASK_EXECUTION_ABORTED",
     "TASK_PROCESS_EXITED_WITH_NON_ZERO_CODE",
     "TASK_PROCESS_SIGKILL_TIMEOUT",
+    "TASK_PROCESS_SIGTERM",
     "TASK_PROCESS_OOM_KILLED",
     "TASK_PROCESS_MAYBE_OOM_KILLED",
     "TASK_RUN_CANCELLED",