Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix:sync metadata cleanup with unregister lifecycle
  • Loading branch information
AsperforMias committed May 30, 2026
commit 2e69cbf6cac5844c732deaee8b703b364c2a880a
10 changes: 9 additions & 1 deletion metadata/info/metadata_info.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package info

import (
"net/url"
"slices"
"strconv"
"strings"
)
Expand Down Expand Up @@ -113,7 +114,7 @@ func addUrl(m map[string][]*common.URL, url *common.URL) {
func removeUrl(m map[string][]*common.URL, url *common.URL) {
if urls, ok := m[url.ServiceKey()]; ok {
for i, u := range urls {
if u == url {
if urlEqual(u, url) {
m[url.ServiceKey()] = deleteItem(urls, i)
break
}
Expand All @@ -124,6 +125,13 @@ func removeUrl(m map[string][]*common.URL, url *common.URL) {
}
}

func urlEqual(left, right *common.URL) bool {
if left == nil || right == nil {
return left == right
}
return left.String() == right.String() && slices.Equal(left.Methods, right.Methods)
}
Comment thread
Alanxtl marked this conversation as resolved.
Resolved

func deleteItem(slice []*common.URL, index int) []*common.URL {
copy(slice[index:], slice[index+1:])
slice = slice[:len(slice)-1]
Expand Down
19 changes: 19 additions & 0 deletions metadata/info/metadata_info_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,18 @@ func TestMetadataInfoAddService(t *testing.T) {
assert.Empty(t, metadataInfo.GetExportedServiceURLs())
}

func TestMetadataInfoRemoveServiceWithClonedURL(t *testing.T) {
metadataInfo := NewMetadataInfo("foo", "")
url, err := common.NewURL("dubbo://127.0.0.1:20000?application=foo&interface=com.foo.Bar&methods=GetPetByID%2CGetPetTypes&side=provider&version=1.0.0")
require.NoError(t, err)

metadataInfo.AddService(url)
metadataInfo.RemoveService(url.Clone())

assert.Empty(t, metadataInfo.Services)
assert.Empty(t, metadataInfo.GetExportedServiceURLs())
}

func TestHessian(t *testing.T) {
metadataInfo := &MetadataInfo{
App: "test",
Expand Down Expand Up @@ -93,6 +105,13 @@ func TestMetadataInfoAddSubscribeURL(t *testing.T) {
assert.Empty(t, info.GetSubscribedURLs())
}

func TestMetadataInfoRemoveSubscribeURLWithClonedURL(t *testing.T) {
info := NewMetadataInfo("dubbo", "tag")
info.AddSubscribeURL(serviceUrl)
info.RemoveSubscribeURL(serviceUrl.Clone())
assert.Empty(t, info.GetSubscribedURLs())
}

func TestNewMetadataInfo(t *testing.T) {
info := NewMetadataInfo("dubbo", "tag")
assert.Equal(t, "dubbo", info.App)
Expand Down
72 changes: 62 additions & 10 deletions registry/servicediscovery/service_discovery_registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ type serviceDiscoveryRegistry struct {
url *common.URL
serviceDiscovery registry.ServiceDiscovery
instances []registry.ServiceInstance
instanceURLs map[registry.ServiceInstance]*common.URL
serviceNameMapping mapping.ServiceNameMapping
metadataReport report.MetadataReport
serviceListeners map[string]registry.ServiceInstancesChangedListener
Expand All @@ -75,6 +76,7 @@ func newServiceDiscoveryRegistry(url *common.URL) (registry.Registry, error) {
return &serviceDiscoveryRegistry{
url: url,
serviceDiscovery: serviceDiscovery,
instanceURLs: make(map[registry.ServiceInstance]*common.URL),
serviceNameMapping: extension.GetGlobalServiceNameMapping(),
metadataReport: metadata.GetMetadataReportByRegistry(url.GetParam(constant.RegistryIdKey, "")),
serviceListeners: make(map[string]registry.ServiceInstancesChangedListener),
Expand Down Expand Up @@ -107,6 +109,7 @@ func (s *serviceDiscoveryRegistry) RegisterService() error {
}
s.lock.Lock()
s.instances = append(s.instances, instance)
s.instanceURLs[instance] = url
s.lock.Unlock()
}
return nil
Expand Down Expand Up @@ -147,42 +150,47 @@ func (s *serviceDiscoveryRegistry) UnRegisterService() error {
s.lock.Unlock()

var errs []error
var removed []registry.ServiceInstance
var removedURLs []*common.URL

for _, v := range origin {
if err := s.serviceDiscovery.Unregister(v); err != nil {
// fail to unregister
keep = append(keep, v)
errs = append(errs, err)
continue
}
removed = append(removed, v)
s.lock.RLock()
if sourceURL, ok := s.instanceURLs[v]; ok {
removedURLs = append(removedURLs, sourceURL)
}
s.lock.RUnlock()
}

s.lock.Lock()
s.instances = keep
for _, instance := range removed {
delete(s.instanceURLs, instance)
}
s.lock.Unlock()
if err := s.syncExportedMetadataAfterUnregister(removedURLs, keep); err != nil {
errs = append(errs, err)
}
return errors.Join(errs...)
}

func (s *serviceDiscoveryRegistry) UnRegister(url *common.URL) error {
if !shouldRegister(url) {
return nil
}
if id, exist := s.url.GetNonDefaultParam(constant.RegistryIdKey); exist {
metadata.RemoveService(id, url)
if metadataInfo := metadata.GetMetadataInfo(id); metadataInfo != nil {
instance := createInstance(metadataInfo, url)
metadataInfo.Revision = instance.GetMetadata()[constant.ExportedServicesRevisionPropertyName]
}
}
return s.UnRegisterService()
}

func (s *serviceDiscoveryRegistry) UnSubscribe(url *common.URL, listener registry.NotifyListener) error {
if !shouldSubscribe(url) {
return nil
}
if id, exist := s.url.GetNonDefaultParam(constant.RegistryIdKey); exist {
metadata.RemoveSubscribeURL(id, url)
}
services := s.getServices(url, nil)
if services == nil {
return nil
Expand All @@ -198,6 +206,50 @@ func (s *serviceDiscoveryRegistry) UnSubscribe(url *common.URL, listener registr
if err != nil {
return err
}
if id, exist := s.url.GetNonDefaultParam(constant.RegistryIdKey); exist {
metadata.RemoveSubscribeURL(id, url)
}
return nil
}

func (s *serviceDiscoveryRegistry) syncExportedMetadataAfterUnregister(removedURLs []*common.URL, keep []registry.ServiceInstance) error {
if len(removedURLs) == 0 {
return nil
}
registryID, exist := s.url.GetNonDefaultParam(constant.RegistryIdKey)
if !exist {
return nil
}
metadataInfo := metadata.GetMetadataInfo(registryID)
if metadataInfo == nil {
return nil
}
for _, removedURL := range removedURLs {
metadata.RemoveService(registryID, removedURL)
}
remainingURLs := metadataInfo.GetExportedServiceURLs()
if len(remainingURLs) == 0 {
metadataInfo.Revision = "0"
return nil
}
instance := createInstance(metadataInfo, remainingURLs[0])
revision := instance.GetMetadata()[constant.ExportedServicesRevisionPropertyName]
metadataInfo.Revision = revision
if metadata.GetMetadataType() == constant.RemoteMetadataStorageType {
if s.metadataReport == nil {
return perrors.New("can not publish app metadata cause report instance not found")
}
if err := s.metadataReport.PublishAppMetadata(metadataInfo.App, revision, metadataInfo); err != nil {
return err
}
}
for _, keepInstance := range keep {
keepInstance.SetServiceMetadata(metadataInfo)
keepInstance.GetMetadata()[constant.ExportedServicesRevisionPropertyName] = revision
if err := s.serviceDiscovery.Update(keepInstance); err != nil {
return perrors.WithMessage(err, "Update service failed")
}
}
return nil
}

Expand Down
115 changes: 107 additions & 8 deletions registry/servicediscovery/service_discovery_registry_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,38 @@ func TestServiceDiscoveryRegistryUnSubscribe(t *testing.T) {
assert.Empty(t, metaInfo.GetSubscribedURLs())
}

func TestServiceDiscoveryRegistryUnRegisterRemovesMetadataAndRefreshesRevision(t *testing.T) {
func TestServiceDiscoveryRegistryUnSubscribeKeepsMetadataOnRemoveFailure(t *testing.T) {
mockSD, mockMapping := setupEnvironment(t)
mockMapping.data[testInterface] = gxset.NewSet(testApp)
mockMapping.removeErr = errors.New("mock remove failed")
regID := fmt.Sprintf("mock-reg-%d", time.Now().UnixNano())

registryURL, _ := common.NewURL(testRegistryURL,
common.WithParamsValue(constant.RegistryKey, "mock"),
common.WithParamsValue(constant.RegistryIdKey, regID))

reg, err := newServiceDiscoveryRegistry(registryURL)
require.NoError(t, err)

consumerURL, _ := common.NewURL("dubbo://127.0.0.1:20000/",
common.WithInterface(testInterface),
common.WithParamsValue(constant.SideKey, constant.SideConsumer),
)

mockSD.wg.Add(1)
_ = reg.Subscribe(consumerURL, &mockNotifyListener{})
mockSD.wg.Wait()

metaInfo := metadata.GetMetadataInfo(regID)
require.NotNil(t, metaInfo)
require.Len(t, metaInfo.GetSubscribedURLs(), 1)

err = reg.UnSubscribe(consumerURL.Clone(), &mockNotifyListener{})
require.Error(t, err)
assert.Len(t, metaInfo.GetSubscribedURLs(), 1)
}

func TestServiceDiscoveryRegistryUnRegisterSyncsBulkMetadataCleanup(t *testing.T) {
mockSD, mockMapping := setupEnvironment(t)
regID := fmt.Sprintf("mock-reg-%d", time.Now().UnixNano())

Expand Down Expand Up @@ -200,17 +231,73 @@ func TestServiceDiscoveryRegistryUnRegisterRemovesMetadataAndRefreshesRevision(t
oldRevision := metaInfo.Revision
require.NotEmpty(t, oldRevision)

err = sdReg.UnRegister(providerURL1)
err = sdReg.UnRegister(providerURL1.Clone())
require.NoError(t, err)

assert.Empty(t, metaInfo.GetExportedServiceURLs())
assert.Empty(t, metaInfo.Services)
assert.Equal(t, "0", metaInfo.Revision)
assert.True(t, mockSD.unregisterCalled)
assert.ElementsMatch(t, []string{providerURL1.Address(), providerURL2.Address()}, mockSD.unregisterIDs)
assert.NotEqual(t, oldRevision, metaInfo.Revision)
}

func TestServiceDiscoveryRegistryUnRegisterServicePartialFailSyncsMetadata(t *testing.T) {
mockSD, mockMapping := setupEnvironment(t)
regID := fmt.Sprintf("mock-reg-%d", time.Now().UnixNano())

registryURL, err := common.NewURL(testRegistryURL,
common.WithParamsValue(constant.RegistryKey, "mock"),
common.WithParamsValue(constant.RegistryIdKey, regID))
require.NoError(t, err)

reg, err := newServiceDiscoveryRegistry(registryURL)
require.NoError(t, err)

providerURL1, err := common.NewURL("dubbo://127.0.0.1:20880/org.apache.dubbo.test.TestService",
common.WithParamsValue(constant.ApplicationKey, testApp),
common.WithInterface(testInterface),
common.WithMethods([]string{"MethodA"}),
common.WithParamsValue(constant.SideKey, constant.SideProvider),
)
require.NoError(t, err)
providerURL2, err := common.NewURL("tri://127.0.0.1:20881/org.apache.dubbo.test.TestService",
common.WithParamsValue(constant.ApplicationKey, testApp),
common.WithInterface(testInterface),
common.WithMethods([]string{"MethodB"}),
common.WithParamsValue(constant.SideKey, constant.SideProvider),
)
require.NoError(t, err)

err = reg.Register(providerURL1)
require.NoError(t, err)
err = reg.Register(providerURL2)
require.NoError(t, err)
assert.True(t, mockMapping.mapCalled)

sdReg, ok := reg.(*serviceDiscoveryRegistry)
require.True(t, ok)

err = sdReg.RegisterService()
require.NoError(t, err)

mockSD.unregisterErrByID = map[string]error{
providerURL1.Address(): errors.New("mock unregister failed"),
}

err = sdReg.UnRegisterService()
require.Error(t, err)

metaInfo := metadata.GetMetadataInfo(regID)
require.NotNil(t, metaInfo)
require.Len(t, metaInfo.GetExportedServiceURLs(), 1)
assert.Equal(t, providerURL2, metaInfo.GetExportedServiceURLs()[0])
assert.Equal(t, providerURL1, metaInfo.GetExportedServiceURLs()[0])
assert.Len(t, metaInfo.Services, 1)

expectedRevision := createInstance(metaInfo, providerURL2).GetMetadata()[constant.ExportedServicesRevisionPropertyName]
expectedRevision := createInstance(metaInfo, providerURL1).GetMetadata()[constant.ExportedServicesRevisionPropertyName]
assert.Equal(t, expectedRevision, metaInfo.Revision)
assert.NotEqual(t, oldRevision, metaInfo.Revision)
assert.True(t, mockSD.unregisterCalled)
assert.True(t, mockSD.updateCalled)
assert.Contains(t, mockSD.updatedIDs, providerURL1.Address())
}

// setupEnvironment initializes the test environment.
Expand Down Expand Up @@ -247,6 +334,8 @@ type mockServiceDiscovery struct {
unregisterCalled bool
unregisterIDs []string
unregisterErrByID map[string]error
updateCalled bool
updatedIDs []string
}

func (m *mockServiceDiscovery) String() string { return "mock" }
Expand All @@ -256,7 +345,13 @@ func (m *mockServiceDiscovery) Register(inst registry.ServiceInstance) error {
m.capturedInstance = inst
return nil
}
func (m *mockServiceDiscovery) Update(inst registry.ServiceInstance) error { return nil }
func (m *mockServiceDiscovery) Update(inst registry.ServiceInstance) error {
m.updateCalled = true
if inst != nil {
m.updatedIDs = append(m.updatedIDs, inst.GetID())
}
return nil
}
func (m *mockServiceDiscovery) Unregister(inst registry.ServiceInstance) error {
m.unregisterCalled = true
if inst != nil {
Expand Down Expand Up @@ -296,6 +391,7 @@ type mockServiceNameMapping struct {
getCalled bool
removeCalled bool
capturedGroup string
removeErr error
}

func (m *mockServiceNameMapping) Map(url *common.URL) error {
Expand All @@ -315,7 +411,10 @@ func (m *mockServiceNameMapping) Get(url *common.URL, _ mapping.MappingListener)
}
return gxset.NewSet(), nil
}
func (m *mockServiceNameMapping) Remove(url *common.URL) error { m.removeCalled = true; return nil }
func (m *mockServiceNameMapping) Remove(url *common.URL) error {
m.removeCalled = true
return m.removeErr
}

type mockNotifyListener struct{}

Expand Down
Loading