Files
Chetan GowdaandGitHub 2312f6752f Prevent workflow task and activity task generation when workflow is paused (#8687)
## What changed?
- Prevents workflow task generation when paused (ex: signals, activity
completions, child workflow completions etc)
- Prevents activity task generation when a workflow is paused and an
inflight workflow task comes back with start activity commands.
- Prevents eager activity starts when the workflow is paused.

## Why?
When a workflow is paused, we should not generate any more new activity
and workflow tasks.

## How did you test it?
- [x] built
- [ ] run locally and tested manually
- [x] covered by existing tests
- [ ] added new unit test(s)
- [x] added new functional test(s)


---

> [!NOTE]
> Prevents workflow/activity task creation and certain API operations
when a workflow is paused, adds safeguards and tests across history,
NDC, and task refresh paths.
> 
> - **Behavior/State**:
> - Add `MutableState.IsWorkflowExecutionStatusPaused()` and honor
paused status across scheduling paths.
>   - `workflow/util.ScheduleWorkflowTask` returns early if paused.
> - **API Handlers**:
> - `RespondWorkflowTaskCompleted`: reject `ForceCreateNewWorkflowTask`
when paused; block eager activity and bypass activity task gen when
paused.
> - `SignalWithStartWorkflow`: do not schedule a new workflow task if
paused.
>   - `UpdateWorkflow`: reject updates while paused.
>   - Activity failure/respond paths: avoid new WFT when paused.
> - **NDC/Replication**:
> - Reapply events and buffered-event flusher: skip scheduling WFT if
paused.
> - `ndc.Workflow.FlushBufferedEvents`: don't schedule WFT when paused.
> - **Task Refresher**:
> - Skip refreshing WFT/activity tasks when paused; allow
timers/search-attr updates; skip close tasks for running/paused.
> - **Interfaces/Mocks**:
> - Add `IsWorkflowExecutionStatusPaused` to `MutableState` interface
and update mocks.
> - **Tests**:
> - New unit tests for paused behavior in handlers, NDC, task refresher,
and transfer queue; functional tests for pause/unpause workflow
behavior.
> 
> <sup>Written by [Cursor
Bugbot]() for commit
17c11c687a0d620cc5a77e6ce9369622feb9214b. This will update automatically
on new commits. Configure
[here]().</sup>
2025-12-15 10:45:31 -08:00

57 lines
1.6 KiB
Go

package updateworkflow
import (
"context"
"testing"
"github.com/stretchr/testify/require"
"go.temporal.io/api/serviceerror"
updatepb "go.temporal.io/api/update/v1"
"go.temporal.io/api/workflowservice/v1"
"go.temporal.io/server/api/historyservice/v1"
"go.temporal.io/server/common/definition"
historyi "go.temporal.io/server/service/history/interfaces"
"go.temporal.io/server/service/history/workflow/update"
"go.uber.org/mock/gomock"
)
func TestApplyRequest_RejectsUpdateOnPausedWorkflow(t *testing.T) {
t.Parallel()
ctrl := gomock.NewController(t)
ms := historyi.NewMockMutableState(ctrl)
ms.EXPECT().GetWorkflowKey().Return(definition.NewWorkflowKey("ns-id", "wf-id", "run-id"))
ms.EXPECT().IsWorkflowExecutionRunning().Return(true)
ms.EXPECT().IsWorkflowExecutionStatusPaused().Return(true)
// Required by update.NewRegistry
ms.EXPECT().GetCurrentVersion().Return(int64(1))
ms.EXPECT().VisitUpdates(gomock.Any())
updateReg := update.NewRegistry(ms)
updater := &Updater{
req: createUpdateRequest("test-update-id"),
}
action, err := updater.ApplyRequest(context.Background(), updateReg, ms)
require.Nil(t, action)
require.Error(t, err)
var failedPrecondition *serviceerror.FailedPrecondition
require.ErrorAs(t, err, &failedPrecondition)
require.Contains(t, err.Error(), "Workflow is paused")
}
func createUpdateRequest(updateID string) *historyservice.UpdateWorkflowExecutionRequest {
return &historyservice.UpdateWorkflowExecutionRequest{
Request: &workflowservice.UpdateWorkflowExecutionRequest{
Request: &updatepb.Request{
Meta: &updatepb.Meta{
UpdateId: updateID,
},
},
},
}
}