Files
tasks/service/history/replication/executable_task_converter.go
LuanandGitHub ea53aa9362 Migrate usage of metrics.Handler to metricDefinition.With (#5435)
## What changed?
Using the new metricDefinition.With approach.

## Why?
The usage of metrics.Handler could be both redundant and unsafe:

```
 handler.Histogram( myHisto.Name(), myHisto.Unit() ).Record(...)
                │             │               └───┐
                │             │                   │
                └─────┐       └───────────┐       │
                      │                   │       │
       Redundant and Unsafe: 'Histogram'  │       │
       is specified despite knowing       │       │
       'myHisto' is a histogram. There's  │       │
       also a risk if 'myHisto.Name()'    │       │
       refers to a metric definition that │       │
       is not a histogram.                │       │
                                          └─── Redundant information
```

And using the new With(Handler) method, there's no need to specify
redundant information.


## How did you test it?
Already exists an ExampleHandler which tests all the new approach
methods.

## Potential risks
People can still use the old approach, because we are keeping
the Handler interface as-is.

## Is hotfix candidate?
No.
2024-03-07 23:09:49 +00:00

138 lines
4.3 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 replication
import (
"fmt"
"time"
enumsspb "go.temporal.io/server/api/enums/v1"
replicationspb "go.temporal.io/server/api/replication/v1"
"go.temporal.io/server/common/metrics"
)
type (
ExecutableTaskConverter interface {
Convert(
taskClusterName string,
clientShardKey ClusterShardKey,
serverShardKey ClusterShardKey,
replicationTasks ...*replicationspb.ReplicationTask,
) []TrackableExecutableTask
}
executableTaskConverterImpl struct {
processToolBox ProcessToolBox
}
)
func NewExecutableTaskConverter(
processToolBox ProcessToolBox,
) *executableTaskConverterImpl {
return &executableTaskConverterImpl{
processToolBox: processToolBox,
}
}
func (e *executableTaskConverterImpl) Convert(
taskClusterName string,
clientShardKey ClusterShardKey,
serverShardKey ClusterShardKey,
replicationTasks ...*replicationspb.ReplicationTask,
) []TrackableExecutableTask {
tasks := make([]TrackableExecutableTask, len(replicationTasks))
for index, replicationTask := range replicationTasks {
metrics.ReplicationTasksRecv.With(e.processToolBox.MetricsHandler).Record(
int64(1),
metrics.FromClusterIDTag(serverShardKey.ClusterID),
metrics.ToClusterIDTag(clientShardKey.ClusterID),
metrics.OperationTag(TaskOperationTag(replicationTask)),
)
tasks[index] = e.convertOne(taskClusterName, replicationTask)
}
return tasks
}
func (e *executableTaskConverterImpl) convertOne(
taskClusterName string,
replicationTask *replicationspb.ReplicationTask,
) TrackableExecutableTask {
var taskCreationTime time.Time
if replicationTask.VisibilityTime != nil {
taskCreationTime = replicationTask.VisibilityTime.AsTime()
} else {
taskCreationTime = time.Now().UTC()
}
switch replicationTask.GetTaskType() {
case enumsspb.REPLICATION_TASK_TYPE_SYNC_SHARD_STATUS_TASK: // TODO to be deprecated
return NewExecutableNoopTask(
e.processToolBox,
replicationTask.SourceTaskId,
taskCreationTime,
taskClusterName,
)
case enumsspb.REPLICATION_TASK_TYPE_HISTORY_METADATA_TASK: // TODO to be deprecated
return NewExecutableNoopTask(
e.processToolBox,
replicationTask.SourceTaskId,
taskCreationTime,
taskClusterName,
)
case enumsspb.REPLICATION_TASK_TYPE_SYNC_ACTIVITY_TASK:
return NewExecutableActivityStateTask(
e.processToolBox,
replicationTask.SourceTaskId,
taskCreationTime,
replicationTask.GetSyncActivityTaskAttributes(),
taskClusterName,
)
case enumsspb.REPLICATION_TASK_TYPE_SYNC_WORKFLOW_STATE_TASK:
return NewExecutableWorkflowStateTask(
e.processToolBox,
replicationTask.SourceTaskId,
taskCreationTime,
replicationTask.GetSyncWorkflowStateTaskAttributes(),
taskClusterName,
)
case enumsspb.REPLICATION_TASK_TYPE_HISTORY_V2_TASK:
return NewExecutableHistoryTask(
e.processToolBox,
replicationTask.SourceTaskId,
taskCreationTime,
replicationTask.GetHistoryTaskAttributes(),
taskClusterName,
)
default:
e.processToolBox.Logger.Error(fmt.Sprintf("unknown replication task: %v", replicationTask))
return NewExecutableUnknownTask(
e.processToolBox,
replicationTask.SourceTaskId,
taskCreationTime,
replicationTask,
)
}
}