Files
tasks/service/history/ndc/events_reapplier_mock.go
Dan DavisonandGitHub 2aa673b629 Prevent reapplying an update with a conflicting ID (#5833)
## What changed?
Skip reapplying an `UpdateAdmitted` event if an update with that ID
already exists.

## Why?
In a split-brain scenario it is possible for both clusters to accept an
update with the same ID. Prior to this PR, conflict resolution would
create an `UpdateAdmitted` event via a reapply, despite the fact that
the update ID conflicts with the other update. This state would not be
correct: the update registry can only hold one of them and it would not
be possible to interact with both updates (i.e. the worker will not be
able to accept/reject/complete both of them).

### Summary:
- We have a function that takes a slice of events and decides whether to
"reapply" them.
- It is called during `WorkflowReset` (might need to reapply a
signal/update in the portion of history being lost) and on conflict
resolution (might need to reapply a signal/update accepted in another
cluster during a split brain situation)
- In the conflict resolution case, there's a possibility that the
incoming accepted request might have an ID that conflicts with one
already in-flight
- But that's not possible in the reset case (the workflow state was
consistent before reset)
- So we need to check for this in the conflict resolution case at least.
That requires having access to a registry (representing the state of the
receiving branch)
- The PR passes the registry down through the stack to the reapply
function.
- Reset doesn't need the check, so we use a nil registry argument in
that case.

## How did you test it?
Test in PR simulates a split-brain situation and performs a reset to
generate the `UpdateAdmitted` event:
`TestHistoryReplicationSignalsAndUpdatesTestSuite/TestConflictResolutionReappliesUpdatesSameIds
`

## Potential risks
It could break workflow reset and history event conflict resolution if
it is not correct.

## Is hotfix candidate?
Yes, it should be included in 1.24.
2024-05-03 16:54:34 -04:00

78 lines
3.1 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.
// Code generated by MockGen. DO NOT EDIT.
// Source: events_reapplier.go
// Package ndc is a generated GoMock package.
package ndc
import (
context "context"
reflect "reflect"
gomock "github.com/golang/mock/gomock"
history "go.temporal.io/api/history/v1"
workflow "go.temporal.io/server/service/history/workflow"
update "go.temporal.io/server/service/history/workflow/update"
)
// MockEventsReapplier is a mock of EventsReapplier interface.
type MockEventsReapplier struct {
ctrl *gomock.Controller
recorder *MockEventsReapplierMockRecorder
}
// MockEventsReapplierMockRecorder is the mock recorder for MockEventsReapplier.
type MockEventsReapplierMockRecorder struct {
mock *MockEventsReapplier
}
// NewMockEventsReapplier creates a new mock instance.
func NewMockEventsReapplier(ctrl *gomock.Controller) *MockEventsReapplier {
mock := &MockEventsReapplier{ctrl: ctrl}
mock.recorder = &MockEventsReapplierMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockEventsReapplier) EXPECT() *MockEventsReapplierMockRecorder {
return m.recorder
}
// ReapplyEvents mocks base method.
func (m *MockEventsReapplier) ReapplyEvents(ctx context.Context, ms workflow.MutableState, updateRegistry update.Registry, historyEvents []*history.HistoryEvent, runID string) ([]*history.HistoryEvent, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "ReapplyEvents", ctx, ms, updateRegistry, historyEvents, runID)
ret0, _ := ret[0].([]*history.HistoryEvent)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// ReapplyEvents indicates an expected call of ReapplyEvents.
func (mr *MockEventsReapplierMockRecorder) ReapplyEvents(ctx, ms, updateRegistry, historyEvents, runID interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ReapplyEvents", reflect.TypeOf((*MockEventsReapplier)(nil).ReapplyEvents), ctx, ms, updateRegistry, historyEvents, runID)
}