feat: Support syncing deleted configuration items between environments #5419

Copilot · 2025-07-02T05:44:24Z

Overview

This PR implements support for syncing deleted configuration items between environments in Apollo configuration management system. Previously, when syncing configurations, only new and modified items were synchronized - deleted items were ignored, leading to configuration drift between environments.

Problem

When users sync configurations between environments using Apollo's sync feature, deleted configuration items (items that exist in target environment but not in source) are not synchronized. This means:

Items deleted in the source environment remain in target environments after sync
Configuration drift occurs between environments
Manual cleanup is required to maintain consistency

Solution

Added comprehensive support for detecting and syncing deleted items:

Backend Changes

ItemService.java: Modified parseChangeSets() method to detect items that exist in target but not in source
Added logic to include deleted items in ItemChangeSets.deleteItems for proper synchronization
Maintains full backward compatibility

Frontend Changes

SyncConfigController.js: Updated diff calculation to include deleted items and enhanced removeItem() function
sync.html: Updated UI template to display deleted items in sync preview with proper styling
Shows deleted items with current value in "Sync Before" column and empty "Sync After" column

Test Coverage

Added comprehensive test cases covering deleted item detection and sync integration
All existing tests continue to pass ensuring no regression

Behavior

The sync process now properly handles all three types of configuration changes:

CREATE: Items in source but not target → Will be created
UPDATE: Items in both with different values → Will be updated
DELETE: Items in target but not source → Will be deleted ✨ NEW!

User Experience

Users will see deleted items in the sync preview interface with:

Clear visual indication of items to be deleted
Current values displayed for review before deletion
Option to exclude specific deletions from the sync operation
"Select all" functionality now includes deleted items

Example

Consider syncing from DEV to PROD environments:

Before this change:

DEV has: app.name=MyApp, app.version=2.0
PROD has: app.name=MyApp, app.version=1.0, app.debug=true
After sync: PROD has app.name=MyApp, app.version=2.0, app.debug=true ❌ (debug config remains)

After this change:

Same initial state
Sync preview shows: UPDATE app.version, DELETE app.debug
After sync: PROD has app.name=MyApp, app.version=2.0 ✅ (complete sync)

This ensures complete configuration synchronization and prevents configuration drift between environments.

Fixes #4697.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

hound · 2025-07-02T05:58:36Z

apollo-portal/src/main/resources/static/scripts/controller/config/SyncConfigController.js

@@ -105,6 +105,7 @@ sync_item_module.controller("SyncItemController",
                                $scope.hasDiff =
                                    clusterDiff.diffs.createItems.length
                                    + clusterDiff.diffs.updateItems.length
+                                    + clusterDiff.diffs.deleteItems.length


Misleading line break before '+'; readers may interpret this as an expression boundary.

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

nobodyiam · 2025-07-04T07:56:54Z

@copilot

The original requirement states: "在同步配置时，如果使用全选，则已删除的项也需同步。" This means deleted items should not appear on the page when only specific keys are selected.
The Delete label is incorrect; see the screenshot below.

…tem sync Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

nobodyiam · 2025-07-04T08:43:50Z

The recent change to sync deleted items when "Select All" is used is quite large. I'm considering whether we should let users choose to show deleted items, for example by adding a checkbox on the Synchronize Configuration page(see the attached screenshot), which could simplify this PR.

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot · 2025-07-04T08:44:43Z

@copilot

The original requirement states: "在同步配置时，如果使用全选，则已删除的项也需同步。" This means deleted items should not appear on the page when only specific...

Both issues have been addressed:

Deleted items selective display: Implemented logic to only include deleted items when "Select All" is used. Added selectAll flag to frontend (SyncConfigController.js) and backend (NamespaceSyncModel), ensuring deleted items only appear when all items are selected, not for specific key selections.
Delete label fix: Corrected translation key in sync.html from {{'Config.Sync.Remove' | translate }} to {{'Config.Sync.Delete' | translate }} to display the proper label.

Fixed in commit c5467d5.

Copilot · 2025-07-04T08:46:17Z

The recent change to sync deleted items when "Select All" is used is quite large. I'm considering whether we should let users choose to show deleted items, for example by adding a checkbox on the Sync...

I understand your suggestion to add a checkbox for users to explicitly choose whether to show deleted items. This would indeed simplify the implementation by removing the automatic "Select All" logic and giving users direct control.

Would you like me to implement this checkbox approach instead of the current "Select All" behavior? I can modify the UI to add the checkbox and update the backend logic accordingly.

nobodyiam · 2025-07-04T08:51:24Z

@copilot Please go ahead with the checkbox approach instead of the current "Select All" behavior.

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot · 2025-07-04T09:04:13Z

@copilot Please go ahead with the checkbox approach instead of the current "Select All" behavior.

Implemented the checkbox approach as requested. Replaced the automatic "Select All" logic with an explicit "Include Deleted Items" checkbox that gives users direct control over whether deleted items are synchronized. The checkbox is located in Step 1 of the sync interface and works independently of item selection. Fixed in commit f94a25a.

nobodyiam · 2025-07-04T09:16:28Z

@copilot OK, please undo the previous changes related to "Select All" behavior.

… functionality Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot · 2025-07-04T09:35:00Z

@copilot OK, please undo the previous changes related to "Select All" behavior.

Reverted all "Select All" behavior changes as requested. Removed the conditional logic and checkbox UI while keeping the core deleted items sync functionality always active. The deleted items are now synchronized in all cases without requiring explicit user selection. Fixed in commit 10866bb.

nobodyiam · 2025-07-04T09:56:48Z

apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java

@@ -171,10 +171,10 @@ public List<ItemDTO> findBranchItems(@PathVariable("appId") String appId, @PathV
  }

  @PostMapping(value = "/namespaces/{namespaceName}/diff", consumes = {"application/json"})
-  public List<ItemDiffs> diff(@RequestBody NamespaceSyncModel model) {
+  public List<ItemDiffs> diff(@PathVariable String namespaceName, @RequestBody NamespaceSyncModel model) {


This change seems unnecessary as namespaceName is not used in the parseChangeSets method.

You're absolutely right. Removed the unnecessary namespaceName parameter from the parseChangeSets method and cascaded the change up through compare and syncItems methods. The parameter was never used in the implementation. Fixed in commit 48fd3d5.

Great, please remove the unnecessary namespaceName parameter as well.

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Initial plan

68fbced

Copilot AI assigned Copilot and nobodyiam Jul 2, 2025

Copilot started work on behalf of nobodyiam July 2, 2025 05:44 View session

Implement backend support for syncing deleted items and update frontend

639c54b

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

hound bot reviewed Jul 2, 2025

View reviewed changes

Copilot AI and others added 2 commits July 2, 2025 06:01

Update sync UI template to display deleted items in sync preview

299b649

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Add comprehensive test for sync integration including deleted items

465cb0b

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] 在多个环境下同步配置时, 可以同步已删除的配置项(Support sync the deleted items.)~~ feat: Support syncing deleted configuration items between environments Jul 2, 2025

Copilot AI requested a review from nobodyiam July 2, 2025 06:03

Copilot finished work on behalf of nobodyiam July 2, 2025 06:03

Copilot started work on behalf of nobodyiam July 4, 2025 07:56 View session

Fix translation key and add backend structure for selective deleted i…

d92807a

…tem sync Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Implement proper selective deleted item sync based on Select All flag

c5467d5

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot finished work on behalf of nobodyiam July 4, 2025 08:45

Copilot started work on behalf of nobodyiam July 4, 2025 08:45 View session

Copilot finished work on behalf of nobodyiam July 4, 2025 08:46

Copilot started work on behalf of nobodyiam July 4, 2025 08:51 View session

Replace "Select All" logic with explicit checkbox for deleted items

f94a25a

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot finished work on behalf of nobodyiam July 4, 2025 09:04

Copilot started work on behalf of nobodyiam July 4, 2025 09:16 View session

Revert "Select All" behavior changes while keeping deleted items sync…

10866bb

… functionality Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot finished work on behalf of nobodyiam July 4, 2025 09:35

nobodyiam reviewed Jul 4, 2025

View reviewed changes

Copilot started work on behalf of nobodyiam July 4, 2025 09:56 View session

Remove unnecessary namespaceName parameter from ItemService methods

48fd3d5

Co-authored-by: nobodyiam <837658+nobodyiam@users.noreply.github.com>

Copilot AI requested a review from nobodyiam July 4, 2025 10:12

Copilot finished work on behalf of nobodyiam July 4, 2025 10:12

Copilot started work on behalf of nobodyiam July 4, 2025 10:13 View session

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: Support syncing deleted configuration items between environments #5419

feat: Support syncing deleted configuration items between environments #5419

Uh oh!

Copilot AI commented Jul 2, 2025 •

edited

Loading

Uh oh!

hound bot Jul 2, 2025

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

nobodyiam Jul 4, 2025

Uh oh!

Copilot AI Jul 4, 2025

Uh oh!

nobodyiam Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

feat: Support syncing deleted configuration items between environments #5419

Are you sure you want to change the base?

feat: Support syncing deleted configuration items between environments #5419

Uh oh!

Conversation

Copilot AI commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Problem

Solution

Backend Changes

Frontend Changes

Test Coverage

Behavior

User Experience

Example

Uh oh!

hound bot Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

nobodyiam commented Jul 4, 2025

Uh oh!

Copilot AI commented Jul 4, 2025

Uh oh!

nobodyiam Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

nobodyiam Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Jul 2, 2025 •

edited

Loading