Files
tasks/service/history/archival_queue_factory_test.go
Yichao YangandGitHub ace58da650 Fix task executable metrics tags (#6742)
## What changed?
<!-- Describe what has changed in this PR -->
- Remove executable.taggedMetricsHandler. 
- Always init executable.metricsHandler with the full set of metric tags
needed to prevent tag mismatch issue.

## Why?
<!-- Tell your future self why have you made these changes -->
- Prevent tag mismatch issue.
- It looks like the task_errors_throttled metric could be emitted before
taggedMetricsHandler is really tagged with the right set of tags.

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
- Run server locally.

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
2024-11-04 11:13:45 -08:00

92 lines
3.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 history
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
persistencespb "go.temporal.io/server/api/persistence/v1"
"go.temporal.io/server/common/clock"
"go.temporal.io/server/common/cluster"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/primitives/timestamp"
"go.temporal.io/server/service/history/shard"
"go.temporal.io/server/service/history/tasks"
"go.temporal.io/server/service/history/tests"
"go.uber.org/mock/gomock"
)
func TestArchivalQueueFactory(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
metricsHandler := metrics.NewMockHandler(ctrl)
metricsHandler.EXPECT().WithTags(gomock.Any()).DoAndReturn(
func(tags ...metrics.Tag) metrics.Handler {
require.Len(t, tags, 1)
assert.Equal(t, metrics.OperationTagName, tags[0].Key())
assert.Equal(t, "ArchivalQueueProcessor", tags[0].Value())
return metricsHandler
},
).Times(1)
metricsHandler.EXPECT().WithTags(gomock.Any()).Return(metricsHandler).Times(1)
mockShard := shard.NewTestContext(
ctrl,
&persistencespb.ShardInfo{
ShardId: 0,
RangeId: 1,
QueueStates: map[int32]*persistencespb.QueueState{
int32(tasks.CategoryIDArchival): {
ReaderStates: nil,
ExclusiveReaderHighWatermark: &persistencespb.TaskKey{
FireTime: timestamp.TimeNowPtrUtc(),
},
},
},
},
tests.NewDynamicConfig(),
)
mockShard.Resource.ClusterMetadata.EXPECT().GetCurrentClusterName().Return(cluster.TestCurrentClusterName).AnyTimes()
queueFactory := NewArchivalQueueFactory(ArchivalQueueFactoryParams{
QueueFactoryBaseParams: QueueFactoryBaseParams{
NamespaceRegistry: mockShard.Resource.GetNamespaceRegistry(),
ClusterMetadata: mockShard.Resource.GetClusterMetadata(),
Config: tests.NewDynamicConfig(),
TimeSource: clock.NewEventTimeSource(),
MetricsHandler: metricsHandler,
Logger: log.NewNoopLogger(),
},
})
queue := queueFactory.CreateQueue(mockShard, nil)
require.NotNil(t, queue)
assert.Equal(t, tasks.CategoryArchival, queue.Category())
}