Files
tasks/service/history/ndc/events_reapplier_test.go
Yu XiaandGitHub f06a98b2a5 Replace metrics client/scope with MetricsHandler (#3561)
* Deprecate metrics client and scope in all source code
2022-11-07 22:03:54 -08:00

235 lines
8.9 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 ndc
import (
"context"
"fmt"
"testing"
"github.com/golang/mock/gomock"
"github.com/pborman/uuid"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
commonpb "go.temporal.io/api/common/v1"
enumspb "go.temporal.io/api/enums/v1"
historypb "go.temporal.io/api/history/v1"
persistencespb "go.temporal.io/server/api/persistence/v1"
"go.temporal.io/server/common/definition"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/payloads"
"go.temporal.io/server/service/history/workflow"
)
type (
nDCEventReapplicationSuite struct {
suite.Suite
*require.Assertions
controller *gomock.Controller
nDCReapplication EventsReapplier
}
)
func TestNDCEventReapplicationSuite(t *testing.T) {
s := new(nDCEventReapplicationSuite)
suite.Run(t, s)
}
func (s *nDCEventReapplicationSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.controller = gomock.NewController(s.T())
logger := log.NewTestLogger()
metricsHandler := metrics.NoopMetricsHandler
s.nDCReapplication = NewEventsReapplier(
metricsHandler,
logger,
)
}
func (s *nDCEventReapplicationSuite) TearDownTest() {
s.controller.Finish()
}
func (s *nDCEventReapplicationSuite) TestReapplyEvents_AppliedEvent() {
runID := uuid.New()
execution := &persistencespb.WorkflowExecutionInfo{
NamespaceId: uuid.New(),
}
event := &historypb.HistoryEvent{
EventId: 1,
EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
Attributes: &historypb.HistoryEvent_WorkflowExecutionSignaledEventAttributes{WorkflowExecutionSignaledEventAttributes: &historypb.WorkflowExecutionSignaledEventAttributes{
Identity: "test",
SignalName: "signal",
Input: payloads.EncodeBytes([]byte{}),
Header: &commonpb.Header{Fields: map[string]*commonpb.Payload{"myheader": {Data: []byte("myheader")}}},
}},
}
attr := event.GetWorkflowExecutionSignaledEventAttributes()
msCurrent := workflow.NewMockMutableState(s.controller)
msCurrent.EXPECT().IsWorkflowExecutionRunning().Return(true)
msCurrent.EXPECT().GetLastWriteVersion().Return(int64(1), nil).AnyTimes()
msCurrent.EXPECT().GetExecutionInfo().Return(execution).AnyTimes()
msCurrent.EXPECT().AddWorkflowExecutionSignaled(
attr.GetSignalName(),
attr.GetInput(),
attr.GetIdentity(),
attr.GetHeader(),
).Return(event, nil)
msCurrent.EXPECT().IsWorkflowPendingOnWorkflowTaskBackoff().Return(true)
dedupResource := definition.NewEventReappliedID(runID, event.GetEventId(), event.GetVersion())
msCurrent.EXPECT().IsResourceDuplicated(dedupResource).Return(false)
msCurrent.EXPECT().UpdateDuplicatedResource(dedupResource)
events := []*historypb.HistoryEvent{
{EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED},
event,
}
appliedEvent, err := s.nDCReapplication.ReapplyEvents(context.Background(), msCurrent, events, runID)
s.NoError(err)
s.Equal(1, len(appliedEvent))
}
func (s *nDCEventReapplicationSuite) TestReapplyEvents_Noop() {
runID := uuid.New()
event := &historypb.HistoryEvent{
EventId: 1,
EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
Attributes: &historypb.HistoryEvent_WorkflowExecutionSignaledEventAttributes{WorkflowExecutionSignaledEventAttributes: &historypb.WorkflowExecutionSignaledEventAttributes{
Identity: "test",
SignalName: "signal",
Input: payloads.EncodeBytes([]byte{}),
}},
}
msCurrent := workflow.NewMockMutableState(s.controller)
dedupResource := definition.NewEventReappliedID(runID, event.GetEventId(), event.GetVersion())
msCurrent.EXPECT().IsResourceDuplicated(dedupResource).Return(true)
events := []*historypb.HistoryEvent{
{EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED},
event,
}
appliedEvent, err := s.nDCReapplication.ReapplyEvents(context.Background(), msCurrent, events, runID)
s.NoError(err)
s.Equal(0, len(appliedEvent))
}
func (s *nDCEventReapplicationSuite) TestReapplyEvents_PartialAppliedEvent() {
runID := uuid.New()
execution := &persistencespb.WorkflowExecutionInfo{
NamespaceId: uuid.New(),
}
event1 := &historypb.HistoryEvent{
EventId: 1,
EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
Attributes: &historypb.HistoryEvent_WorkflowExecutionSignaledEventAttributes{WorkflowExecutionSignaledEventAttributes: &historypb.WorkflowExecutionSignaledEventAttributes{
Identity: "test",
SignalName: "signal",
Input: payloads.EncodeBytes([]byte{}),
Header: &commonpb.Header{Fields: map[string]*commonpb.Payload{"myheader": {Data: []byte("myheader")}}},
}},
}
event2 := &historypb.HistoryEvent{
EventId: 2,
EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
Attributes: &historypb.HistoryEvent_WorkflowExecutionSignaledEventAttributes{WorkflowExecutionSignaledEventAttributes: &historypb.WorkflowExecutionSignaledEventAttributes{
Identity: "test",
SignalName: "signal",
Input: payloads.EncodeBytes([]byte{}),
Header: &commonpb.Header{Fields: map[string]*commonpb.Payload{"myheader": {Data: []byte("myheader")}}},
}},
}
attr1 := event1.GetWorkflowExecutionSignaledEventAttributes()
msCurrent := workflow.NewMockMutableState(s.controller)
msCurrent.EXPECT().IsWorkflowExecutionRunning().Return(true)
msCurrent.EXPECT().GetLastWriteVersion().Return(int64(1), nil).AnyTimes()
msCurrent.EXPECT().GetExecutionInfo().Return(execution).AnyTimes()
msCurrent.EXPECT().AddWorkflowExecutionSignaled(
attr1.GetSignalName(),
attr1.GetInput(),
attr1.GetIdentity(),
attr1.GetHeader(),
).Return(event1, nil)
msCurrent.EXPECT().IsWorkflowPendingOnWorkflowTaskBackoff().Return(true)
dedupResource1 := definition.NewEventReappliedID(runID, event1.GetEventId(), event1.GetVersion())
msCurrent.EXPECT().IsResourceDuplicated(dedupResource1).Return(false)
dedupResource2 := definition.NewEventReappliedID(runID, event2.GetEventId(), event2.GetVersion())
msCurrent.EXPECT().IsResourceDuplicated(dedupResource2).Return(true)
msCurrent.EXPECT().UpdateDuplicatedResource(dedupResource1)
events := []*historypb.HistoryEvent{
{EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED},
event1,
event2,
}
appliedEvent, err := s.nDCReapplication.ReapplyEvents(context.Background(), msCurrent, events, runID)
s.NoError(err)
s.Equal(1, len(appliedEvent))
}
func (s *nDCEventReapplicationSuite) TestReapplyEvents_Error() {
runID := uuid.New()
execution := &persistencespb.WorkflowExecutionInfo{
NamespaceId: uuid.New(),
}
event := &historypb.HistoryEvent{
EventId: 1,
EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED,
Attributes: &historypb.HistoryEvent_WorkflowExecutionSignaledEventAttributes{WorkflowExecutionSignaledEventAttributes: &historypb.WorkflowExecutionSignaledEventAttributes{
Identity: "test",
SignalName: "signal",
Input: payloads.EncodeBytes([]byte{}),
Header: &commonpb.Header{Fields: map[string]*commonpb.Payload{"myheader": {Data: []byte("myheader")}}},
}},
}
attr := event.GetWorkflowExecutionSignaledEventAttributes()
msCurrent := workflow.NewMockMutableState(s.controller)
msCurrent.EXPECT().IsWorkflowExecutionRunning().Return(true)
msCurrent.EXPECT().GetLastWriteVersion().Return(int64(1), nil).AnyTimes()
msCurrent.EXPECT().GetExecutionInfo().Return(execution).AnyTimes()
msCurrent.EXPECT().AddWorkflowExecutionSignaled(
attr.GetSignalName(),
attr.GetInput(),
attr.GetIdentity(),
attr.GetHeader(),
).Return(nil, fmt.Errorf("test"))
dedupResource := definition.NewEventReappliedID(runID, event.GetEventId(), event.GetVersion())
msCurrent.EXPECT().IsResourceDuplicated(dedupResource).Return(false)
events := []*historypb.HistoryEvent{
{EventType: enumspb.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED},
event,
}
appliedEvent, err := s.nDCReapplication.ReapplyEvents(context.Background(), msCurrent, events, runID)
s.Error(err)
s.Equal(0, len(appliedEvent))
}