Heartbeating activities should be interrupted when the activities are paused.

[drewhoskins-temporal]

Is your feature request related to a problem? Please describe.

When a user runs temporal activity pause, this should work on long-running activities that heartbeat.
Users likely won't have predicted in advance that they're going to need to pause the activity, so ideally this would interrupt the activity's execution by default.

Describe the solution you'd like

Ideally a cancel-like exception could be thrown (in languages where that's appropriate)

• Users should be able to distinguish between this and cancel, as there maybe different actions they want to take when the activity is ending completely vs when it's going to resume later.

Additional context

Per-SDK Tickets

• PHP Heartbeating activities should be interrupted when the activities are paused. sdk-php#588
• Python Heartbeating activities should be interrupted when the activities are paused. sdk-python#812
• Java Heartbeating activities should be interrupted when the activities are paused. sdk-java#2465
• .NET Heartbeating activities should be interrupted when the activities are paused. sdk-dotnet#441
• Go Heartbeating activities should be interrupted when the activities are paused. sdk-go#1899
• TypeScript Heartbeating activities should be interrupted when the activities are paused. sdk-typescript#1665
• ruby Heartbeating activities should be interrupted when the activities are paused. sdk-ruby#241
• core Heartbeating activities should be interrupted when the activities are paused. sdk-core#895

[cretz]

@drewhoskins-temporal - can you confirm whether there is server-side work? RecordActivityTaskHeartbeatResponse.activity_paused is present, just need to confirm if we should always interrupt on that or if interrupt is a separate option the pauser sets and therefore there needs to be another field there.

[drewhoskins-temporal]

• Always, for now
• We can add a flag later to turn it off if people ask for it (but they probably won't).

Reasoning:

• It’s important that by default, pause “just works” if people don’t notice the fine print.
• Users will be able to write a rule like “Pause activities of type T when they fail” so they probably won’t need it.