[Concurrency] Improve crash message on continuation misuse (#75613)

ktoso · web-flow · commit f300164accb6 · 2024-08-02T00:46:45.000-07:00
diff --git a/stdlib/public/Concurrency/CheckedContinuation.swift b/stdlib/public/Concurrency/CheckedContinuation.swift
@@ -79,7 +79,7 @@ internal final class CheckedContinuationCanary: @unchecked Sendable {
     // Log if the continuation was never consumed before the instance was
     // destructed.
     if _continuationPtr.pointee != nil {
-      logFailedCheck("SWIFT TASK CONTINUATION MISUSE: \(function) leaked its continuation!\n")
+      logFailedCheck("SWIFT TASK CONTINUATION MISUSE: \(function) leaked its continuation without resuming it. This may cause tasks waiting on it to remain suspended forever.\n")
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ internal final class CheckedContinuationCanary: @unchecked Sendable {`
`79`	`79`	`// Log if the continuation was never consumed before the instance was`
`80`	`80`	`// destructed.`
`81`	`81`	`if _continuationPtr.pointee != nil {`
`82`		`- logFailedCheck("SWIFT TASK CONTINUATION MISUSE: \(function) leaked its continuation!\n")`
	`82`	`+ logFailedCheck("SWIFT TASK CONTINUATION MISUSE: \(function) leaked its continuation without resuming it. This may cause tasks waiting on it to remain suspended forever.\n")`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`	`}`