direct: save state before publishing dashboard; add acceptance tests

denik · denik · commit 9f7fc23c5e2e · 2026-06-02T20:58:56.000+02:00
dashboard.DoCreate now calls engine.SaveState immediately after the
dashboard is created (with etag persisted), before publishDashboard.
A failed publish leaves the draft tracked in state rather than
orphaned; the next deploy finds it via DoRead and re-publishes via
DoUpdate without recreating the dashboard.

The old trash-on-publish-failure cleanup is removed — it was a
fragile workaround for the lack of state persistence and is now
unnecessary.

Acceptance tests:
- publish-failure-cleans-up-dashboard: updated to reflect the new
  behavior per engine (direct: draft persists with URL; terraform:
  existing behavior, cleaned up). Output files split to per-engine
  variants (out.summary.*.txt, out.dashboardrequests.*.txt).
- publish-failure-retry (new, direct only): verifies end-to-end that
  a transient publish failure leaves the draft in state (summary shows
  URL, plan detects diff), and the subsequent deploy re-publishes
  without issuing a CREATE call.

Co-authored-by: Denis Bilenko
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.dashboardrequests.direct.txt b/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.dashboardrequests.direct.txt
@@ -0,0 +1,39 @@
+{
+  "method": "POST",
+  "path": "/api/2.0/workspace/mkdirs",
+  "body": {
+    "path": "/Workspace/Users/[USERNAME]/.bundle/publish-failure-cleans-up-dashboard/default/artifacts/.internal"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/workspace/mkdirs",
+  "body": {
+    "path": "/Workspace/Users/[USERNAME]/.bundle/publish-failure-cleans-up-dashboard/default/files"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/workspace/mkdirs",
+  "body": {
+    "path": "/Workspace/Users/[USERNAME]/.bundle/publish-failure-cleans-up-dashboard/default/resources"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards",
+  "body": {
+    "display_name": "my dashboard",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/publish-failure-cleans-up-dashboard/default/resources",
+    "serialized_dashboard": "{\"pages\":[{\"name\":\"test-page\",\"displayName\":\"Test Dashboard\"}]}\n",
+    "warehouse_id": "doesnotexist"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]/published",
+  "body": {
+    "embed_credentials": false,
+    "warehouse_id": "doesnotexist"
+  }
+}
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.dashboardrequests.terraform.txt b/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.dashboardrequests.terraform.txt
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.deploy.direct.txt b/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.deploy.direct.txt
@@ -9,5 +9,6 @@ HTTP Status: 400 Bad Request
 API error_code: RESOURCE_DOES_NOT_EXIST
 API message: Warehouse doesnotexist does not exist
 
+Updating deployment state...
 
 Exit code: 1
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.summary.direct.txt b/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.summary.direct.txt
@@ -0,0 +1,12 @@
+
+>>> [CLI] bundle summary
+Name: publish-failure-cleans-up-dashboard
+Target: default
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/publish-failure-cleans-up-dashboard/default
+Resources:
+  Dashboards:
+    dashboard1:
+      Name: my dashboard
+      URL:  [DATABRICKS_URL]/dashboardsv3/[DASHBOARD_ID]/published?o=[NUMID]
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.summary.terraform.txt b/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/out.summary.terraform.txt
@@ -0,0 +1,12 @@
+
+>>> [CLI] bundle summary
+Name: publish-failure-cleans-up-dashboard
+Target: default
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/publish-failure-cleans-up-dashboard/default
+Resources:
+  Dashboards:
+    dashboard1:
+      Name: my dashboard
+      URL:  (not deployed)
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/output.txt b/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/output.txt
@@ -1,12 +0,0 @@
-
->>> [CLI] bundle summary
-Name: publish-failure-cleans-up-dashboard
-Target: default
-Workspace:
-  User: [USERNAME]
-  Path: /Workspace/Users/[USERNAME]/.bundle/publish-failure-cleans-up-dashboard/default
-Resources:
-  Dashboards:
-    dashboard1:
-      Name: my dashboard
-      URL:  (not deployed)
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/script b/acceptance/bundle/resources/dashboards/publish-failure-cleans-up-dashboard/script
@@ -4,9 +4,9 @@ envsubst < databricks.yml.tmpl > databricks.yml
 # Deploy the dashboard. The dashboard will be created but publish will fail because the warehouse does not exist.
 errcode trace $CLI bundle deploy &> out.deploy.$DATABRICKS_BUNDLE_ENGINE.txt
 
-trace $CLI bundle summary
+# After publish failure the dashboard draft should be in state (direct) or cleaned up (terraform).
+trace $CLI bundle summary &>> out.summary.$DATABRICKS_BUNDLE_ENGINE.txt
 
-# API should record a DELETE call to clean up the draft dashboard that was not published.
-# Request sequence is identical across terraform and direct modes.
+# API request sequence differs between engines (direct: no DELETE; terraform: DELETE to clean up).
 unset MSYS_NO_PATHCONV
-print_requests.py //lakeview/dashboards //workspace/mkdirs > out.dashboardrequests.txt
+print_requests.py //lakeview/dashboards //workspace/mkdirs > out.dashboardrequests.$DATABRICKS_BUNDLE_ENGINE.txt
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-retry/dashboard.lvdash.json b/acceptance/bundle/resources/dashboards/publish-failure-retry/dashboard.lvdash.json
@@ -0,0 +1 @@
+{"pages":[{"name":"test-page","displayName":"Test Dashboard"}]}
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-retry/databricks.yml.tmpl b/acceptance/bundle/resources/dashboards/publish-failure-retry/databricks.yml.tmpl
@@ -0,0 +1,9 @@
+bundle:
+  name: publish-failure-retry
+
+resources:
+  dashboards:
+    dashboard1:
+      display_name: my dashboard
+      warehouse_id: someid
+      file_path: ./dashboard.lvdash.json
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-retry/out.test.toml b/acceptance/bundle/resources/dashboards/publish-failure-retry/out.test.toml
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-retry/output.txt b/acceptance/bundle/resources/dashboards/publish-failure-retry/output.txt
@@ -0,0 +1,64 @@
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/publish-failure-retry/default/files...
+Deploying resources...
+Error: cannot create resources.dashboards.dashboard1: Fault injected by test. (400 INJECTED)
+
+Endpoint: POST [DATABRICKS_URL]/api/2.0/lakeview/dashboards/[DASHBOARD_ID]/published
+HTTP Status: 400 Bad Request
+API error_code: INJECTED
+API message: Fault injected by test.
+
+Updating deployment state...
+
+Exit code: 1
+
+>>> [CLI] bundle summary
+Name: publish-failure-retry
+Target: default
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/publish-failure-retry/default
+Resources:
+  Dashboards:
+    dashboard1:
+      Name: my dashboard
+      URL:  [DATABRICKS_URL]/dashboardsv3/[DASHBOARD_ID]/published?o=[NUMID]
+
+>>> [CLI] bundle plan
+update dashboards.dashboard1
+
+Plan: 0 to add, 1 to change, 0 to delete, 0 unchanged
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/publish-failure-retry/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+{
+  "method": "PATCH",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]",
+  "body": {
+    "display_name": "my dashboard",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/publish-failure-retry/default/resources",
+    "serialized_dashboard": "{\"pages\":[{\"name\":\"test-page\",\"displayName\":\"Test Dashboard\"}]}\n",
+    "warehouse_id": "someid"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]/published",
+  "body": {
+    "embed_credentials": false,
+    "warehouse_id": "someid"
+  }
+}
+
+>>> [CLI] bundle destroy --auto-approve
+The following resources will be deleted:
+  delete resources.dashboards.dashboard1
+
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/publish-failure-retry/default
+
+Deleting files...
+Destroy complete!
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-retry/script b/acceptance/bundle/resources/dashboards/publish-failure-retry/script
@@ -0,0 +1,30 @@
+envsubst < databricks.yml.tmpl > databricks.yml
+
+cleanup() {
+    trace $CLI bundle destroy --auto-approve
+    rm -f out.requests.txt
+}
+trap cleanup EXIT
+
+# Inject a single publish failure so the first deploy creates the dashboard
+# draft but fails to publish it.
+fault.py "POST /api/2.0/lakeview/dashboards/*" 400 0 1
+
+# First deploy: dashboard is created and saved to state, but publish fails.
+errcode trace $CLI bundle deploy
+
+# Dashboard should be in state (tracked) despite the publish failure.
+trace $CLI bundle summary
+
+# Plan should show that publishing is still needed.
+trace $CLI bundle plan
+
+# Discard first-deploy requests so the output only contains second-deploy
+# calls, making it easy to confirm no CREATE was issued.
+rm out.requests.txt
+
+# Second deploy: fault is gone; must publish the existing draft, not create a new one.
+trace $CLI bundle deploy
+
+# Confirm: second deploy issued an UPDATE and a PUBLISH call but no CREATE.
+print_requests.py //lakeview/dashboards
diff --git a/acceptance/bundle/resources/dashboards/publish-failure-retry/test.toml b/acceptance/bundle/resources/dashboards/publish-failure-retry/test.toml
@@ -0,0 +1,12 @@
+Cloud = false
+Local = true
+RecordRequests = true
+
+# Only run with the direct engine: the test verifies direct engine's SaveState
+# behavior (draft persists on publish failure and is re-published on retry).
+[EnvMatrix]
+DATABRICKS_BUNDLE_ENGINE = ["direct"]
+
+[[Repls]]
+Old = "[0-9a-f]{32}"
+New = "[DASHBOARD_ID]"
diff --git a/bundle/direct/dresources/dashboard.go b/bundle/direct/dresources/dashboard.go
@@ -10,7 +10,6 @@ import (
 
 	"github.com/databricks/cli/bundle/config/resources"
 	"github.com/databricks/cli/bundle/deployplan"
-	"github.com/databricks/cli/libs/log"
 	"github.com/databricks/cli/libs/structs/structpath"
 	"github.com/databricks/cli/libs/utils"
 	"github.com/databricks/databricks-sdk-go"
@@ -299,23 +298,17 @@ func (r *ResourceDashboard) DoCreate(ctx context.Context, engine *Engine, config
 
 	// Persist the etag in state.
 	config.Etag = createResp.Etag
+	// Save state before publishing so an interrupted publish leaves a tracked
+	// draft rather than an orphan. The next deploy finds the draft in state and
+	// re-publishes via DoUpdate without recreating the dashboard.
 	engine.SaveState(ctx, createResp.DashboardId, config)
 
 	var publishResp *dashboards.PublishedDashboard
 	// Note, today config.Published is always true (we do not have this field in input config).
 	if config.Published {
 		publishResp, err = r.publishDashboard(ctx, createResp.DashboardId, config)
 		if err != nil {
-			// If the publish fails, we should delete the dashboard to avoid leaving it in a bad state.
-			deleteErr := r.client.Lakeview.Trash(ctx, dashboards.TrashDashboardRequest{
-				DashboardId: createResp.DashboardId,
-			})
-			if deleteErr != nil {
-				log.Warnf(ctx, "failed to delete draft dashboard %s after publish failed: %v", createResp.DashboardId, deleteErr)
-				return "", nil, deleteErr
-			}
 			return "", nil, err
-			// QQQ: instead, we could store partial state with published=false
 		}
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"pages":[{"name":"test-page","displayName":"Test Dashboard"}]}`