Improve the error experience around deadlocks

Author: ericallam

apps/webapp/app/components/runs/v3/SpanEvents.tsx

@@ -83,7 +83,13 @@ export function SpanEventError({
         time={spanEvent.time}
         titleClassName="text-rose-500"
       />
-      {enhancedException.message && <Callout variant="error">{enhancedException.message}</Callout>}
+      {enhancedException.message && (
+        <Callout variant="error">
+          <pre className="text-wrap font-sans text-sm font-normal text-rose-200">
+            {enhancedException.message}
+          </pre>
+        </Callout>
+      )}
       {enhancedException.link &&
         (enhancedException.link.magic === "CONTACT_FORM" ? (
           <Feedback

apps/webapp/app/routes/resources.orgs.$organizationSlug.projects.$projectParam.env.$envParam.runs.$runParam.spans.$spanParam/route.tsx

@@ -808,7 +808,13 @@ function RunError({ error }: { error: TaskRunError }) {
       return (
         <div className="flex flex-col gap-2 rounded-sm border border-rose-500/50 px-3 pb-3 pt-2">
           <Header3 className="text-rose-500">{name}</Header3>
-          {enhancedError.message && <Callout variant="error">{enhancedError.message}</Callout>}
+          {enhancedError.message && (
+            <Callout variant="error">
+              <pre className="text-wrap font-sans text-sm font-normal text-rose-200">
+                {enhancedError.message}
+              </pre>
+            </Callout>
+          )}
           {enhancedError.link &&
             (enhancedError.link.magic === "CONTACT_FORM" ? (
               <Feedback

apps/webapp/app/runEngine/concerns/runChainStates.server.ts

@@ -268,8 +268,6 @@ To fix this, you can:
 1. Enable releaseConcurrencyOnWaitpoint on the queue
 2. Use a different queue for the child task
 3. Increase the concurrency limits
-4. Use trigger() instead of triggerAndWait() if you don't need to wait
-
-Learn more about concurrency and deadlocks at https://trigger.dev/docs/queue-concurrency`;
+4. Use trigger() instead of triggerAndWait() if you don't need to wait`;
   }
 }

packages/core/src/v3/apiClient/errors.ts

@@ -28,23 +28,32 @@ export class ApiError extends Error {
   }
 
   private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
-    const msg = error?.message
+    const errorMessage = error?.message
       ? typeof error.message === "string"
         ? error.message
         : JSON.stringify(error.message)
+      : typeof error === "string"
+      ? error
       : error
       ? JSON.stringify(error)
-      : message;
+      : undefined;
 
-    if (status && msg) {
-      return `${status} ${msg}`;
+    if (errorMessage) {
+      return errorMessage;
     }
+
+    if (status && message) {
+      return `${status} ${message}`;
+    }
+
     if (status) {
       return `${status} status code (no body)`;
     }
-    if (msg) {
-      return msg;
+
+    if (message) {
+      return message;
     }
+
     return "(no status code or body)";
   }
 

packages/core/src/v3/errors.ts

@@ -690,6 +690,21 @@ export function taskRunErrorEnhancer(error: TaskRunError): EnhanceError<TaskRunE
         };
       }
 
+      if (error.name === "TriggerApiError") {
+        if (error.message.startsWith("Deadlock detected:")) {
+          return {
+            type: "BUILT_IN_ERROR",
+            name: "Concurrency Deadlock Error",
+            message: error.message,
+            stackTrace: "",
+            link: {
+              name: "Read the docs",
+              href: links.docs.concurrency.deadlock,
+            },
+          };
+        }
+      }
+
       break;
     }
     case "STRING_ERROR": {

packages/core/src/v3/links.ts

@@ -18,6 +18,7 @@ export const links = {
     concurrency: {
       recursiveDeadlock:
         "https://trigger.dev/docs/queue-concurrency#waiting-for-a-subtask-on-the-same-queue",
+      deadlock: "https://trigger.dev/docs/queue-concurrency#deadlock",
     },
   },
   site: {

references/hello-world/src/trigger/deadlocks.ts

@@ -3,7 +3,7 @@ import { task, queue } from "@trigger.dev/sdk";
 const deadlockQueue = queue({
   name: "deadlock-queue",
   concurrencyLimit: 1,
-  releaseConcurrencyOnWaitpoint: true,
+  releaseConcurrencyOnWaitpoint: false,
 });
 
 export const deadlockTester = task({