mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
09231340b2
## What changed? <!-- Describe what has changed in this PR --> Remove "consistency check" parameter from GetAndUpdateWorkflow and GetWorkflowLease To support those cases where is was still used - old version is preserved with different function name. Also remove dead code and dead tests. ## Why? <!-- Tell your future self why have you made these changes --> Current implementation has some issues. a. It is hard to understand, which can (and does) lead to hard-to-detect bugs b. Predicate (I'm not calling it "consistency check" because it is not) is used only in just 2 cases out of > 70. In all other cases “do nothing” check is provided. c. Current implementation of predicate check introduce huge “side effect” (clear WF context) which (most likely) has little to do with loading mutable state. I'm still not sure it should be used in the way it is used. d. It is hard to tell if current implementation do anything useful - it loads mutable state, and if predicate failed - clear context and load it again. That is all. It is not clear that clear WF context somehow affect mutable state loading at all… e. Logic in one (or two) consistency check function is complicated and clearly out of boundaries for "consistency check"scope. It looks more like business logic. Thus introduce more side-effects. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> unit test. add a bit more tests to cover clock related logic. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> This is core logic, and has side-effects. I try to minimize the risk by keeping the old version intact, but it still exist. ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> No --------- Co-authored-by: Yichao Yang <[email protected]>
88 lines
2.8 KiB
Go
88 lines
2.8 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 isworkflowtaskvalid
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.temporal.io/server/api/historyservice/v1"
|
|
"go.temporal.io/server/common"
|
|
"go.temporal.io/server/common/definition"
|
|
"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,
|
|
req *historyservice.IsWorkflowTaskValidRequest,
|
|
shardContext shard.Context,
|
|
workflowConsistencyChecker api.WorkflowConsistencyChecker,
|
|
) (resp *historyservice.IsWorkflowTaskValidResponse, retError error) {
|
|
isValid := false
|
|
err := api.GetAndUpdateWorkflowWithNew(
|
|
ctx,
|
|
req.Clock,
|
|
definition.NewWorkflowKey(
|
|
req.NamespaceId,
|
|
req.Execution.WorkflowId,
|
|
req.Execution.RunId,
|
|
),
|
|
func(workflowLease api.WorkflowLease) (*api.UpdateWorkflowAction, error) {
|
|
isTaskValid, err := isWorkflowTaskValid(workflowLease, req.ScheduledEventId)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
isValid = isTaskValid
|
|
return &api.UpdateWorkflowAction{
|
|
Noop: true,
|
|
CreateWorkflowTask: false,
|
|
}, nil
|
|
},
|
|
nil,
|
|
shardContext,
|
|
workflowConsistencyChecker,
|
|
)
|
|
return &historyservice.IsWorkflowTaskValidResponse{
|
|
IsValid: isValid,
|
|
}, err
|
|
}
|
|
|
|
func isWorkflowTaskValid(
|
|
workflowLease api.WorkflowLease,
|
|
scheduledEventID int64,
|
|
) (bool, error) {
|
|
mutableState := workflowLease.GetMutableState()
|
|
if !mutableState.IsWorkflowExecutionRunning() {
|
|
return false, consts.ErrWorkflowCompleted
|
|
}
|
|
|
|
workflowTask := mutableState.GetWorkflowTaskByID(scheduledEventID)
|
|
if workflowTask == nil {
|
|
return false, nil
|
|
}
|
|
return workflowTask.StartedEventID == common.EmptyEventID, nil
|
|
}
|