direct: Replace custom changedesc logic with settings (#4389)

denik · web-flow · commit 8a17f78a8cd0 · 2026-01-29T14:56:46.000+01:00
## Why

Replace code with configuration, less error-prone.
diff --git a/acceptance/bundle/migrate/dashboards/out.plan_after_migrate.json b/acceptance/bundle/migrate/dashboards/out.plan_after_migrate.json
@@ -29,7 +29,7 @@
         },
         "serialized_dashboard": {
           "action": "skip",
-          "reason": "custom",
+          "reason": "builtin_rule",
           "old": "{\"pages\":[{\"name\":\"02724bf2\",\"displayName\":\"Dashboard test bundle-deploy-dashboard\"}]}\n",
           "new": "{\"pages\":[{\"name\":\"02724bf2\",\"displayName\":\"Dashboard test bundle-deploy-dashboard\"}]}\n",
           "remote": "{\"pages\":[{\"displayName\":\"Dashboard test bundle-deploy-dashboard\",\"name\":\"02724bf2\",\"pageType\":\"PAGE_TYPE_CANVAS\"}]}\n"
diff --git a/acceptance/bundle/migrate/runas/out.plan.json b/acceptance/bundle/migrate/runas/out.plan.json
@@ -37,7 +37,7 @@
       "changes": {
         "run_as": {
           "action": "skip",
-          "reason": "custom",
+          "reason": "builtin_rule",
           "old": {
             "service_principal_name": "[UUID]"
           },
diff --git a/acceptance/bundle/resources/dashboards/dataset-catalog-schema/out.plan.direct.json b/acceptance/bundle/resources/dashboards/dataset-catalog-schema/out.plan.direct.json
@@ -23,13 +23,13 @@
       "changes": {
         "dataset_catalog": {
           "action": "skip",
-          "reason": "custom",
+          "reason": "builtin_rule",
           "old": "main",
           "new": "main"
         },
         "dataset_schema": {
           "action": "skip",
-          "reason": "custom",
+          "reason": "builtin_rule",
           "old": "default",
           "new": "default"
         },
diff --git a/acceptance/bundle/resources/dashboards/detect-change/out.plan.direct.json b/acceptance/bundle/resources/dashboards/detect-change/out.plan.direct.json
@@ -38,7 +38,7 @@
         },
         "serialized_dashboard": {
           "action": "skip",
-          "reason": "custom",
+          "reason": "builtin_rule",
           "old": "{\n  \"pages\": [\n    {\n      \"displayName\": \"New Page\",\n      \"layout\": [\n        {\n          \"position\": {\n            \"height\": 2,\n            \"width\": 6,\n            \"x\": 0,\n            \"y\": 0\n          },\n          \"widget\": {\n            \"name\": \"82eb9107\",\n            \"textbox_spec\": \"# I'm a title\"\n          }\n        },\n        {\n          \"position\": {\n            \"height\": 2,\n            \"width\": 6,\n            \"x\": 0,\n            \"y\": 2\n          },\n          \"widget\": {\n            \"name\": \"ffa6de4f\",\n            \"textbox_spec\": \"Text\"\n          }\n        }\n      ],\n      \"name\": \"fdd21a3c\"\n    }\n  ]\n}\n",
           "new": "{\n  \"pages\": [\n    {\n      \"displayName\": \"New Page\",\n      \"layout\": [\n        {\n          \"position\": {\n            \"height\": 2,\n            \"width\": 6,\n            \"x\": 0,\n            \"y\": 0\n          },\n          \"widget\": {\n            \"name\": \"82eb9107\",\n            \"textbox_spec\": \"# I'm a title\"\n          }\n        },\n        {\n          \"position\": {\n            \"height\": 2,\n            \"width\": 6,\n            \"x\": 0,\n            \"y\": 2\n          },\n          \"widget\": {\n            \"name\": \"ffa6de4f\",\n            \"textbox_spec\": \"Text\"\n          }\n        }\n      ],\n      \"name\": \"fdd21a3c\"\n    }\n  ]\n}\n",
           "remote": "{}\n"
diff --git a/acceptance/bundle/resources/dashboards/simple/out.plan.direct.json b/acceptance/bundle/resources/dashboards/simple/out.plan.direct.json
@@ -29,7 +29,7 @@
         },
         "serialized_dashboard": {
           "action": "skip",
-          "reason": "custom",
+          "reason": "builtin_rule",
           "old": "{ }\n",
           "new": "{ }\n",
           "remote": "{}\n"
diff --git a/acceptance/bundle/resources/dashboards/unpublish-out-of-band/out.plan.direct.json b/acceptance/bundle/resources/dashboards/unpublish-out-of-band/out.plan.direct.json
@@ -45,7 +45,7 @@
         },
         "serialized_dashboard": {
           "action": "skip",
-          "reason": "custom",
+          "reason": "builtin_rule",
           "old": "{\"pages\":[{\"displayName\":\"Test Dashboard\",\"name\":\"test-page\"}]}",
           "new": "{\"pages\":[{\"displayName\":\"Test Dashboard\",\"name\":\"test-page\"}]}",
           "remote": "{\"pages\":[{\"displayName\":\"Test Dashboard\",\"name\":\"test-page\",\"pageType\":\"PAGE_TYPE_CANVAS\"}]}"
diff --git a/acceptance/bundle/resources/quality_monitors/change_assets_dir/out.plan.direct.json b/acceptance/bundle/resources/quality_monitors/change_assets_dir/out.plan.direct.json
@@ -38,7 +38,7 @@
         },
         "warehouse_id": {
           "action": "skip",
-          "reason": "config_only",
+          "reason": "builtin_rule",
           "old": "[TEST_DEFAULT_WAREHOUSE_ID]",
           "new": "[TEST_DEFAULT_WAREHOUSE_ID]"
         }
diff --git a/acceptance/bundle/resources/quality_monitors/change_output_schema_name/out.plan.direct.json b/acceptance/bundle/resources/quality_monitors/change_output_schema_name/out.plan.direct.json
@@ -35,7 +35,7 @@
         },
         "warehouse_id": {
           "action": "skip",
-          "reason": "config_only",
+          "reason": "builtin_rule",
           "old": "[TEST_DEFAULT_WAREHOUSE_ID]",
           "new": "[TEST_DEFAULT_WAREHOUSE_ID]"
         }
diff --git a/acceptance/bundle/resources/quality_monitors/change_table_name/out.plan.direct.json b/acceptance/bundle/resources/quality_monitors/change_table_name/out.plan.direct.json
@@ -38,7 +38,7 @@
         },
         "warehouse_id": {
           "action": "skip",
-          "reason": "config_only",
+          "reason": "builtin_rule",
           "old": "[TEST_DEFAULT_WAREHOUSE_ID]",
           "new": "[TEST_DEFAULT_WAREHOUSE_ID]"
         }
diff --git a/acceptance/bundle/resources/quality_monitors/create/out.plan_noop.direct.json b/acceptance/bundle/resources/quality_monitors/create/out.plan_noop.direct.json
@@ -20,7 +20,7 @@
       "changes": {
         "warehouse_id": {
           "action": "skip",
-          "reason": "config_only",
+          "reason": "builtin_rule",
           "old": "[TEST_DEFAULT_WAREHOUSE_ID]",
           "new": "[TEST_DEFAULT_WAREHOUSE_ID]"
         }
diff --git a/bundle/direct/dresources/cluster.go b/bundle/direct/dresources/cluster.go
@@ -122,7 +122,8 @@ func (r *ResourceCluster) DoDelete(ctx context.Context, id string) error {
 }
 
 func (r *ResourceCluster) OverrideChangeDesc(ctx context.Context, p *structpath.PathNode, change *ChangeDesc, remoteState *compute.ClusterDetails) error {
-	if change.Action == deployplan.Skip {
+	// We're only interested in downgrading some updates to skips. Changes that already skipped or cause recreation should remain unchanged.
+	if change.Action != deployplan.Update {
 		return nil
 	}
 
diff --git a/bundle/direct/dresources/dashboard.go b/bundle/direct/dresources/dashboard.go
@@ -373,20 +373,6 @@ func (r *ResourceDashboard) OverrideChangeDesc(_ context.Context, path *structpa
 		} else {
 			change.Action = deployplan.Update
 		}
-	case "parent_path":
-		if change.Action == deployplan.Update {
-			change.Action = deployplan.Recreate
-		}
-	case "serialized_dashboard", "dataset_catalog", "dataset_schema":
-		// "serialized_dashboard" locally and remotely will have different diffs.
-		// We only need to rely on etag here, and can skip this field for diff computation.
-
-		// "dataset_catalog" and "dataset_schema" are write-only fields that are not returned by the server.
-		// They will always differ between local config (which has values) and remote state (which has empty strings),
-		// so we skip them for remote diff computation to avoid false positives.
-		if change.Old == change.New {
-			change.Action = deployplan.Skip
-		}
 	}
 
 	return nil
diff --git a/bundle/direct/dresources/pipeline.go b/bundle/direct/dresources/pipeline.go
@@ -4,9 +4,6 @@ import (
 	"context"
 
 	"github.com/databricks/cli/bundle/config/resources"
-	"github.com/databricks/cli/bundle/deployplan"
-	"github.com/databricks/cli/libs/structs/structdiff"
-	"github.com/databricks/cli/libs/structs/structpath"
 	"github.com/databricks/cli/libs/utils"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/service/pipelines"
@@ -122,16 +119,6 @@ func (r *ResourcePipeline) DoDelete(ctx context.Context, id string) error {
 	return r.client.Pipelines.DeleteByPipelineId(ctx, id)
 }
 
-func (*ResourcePipeline) OverrideChangeDesc(ctx context.Context, path *structpath.PathNode, ch *ChangeDesc, _ *pipelines.GetPipelineResponse) error {
-	if path.String() == "run_as" {
-		if structdiff.IsEqual(ch.Old, ch.New) {
-			ch.Action = deployplan.Skip
-		}
-	}
-
-	return nil
-}
-
 // Note, terraform provider either
 // a) reads back state at least once and fails create if state is "failed"
 // b) repeatededly reads state until state is "running" (if spec.Contionous is set).
diff --git a/bundle/direct/dresources/quality_monitor.go b/bundle/direct/dresources/quality_monitor.go
@@ -4,8 +4,6 @@ import (
 	"context"
 
 	"github.com/databricks/cli/bundle/config/resources"
-	"github.com/databricks/cli/bundle/deployplan"
-	"github.com/databricks/cli/libs/structs/structpath"
 	"github.com/databricks/cli/libs/utils"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
@@ -115,11 +113,3 @@ func (r *ResourceQualityMonitor) DoDelete(ctx context.Context, id string) error
 	})
 	return err
 }
-
-func (r *ResourceQualityMonitor) OverrideChangeDesc(_ context.Context, path *structpath.PathNode, change *ChangeDesc, _ *catalog.MonitorInfo) error {
-	if path.String() == "warehouse_id" && change.Old == change.New {
-		change.Action = deployplan.Skip
-		change.Reason = deployplan.ReasonConfigOnly
-	}
-	return nil
-}
diff --git a/bundle/direct/dresources/resources.yml b/bundle/direct/dresources/resources.yml
@@ -15,6 +15,8 @@ resources:
       - storage
       - ingestion_definition.connection_name
       - ingestion_definition.ingestion_gateway_id
+    ignore_remote_changes:
+      - run_as
 
   models:
     recreate_on_changes:
@@ -67,6 +69,8 @@ resources:
     recreate_on_changes:
       - assets_dir
       - table_name
+    ignore_remote_changes:
+      - warehouse_id
 
   schemas:
     recreate_on_changes:
@@ -85,7 +89,19 @@ resources:
 
   # clusters: no special config
 
-  # dashboards: no special config
+  dashboards:
+    recreate_on_changes:
+      - parent_path
+
+    ignore_remote_changes:
+      # "serialized_dashboard" locally and remotely will have different contents
+      # We only need to rely on etag here, and can skip this field for diff computation.
+      - serialized_dashboard
+
+      # "dataset_catalog" and "dataset_schema" are write-only fields that are not returned by the server.
+      # They will always differ between local config (which has values) and remote state (which has empty strings).
+      - dataset_catalog
+      - dataset_schema
 
   apps:
     recreate_on_changes:

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`},`
`39`	`39`	`"warehouse_id": {`
`40`	`40`	`"action": "skip",`
`41`		`- "reason": "config_only",`
	`41`	`+ "reason": "builtin_rule",`
`42`	`42`	`"old": "[TEST_DEFAULT_WAREHOUSE_ID]",`
`43`	`43`	`"new": "[TEST_DEFAULT_WAREHOUSE_ID]"`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@`
`35`	`35`	`},`
`36`	`36`	`"warehouse_id": {`
`37`	`37`	`"action": "skip",`
`38`		`- "reason": "config_only",`
	`38`	`+ "reason": "builtin_rule",`
`39`	`39`	`"old": "[TEST_DEFAULT_WAREHOUSE_ID]",`
`40`	`40`	`"new": "[TEST_DEFAULT_WAREHOUSE_ID]"`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`"changes": {`
`21`	`21`	`"warehouse_id": {`
`22`	`22`	`"action": "skip",`
`23`		`- "reason": "config_only",`
	`23`	`+ "reason": "builtin_rule",`
`24`	`24`	`"old": "[TEST_DEFAULT_WAREHOUSE_ID]",`
`25`	`25`	`"new": "[TEST_DEFAULT_WAREHOUSE_ID]"`
`26`	`26`	`}`