Feat/revision canonical metadata#3370
Open
Qiao-yq wants to merge 8 commits into
Open
Conversation
Add three methods to replace CRC32-based revision with MD5 over deterministic ServiceInfo serialization, aligning with Java dubbo's MetadataInfo.calAndGetRevision(). - ServiceInfo.toDescString(): deterministic string representation in format (name|group|version|protocol|port|path|params|methods), with sorted params/methods keys for stable output. - CalRevision(app, services): computes MD5 hex digest from app name concatenated with sorted ServiceInfo.toDescString() outputs. Returns 0 for empty services (matches Java EMPTY_REVISION). - MetadataInfo.CalAndGetRevision(): updates info.Revision in-place. This replaces the coarse app+path+version+port+method CRC32 approach in resolveRevision, ensuring group/protocol/params changes are captured and revision is strongly bound to the serialized MetadataInfo content.
…alculation Refactor resolveRevision to derive revision from canonical ServiceInfo objects rather than raw URLs, aligning with Java dubbo's MetadataInfo.calAndGetRevision(). Changes in service_revision_customizer.go: - resolveRevision now converts URLs to ServiceInfo via NewServiceInfoWithURL, groups by MatchKey, and delegates to info.CalRevision (MD5 over sorted toDescString) instead of CRC32-summing app+path+version+port+method. - Customizers now source URLs from instance.GetServiceMetadata() rather than the global GetMetadataService(), so each instance's revision is scoped to its own MetadataInfo. This fixes cross-test state leakage. Changes in service_revision_customizer_test.go (new, 10 cases): - Group / protocol / params / methods / version change triggers revision change - Deterministic: same input always produces same revision - Empty URL list returns 0 - Ordering-independent: URL insertion order and param key order do not affect revision - Non-IncludeKeys params are ignored
Switch the hash algorithm used in CalRevision from MD5 (32 hex chars) to SHA-512 (128 hex chars) for stronger collision resistance.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #3370 +/- ##
===========================================
+ Coverage 46.76% 52.61% +5.85%
===========================================
Files 295 492 +197
Lines 17172 37916 +20744
===========================================
+ Hits 8031 19951 +11920
- Misses 8287 16357 +8070
- Partials 854 1608 +754 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Alanxtl
reviewed
Jun 5, 2026
Contributor
Alanxtl
left a comment
Alanxtl
left a comment
There was a problem hiding this comment.
PR 描述里说 remote cache miss 会 fallback 到 provider metadata service，但代码 service_instances_changed_listener_impl.go:261-268 没有 fallback：remote metadata report 失败就直接返回 error，实例会被跳过。这个兼容性说明需要改，或者补 fallback 和端到端测试。
Contributor
|
另外pr描述里面改一下 我们没有align with java |
Environment is instance-level routing metadata (per the consumer-side comment in service_instances_changed_listener_impl.go). The consumer always overrides it from the current instance metadata, regardless of what is cached by revision. Including it in IncludeKeys caused revision to change between instances with different environment tags, producing spurious revision updates with no routing impact.
Alanxtl
reviewed
Jun 5, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates dubbo-go’s application-level metadata revision calculation to be deterministic and collision-resistant by switching from a CRC32-sum over a subset of URL fields to a canonical SHA-512 digest over a stable, sorted service description.
Changes:
- Introduce canonical
ServiceInfostring serialization and compute revision via SHA-512 overapp + sorted(services). - Rework service revision customizers to compute revision from instance-scoped
ServiceMetadataURLs rather than a globally aggregated URL set. - Add a dedicated test suite covering revision change detection and determinism across ordering and filtering cases.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| registry/servicediscovery/customizer/service_revision_customizer.go | Switch revision computation to canonical ServiceInfo + SHA-512 and use instance service metadata as the URL source. |
| registry/servicediscovery/customizer/service_revision_customizer_test.go | Add test coverage for revision determinism and change detection across key metadata dimensions. |
| metadata/info/metadata_info.go | Add canonical serialization (toDescString), SHA-512 CalRevision, and MetadataInfo.CalAndGetRevision. |
| metadata/info/metadata_info_test.go | Update expectations around instance-level params (e.g., environment) being excluded from ServiceInfo params. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #3350
Summary
Replace the CRC32-based revision calculation with a canonical SHA512-based approach.
The existing
resolveRevisionbuilds revision from a few raw URL fields (app + path + version + port + method) and sums CRC32 values — missinggroup,protocol, andparams(timeout/loadbalance/cluster/serialization, etc.), with weak collision resistance and no binding to the actual serialized metadata content.Changes
metadata/info/metadata_info.goThree new methods:
ServiceInfo.toDescString()— deterministic string representation in formatname|group|version|protocol|port|path|params|methods, with sorted params keys and sorted methods for stable output.CalRevision(app, services)— computes SHA512 hex digest fromappconcatenated with sortedServiceInfo.toDescString()outputs. Returns"0"for empty services.MetadataInfo.CalAndGetRevision()— updatesinfo.Revisionin-place from its own canonical services map.registry/servicediscovery/customizer/service_revision_customizer.goresolveRevision— rewrites the core logic: instead of CRC32‑summingapp+path+version+port+method, it converts each URL to a canonicalServiceInfoviaNewServiceInfoWithURL, groups byMatchKey, and delegates toinfo.CalRevision.instance.GetServiceMetadata()(instance‑scoped) rather thanGetMetadataService().GetExportedServiceURLs()(global aggregation). Each instance's revision now correctly reflects only its own app's metadata.registry/servicediscovery/customizer/service_revision_customizer_test.go(new)10 test cases covering:
group/protocol/params/methods/versionchange detection, deterministic output, empty input, URL ordering independence, param key ordering independence, and non‑IncludeKeysfiltering.Compatibility
The revision algorithm change is a one-time switch. On the consumer side,
GetMetadataInfo()fetches metadata by revision:remote, query the metadata center (Nacos/ZK/Etcd). Failure →skip the instance. No automatic fallback to RPC.
local, call the provider's MetadataService directly via RPC.When multiple instances share the same revision,
OnEventretries themsequentially until one succeeds. Consumers using a stale cached revision
will miss transiently, then pick up the new revision from the next
service discovery event.
Checklist
develop