Files
tasks/service/history/replication/task_fetcher_mock.go
Michael SnowdenandGitHub 34fc9286e6 Remove common.Daemon interface (#4573)
<!-- Describe what has changed in this PR -->
**What changed?**
I removed the common.Daemon interface.

<!-- Tell your future self why have you made these changes -->
**Why?**
The main reason is that it makes it nearly impossible to figure out
where a Start or Stop method of a concrete type is actually called.

Before:
<img width="1254" alt="image"
src="https://github.com/temporalio/temporal/assets/5942963/bdbe5d97-0d60-4690-a873-bf9797441284">

After:
<img width="724" alt="image"
src="https://github.com/temporalio/temporal/assets/5942963/8bdcb01a-b5e9-4ba7-8f9a-ccbc6bc6a5d9">

Conversely, it makes it harder to find the actual implementation for a
method at its callsite.

Before:
<img width="851" alt="image"
src="https://github.com/temporalio/temporal/assets/5942963/c651b90b-430c-4a93-951e-21fc26e1f309">


After:
<img width="908" alt="image"
src="https://github.com/temporalio/temporal/assets/5942963/2e877c3f-7a63-48b8-a83a-302b93be92f3">


Finally, we actually don't use this abstraction for anything. We don't
need to ever view something as an abstract background process--only fx
needs to define and consume an abstraction like that. Most of our
callsites of Start and Stop already have a more concrete type available.
It's a useful abstraction *conceptually*, but, in code, it just makes it
impossible to find where things are used or defined.

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
I verified that it's much easier to find where a Start or Stop method is
defined / called.

To write this, I removed the embedded common.Daemon from all interfaces,
looked for unresolved-reference errors, and then I added the method to
the type of whatever variable was complaining. That way, the methods are
present at the most concrete level possible, which will ensure that
there are as few choices as possible when finding references or
definitions.

<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**
Maybe we were doing something weird with reflection for this or there's
some other use case I'm unaware of.

<!-- 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-03 10:30:11 -07:00

175 lines
6.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: task_fetcher.go
// Package replication is a generated GoMock package.
package replication
import (
reflect "reflect"
gomock "github.com/golang/mock/gomock"
quotas "go.temporal.io/server/common/quotas"
)
// MockTaskFetcherFactory is a mock of TaskFetcherFactory interface.
type MockTaskFetcherFactory struct {
ctrl *gomock.Controller
recorder *MockTaskFetcherFactoryMockRecorder
}
// MockTaskFetcherFactoryMockRecorder is the mock recorder for MockTaskFetcherFactory.
type MockTaskFetcherFactoryMockRecorder struct {
mock *MockTaskFetcherFactory
}
// NewMockTaskFetcherFactory creates a new mock instance.
func NewMockTaskFetcherFactory(ctrl *gomock.Controller) *MockTaskFetcherFactory {
mock := &MockTaskFetcherFactory{ctrl: ctrl}
mock.recorder = &MockTaskFetcherFactoryMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockTaskFetcherFactory) EXPECT() *MockTaskFetcherFactoryMockRecorder {
return m.recorder
}
// GetOrCreateFetcher mocks base method.
func (m *MockTaskFetcherFactory) GetOrCreateFetcher(clusterName string) taskFetcher {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "GetOrCreateFetcher", clusterName)
ret0, _ := ret[0].(taskFetcher)
return ret0
}
// GetOrCreateFetcher indicates an expected call of GetOrCreateFetcher.
func (mr *MockTaskFetcherFactoryMockRecorder) GetOrCreateFetcher(clusterName interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetOrCreateFetcher", reflect.TypeOf((*MockTaskFetcherFactory)(nil).GetOrCreateFetcher), clusterName)
}
// Start mocks base method.
func (m *MockTaskFetcherFactory) Start() {
m.ctrl.T.Helper()
m.ctrl.Call(m, "Start")
}
// Start indicates an expected call of Start.
func (mr *MockTaskFetcherFactoryMockRecorder) Start() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Start", reflect.TypeOf((*MockTaskFetcherFactory)(nil).Start))
}
// Stop mocks base method.
func (m *MockTaskFetcherFactory) Stop() {
m.ctrl.T.Helper()
m.ctrl.Call(m, "Stop")
}
// Stop indicates an expected call of Stop.
func (mr *MockTaskFetcherFactoryMockRecorder) Stop() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Stop", reflect.TypeOf((*MockTaskFetcherFactory)(nil).Stop))
}
// MocktaskFetcher is a mock of taskFetcher interface.
type MocktaskFetcher struct {
ctrl *gomock.Controller
recorder *MocktaskFetcherMockRecorder
}
// MocktaskFetcherMockRecorder is the mock recorder for MocktaskFetcher.
type MocktaskFetcherMockRecorder struct {
mock *MocktaskFetcher
}
// NewMocktaskFetcher creates a new mock instance.
func NewMocktaskFetcher(ctrl *gomock.Controller) *MocktaskFetcher {
mock := &MocktaskFetcher{ctrl: ctrl}
mock.recorder = &MocktaskFetcherMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MocktaskFetcher) EXPECT() *MocktaskFetcherMockRecorder {
return m.recorder
}
// Stop mocks base method.
func (m *MocktaskFetcher) Stop() {
m.ctrl.T.Helper()
m.ctrl.Call(m, "Stop")
}
// Stop indicates an expected call of Stop.
func (mr *MocktaskFetcherMockRecorder) Stop() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Stop", reflect.TypeOf((*MocktaskFetcher)(nil).Stop))
}
// getRateLimiter mocks base method.
func (m *MocktaskFetcher) getRateLimiter() quotas.RateLimiter {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "getRateLimiter")
ret0, _ := ret[0].(quotas.RateLimiter)
return ret0
}
// getRateLimiter indicates an expected call of getRateLimiter.
func (mr *MocktaskFetcherMockRecorder) getRateLimiter() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "getRateLimiter", reflect.TypeOf((*MocktaskFetcher)(nil).getRateLimiter))
}
// getRequestChan mocks base method.
func (m *MocktaskFetcher) getRequestChan() chan<- *replicationTaskRequest {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "getRequestChan")
ret0, _ := ret[0].(chan<- *replicationTaskRequest)
return ret0
}
// getRequestChan indicates an expected call of getRequestChan.
func (mr *MocktaskFetcherMockRecorder) getRequestChan() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "getRequestChan", reflect.TypeOf((*MocktaskFetcher)(nil).getRequestChan))
}
// getSourceCluster mocks base method.
func (m *MocktaskFetcher) getSourceCluster() string {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "getSourceCluster")
ret0, _ := ret[0].(string)
return ret0
}
// getSourceCluster indicates an expected call of getSourceCluster.
func (mr *MocktaskFetcherMockRecorder) getSourceCluster() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "getSourceCluster", reflect.TypeOf((*MocktaskFetcher)(nil).getSourceCluster))
}