feat: Support version history for traffic rules

[mochengqian]

Closes #1473.

What this PR delivers

This PR adds version history and optimistic locking for the three governor-managed traffic rule kinds:

• Condition Route
• Tag Route
• Dynamic Config / Configurator

The scope is intentionally limited to an immutable history ledger, current-version metadata, diff support, and write preconditions. Rollback is not part of this PR. The previous rollback API/UI/proto surface was removed because rollback is deprecated and should not be implied as production-ready behavior.

User-visible behavior

• Rule detail pages can open a History drawer showing version number, source, author, timestamp, operation, and optional reason.
• A historical version can be viewed as JSON.
• A historical version can be diffed against the current version with Monaco diff.
• Existing write APIs accept optional expectedVersionId for optimistic locking.
• Concurrent edits return a 409 conflict or pending-intent response instead of silently overwriting another writer.
• Version history is disabled by default and can be enabled with ruleVersioning.enabled: true.

Backend design

Versioning is implemented on top of the existing Resource Store infrastructure, with one store per resource kind:

• RuleVersionResource: immutable version records
• RuleIntentResource: pending/applied mutation intents
• RuleMetaResource: current version pointer and monotonic version number state

The ResourceStore adapter routes these three resource kinds to separate stores. This is required by the Resource Store contract and keeps kind validation, indexes, and schemas correct.

Mutation flow

Console writes use a single authoritative commit path:

Console mutation
  1. Check expectedVersionId and open intents
  2. Create RuleIntent(PENDING)
  3. Mutate the rule through ResourceManager / governor
  4. Mark RuleIntent(APPLIED)

Versioning subscriber / repair
  1. Observe the actual rule state change
  2. Find the matching APPLIED/PENDING intent by content hash
  3. Insert exactly one RuleVersion from the actual state
  4. Update RuleMeta currentVersionId / currentVersionNo

The Console path does not synchronously insert versions. This keeps version history as a true state-change log and avoids duplicate/conflicting commit paths.

Deduplication

Deduplication only compares the new snapshot with the latest version. Consecutive duplicate events are skipped, but legitimate transitions such as A -> B -> A are preserved.

Bootstrap

When enabled, startup scans existing traffic rules and records one idempotent BOOTSTRAP baseline version per rule through the versioning store path.

API surface

Per rule kind: condition-rule, tag-rule, configurator.

GET /api/v1/{kind}/:ruleName/versions
GET /api/v1/{kind}/:ruleName/versions/:versionId
GET /api/v1/{kind}/:ruleName/versions/:versionId/diff?against=current|previous|<versionId>

Cross-cutting intent reconciliation endpoints:

POST /api/v1/rule-version-intents/:intentId/repair
POST /api/v1/rule-version-intents/:intentId/abandon
     body: { "reason": "<required>" }

Existing traffic-rule write endpoints remain backward compatible. When supplied, expectedVersionId is treated as a weak-CAS precondition against RuleMeta.currentVersionId:

PUT    /api/v1/{kind}/:ruleName?expectedVersionId=<id>
POST   /api/v1/{kind}/:ruleName?expectedVersionId=<id>
DELETE /api/v1/{kind}/:ruleName?expectedVersionId=<id>

Conflict response:

{
  "code": "VERSION_CONFLICT",
  "message": "rule version conflict",
  "currentVersionId": 123
}

Pending intent response:

{
  "code": "VERSION_LEDGER_PENDING",
  "message": "rule version intent is pending",
  "intentId": 456
}

Configuration

ruleVersioning:
  enabled: false
  maxVersionsPerRule: 5

maxVersionsPerRule controls retention per rule. Version numbers are monotonic and are not reused after trimming.

Explicitly out of scope

• Rollback / re-publish old snapshots
• AffinityRoute integration
• Non-ZK registry source labeling beyond the existing event context support
• Removing pre-existing frontend post-write sleeps
• Batch bootstrap optimization for very large installs

Validation notes

The implementation has been kept Resource Store based and avoids SQL-specific paths. Proto files are regenerated for the versioning resources.

Suggested focused validation before merge:

go test ./pkg/core/versioning/... \
        ./pkg/config/versioning/... \
        ./pkg/config/app/... \
        ./pkg/console/handler/... \
        ./pkg/console/service/...

cd ui-vue3 && npm run type-check

[Copilot]

Pull request overview

This PR introduces immutable version history, diff viewing, and rollback for governor-managed traffic rules (Condition Route, Tag Route, Dynamic Config) in Dubbo Admin, along with optimistic concurrency control to prevent silent overwrites.

Changes:

• Backend: adds a versioning subsystem (stores, service, subscriber, bootstrap, intent workflow) plus REST endpoints for listing/getting/diffing/rollback and intent repair/abandon.
• Frontend: adds shared history/diff/rollback UI components, wires them into rule pages, and threads expectedVersionId through mutations with 409 conflict handling.
• Store/core plumbing: adds ListResources() and aligns empty-index ListByIndexes semantics across memory/GORM stores.

Reviewed changes

Copilot reviewed 62 out of 62 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
ui-vue3/src/views/traffic/tagRule/tabs/updateByYAMLView.vue	Adds expectedVersionId concurrency + version-error notifications for YAML editing.
ui-vue3/src/views/traffic/tagRule/tabs/updateByFormView.vue	Threads version precondition into form updates and handles version conflicts.
ui-vue3/src/views/traffic/tagRule/tabs/formView.vue	Integrates history panel entry point and current version badge.
ui-vue3/src/views/traffic/tagRule/index.vue	Uses current version id precondition on delete and conflict notifications.
ui-vue3/src/views/traffic/routingRule/tabs/updateByYAMLView.vue	Adds expectedVersionId concurrency + version-error notifications for YAML editing.
ui-vue3/src/views/traffic/routingRule/tabs/updateByFormView.vue	Threads version precondition into form updates and handles version conflicts.
ui-vue3/src/views/traffic/routingRule/tabs/formView.vue	Integrates history panel entry point and current version badge.
ui-vue3/src/views/traffic/routingRule/index.vue	Uses current version id precondition on delete and conflict notifications.
ui-vue3/src/views/traffic/dynamicConfig/tabs/YAMLView.vue	Adds history panel + expectedVersionId concurrency for YAML-based configurator edits.
ui-vue3/src/views/traffic/dynamicConfig/tabs/formView.vue	Adds history panel + expectedVersionId concurrency for form-based configurator edits.
ui-vue3/src/views/traffic/dynamicConfig/index.vue	Uses current version id precondition on delete and conflict notifications.
ui-vue3/src/views/traffic/_shared/ruleVersion.ts	Shared helpers for fetching current version state and displaying conflict/pending notifications.
ui-vue3/src/views/traffic/_shared/RuleHistoryPanel.vue	New history panel orchestrating list/view/diff/rollback flows.
ui-vue3/src/views/traffic/_shared/RuleHistoryDrawer.vue	Drawer UI for version timeline and actions.
ui-vue3/src/views/traffic/_shared/RuleDiffEditor.vue	Monaco diff editor wrapper for version comparisons.
ui-vue3/src/mocks/handlers/tagRule.ts	MSW: simulates version conflicts/pending and records admin writes for tag rules.
ui-vue3/src/mocks/handlers/routingRule.ts	MSW: simulates version conflicts/pending and records admin writes for condition rules.
ui-vue3/src/mocks/handlers/dynamicConfig.ts	MSW: simulates version conflicts/pending and records admin writes for configurators (with URL decoding).
ui-vue3/src/mocks/handlers/ruleVersion.ts	MSW: full in-browser mock ledger + diff/rollback + intent repair/abandon flows.
ui-vue3/src/mocks/handlers.ts	Registers ruleVersion MSW handlers.
ui-vue3/src/base/http/request.ts	Suppresses generic error toasts for version conflict/pending so the dedicated notifications can be used.
ui-vue3/src/api/service/traffic.ts	Adds versioning API surface + threads expectedVersionId into existing mutations.
pkg/store/memory/store.go	Adds ListResources() with sorting and error propagation.
pkg/store/memory/store_test.go	Tests ListResources() sorting and empty-index semantics.
pkg/store/dbcommon/gorm_store.go	Adds ListResources() and aligns empty-index semantics with memory store.
pkg/store/dbcommon/gorm_store_test.go	Tests empty-index behavior and ListResources() ordering.
pkg/core/versioning/types.go	Defines version/meta/intent models, enums, and shared errors.
pkg/core/versioning/subscriber.go	Records upstream changes and attaches events to matching admin intents.
pkg/core/versioning/store.go	In-memory immutable ledger store + intent lifecycle + retention trimming + dedup.
pkg/core/versioning/store_gorm.go	GORM-backed immutable ledger store + intent lifecycle + trimming + dedup.
pkg/core/versioning/store_gorm_test.go	Tests GORM store migration, trimming, dedup, intents, and concurrency monotonicity.
pkg/core/versioning/service.go	Versioning service API: list/get/diff, expected-version check, intents, repair helpers.
pkg/core/versioning/normalize.go	Canonical JSON normalization and sha256 hashing for dedup and intent matching.
pkg/core/versioning/e2e_rollback_drill_test.go	End-to-end drill covering bootstrap, admin edit, upstream push, rollback, and retention trim.
pkg/core/versioning/component.go	Runtime component wiring: store selection, event subscriptions, startup repair/bootstrap scan.
pkg/core/store/store.go	Extends ResourceStore interface with ListResources().
pkg/core/manager/manager.go	Adds List(rk) to manager via store’s ListResources().
pkg/core/manager/manager_test.go	Verifies manager List returns sorted resources.
pkg/core/events/eventbus.go	Adds SourceRegistryContextKey and clarifies event context immutability expectations.
pkg/core/discovery/subscriber/zk_config.go	Adds ZK delete nil-guard and emits source-registry context for version attribution.
pkg/core/discovery/subscriber/zk_config_test.go	Tests delete path uses local old rule and missing-local-rule is a noop.
pkg/core/bootstrap/bootstrap.go	Registers the versioning component as an optional bootstrap component.
pkg/console/service/tag_rule.go	Wraps tag rule mutations with intent-based versioning and expectedVersionId checks.
pkg/console/service/configurator_rule.go	Wraps configurator mutations with intent-based versioning and expectedVersionId checks.
pkg/console/service/condition_rule.go	Wraps condition rule mutations with intent-based versioning and expectedVersionId checks.
pkg/console/service/rule_version.go	Adds console-layer services for version list/get/diff/rollback and intent repair/abandon.
pkg/console/service/rule_version_test.go	Covers conflict handling, pending intents, rollback paths, delete marker semantics, and intent recovery.
pkg/console/model/tag_rule.go	Exposes force and priority fields in tag rule responses.
pkg/console/model/condition_rule.go	Exposes force and priority fields in condition rule responses.
pkg/console/handler/tag_rule.go	Adds mutation options parsing and maps versioning conflicts/pending to 409.
pkg/console/handler/configurator_rule.go	Adds mutation options parsing and maps versioning conflicts/pending to 409.
pkg/console/handler/condition_rule.go	Adds mutation options parsing and maps versioning conflicts/pending to 409.
pkg/console/handler/rule_version.go	Implements versioning REST endpoints and error-to-HTTP mapping.
pkg/console/handler/rule_version_test.go	Tests status/code mapping for InvalidArgument and pending intent id propagation.
pkg/console/router/router.go	Registers versioning endpoints under the existing traffic rule routes + intent ops routes.
pkg/console/context/context.go	Exposes RuleVersioning service from the runtime component.
pkg/console/component_test.go	Ensures auth middleware blocks rollback endpoint without a session.
pkg/config/versioning/config.go	Adds versioning config block, defaults, sanitize and validation.
pkg/config/versioning/config_test.go	Tests defaults, sanitize, and validation for versioning config.
pkg/config/app/admin.go	Adds versioning config to AdminConfig and ensures defaults for nil config blocks.
pkg/config/app/admin_test.go	Tests AdminConfig defaulting behavior when Versioning config is missing.

Comments suppressed due to low confidence (1)

ui-vue3/src/views/traffic/dynamicConfig/tabs/YAMLView.vue:205

• The catch block only calls notifyRuleVersionError(...) and then swallows the exception. This can hide non-versioning failures (notably YAML parse errors from yaml.load or other runtime exceptions) because the request interceptor won’t run for those cases. Consider rethrowing or showing a generic error toast when notifyRuleVersionError returns false.

---

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

[robocanic]

感谢PR，有几个关键问题，期待后续和我讨论更好的方案：

1. 架构设计问题，为什么不把ruleVersion视为一种Resource？这样就能复用现有的Resource的链路，能减少很多重复代码且代码链路更清晰。
2. 没有任何注释，很多代码只能给AI才能读懂。
3. golang不提倡过度封装，很多宽泛的接口层没有意义。

[robocanic]

Suggestion: 不要叫Versioning，这个名字太宽泛了，用Rule来表示路由规则领域的配置，会更清晰和规范

[robocanic]

Question: 为什么要加这一行？

[robocanic]

Question: 为什么要ensureDefaults?

[robocanic]

危险操作，不应该在接口层暴露这种全扫的操作

[robocanic]

Suggestion：Golang中不提倡这种宽Service Interface接口，多这一层没有意义

[robocanic]

Suggestion：为什么不将Version作为一种Resource，复用现有的ResourceStore，ResourceManager链路呢？写了很多重复代码

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud