crux icon indicating copy to clipboard operation
crux copied to clipboard

Docs for `CommandContext` should warn about task cancellation

Open charypar opened this issue 6 months ago • 1 comments

The shell communication futures in CommandContext can only proceed when their associated RequestHandle is resolved. If the handle is droped, the task awaiting the future can never proceed, and the Command executor will evict it to avoid leaking memory.

This can lead to a surprising behaviour where tasks terminate unexpectedly. We should warn about this situation in the documentation for the methods which return futures susceptible to this behaviour.

charypar avatar Jun 02 '25 16:06 charypar

Linking this to #352 as a possible place to fix this

mhedgpeth avatar Jun 18 '25 11:06 mhedgpeth