From 62b7b61cc8dd3d0858b343114088ab6e67f55832 Mon Sep 17 00:00:00 2001 From: JmPotato Date: Wed, 22 Jan 2025 10:59:40 +0800 Subject: [PATCH] Use more simple namings Signed-off-by: JmPotato --- client/clients/tso/client.go | 4 +-- client/inner_client.go | 2 +- client/servicediscovery/callbacks.go | 4 +-- .../mock_service_discovery.go | 12 ++++---- client/servicediscovery/service_discovery.go | 30 +++++++++---------- .../servicediscovery/tso_service_discovery.go | 12 ++++---- tests/integrations/client/client_test.go | 2 +- 7 files changed, 33 insertions(+), 33 deletions(-) diff --git a/client/clients/tso/client.go b/client/clients/tso/client.go index 1a101cf6b17..8af2890750e 100644 --- a/client/clients/tso/client.go +++ b/client/clients/tso/client.go @@ -116,8 +116,8 @@ func NewClient( }, } - c.svcDiscovery.ExecuteAndAddServingURLSwitchedCallback(c.updateTSOLeaderURL) - c.svcDiscovery.AddServiceURLsSwitchedCallback(c.scheduleUpdateTSOConnectionCtxs) + c.svcDiscovery.ExecAndAddLeaderSwitchedCallback(c.updateTSOLeaderURL) + c.svcDiscovery.AddMembersChangedCallback(c.scheduleUpdateTSOConnectionCtxs) return c } diff --git a/client/inner_client.go b/client/inner_client.go index da4d89908cf..de13bb324f5 100644 --- a/client/inner_client.go +++ b/client/inner_client.go @@ -189,7 +189,7 @@ func (c *innerClient) setup() error { } // Register callbacks - c.serviceDiscovery.AddServingURLSwitchedCallback(c.scheduleUpdateTokenConnection) + c.serviceDiscovery.AddLeaderSwitchedCallback(c.scheduleUpdateTokenConnection) // Create dispatchers c.createTokenDispatcher() diff --git a/client/servicediscovery/callbacks.go b/client/servicediscovery/callbacks.go index 392810c2ab3..c21217f7e44 100644 --- a/client/servicediscovery/callbacks.go +++ b/client/servicediscovery/callbacks.go @@ -47,13 +47,13 @@ func (c *serviceCallbacks) setServiceModeUpdateCallback(cb func(pdpb.ServiceMode c.serviceModeUpdateCb = cb } -func (c *serviceCallbacks) addServingURLSwitchedCallback(cb leaderSwitchedCallbackFunc) { +func (c *serviceCallbacks) addLeaderSwitchedCallback(cb leaderSwitchedCallbackFunc) { c.Lock() defer c.Unlock() c.leaderSwitchedCbs = append(c.leaderSwitchedCbs, cb) } -func (c *serviceCallbacks) addServiceURLsSwitchedCallback(cb func()) { +func (c *serviceCallbacks) addMembersChangedCallback(cb func()) { c.Lock() defer c.Unlock() c.membersChangedCbs = append(c.membersChangedCbs, cb) diff --git a/client/servicediscovery/mock_service_discovery.go b/client/servicediscovery/mock_service_discovery.go index 5e4e2654412..362626243f7 100644 --- a/client/servicediscovery/mock_service_discovery.go +++ b/client/servicediscovery/mock_service_discovery.go @@ -100,11 +100,11 @@ func (*mockServiceDiscovery) ScheduleCheckMemberChanged() {} // CheckMemberChanged implements the ServiceDiscovery interface. func (*mockServiceDiscovery) CheckMemberChanged() error { return nil } -// ExecuteAndAddServingURLSwitchedCallback implements the ServiceDiscovery interface. -func (*mockServiceDiscovery) ExecuteAndAddServingURLSwitchedCallback(leaderSwitchedCallbackFunc) {} +// ExecAndAddLeaderSwitchedCallback implements the ServiceDiscovery interface. +func (*mockServiceDiscovery) ExecAndAddLeaderSwitchedCallback(leaderSwitchedCallbackFunc) {} -// AddServingURLSwitchedCallback implements the ServiceDiscovery interface. -func (*mockServiceDiscovery) AddServingURLSwitchedCallback(leaderSwitchedCallbackFunc) {} +// AddLeaderSwitchedCallback implements the ServiceDiscovery interface. +func (*mockServiceDiscovery) AddLeaderSwitchedCallback(leaderSwitchedCallbackFunc) {} -// AddServiceURLsSwitchedCallback implements the ServiceDiscovery interface. -func (*mockServiceDiscovery) AddServiceURLsSwitchedCallback(func()) {} +// AddMembersChangedCallback implements the ServiceDiscovery interface. +func (*mockServiceDiscovery) AddMembersChangedCallback(func()) {} diff --git a/client/servicediscovery/service_discovery.go b/client/servicediscovery/service_discovery.go index 50693ff58fa..1a6b8a7043f 100644 --- a/client/servicediscovery/service_discovery.go +++ b/client/servicediscovery/service_discovery.go @@ -126,16 +126,16 @@ type ServiceDiscovery interface { // CheckMemberChanged immediately check if there is any membership change among the leader/followers // in a quorum-based cluster or among the primary/secondaries in a primary/secondary configured cluster. CheckMemberChanged() error - // ExecuteAndAddServingURLSwitchedCallback executes the callback once and adds it to the callback list then. - ExecuteAndAddServingURLSwitchedCallback(cb leaderSwitchedCallbackFunc) - // AddServingURLSwitchedCallback adds callbacks which will be called when the leader + // ExecAndAddLeaderSwitchedCallback executes the callback once and adds it to the callback list then. + ExecAndAddLeaderSwitchedCallback(cb leaderSwitchedCallbackFunc) + // AddLeaderSwitchedCallback adds callbacks which will be called when the leader // in a quorum-based cluster or the primary in a primary/secondary configured cluster // is switched. - AddServingURLSwitchedCallback(cb leaderSwitchedCallbackFunc) - // AddServiceURLsSwitchedCallback adds callbacks which will be called when any leader/follower + AddLeaderSwitchedCallback(cb leaderSwitchedCallbackFunc) + // AddMembersChangedCallback adds callbacks which will be called when any leader/follower // in a quorum-based cluster or any primary/secondary in a primary/secondary configured cluster // is changed. - AddServiceURLsSwitchedCallback(cb func()) + AddMembersChangedCallback(cb func()) } // ServiceClient is an interface that defines a set of operations for a raw PD gRPC client to specific PD server. @@ -776,8 +776,8 @@ func (c *serviceDiscovery) CheckMemberChanged() error { return c.updateMember() } -// ExecuteAndAddServingURLSwitchedCallback executes the callback once and adds it to the callback list then. -func (c *serviceDiscovery) ExecuteAndAddServingURLSwitchedCallback(callback leaderSwitchedCallbackFunc) { +// ExecAndAddLeaderSwitchedCallback executes the callback once and adds it to the callback list then. +func (c *serviceDiscovery) ExecAndAddLeaderSwitchedCallback(callback leaderSwitchedCallbackFunc) { url := c.getLeaderURL() if len(url) > 0 { if err := callback(url); err != nil { @@ -785,20 +785,20 @@ func (c *serviceDiscovery) ExecuteAndAddServingURLSwitchedCallback(callback lead zap.String("url", url), errs.ZapError(err)) } } - c.AddServingURLSwitchedCallback(callback) + c.AddLeaderSwitchedCallback(callback) } -// AddServingURLSwitchedCallback adds callbacks which will be called when the leader +// AddLeaderSwitchedCallback adds callbacks which will be called when the leader // in a quorum-based cluster or the primary in a primary/secondary configured cluster // is switched. -func (c *serviceDiscovery) AddServingURLSwitchedCallback(callback leaderSwitchedCallbackFunc) { - c.callbacks.addServingURLSwitchedCallback(callback) +func (c *serviceDiscovery) AddLeaderSwitchedCallback(callback leaderSwitchedCallbackFunc) { + c.callbacks.addLeaderSwitchedCallback(callback) } -// AddServiceURLsSwitchedCallback adds callbacks which will be called when any primary/secondary +// AddMembersChangedCallback adds callbacks which will be called when any primary/secondary // in a primary/secondary configured cluster is changed. -func (c *serviceDiscovery) AddServiceURLsSwitchedCallback(callback func()) { - c.callbacks.addServiceURLsSwitchedCallback(callback) +func (c *serviceDiscovery) AddMembersChangedCallback(callback func()) { + c.callbacks.addMembersChangedCallback(callback) } // getLeaderURL returns the leader URL. diff --git a/client/servicediscovery/tso_service_discovery.go b/client/servicediscovery/tso_service_discovery.go index d3f9a6b307a..06401427522 100644 --- a/client/servicediscovery/tso_service_discovery.go +++ b/client/servicediscovery/tso_service_discovery.go @@ -358,8 +358,8 @@ func (c *tsoServiceDiscovery) CheckMemberChanged() error { return nil } -// ExecuteAndAddServingURLSwitchedCallback executes the callback once and adds it to the callback list then. -func (c *tsoServiceDiscovery) ExecuteAndAddServingURLSwitchedCallback(callback leaderSwitchedCallbackFunc) { +// ExecAndAddLeaderSwitchedCallback executes the callback once and adds it to the callback list then. +func (c *tsoServiceDiscovery) ExecAndAddLeaderSwitchedCallback(callback leaderSwitchedCallbackFunc) { url := c.getPrimaryURL() if len(url) > 0 { if err := callback(url); err != nil { @@ -369,13 +369,13 @@ func (c *tsoServiceDiscovery) ExecuteAndAddServingURLSwitchedCallback(callback l c.tsoLeaderUpdatedCb = callback } -// AddServingURLSwitchedCallback adds callbacks which will be called when the primary in +// AddLeaderSwitchedCallback adds callbacks which will be called when the primary in // a primary/secondary configured cluster is switched. -func (*tsoServiceDiscovery) AddServingURLSwitchedCallback(leaderSwitchedCallbackFunc) {} +func (*tsoServiceDiscovery) AddLeaderSwitchedCallback(leaderSwitchedCallbackFunc) {} -// AddServiceURLsSwitchedCallback adds callbacks which will be called when any primary/secondary +// AddMembersChangedCallback adds callbacks which will be called when any primary/secondary // in a primary/secondary configured cluster is changed. -func (*tsoServiceDiscovery) AddServiceURLsSwitchedCallback(func()) {} +func (*tsoServiceDiscovery) AddMembersChangedCallback(func()) {} // GetServiceClient implements ServiceDiscovery func (c *tsoServiceDiscovery) GetServiceClient() ServiceClient { diff --git a/tests/integrations/client/client_test.go b/tests/integrations/client/client_test.go index 7351f8ee30c..af8cdc00a7e 100644 --- a/tests/integrations/client/client_test.go +++ b/tests/integrations/client/client_test.go @@ -238,7 +238,7 @@ func TestGetTSAfterTransferLeader(t *testing.T) { defer cli.Close() var leaderSwitched atomic.Bool - cli.GetServiceDiscovery().AddServingURLSwitchedCallback(func(string) error { + cli.GetServiceDiscovery().AddLeaderSwitchedCallback(func(string) error { leaderSwitched.Store(true) return nil })