fix(diff): clear unmatching deprecated fields

pkg/diff/diff.go

@@ -14,7 +14,7 @@
 	"github.com/kong/go-database-reconciler/pkg/crud"
 	"github.com/kong/go-database-reconciler/pkg/konnect"
 	"github.com/kong/go-database-reconciler/pkg/state"
 	"github.com/kong/go-database-reconciler/pkg/types"
 	"github.com/kong/go-database-reconciler/pkg/utils"
 	"github.com/kong/go-kong/kong"
 )
@@ -612,28 +612,35 @@
 			pluginCopy := &state.Plugin{Plugin: *plugin.DeepCopy()}
 			e.Obj = pluginCopy
 
-			exists, err := utils.WorkspaceExists(ctx, sc.kongClient)
-			if err == nil && exists {
-				var schema map[string]interface{}
-				schema, err = sc.kongClient.Plugins.GetFullSchema(ctx, pluginCopy.Plugin.Name)
-				if err != nil {
-					return nil, err
-				}
+			if oldPlugin, ok := e.OldObj.(*state.Plugin); ok {
+				oldPluginCopy := &state.Plugin{Plugin: *oldPlugin.DeepCopy()}
+				e.OldObj = oldPluginCopy
+
+				if exists, _ := utils.WorkspaceExists(ctx, sc.kongClient); exists {
+					var schema map[string]interface{}
+					schema, err = sc.kongClient.Plugins.GetFullSchema(ctx, pluginCopy.Plugin.Name)
+					if err != nil {
+						return nil, err
+					}
 
-				// fill defaults and auto fields for the configuration that will be used for the diff
-				newPlugin := &pluginCopy.Plugin
-				if err := kong.FillPluginsDefaults(newPlugin, schema); err != nil {
-					return nil, fmt.Errorf("failed processing auto fields: %w", err)
-				}
+					// fill defaults and auto fields for the configuration that will be used for the diff
+					if err := kong.FillPluginsDefaults(&pluginCopy.Plugin, schema); err != nil {
+						return nil, fmt.Errorf("failed processing auto fields: %w", err)
+					}
+
+					// only fill auto fields for the configuration sent to Kong
+					// this is done because we want to avoid Kong to auto generate fields, which
+					// would make decK's configuration no longer fully "declarative"
+					if err := kong.FillPluginsDefaultsWithOpts(&plugin.Plugin, schema, kong.FillRecordOptions{
+						FillDefaults: false,
+						FillAuto:     true,
+					}); err != nil {
+						return nil, fmt.Errorf("failed processing auto fields: %w", err)
+					}
 
-				// only fill auto fields for the configuration sent to Kong
-				// this is done because we want to avoid Kong to auto generate fields, which
-				// would make decK's configuration no longer fully "declarative"
-				if err := kong.FillPluginsDefaultsWithOpts(&plugin.Plugin, schema, kong.FillRecordOptions{
-					FillDefaults: false,
-					FillAuto:     true,
-				}); err != nil {
-					return nil, fmt.Errorf("failed processing auto fields: %w", err)
+					if err := kong.ClearUnmatchingDeprecations(&pluginCopy.Plugin, &oldPluginCopy.Plugin, schema); err != nil {
+						return nil, fmt.Errorf("failed processing auto fields: %w", err)
+					}
 				}
 			}
 		}

pkg/types/plugin.go

@@ -186,6 +186,10 @@
 		return nil, fmt.Errorf("failed processing auto fields: %w", err)
 	}
 
+	if err := kong.ClearUnmatchingDeprecations(&pluginWithDefaults.Plugin, &currentPlugin.Plugin, schema); err != nil {
+		return nil, fmt.Errorf("failed clearing unmatching deprecations fields: %w", err)
+	}
+
 	if !currentPlugin.EqualWithOpts(pluginWithDefaults, false, true, false) {
 		return &crud.Event{
 			Op:     crud.Update,

tests/integration/diff_test.go

@@ -454,6 +454,190 @@ Summary:
 	"errors": []
 }
 
+`
+	expectedOutputPluginUpdateNoChange = `Summary:
+  Created: 0
+  Updated: 0
+  Deleted: 0
+`
+
+	expectedOutputPluginUpdateChangedNewFields = `updating plugin rate-limiting-advanced (global)  {
+   "config": {
+     "consumer_groups": null,
+     "dictionary_name": "kong_rate_limiting_counters",
+     "disable_penalty": false,
+     "enforce_consumer_groups": false,
+     "error_code": 429,
+     "error_message": "API rate limit exceeded",
+     "header_name": null,
+     "hide_client_headers": false,
+     "identifier": "consumer",
+     "limit": [
+       10
+     ],
+     "namespace": "ZEz47TWgUrv01HenyQBQa8io06MWsp0L",
+     "path": null,
+     "redis": {
+       "cluster_max_redirections": 5,
+       "cluster_nodes": [
+         {
+           "ip": "127.0.1.0",
+-          "port": 6379
++          "port": 7379
+         },
+         {
+           "ip": "127.0.1.0",
+-          "port": 6380
++          "port": 7380
+         },
+         {
+           "ip": "127.0.1.0",
+-          "port": 6381
++          "port": 7381
+         }
+       ],
+-      "connect_timeout": 2000,
++      "connect_timeout": 2005,
+       "connection_is_proxied": false,
+       "database": 0,
+       "host": "127.0.0.5",
+       "keepalive_backlog": null,
+       "keepalive_pool_size": 256,
+       "password": null,
+       "port": 6380,
+-      "read_timeout": 2000,
++      "read_timeout": 2006,
+-      "send_timeout": 2000,
++      "send_timeout": 2007,
+       "sentinel_master": "mymaster",
+       "sentinel_nodes": [
+         {
+           "host": "127.0.2.0",
+-          "port": 6379
++          "port": 8379
+         },
+         {
+           "host": "127.0.2.0",
+-          "port": 6380
++          "port": 8380
+         },
+         {
+           "host": "127.0.2.0",
+-          "port": 6381
++          "port": 8381
+         }
+       ],
+       "sentinel_password": null,
+       "sentinel_role": "master",
+       "sentinel_username": null,
+       "server_name": null,
+       "ssl": false,
+       "ssl_verify": false,
+       "username": null
+     },
+     "retry_after_jitter_max": 0,
+     "strategy": "redis",
+     "sync_rate": 10,
+     "window_size": [
+       60
+     ],
+     "window_type": "sliding"
+   },
+   "enabled": true,
+   "id": "a1368a28-cb5c-4eee-86d8-03a6bdf94b5e",
+   "name": "rate-limiting-advanced",
+   "protocols": [
+     "grpc",
+     "grpcs",
+     "http",
+     "https"
+   ]
+ }
+
+Summary:
+  Created: 0
+  Updated: 1
+  Deleted: 0
+`
+	expectedOutputPluginUpdateChangedOldFields = `updating plugin rate-limiting-advanced (global)  {
+   "config": {
+     "consumer_groups": null,
+     "dictionary_name": "kong_rate_limiting_counters",
+     "disable_penalty": false,
+     "enforce_consumer_groups": false,
+     "error_code": 429,
+     "error_message": "API rate limit exceeded",
+     "header_name": null,
+     "hide_client_headers": false,
+     "identifier": "consumer",
+     "limit": [
+       10
+     ],
+     "namespace": "ZEz47TWgUrv01HenyQBQa8io06MWsp0L",
+     "path": null,
+     "redis": {
+       "cluster_addresses": [
+-        "127.0.1.0:6379",
++        "127.0.1.0:7379",
+-        "127.0.1.0:6380",
++        "127.0.1.0:7380",
+-        "127.0.1.0:6381"
++        "127.0.1.0:7381"
+       ],
+       "cluster_max_redirections": 5,
+       "connect_timeout": 2000,
+       "connection_is_proxied": false,
+       "database": 0,
+       "host": "127.0.0.5",
+       "keepalive_backlog": null,
+       "keepalive_pool_size": 256,
+       "password": null,
+       "port": 6380,
+       "read_timeout": 2000,
+       "send_timeout": 2000,
+       "sentinel_addresses": [
+-        "127.0.2.0:6379",
++        "127.0.2.0:8379",
+-        "127.0.2.0:6380",
++        "127.0.2.0:8380",
+-        "127.0.2.0:6381"
++        "127.0.2.0:8381"
+       ],
+       "sentinel_master": "mymaster",
+       "sentinel_password": null,
+       "sentinel_role": "master",
+       "sentinel_username": null,
+       "server_name": null,
+       "ssl": false,
+       "ssl_verify": false,
+-      "timeout": 2000,
++      "timeout": 2007,
+       "username": null
+     },
+     "retry_after_jitter_max": 0,
+     "strategy": "redis",
+-    "sync_rate": 10,
++    "sync_rate": 11,
+     "window_size": [
+       60
+     ],
+     "window_type": "sliding"
+   },
+   "enabled": true,
+   "id": "a1368a28-cb5c-4eee-86d8-03a6bdf94b5e",
+   "name": "rate-limiting-advanced",
+   "protocols": [
+     "grpc",
+     "grpcs",
+     "http",
+     "https"
+   ]
+ }
+
+Summary:
+  Created: 0
+  Updated: 1
+  Deleted: 0
 `
 )
 
@@ -742,3 +926,56 @@ func Test_Diff_Unmasked_NewerThan3x(t *testing.T) {
 		})
 	}
 }
+
+func Test_Diff_PluginUpdate_NewerThan3x(t *testing.T) {
+	runWhenEnterpriseOrKonnect(t, ">=3.8.0")
+	setup(t)
+
+	tests := []struct {
+		name             string
+		initialStateFile string
+		stateFile        string
+		expectedDiff     string
+	}{
+		{
+			initialStateFile: "testdata/diff/004-plugin-update/initial-ee.yaml",
+			stateFile:        "testdata/diff/004-plugin-update/initial-ee.yaml",
+			expectedDiff:     expectedOutputPluginUpdateNoChange,
+		},
+		{
+			initialStateFile: "testdata/diff/004-plugin-update/initial-ee.yaml",
+			stateFile:        "testdata/diff/004-plugin-update/kong-ee-no-change-old-fields.yaml",
+			expectedDiff:     expectedOutputPluginUpdateNoChange,
+		},
+		{
+			initialStateFile: "testdata/diff/004-plugin-update/initial-ee.yaml",
+			stateFile:        "testdata/diff/004-plugin-update/kong-ee-no-change-new-fields.yaml",
+			expectedDiff:     expectedOutputPluginUpdateNoChange,
+		},
+		{
+			initialStateFile: "testdata/diff/004-plugin-update/initial-ee.yaml",
+			stateFile:        "testdata/diff/004-plugin-update/kong-ee-changed-new-fields.yaml",
+			expectedDiff:     expectedOutputPluginUpdateChangedNewFields,
+		},
+		{
+			initialStateFile: "testdata/diff/004-plugin-update/initial-ee.yaml",
+			stateFile:        "testdata/diff/004-plugin-update/kong-ee-changed-old-fields.yaml",
+			expectedDiff:     expectedOutputPluginUpdateChangedOldFields,
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			// initialize state
+			assert.NoError(t, sync(tc.initialStateFile))
+
+			fmt.Println("New stuff")
+			fmt.Println("New stuff")
+			fmt.Println("New stuff")
+			fmt.Println("New stuff")
+
+			out, err := diff(tc.stateFile)
+			assert.NoError(t, err)
+			assert.Equal(t, tc.expectedDiff, out)
+		})
+	}
+}

tests/integration/testdata/diff/004-plugin-update/initial-ee.yaml

@@ -0,0 +1,61 @@
+_format_version: "3.0"
+services:
+  - name: svc1
+    id: 9ecf5708-f2f4-444e-a4c7-fcd3a57f9a6d
+    host: mockbin.org
+    tags:
+      - test
+plugins:
+- id: a1368a28-cb5c-4eee-86d8-03a6bdf94b5e
+  enabled: true
+  name: rate-limiting-advanced
+  config:
+    consumer_groups: null
+    dictionary_name: kong_rate_limiting_counters
+    disable_penalty: false
+    enforce_consumer_groups: false
+    error_code: 429
+    error_message: API rate limit exceeded
+    header_name: null
+    hide_client_headers: false
+    identifier: consumer
+    limit:
+    - 10
+    namespace: ZEz47TWgUrv01HenyQBQa8io06MWsp0L
+    path: null
+    redis:
+      host: 127.0.0.5
+      port: 6380
+      cluster_addresses:
+      - 127.0.1.0:6379
+      - 127.0.1.0:6380
+      - 127.0.1.0:6381
+      cluster_nodes:
+      - ip: 127.0.1.0
+        port: 6379
+      - ip: 127.0.1.0
+        port: 6380
+      - ip: 127.0.1.0
+        port: 6381
+      timeout: 2000
+      connect_timeout: 2000
+      read_timeout: 2000
+      send_timeout: 2000
+      sentinel_addresses:
+      - 127.0.2.0:6379
+      - 127.0.2.0:6380
+      - 127.0.2.0:6381
+      sentinel_master: mymaster
+      sentinel_nodes:
+      - host: 127.0.2.0
+        port: 6379
+      - host: 127.0.2.0
+        port: 6380
+      - host: 127.0.2.0
+        port: 6381
+      sentinel_role: master
+    strategy: redis
+    sync_rate: 10
+    window_size:
+    - 60
+    window_type: sliding