Files
Stephan BehnkeandGitHub 4d41efecb0 Rename api.WorkflowContext to api.WorkflowLease (#5386)
## What changed?
<!-- Describe what has changed in this PR -->

Renamed `api.WorkflowContext` to `api.WorkflowLease`.

## Why?

The name is confusing as there is already a `workflow.Context`. It keeps
coming up for me and makes it unnecessarily harder to read/understand
the code. The current name also doesn't _add_ anything but the entity
_is_ different from `workflow.Context`. I believe it effectively acts as
a "lease".

If that one doesn't work, I'm happy to find a better name than that
together.

## How did you test it?

Compiler.

## Potential risks

N/A

## Is hotfix candidate?

No
2024-02-05 09:41:18 -08:00

81 lines
2.6 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package resetstickytaskqueue
import (
"context"
"go.temporal.io/server/api/historyservice/v1"
"go.temporal.io/server/common/definition"
"go.temporal.io/server/common/namespace"
"go.temporal.io/server/service/history/api"
"go.temporal.io/server/service/history/consts"
"go.temporal.io/server/service/history/shard"
)
func Invoke(
ctx context.Context,
resetRequest *historyservice.ResetStickyTaskQueueRequest,
shard shard.Context,
workflowConsistencyChecker api.WorkflowConsistencyChecker,
) (*historyservice.ResetStickyTaskQueueResponse, error) {
namespaceID := namespace.ID(resetRequest.GetNamespaceId())
err := api.ValidateNamespaceUUID(namespaceID)
if err != nil {
return nil, err
}
err = api.GetAndUpdateWorkflowWithNew(
ctx,
nil,
api.BypassMutableStateConsistencyPredicate,
definition.NewWorkflowKey(
resetRequest.NamespaceId,
resetRequest.Execution.WorkflowId,
resetRequest.Execution.RunId,
),
func(workflowLease api.WorkflowLease) (*api.UpdateWorkflowAction, error) {
mutableState := workflowLease.GetMutableState()
if !mutableState.IsWorkflowExecutionRunning() {
return nil, consts.ErrWorkflowCompleted
}
mutableState.ClearStickyTaskQueue()
return &api.UpdateWorkflowAction{
Noop: true,
CreateWorkflowTask: false,
}, nil
},
nil,
shard,
workflowConsistencyChecker,
)
if err != nil {
return nil, err
}
return &historyservice.ResetStickyTaskQueueResponse{}, nil
}