Files
tasks/service/history/interfaces/shard_context.go
Yichao YangandGitHub 63839f1a9d CHASM: Propagate ArchetypeID (#8693)
## What changed?
- Use archetypeID everywhere in history service and pass them to
persistence

## Why?
- Required for separate ID space work.

## How did you test it?
- [x] built
- [ ] run locally and tested manually
- [x] covered by existing tests
- [x] added new unit test(s)
- [ ] added new functional test(s)
2025-11-26 16:04:44 -08:00

121 lines
5.7 KiB
Go

package interfaces
import (
"context"
"time"
commonpb "go.temporal.io/api/common/v1"
"go.temporal.io/server/api/adminservice/v1"
clockspb "go.temporal.io/server/api/clock/v1"
"go.temporal.io/server/api/historyservice/v1"
persistencespb "go.temporal.io/server/api/persistence/v1"
"go.temporal.io/server/chasm"
"go.temporal.io/server/common/archiver"
"go.temporal.io/server/common/clock"
"go.temporal.io/server/common/cluster"
"go.temporal.io/server/common/definition"
"go.temporal.io/server/common/finalizer"
"go.temporal.io/server/common/locks"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/namespace"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/persistence/serialization"
"go.temporal.io/server/common/pingable"
"go.temporal.io/server/common/searchattribute"
"go.temporal.io/server/service/history/configs"
"go.temporal.io/server/service/history/events"
"go.temporal.io/server/service/history/hsm"
"go.temporal.io/server/service/history/tasks"
)
//go:generate mockgen -package $GOPACKAGE -source $GOFILE -destination shard_context_mock.go
type (
// ShardContext represents a history engine shard
ShardContext interface {
GetShardID() int32
GetRangeID() int64
GetOwner() string
GetExecutionManager() persistence.ExecutionManager
GetNamespaceRegistry() namespace.Registry
GetClusterMetadata() cluster.Metadata
GetConfig() *configs.Config
GetEventsCache() events.Cache
GetLogger() log.Logger
GetThrottledLogger() log.Logger
GetMetricsHandler() metrics.Handler
GetTimeSource() clock.TimeSource
GetRemoteAdminClient(string) (adminservice.AdminServiceClient, error)
GetHistoryClient() historyservice.HistoryServiceClient
GetPayloadSerializer() serialization.Serializer
GetSearchAttributesProvider() searchattribute.Provider
GetSearchAttributesMapperProvider() searchattribute.MapperProvider
GetArchivalMetadata() archiver.ArchivalMetadata
GetEngine(ctx context.Context) (Engine, error)
AssertOwnership(ctx context.Context) error
NewVectorClock() (*clockspb.VectorClock, error)
CurrentVectorClock() *clockspb.VectorClock
GenerateTaskID() (int64, error)
GenerateTaskIDs(number int) ([]int64, error)
GetQueueExclusiveHighReadWatermark(category tasks.Category) tasks.Key
GetQueueState(category tasks.Category) (*persistencespb.QueueState, bool)
SetQueueState(category tasks.Category, tasksCompleted int, state *persistencespb.QueueState) error
UpdateReplicationQueueReaderState(readerID int64, readerState *persistencespb.QueueReaderState) error
GetReplicatorDLQAckLevel(sourceCluster string) int64
UpdateReplicatorDLQAckLevel(sourCluster string, ackLevel int64) error
UpdateRemoteClusterInfo(cluster string, ackTaskID int64, ackTimestamp time.Time)
UpdateRemoteReaderInfo(readerID int64, ackTaskID int64, ackTimestamp time.Time) error
SetCurrentTime(cluster string, currentTime time.Time)
GetCurrentTime(cluster string) time.Time
GetReplicationStatus(cluster []string) (map[string]*historyservice.ShardReplicationStatusPerCluster, map[string]*historyservice.HandoverNamespaceInfo, error)
UpdateHandoverNamespace(ns *namespace.Namespace, deletedFromDb bool)
AppendHistoryEvents(ctx context.Context, request *persistence.AppendHistoryNodesRequest, namespaceID namespace.ID, execution *commonpb.WorkflowExecution) (int, error)
AddTasks(ctx context.Context, request *persistence.AddHistoryTasksRequest) error
AddSpeculativeWorkflowTaskTimeoutTask(task *tasks.WorkflowTaskTimeoutTask) error
GetHistoryTasks(ctx context.Context, request *persistence.GetHistoryTasksRequest) (*persistence.GetHistoryTasksResponse, error)
CreateWorkflowExecution(ctx context.Context, request *persistence.CreateWorkflowExecutionRequest) (*persistence.CreateWorkflowExecutionResponse, error)
UpdateWorkflowExecution(ctx context.Context, request *persistence.UpdateWorkflowExecutionRequest) (*persistence.UpdateWorkflowExecutionResponse, error)
ConflictResolveWorkflowExecution(ctx context.Context, request *persistence.ConflictResolveWorkflowExecutionRequest) (*persistence.ConflictResolveWorkflowExecutionResponse, error)
SetWorkflowExecution(ctx context.Context, request *persistence.SetWorkflowExecutionRequest) (*persistence.SetWorkflowExecutionResponse, error)
GetCurrentExecution(ctx context.Context, request *persistence.GetCurrentExecutionRequest) (*persistence.GetCurrentExecutionResponse, error)
GetWorkflowExecution(ctx context.Context, request *persistence.GetWorkflowExecutionRequest) (*persistence.GetWorkflowExecutionResponse, error)
// DeleteWorkflowExecution add task to delete visibility, current workflow execution, and deletes workflow execution.
// If branchToken != nil, then delete history also, otherwise leave history.
DeleteWorkflowExecution(ctx context.Context, workflowKey definition.WorkflowKey, archetypeID chasm.ArchetypeID, branchToken []byte, closeExecutionVisibilityTaskID int64, workflowCloseTime time.Time, stage *tasks.DeleteWorkflowExecutionStage) error
GetCachedWorkflowContext(ctx context.Context, namespaceID namespace.ID, execution *commonpb.WorkflowExecution, lockPriority locks.Priority) (WorkflowContext, ReleaseWorkflowContextFunc, error)
GetCurrentCachedWorkflowContext(ctx context.Context, namespaceID namespace.ID, workflowID string, lockPriority locks.Priority) (ReleaseWorkflowContextFunc, error)
UnloadForOwnershipLost()
StateMachineRegistry() *hsm.Registry
GetFinalizer() *finalizer.Finalizer
ChasmRegistry() *chasm.Registry
}
// A ControllableContext is a Context plus other methods needed by
// the Controller.
ControllableContext interface {
ShardContext
pingable.Pingable
IsValid() bool
FinishStop()
}
)