Skip to content

feat: complete local app metadata lifecycle - #3357

Merged
Alanxtl merged 5 commits into
apache:developfrom
AsperforMias:feat/lifecycle-metadata-app-level
May 31, 2026
Merged

Alanxtl merged 5 commits into
apache:developfrom
AsperforMias:feat/lifecycle-metadata-app-level

Conversation

@AsperforMias

Copy link
Copy Markdown
Contributor

Description

Fixes #3349 (issue)

What changed

  • added metadata.RemoveService and metadata.RemoveSubscribeURL
  • called local metadata cleanup in UnRegister and UnSubscribe
  • refreshed local exported metadata revision after provider unregister
  • added tests for unregister/unsubscribe metadata cleanup

Why

We already update local application-level metadata on register/subscribe, but the unregister/unsubscribe path does not clean it up.

That leaves stale service URLs in local MetadataInfo, and the local revision can stay behind the actual exported state.

This change keeps the existing flow as-is and only fills in the missing local cleanup path.

Checklist

  • I confirm the target branch is develop
  • Code has passed local testing
  • I have added tests that prove my fix is effective or that my feature works

@codecov-commenter

codecov-commenter commented May 30, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 75.30864% with 20 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.51%. Comparing base (60d1c2a) to head (0a53f25).
⚠️ Report is 813 commits behind head on develop.

Files with missing lines Patch % Lines
...try/servicediscovery/service_discovery_registry.go 80.00% 7 Missing and 4 partials ⚠️
metadata/info/metadata_info.go 68.75% 5 Missing ⚠️
metadata/metadata.go 60.00% 2 Missing and 2 partials ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3357      +/-   ##
===========================================
+ Coverage    46.76%   52.51%   +5.74%     
===========================================
  Files          295      492     +197     
  Lines        17172    37871   +20699     
===========================================
+ Hits          8031    19888   +11857     
- Misses        8287    16376    +8089     
- Partials       854     1607     +753     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Alanxtl Alanxtl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RemoveService / RemoveSubscribeURL 依赖底层 removeUrl 的指针相等:if u == url。如果 unregister/unsubscribe 传入的是 url.Clone() 或逻辑相同但不是同一个指针的 URL,Services 会按 match key 删除,但 exportedServiceURLs/subscribedServiceURLs 仍残留,revision 计算还会继续包含旧 URL。

相关代码在 metadata_info.go 建议按 URL key / service key + protocol + address / URLEqual 之类的逻辑相等删除,并补 clone URL 的测试。

Comment on lines +169 to +185
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)
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UnRegister(url) 现在只删当前 URL 的 metadata,但随后仍调用 bulk 的 UnRegisterService(),它会遍历并注销 s.instances 里的所有 instance。也就是说两个 provider URL 注册后,注销 providerURL1 会把 providerURL2 的 instance 也从 service discovery 删除,但本地 metadata 还保留 providerURL2。这会造成 registry 侧和本地 metadata 状态分裂。

建议要么做 targeted unregister,要么如果语义就是注销整个 app,就同步清空对应 metadata;测试里也应断言 mockSD.unregisterIDs 只包含目标 URL。

@Alanxtl

Alanxtl commented May 30, 2026

Copy link
Copy Markdown
Member
  1. UnRegister(url) 只删当前 URL 的 metadata,但后面仍然调用 UnRegisterService(),它会注销 s.instances 里的所有实例。这样会出现“metadata 只删一个,registry 注销全部”的状态不一致。

  2. RemoveService / RemoveSubscribeURL 底层是指针相等判断,url.Clone() 或逻辑相同但不是同一个指针的 URL 删不掉,旧 URL 仍会残留并参与 revision 计算。

  3. [FEATURE] Complete local lifecycle for application-level metadata / 完善应用级 metadata 本地生命周期 #3349 “删除后重新计算并发布应用级 metadata revision”,这个 PR 只刷新了本地 Revision,没有处理 remote metadata storage 下的 publish/update。

  4. cleanup 发生在实际 unregister / remove 成功之前。如果后面的 registry unregister 或 service-app mapping remove 失败,本地 metadata 已经被删了,也会造成状态不一致。

@AsperforMias

Copy link
Copy Markdown
Contributor Author

有俩问题想对齐一下您的期望:

关于 remote metadata storage 这点:

  1. 如果 unregister 之后仍然有剩余 exported services,我当前理解是:

    • 重新计算 revision
    • 重新 publish app metadata
    • 更新存活 instance 的 revision
      这个方向符合预期吗?
  2. 如果 unregister 之后 exported services 已经为空,您比较期望的是哪种?

      1. 只把本地 revision 置为 0,remote metadata 保留历史 revision 数据
      1. 仍然向 remote metadata publish 一个“空的/清空后的” MetadataInfo
      1. 需要有明确的 remote unpublish / cleanup 语义

@AsperforMias

Copy link
Copy Markdown
Contributor Author

cleanup 发生在实际 unregister / remove 成功之前。如果后面的 registry unregister 或 service-app mapping remove 失败,本地 metadata 已经被删了,也会造成状态不一致。

然后这个的话,我也想确认一下:

  1. 对于 UnSubscribe,我理解应该是:

    • 先执行 serviceNameMapping.Remove(url)
    • 只有成功后才删除本地 subscribed metadata
      这个顺序是您要的吗?
  2. 对于 provider UnRegister,当前 service discovery 这条链路还是 bulk UnRegisterService() 语义,不是 targeted unregister

    我现在的处理方向是:

    • 先执行实际 unregister
    • 只对成功 unregister 的 instances 同步做 metadata cleanup
    • 对失败保留的 instances 不改本地 metadata

    您这里期望的是哪种?:

    • A. 这样按成功结果同步 cleanup 就可以
    • B. 需要更强的一致性语义,例如出现部分失败时不更新任何 metadata

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR completes local application-level metadata cleanup for service discovery unregister/unsubscribe flows, aligning removal paths with existing register/subscribe metadata updates.

Changes:

  • Adds top-level metadata removal APIs for exported and subscribed URLs.
  • Wires unsubscribe and service unregister cleanup into service discovery registry behavior.
  • Adds tests covering unsubscribe cleanup and unregister metadata revision updates.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
metadata/metadata.go Adds public metadata removal wrappers.
metadata/metadata_test.go Adds tests for top-level remove APIs.
metadata/info/metadata_info.go Allows removing cloned/equivalent URLs instead of only identical pointers.
metadata/info/metadata_info_test.go Tests cloned URL removal behavior.
registry/servicediscovery/service_discovery_registry.go Tracks registered instance source URLs and cleans metadata during unregister/unsubscribe.
registry/servicediscovery/service_discovery_registry_test.go Adds lifecycle tests for unsubscribe and unregister metadata cleanup.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +216 to +217
if len(removedURLs) == 0 {
return nil
Comment thread metadata/metadata.go
if !exist {
return
}
metadataInfo.RemoveService(url)

@AlexStocks AlexStocks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read-only review 完成:未发现需要阻断合并的问题。

验证:

  • golangci-lint run --new-from-rev origin/develop ./...:0 issues
  • go test ./metadata/... ./registry/servicediscovery/...:通过

审查重点:本 PR 补齐 app-level metadata 在 unregister / unsubscribe 后的本地状态清理和剩余实例 revision 同步;当前新增用例覆盖 cloned URL remove、partial unregister 后 metadata 同步、bulk unregister 清理等路径,未发现新增逻辑漏洞。

@Alanxtl

Alanxtl commented May 31, 2026

Copy link
Copy Markdown
Member
  1. remote metadata storage:

    • unregister 后如果还有剩余 exported services:是的,应该重新计算 revision、publish app metadata、更新存活 instance 上的 revision。这个方向符合预期。
    • unregister 后如果 exported services 为空:我建议本 issue 里只做本地 revision 置 0,remote metadata 保留历史 revision 数据。因为没有 live instance 再引用旧 revision 了;remote unpublish / cleanup 应该放到 cleanup policy 那个独立问题里,不要在 #3349 里扩 scope。
  2. cleanup 顺序:

    • UnSubscribe:是的,先 serviceNameMapping.Remove(url),成功后再删本地 subscribed metadata。失败就保留本地 metadata。
    • provider UnRegister:我倾向选 A,也就是按实际成功结果同步 cleanup。成功 unregister 的删 metadata,失败保留的继续留在 metadata。B 的 all-or-nothing 太强,反而会让已经成功下线的 instance 继续残留 metadata。

@AsperforMias

Copy link
Copy Markdown
Contributor Author
  1. remote metadata storage:

    • unregister 后如果还有剩余 exported services:是的,应该重新计算 revision、publish app metadata、更新存活 instance 上的 revision。这个方向符合预期。
    • unregister 后如果 exported services 为空:我建议本 issue 里只做本地 revision 置 0,remote metadata 保留历史 revision 数据。因为没有 live instance 再引用旧 revision 了;remote unpublish / cleanup 应该放到 cleanup policy 那个独立问题里,不要在 #3349 里扩 scope。
  2. cleanup 顺序:

    • UnSubscribe:是的,先 serviceNameMapping.Remove(url),成功后再删本地 subscribed metadata。失败就保留本地 metadata。
    • provider UnRegister:我倾向选 A,也就是按实际成功结果同步 cleanup。成功 unregister 的删 metadata,失败保留的继续留在 metadata。B 的 all-or-nothing 太强,反而会让已经成功下线的 instance 继续残留 metadata。

已逐个自检+测试,感觉现在基本完成要求(?
叨扰您再看一下还有没有要修订的点

Comment thread metadata/info/metadata_info.go Resolved

@Alanxtl Alanxtl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool work, lgtm

@AsperforMias

Copy link
Copy Markdown
Contributor Author

cool work, lgtm

thanks for ur guide~

@sonarqubecloud

Copy link
Copy Markdown

@Alanxtl
Alanxtl merged commit 48ec2ac into apache:develop May 31, 2026
8 checks passed
@AsperforMias
AsperforMias deleted the feat/lifecycle-metadata-app-level branch May 31, 2026 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Complete local lifecycle for application-level metadata / 完善应用级 metadata 本地生命周期

5 participants