Reason isn't displayed when stop workflow with CANCEL stoptype

[nakanaori]

When we stop the workflow using FAIL StopType, the reason that we specify is shown. Why do When we use CANCEL StopType, the reason that we specify isn't shown?

both of these use StopWorkflow function from IWF Client

• FAIL stoptype
  

• CANCEL stoptype
  

[longquanzheng]

This is because Temporal SDK doesn't support this: https://github.com/temporalio/sdk-go/blob/7dbde86f46b75cd99dc8e36cedc1bfd45e2bc01e/client/client.go#L299

It doesn't provide a way to pass a reason.

As a result, iWF can not pass it to the CancelEvent:

iwf/service/api/service.go

Line 177 in 696223a

err := s.client.CancelWorkflow(ctx, wfId, runId)

There is a related problem for Terminate stop type. Even thought terminate allow passing reason, the get workflow result API of Temporal client doesn't allow retrieving the reason back..I just opened an issue/feature request: temporalio/features#325

[longquanzheng]

@nakanaori how important is that for you? I just think out a workaround if you want to just persist the message so that it won’t be lost .

[nakanaori]

Thank you for replying @longquanzheng. Do you mean we persist the reason in our own database?

[longquanzheng]

No. I am thinking that in iWF API service, right before this line,

iwf/service/api/service.go

Line 177 in 696223a

err := s.client.CancelWorkflow(ctx, wfId, runId)

, send a signal to the workflow with a iWF system signal name

iwf/service/const.go

Line 35 in 696223a

SkipTimerSignalChannelName = IwfSystemConstPrefix + "SkipTimerChannel"

, like

StopReasonSignalChannelName    = IwfSystemConstPrefix + "StopReason"

So that the reason will be recorded into history.

It will be just a few lines of code in iWF.