mirror of
https://github.com/hanzoai/tasks.git
synced 2026-11-03 03:56:04 +00:00
Roey BermanandGitHub
c76f4a2caa
## Notes for reviewers I don't consider this a final approach but I do think it's a step in the right direction, we need to model more state machines on top of this to form a more solid API. Note that mutable state itself is registered as a state machine in the HSM framework and used as the root node in the HSM tree. It's a bit annoying that all of the unit tests need to register the workflow state machine but I think this is ended up being the cleanest approach from the HSM framework perspective. There's still some follow-up work, like collapsing timer tasks and support for interacting with history event, that I'll take on later. Replication support for the framework will also come at a later time. - See discussions in related PRs (#5446, #5495) ## What changed? - Modified the statemachines abstraction to be a bit more generic - Rewrote callbacks as a plugin using this framework ## Why? This centralizes most the callback code in the plugin directory instead of having it spread out the entire project moving common concerns such as staleness checks, task generation, and (in the future) replication into a framework and should generally help speed up feature delivery and maintainability. I plan to leverage this framework when implementing Nexus operations. ## How did you test it? Existing tests from the feature branch and added unit tests.
74 lines
2.8 KiB
Go
74 lines
2.8 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2024 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// 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 hsm
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
persistencespb "go.temporal.io/server/api/persistence/v1"
|
|
"go.temporal.io/server/common/definition"
|
|
)
|
|
|
|
// Ref is a reference to a statemachine on a specific workflow.
|
|
// It contains the workflow key and the key of the statemachine in the state machine [Store] as well as the namespace
|
|
// failover version and transition count that is expected to match on the referenced state machine.
|
|
type Ref struct {
|
|
WorkflowKey definition.WorkflowKey
|
|
StateMachineRef *persistencespb.StateMachineRef
|
|
}
|
|
|
|
// StateMachinePath gets the state machine path for from this reference.
|
|
func (r Ref) StateMachinePath() []Key {
|
|
path := make([]Key, len(r.StateMachineRef.Path))
|
|
for i, k := range r.StateMachineRef.Path {
|
|
path[i] = Key{Type: k.Type, ID: k.Id}
|
|
}
|
|
return path
|
|
}
|
|
|
|
// AccessType is a specifier for storage access.
|
|
type AccessType int
|
|
|
|
const (
|
|
// AccessRead specifies read access.
|
|
AccessRead AccessType = iota
|
|
// AccessWrite specifies write access.
|
|
AccessWrite AccessType = iota
|
|
)
|
|
|
|
// Executor environment.
|
|
type Environment interface {
|
|
// Wall clock. Backed by a the shard's time source.
|
|
Now() time.Time
|
|
// Access a state machine Node for the given ref.
|
|
//
|
|
// When using AccessRead, the accessor must guarantee not to mutate any state, accessor errors will not cause
|
|
// mutable state unload.
|
|
Access(ctx context.Context, ref Ref, accessType AccessType, accessor func(*Node) error) error
|
|
}
|
|
|
|
// Executor is responsible for executing tasks.
|
|
// Implementations should be registered via [RegisterExecutor] to handle specific task types.
|
|
type Executor[T Task] func(ctx context.Context, env Environment, ref Ref, task T) error
|