Fix error propogation in the bundle generate dashboard command (#3354)

## Changes
Fixes a regression introduced in
#3175, where the errors in these
functions would be dropped instead of being propagated. I noticed this
regression while updating the CLI dashboard.

This also highlights the downside returning diagnostics and using
`logdiag` to log it later, outside mutators, since a linter would have
caught it otherwise.

## Tests
Added regression test. Also manually:

Before:
```
➜  cli_telemetry_dashboard git:(main) databricks bundle generate dashboard --resource cli_telemetry -p logfood        
➜  cli_telemetry_dashboard git:(main) git status                     
On branch main
Your branch is up to date with 'origin/main'.
```

After:
```
➜  cli_telemetry_dashboard git:(main) cli bundle generate dashboard --resource cli_telemetry -p logfood        
Error: src/cli_telemetry.lvdash.json already exists. Use --force to overwrite
```

Ideally, we would not use logdiag here and instead refactor these and
other functions like these to return errors. It's out of scope for me
for now.

Author: shreyas-goenka

acceptance/bundle/deploy/dashboard/generate_inplace/dashboard.lvdash.json

@@ -0,0 +1,7 @@
+{
+  "uiSettings": {
+    "theme": {
+      "widgetHeaderAlignment": "ALIGNMENT_UNSPECIFIED"
+    }
+  }
+}

acceptance/bundle/deploy/dashboard/generate_inplace/databricks.yml

@@ -0,0 +1,9 @@
+bundle:
+  name: dashboard-replace-$UNIQUE_NAME
+
+resources:
+  dashboards:
+    already_exists:
+      file_path: ./dashboard.lvdash.json
+      display_name: Already Exists
+      warehouse_id: $TEST_DEFAULT_WAREHOUSE_ID

acceptance/bundle/deploy/dashboard/generate_inplace/out.test.toml

@@ -0,0 +1,5 @@
+Local = false
+Cloud = true
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform"]

acceptance/bundle/deploy/dashboard/generate_inplace/output.txt

@@ -0,0 +1,42 @@
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dashboard-replace-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+=== Get current dashboard
+"{\n  \"uiSettings\": {\n    \"theme\": {\n      \"widgetHeaderAlignment\": \"ALIGNMENT_UNSPECIFIED\"\n    }\n  }\n}\n"
+
+=== Update dashboard
+"{}\n"
+
+>>> [CLI] bundle generate dashboard --resource already_exists
+Error: dashboard.lvdash.json already exists. Use --force to overwrite
+
+
+Exit code: 1
+
+>>> cat dashboard.lvdash.json
+{
+  "uiSettings": {
+    "theme": {
+      "widgetHeaderAlignment": "ALIGNMENT_UNSPECIFIED"
+    }
+  }
+}
+
+>>> [CLI] bundle generate dashboard --resource already_exists --force
+Writing dashboard to "dashboard.lvdash.json"
+
+>>> cat dashboard.lvdash.json
+{}
+
+>>> [CLI] bundle destroy --auto-approve
+The following resources will be deleted:
+  delete dashboard already_exists
+
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/dashboard-replace-[UNIQUE_NAME]/default
+
+Deleting files...
+Destroy complete!

acceptance/bundle/deploy/dashboard/generate_inplace/script

@@ -0,0 +1,28 @@
+envsubst < databricks.yml > databricks.yml.subst
+mv databricks.yml.subst databricks.yml
+
+# Deploy bundle once to create the dashboard.
+trace $CLI bundle deploy
+
+cleanup() {
+    trace $CLI bundle destroy --auto-approve
+}
+trap cleanup EXIT
+
+dashboard_id=$($CLI bundle summary -o json | jq .resources.dashboards.already_exists.id -r)
+
+title "Get current dashboard\n"
+$CLI lakeview get $dashboard_id | jq .serialized_dashboard
+
+title "Update dashboard\n"
+$CLI lakeview update $dashboard_id --display-name "Updated dashboard" | jq .serialized_dashboard
+
+# This should error.
+errcode trace $CLI bundle generate dashboard --resource already_exists
+
+trace cat dashboard.lvdash.json
+
+# this should successfully update the dashboard.
+trace $CLI bundle generate dashboard --resource already_exists --force
+
+trace cat dashboard.lvdash.json

acceptance/bundle/deploy/dashboard/generate_inplace/test.toml

@@ -0,0 +1,2 @@
+Cloud = true
+Local = false

cmd/bundle/generate/dashboard.go

@@ -238,17 +238,19 @@ func (d *dashboard) saveConfiguration(ctx context.Context, b *bundle.Bundle, das
 	return nil
 }
 
-func waitForChanges(ctx context.Context, w *databricks.WorkspaceClient, dashboard *dashboards.Dashboard) diag.Diagnostics {
+func waitForChanges(ctx context.Context, w *databricks.WorkspaceClient, dashboard *dashboards.Dashboard) {
 	// Compute [time.Time] for the most recent update.
 	tref, err := time.Parse(time.RFC3339, dashboard.UpdateTime)
 	if err != nil {
-		return diag.FromErr(err)
+		logdiag.LogError(ctx, err)
+		return
 	}
 
 	for {
 		obj, err := w.Workspace.GetStatusByPath(ctx, dashboard.Path)
 		if err != nil {
-			return diag.FromErr(err)
+			logdiag.LogError(ctx, err)
+			return
 		}
 
 		// Compute [time.Time] from timestamp in millis since epoch.
@@ -259,18 +261,18 @@ func waitForChanges(ctx context.Context, w *databricks.WorkspaceClient, dashboar
 
 		time.Sleep(1 * time.Second)
 	}
-
-	return nil
 }
 
-func (d *dashboard) updateDashboardForResource(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
+func (d *dashboard) updateDashboardForResource(ctx context.Context, b *bundle.Bundle) {
 	resource, ok := b.Config.Resources.Dashboards[d.resource]
 	if !ok {
-		return diag.Errorf("dashboard resource %q is not defined", d.resource)
+		logdiag.LogError(ctx, fmt.Errorf("dashboard resource %q is not defined", d.resource))
+		return
 	}
 
 	if resource.FilePath == "" {
-		return diag.Errorf("dashboard resource %q has no file path defined", d.resource)
+		logdiag.LogError(ctx, fmt.Errorf("dashboard resource %q has no file path defined", d.resource))
+		return
 	}
 
 	// Resolve the dashboard ID from the resource.
@@ -286,19 +288,21 @@ func (d *dashboard) updateDashboardForResource(ctx context.Context, b *bundle.Bu
 	for {
 		dashboard, err := w.Lakeview.GetByDashboardId(ctx, dashboardID)
 		if err != nil {
-			return diag.FromErr(err)
+			logdiag.LogError(ctx, err)
+			return
 		}
 
 		if etag != dashboard.Etag {
 			err = d.saveSerializedDashboard(ctx, b, dashboard, dashboardPath)
 			if err != nil {
-				return diag.FromErr(err)
+				logdiag.LogError(ctx, err)
+				return
 			}
 		}
 
 		// Abort if we are not watching for changes.
 		if !d.watch {
-			return nil
+			return
 		}
 
 		// Update the etag for the next iteration.