Files
Sean KaneandGitHub c2e0c0c170 improvement: bypass middle-man-struct for batch operations (#8081)
## What changed?
Remove `BatchParams` to safely serialize proto -> json -> proto and add
a `BatchOperation` proto definition

## Why?
Remove custom serialization of proto for json safety.

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

## Potential risks
Could break batching backwards compatibility but tests should catch this
2025-08-04 14:26:50 -06:00

86 lines
2.5 KiB
Go

package batcher
import (
"go.temporal.io/api/workflowservice/v1"
sdkworker "go.temporal.io/sdk/worker"
"go.temporal.io/sdk/workflow"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/namespace"
"go.temporal.io/server/common/sdk"
workercommon "go.temporal.io/server/service/worker/common"
"go.uber.org/fx"
)
const (
// BatchWFTypeName is the workflow type
BatchWFTypeName = "temporal-sys-batch-workflow"
BatchWFTypeProtobufName = "temporal-sys-batch-workflow-protobuf"
NamespaceDivision = "TemporalBatcher"
)
type (
workerComponent struct {
activityDeps activityDeps
dc *dynamicconfig.Collection
enabledFeature dynamicconfig.BoolPropertyFnWithNamespaceFilter
}
activityDeps struct {
fx.In
MetricsHandler metrics.Handler
Logger log.Logger
ClientFactory sdk.ClientFactory
FrontendClient workflowservice.WorkflowServiceClient
}
fxResult struct {
fx.Out
Component workercommon.PerNSWorkerComponent `group:"perNamespaceWorkerComponent"`
}
)
var Module = fx.Options(
fx.Provide(NewResult),
)
func NewResult(
dc *dynamicconfig.Collection,
params activityDeps,
) fxResult {
return fxResult{
Component: &workerComponent{
activityDeps: params,
dc: dc,
enabledFeature: dynamicconfig.EnableBatcherNamespace.Get(dc),
},
}
}
func (s *workerComponent) DedicatedWorkerOptions(ns *namespace.Namespace) *workercommon.PerNSDedicatedWorkerOptions {
namespaceName := ns.Name().String()
enableFeature := s.enabledFeature(namespaceName)
return &workercommon.PerNSDedicatedWorkerOptions{
Enabled: enableFeature,
}
}
func (s *workerComponent) Register(registry sdkworker.Registry, ns *namespace.Namespace, _ workercommon.RegistrationDetails) func() {
registry.RegisterWorkflowWithOptions(BatchWorkflow, workflow.RegisterOptions{Name: BatchWFTypeName})
// Newer version of the batch workflow which was rewritten to accept a proto struct as input.
registry.RegisterWorkflowWithOptions(BatchWorkflowProtobuf, workflow.RegisterOptions{Name: BatchWFTypeProtobufName})
registry.RegisterActivity(s.activities(ns.Name(), ns.ID()))
return nil
}
func (s *workerComponent) activities(name namespace.Name, id namespace.ID) *activities {
return &activities{
activityDeps: s.activityDeps,
namespace: name,
namespaceID: id,
rps: dynamicconfig.BatcherRPS.Get(s.dc),
concurrency: dynamicconfig.BatcherConcurrency.Get(s.dc),
}
}