Files
tasks/common/membership/interfaces_mock.go
Alfred LandrumandGitHub ea684b1e4a move ringpop start call to service start (#4510)
<!-- Describe what has changed in this PR -->
**What changed?**
This moves the membership monitor Start call from a fx lifecycle hook to
each individual service's start method.

Note: this is on top of https://github.com/temporalio/temporal/pull/4506
, which is needed so that services can still get the hostinfo (server
address) to use when they, eg, initialize their service tagged loggers.

<!-- Tell your future self why have you made these changes -->
**Why?**
In short, because a service instance shouldn't join ringpop, and hence
begin to have requests forwarded to it, until it is ready to receive
them. In internal testing, focusing on the impact of history service
restarts/upgrades, we've seen requests suffer unnecessary delay because
they were forwarded to a new history pod before it began accepting on
its announced service address.

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
This has been tested in a staging environment, and for each service
(listener, matching, history, worker), scaling up & down pod counts,
including to/from zero.

~~Note that with this change, the history service currently generates
errors at startup as it attempts lookups during its fx start sequence
(inside controller_impl.go), but it will acquire shards as expected.
I'll address the error logs in a quick followup PR.~~ (I addressed this
in this PR.)

<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**
If there's a condition that we haven't seen in testing that causes
services to lookup ringpop information during fx start time, they'll see
errors in places that haven't before. That could manifest as services
failing to start up, or failing to take on work as quickly as they had.

<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
No.
2023-07-06 06:51:54 -07:00

274 lines
9.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.
// Code generated by MockGen. DO NOT EDIT.
// Source: interfaces.go
// Package membership is a generated GoMock package.
package membership
import (
context "context"
reflect "reflect"
gomock "github.com/golang/mock/gomock"
primitives "go.temporal.io/server/common/primitives"
)
// MockMonitor is a mock of Monitor interface.
type MockMonitor struct {
ctrl *gomock.Controller
recorder *MockMonitorMockRecorder
}
// MockMonitorMockRecorder is the mock recorder for MockMonitor.
type MockMonitorMockRecorder struct {
mock *MockMonitor
}
// NewMockMonitor creates a new mock instance.
func NewMockMonitor(ctrl *gomock.Controller) *MockMonitor {
mock := &MockMonitor{ctrl: ctrl}
mock.recorder = &MockMonitorMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockMonitor) EXPECT() *MockMonitorMockRecorder {
return m.recorder
}
// EvictSelf mocks base method.
func (m *MockMonitor) EvictSelf() error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "EvictSelf")
ret0, _ := ret[0].(error)
return ret0
}
// EvictSelf indicates an expected call of EvictSelf.
func (mr *MockMonitorMockRecorder) EvictSelf() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "EvictSelf", reflect.TypeOf((*MockMonitor)(nil).EvictSelf))
}
// GetReachableMembers mocks base method.
func (m *MockMonitor) GetReachableMembers() ([]string, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "GetReachableMembers")
ret0, _ := ret[0].([]string)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// GetReachableMembers indicates an expected call of GetReachableMembers.
func (mr *MockMonitorMockRecorder) GetReachableMembers() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetReachableMembers", reflect.TypeOf((*MockMonitor)(nil).GetReachableMembers))
}
// GetResolver mocks base method.
func (m *MockMonitor) GetResolver(service primitives.ServiceName) (ServiceResolver, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "GetResolver", service)
ret0, _ := ret[0].(ServiceResolver)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// GetResolver indicates an expected call of GetResolver.
func (mr *MockMonitorMockRecorder) GetResolver(service interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetResolver", reflect.TypeOf((*MockMonitor)(nil).GetResolver), service)
}
// Start mocks base method.
func (m *MockMonitor) Start() {
m.ctrl.T.Helper()
m.ctrl.Call(m, "Start")
}
// Start indicates an expected call of Start.
func (mr *MockMonitorMockRecorder) Start() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Start", reflect.TypeOf((*MockMonitor)(nil).Start))
}
// WaitUntilInitialized mocks base method.
func (m *MockMonitor) WaitUntilInitialized(arg0 context.Context) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "WaitUntilInitialized", arg0)
ret0, _ := ret[0].(error)
return ret0
}
// WaitUntilInitialized indicates an expected call of WaitUntilInitialized.
func (mr *MockMonitorMockRecorder) WaitUntilInitialized(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "WaitUntilInitialized", reflect.TypeOf((*MockMonitor)(nil).WaitUntilInitialized), arg0)
}
// MockServiceResolver is a mock of ServiceResolver interface.
type MockServiceResolver struct {
ctrl *gomock.Controller
recorder *MockServiceResolverMockRecorder
}
// MockServiceResolverMockRecorder is the mock recorder for MockServiceResolver.
type MockServiceResolverMockRecorder struct {
mock *MockServiceResolver
}
// NewMockServiceResolver creates a new mock instance.
func NewMockServiceResolver(ctrl *gomock.Controller) *MockServiceResolver {
mock := &MockServiceResolver{ctrl: ctrl}
mock.recorder = &MockServiceResolverMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockServiceResolver) EXPECT() *MockServiceResolverMockRecorder {
return m.recorder
}
// AddListener mocks base method.
func (m *MockServiceResolver) AddListener(name string, notifyChannel chan<- *ChangedEvent) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "AddListener", name, notifyChannel)
ret0, _ := ret[0].(error)
return ret0
}
// AddListener indicates an expected call of AddListener.
func (mr *MockServiceResolverMockRecorder) AddListener(name, notifyChannel interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddListener", reflect.TypeOf((*MockServiceResolver)(nil).AddListener), name, notifyChannel)
}
// Lookup mocks base method.
func (m *MockServiceResolver) Lookup(key string) (HostInfo, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "Lookup", key)
ret0, _ := ret[0].(HostInfo)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// Lookup indicates an expected call of Lookup.
func (mr *MockServiceResolverMockRecorder) Lookup(key interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Lookup", reflect.TypeOf((*MockServiceResolver)(nil).Lookup), key)
}
// MemberCount mocks base method.
func (m *MockServiceResolver) MemberCount() int {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "MemberCount")
ret0, _ := ret[0].(int)
return ret0
}
// MemberCount indicates an expected call of MemberCount.
func (mr *MockServiceResolverMockRecorder) MemberCount() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "MemberCount", reflect.TypeOf((*MockServiceResolver)(nil).MemberCount))
}
// Members mocks base method.
func (m *MockServiceResolver) Members() []HostInfo {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "Members")
ret0, _ := ret[0].([]HostInfo)
return ret0
}
// Members indicates an expected call of Members.
func (mr *MockServiceResolverMockRecorder) Members() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Members", reflect.TypeOf((*MockServiceResolver)(nil).Members))
}
// RemoveListener mocks base method.
func (m *MockServiceResolver) RemoveListener(name string) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "RemoveListener", name)
ret0, _ := ret[0].(error)
return ret0
}
// RemoveListener indicates an expected call of RemoveListener.
func (mr *MockServiceResolverMockRecorder) RemoveListener(name interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RemoveListener", reflect.TypeOf((*MockServiceResolver)(nil).RemoveListener), name)
}
// RequestRefresh mocks base method.
func (m *MockServiceResolver) RequestRefresh() {
m.ctrl.T.Helper()
m.ctrl.Call(m, "RequestRefresh")
}
// RequestRefresh indicates an expected call of RequestRefresh.
func (mr *MockServiceResolverMockRecorder) RequestRefresh() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RequestRefresh", reflect.TypeOf((*MockServiceResolver)(nil).RequestRefresh))
}
// MockHostInfoProvider is a mock of HostInfoProvider interface.
type MockHostInfoProvider struct {
ctrl *gomock.Controller
recorder *MockHostInfoProviderMockRecorder
}
// MockHostInfoProviderMockRecorder is the mock recorder for MockHostInfoProvider.
type MockHostInfoProviderMockRecorder struct {
mock *MockHostInfoProvider
}
// NewMockHostInfoProvider creates a new mock instance.
func NewMockHostInfoProvider(ctrl *gomock.Controller) *MockHostInfoProvider {
mock := &MockHostInfoProvider{ctrl: ctrl}
mock.recorder = &MockHostInfoProviderMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockHostInfoProvider) EXPECT() *MockHostInfoProviderMockRecorder {
return m.recorder
}
// HostInfo mocks base method.
func (m *MockHostInfoProvider) HostInfo() HostInfo {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "HostInfo")
ret0, _ := ret[0].(HostInfo)
return ret0
}
// HostInfo indicates an expected call of HostInfo.
func (mr *MockHostInfoProviderMockRecorder) HostInfo() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "HostInfo", reflect.TypeOf((*MockHostInfoProvider)(nil).HostInfo))
}