milvus/internal/util/proxyutil/mock_proxy_watcher.go
yihao.dai 44d915a43b
fix: [2.5] Remove stale proxy clients on rewatch etcd (#46491)
### **User description**
AddProxyClients now removes clients not in the new snapshot before
adding new ones. This ensures proper cleanup when ProxyWatcher re-watche
etcd.

issue: https://github.com/milvus-io/milvus/issues/46397

pr: https://github.com/milvus-io/milvus/pull/46398


___

### **PR Type**
Bug fix


___

### **Description**
- Rename `AddProxyClients` to `SetProxyClients` for clearer semantics

- Implement stale client cleanup before adding new proxy clients

- Remove proxy clients not present in new etcd snapshot

- Update all callers in querycoord and rootcoord servers

- Regenerate mock files with mockery v2.53.3


___

### Diagram Walkthrough


```mermaid
flowchart LR
  A["ProxyWatcher detects<br/>etcd change"] -->|calls| B["SetProxyClients<br/>with new snapshot"]
  B -->|removes| C["Stale clients<br/>not in snapshot"]
  C -->|closes| D["Cleanup resources"]
  B -->|adds| E["New proxy clients<br/>from snapshot"]
```



<details><summary><h3>File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Bug
fix</strong></td><td><details><summary>3 files</summary><table>
<tr>
<td><strong>proxy_client_manager.go</strong><dd><code>Rename
AddProxyClients to SetProxyClients with cleanup</code>&nbsp; &nbsp;
&nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-1a13e14654661bffe70ce626777d527871fcae62361a5fc18b7dca93e66afe1e">+22/-2</a>&nbsp;
&nbsp; </td>

</tr>

<tr>
<td><strong>server.go</strong><dd><code>Update ProxyWatcher to use
SetProxyClients</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-87d7712e6df027656ba9d433fb77b702c185486130879be54204da2b8f092230">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
<td><strong>root_coord.go</strong><dd><code>Update ProxyWatcher
initialization to SetProxyClients</code>&nbsp; &nbsp; &nbsp; &nbsp;
</dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-8fab0705c4ddb5f98e5955d3c3013fa795c87237a8525e189c3296d98dcce47f">+2/-2</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

</table></details></td></tr><tr><td><strong>Tests</strong></td><td><details><summary>1
files</summary><table>
<tr>
<td><strong>proxy_client_manager_test.go</strong><dd><code>Update test
for SetProxyClients stale removal</code>&nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-fb82a84e67ec187c1bfbdc4335c18b504b2f4392758d859e54115684ea8a526d">+26/-10</a>&nbsp;
</td>

</tr>

</table></details></td></tr><tr><td><strong>Miscellaneous</strong></td><td><details><summary>7
files</summary><table>
<tr>
<td><strong>mock_proxy_client_manager.go</strong><dd><code>Regenerate
mock with SetProxyClients method</code>&nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
</dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-8cc3cfe21d2694f58ebe7f2d44e12c467d9e83ac9edb37bcb6c7262e7b2ca09d">+78/-38</a>&nbsp;
</td>

</tr>

<tr>
<td><strong>mock_proxy_watcher.go</strong><dd><code>Regenerate mock with
mockery v2.53.3</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-0c22e89cbee68c397abee52e797166fbac754b439eb1304baf53dd207e8f11d2">+9/-5</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
<td><strong>mock_global_id_allocator.go</strong><dd><code>Regenerate
mock with mockery v2.53.3</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-1822c38f0a6c4225134bee554bf518d0b9184040ea5bb3d9e926515ae80655c8">+15/-3</a>&nbsp;
&nbsp; </td>

</tr>

<tr>
<td><strong>mock_grpc_client.go</strong><dd><code>Regenerate mock with
mockery v2.53.3</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-6137f17eb7eef693d72c6181f519f7b1a87669a00f5268cbd7c3399567451e64">+33/-13</a>&nbsp;
</td>

</tr>

<tr>
<td><strong>allocator.go</strong><dd><code>Regenerate mock with mockery
v2.53.3</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-e2482bb9748ad163ba57c65251355035f45c140f12214cd96cc5da88376fcc39">+26/-6</a>&nbsp;
&nbsp; </td>

</tr>

<tr>
<td><strong>mock_factory.go</strong><dd><code>Regenerate mock with
mockery v2.53.3</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-bc91a5fcdc0bd52eaaaf805d15985fe578debbb2576eb0c97d08e0573d0132e6">+18/-2</a>&nbsp;
&nbsp; </td>

</tr>

<tr>
<td><strong>mock_session.go</strong><dd><code>Regenerate mock with
mockery v2.53.3</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></td>
<td><a
href="https://github.com/milvus-io/milvus/pull/46491/files#diff-850f08ed9571fd6f3f84bd846fa29dab2d52be7c8f9d9b358fc667c6970a90e6">+79/-19</a>&nbsp;
</td>

</tr>
</table></details></td></tr></tbody></table>

</details>

___

Signed-off-by: bigsheeper <yihao.dai@zilliz.com>
2025-12-23 21:11:19 +08:00

208 lines
6.1 KiB
Go

// Code generated by mockery v2.53.3. DO NOT EDIT.
package proxyutil
import (
context "context"
sessionutil "github.com/milvus-io/milvus/internal/util/sessionutil"
mock "github.com/stretchr/testify/mock"
)
// MockProxyWatcher is an autogenerated mock type for the ProxyWatcherInterface type
type MockProxyWatcher struct {
mock.Mock
}
type MockProxyWatcher_Expecter struct {
mock *mock.Mock
}
func (_m *MockProxyWatcher) EXPECT() *MockProxyWatcher_Expecter {
return &MockProxyWatcher_Expecter{mock: &_m.Mock}
}
// AddSessionFunc provides a mock function with given fields: fns
func (_m *MockProxyWatcher) AddSessionFunc(fns ...func(*sessionutil.Session)) {
_va := make([]interface{}, len(fns))
for _i := range fns {
_va[_i] = fns[_i]
}
var _ca []interface{}
_ca = append(_ca, _va...)
_m.Called(_ca...)
}
// MockProxyWatcher_AddSessionFunc_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddSessionFunc'
type MockProxyWatcher_AddSessionFunc_Call struct {
*mock.Call
}
// AddSessionFunc is a helper method to define mock.On call
// - fns ...func(*sessionutil.Session)
func (_e *MockProxyWatcher_Expecter) AddSessionFunc(fns ...interface{}) *MockProxyWatcher_AddSessionFunc_Call {
return &MockProxyWatcher_AddSessionFunc_Call{Call: _e.mock.On("AddSessionFunc",
append([]interface{}{}, fns...)...)}
}
func (_c *MockProxyWatcher_AddSessionFunc_Call) Run(run func(fns ...func(*sessionutil.Session))) *MockProxyWatcher_AddSessionFunc_Call {
_c.Call.Run(func(args mock.Arguments) {
variadicArgs := make([]func(*sessionutil.Session), len(args)-0)
for i, a := range args[0:] {
if a != nil {
variadicArgs[i] = a.(func(*sessionutil.Session))
}
}
run(variadicArgs...)
})
return _c
}
func (_c *MockProxyWatcher_AddSessionFunc_Call) Return() *MockProxyWatcher_AddSessionFunc_Call {
_c.Call.Return()
return _c
}
func (_c *MockProxyWatcher_AddSessionFunc_Call) RunAndReturn(run func(...func(*sessionutil.Session))) *MockProxyWatcher_AddSessionFunc_Call {
_c.Run(run)
return _c
}
// DelSessionFunc provides a mock function with given fields: fns
func (_m *MockProxyWatcher) DelSessionFunc(fns ...func(*sessionutil.Session)) {
_va := make([]interface{}, len(fns))
for _i := range fns {
_va[_i] = fns[_i]
}
var _ca []interface{}
_ca = append(_ca, _va...)
_m.Called(_ca...)
}
// MockProxyWatcher_DelSessionFunc_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'DelSessionFunc'
type MockProxyWatcher_DelSessionFunc_Call struct {
*mock.Call
}
// DelSessionFunc is a helper method to define mock.On call
// - fns ...func(*sessionutil.Session)
func (_e *MockProxyWatcher_Expecter) DelSessionFunc(fns ...interface{}) *MockProxyWatcher_DelSessionFunc_Call {
return &MockProxyWatcher_DelSessionFunc_Call{Call: _e.mock.On("DelSessionFunc",
append([]interface{}{}, fns...)...)}
}
func (_c *MockProxyWatcher_DelSessionFunc_Call) Run(run func(fns ...func(*sessionutil.Session))) *MockProxyWatcher_DelSessionFunc_Call {
_c.Call.Run(func(args mock.Arguments) {
variadicArgs := make([]func(*sessionutil.Session), len(args)-0)
for i, a := range args[0:] {
if a != nil {
variadicArgs[i] = a.(func(*sessionutil.Session))
}
}
run(variadicArgs...)
})
return _c
}
func (_c *MockProxyWatcher_DelSessionFunc_Call) Return() *MockProxyWatcher_DelSessionFunc_Call {
_c.Call.Return()
return _c
}
func (_c *MockProxyWatcher_DelSessionFunc_Call) RunAndReturn(run func(...func(*sessionutil.Session))) *MockProxyWatcher_DelSessionFunc_Call {
_c.Run(run)
return _c
}
// Stop provides a mock function with no fields
func (_m *MockProxyWatcher) Stop() {
_m.Called()
}
// MockProxyWatcher_Stop_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Stop'
type MockProxyWatcher_Stop_Call struct {
*mock.Call
}
// Stop is a helper method to define mock.On call
func (_e *MockProxyWatcher_Expecter) Stop() *MockProxyWatcher_Stop_Call {
return &MockProxyWatcher_Stop_Call{Call: _e.mock.On("Stop")}
}
func (_c *MockProxyWatcher_Stop_Call) Run(run func()) *MockProxyWatcher_Stop_Call {
_c.Call.Run(func(args mock.Arguments) {
run()
})
return _c
}
func (_c *MockProxyWatcher_Stop_Call) Return() *MockProxyWatcher_Stop_Call {
_c.Call.Return()
return _c
}
func (_c *MockProxyWatcher_Stop_Call) RunAndReturn(run func()) *MockProxyWatcher_Stop_Call {
_c.Run(run)
return _c
}
// WatchProxy provides a mock function with given fields: ctx
func (_m *MockProxyWatcher) WatchProxy(ctx context.Context) error {
ret := _m.Called(ctx)
if len(ret) == 0 {
panic("no return value specified for WatchProxy")
}
var r0 error
if rf, ok := ret.Get(0).(func(context.Context) error); ok {
r0 = rf(ctx)
} else {
r0 = ret.Error(0)
}
return r0
}
// MockProxyWatcher_WatchProxy_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'WatchProxy'
type MockProxyWatcher_WatchProxy_Call struct {
*mock.Call
}
// WatchProxy is a helper method to define mock.On call
// - ctx context.Context
func (_e *MockProxyWatcher_Expecter) WatchProxy(ctx interface{}) *MockProxyWatcher_WatchProxy_Call {
return &MockProxyWatcher_WatchProxy_Call{Call: _e.mock.On("WatchProxy", ctx)}
}
func (_c *MockProxyWatcher_WatchProxy_Call) Run(run func(ctx context.Context)) *MockProxyWatcher_WatchProxy_Call {
_c.Call.Run(func(args mock.Arguments) {
run(args[0].(context.Context))
})
return _c
}
func (_c *MockProxyWatcher_WatchProxy_Call) Return(_a0 error) *MockProxyWatcher_WatchProxy_Call {
_c.Call.Return(_a0)
return _c
}
func (_c *MockProxyWatcher_WatchProxy_Call) RunAndReturn(run func(context.Context) error) *MockProxyWatcher_WatchProxy_Call {
_c.Call.Return(run)
return _c
}
// NewMockProxyWatcher creates a new instance of MockProxyWatcher. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
// The first argument is typically a *testing.T value.
func NewMockProxyWatcher(t interface {
mock.TestingT
Cleanup(func())
}) *MockProxyWatcher {
mock := &MockProxyWatcher{}
mock.Mock.Test(t)
t.Cleanup(func() { mock.AssertExpectations(t) })
return mock
}