Files
David ReissandGitHub c73b681b4b Typed dynamic config (#5739)
## What changed?
Dynamic config improvements:
- Typed settings to prevent misuse
- Moved defaults to where settings are defined
- Code generation to make it easy to add new types and filters
- Shorter names for readability

## Why?
Making it easier to use, preventing misuse, making it easy to extend,
easier to parse and generate documentation from, base for future
enhancements (e.g. validation at load time)

## How did you test it?
modified existing tests

## Potential risks
typo or missed something in all the merges and refactors
2024-05-06 11:25:19 -07:00

107 lines
3.4 KiB
Go

// The MIT License
//
// Copyright (c) 2022 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 batcher
import (
"go.temporal.io/api/workflowservice/v1"
sdkworker "go.temporal.io/sdk/worker"
"go.temporal.io/sdk/workflow"
"go.uber.org/fx"
"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"
)
const (
// BatchWFTypeName is the workflow type
BatchWFTypeName = "temporal-sys-batch-workflow"
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) {
registry.RegisterWorkflowWithOptions(BatchWorkflow, workflow.RegisterOptions{Name: BatchWFTypeName})
registry.RegisterActivity(s.activities(ns.Name(), ns.ID()))
}
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),
}
}