refactor: move ConfigureDashboardSerializedDashboard call down the transformation pipeline, closer to terraform write

Author: anton-107

bundle/config/mutator/paths/dashboard_paths_visitor.go

@@ -13,6 +13,6 @@ func VisitDashboardPaths(value dyn.Value, fn VisitFunc) (dyn.Value, error) {
 	)
 
 	return dyn.MapByPattern(value, pattern, func(path dyn.Path, value dyn.Value) (dyn.Value, error) {
-		return fn(path, TranslateModeLocalAbsoluteFile, value)
+		return fn(path, TranslateModeLocalRelative, value)
 	})
 }

bundle/config/mutator/resourcemutator/configure_dashboards_serialized_dashboard.go

@@ -4,14 +4,10 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/databricks/cli/bundle"
-	"github.com/databricks/cli/libs/diag"
 	"github.com/databricks/cli/libs/dyn"
-)
 
-const (
-	filePathFieldName            = "file_path"
-	serializedDashboardFieldName = "serialized_dashboard"
+	"github.com/databricks/cli/bundle"
+	"github.com/databricks/cli/libs/diag"
 )
 
 type configureDashboardSerializedDashboard struct{}
@@ -25,42 +21,32 @@ func (c configureDashboardSerializedDashboard) Name() string {
 }
 
 func (c configureDashboardSerializedDashboard) Apply(_ context.Context, b *bundle.Bundle) diag.Diagnostics {
-	var diags diag.Diagnostics
-
+	for _, dashboard := range b.Config.Resources.Dashboards {
+		path := dashboard.FilePath
+		if path == "" {
+			continue
+		}
+		contents, err := b.SyncRoot.ReadFile(path)
+		if err != nil {
+			return diag.FromErr(fmt.Errorf("failed to read serialized dashboard from file_path %s: %w", path, err))
+		}
+		dashboard.SerializedDashboard = string(contents)
+	}
+
+	// Drop the "file_path" field. It is mutually exclusive with "serialized_dashboard".
 	pattern := dyn.NewPattern(
 		dyn.Key("resources"),
 		dyn.Key("dashboards"),
 		dyn.AnyKey(),
 	)
-
-	// Configure serialized_dashboard field for all dashboards.
 	err := b.Config.Mutate(func(v dyn.Value) (dyn.Value, error) {
 		return dyn.MapByPattern(v, pattern, func(p dyn.Path, v dyn.Value) (dyn.Value, error) {
-			// Include "serialized_dashboard" field if "file_path" is set.
-			// Note: the Terraform resource supports "file_path" natively, but we read the contents of the dashboard here
-			// to cover the use case of deployments from the workspace
-			path, ok := v.Get(filePathFieldName).AsString()
-			if !ok {
-				return v, nil
-			}
-
-			contents, err := b.SyncRoot.ReadFile(path)
-			if err != nil {
-				return dyn.InvalidValue, fmt.Errorf("failed to read serialized dashboard from file_path %s: %w", path, err)
-			}
-
-			v, err = dyn.Set(v, serializedDashboardFieldName, dyn.V(string(contents)))
-			if err != nil {
-				return dyn.InvalidValue, fmt.Errorf("failed to set serialized_dashboard: %w", err)
-			}
-
-			// Drop the "file_path" field. It is mutually exclusive with "serialized_dashboard".
 			return dyn.Walk(v, func(p dyn.Path, v dyn.Value) (dyn.Value, error) {
 				switch len(p) {
 				case 0:
 					return v, nil
 				case 1:
-					if p[0] == dyn.Key(filePathFieldName) {
+					if p[0] == dyn.Key("file_path") {
 						return v, dyn.ErrDrop
 					}
 				}
@@ -71,6 +57,7 @@ func (c configureDashboardSerializedDashboard) Apply(_ context.Context, b *bundl
 		})
 	})
 
+	var diags diag.Diagnostics
 	diags = diags.Extend(diag.FromErr(err))
 	return diags
 }

bundle/config/mutator/resourcemutator/resource_mutator.go

@@ -41,11 +41,6 @@ func applyInitializeMutators(ctx context.Context, b *bundle.Bundle) diag.Diagnos
 		// Updates (dynamic): resources.dashboards.*.embed_credentials (sets to false if not set)
 		ConfigureDashboardDefaults(),
 
-		// Reads (typed): resources.dashboards.*.file_path (checks for existing file_path)
-		// Updates (typed): resources.dashboards.*.serialized_dashboard (sets to the contents of the file in file_path)
-		// Removes resources.dashboards.*.file_path
-		ConfigureDashboardSerializedDashboard(),
-
 		// Reads (dynamic): resources.volumes.* (checks for existing volume_type)
 		// Updates (dynamic): resources.volumes.*.volume_type (sets to "MANAGED" if not set)
 		ConfigureVolumeDefaults(),

bundle/config/mutator/translate_paths_dashboards_test.go

@@ -49,7 +49,7 @@ func TestTranslatePathsDashboards_FilePathRelativeSubDirectory(t *testing.T) {
 	// Assert that the file path for the dashboard has been converted to its local absolute path.
 	assert.Equal(
 		t,
-		filepath.ToSlash(filepath.Join(dir, "src", "my_dashboard.lvdash.json")),
+		filepath.ToSlash(filepath.Join("src", "my_dashboard.lvdash.json")),
 		b.Config.Resources.Dashboards["dashboard"].FilePath,
 	)
 }

bundle/phases/bind.go

@@ -3,6 +3,8 @@ package phases
 import (
 	"context"
 
+	"github.com/databricks/cli/bundle/config/mutator/resourcemutator"
+
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/deploy/lock"
 	"github.com/databricks/cli/bundle/deploy/terraform"
@@ -25,6 +27,7 @@ func Bind(ctx context.Context, b *bundle.Bundle, opts *terraform.BindOptions) (d
 	diags = diags.Extend(bundle.ApplySeq(ctx, b,
 		terraform.StatePull(),
 		terraform.Interpolate(),
+		resourcemutator.ConfigureDashboardSerializedDashboard(),
 		terraform.Write(),
 		terraform.Import(opts),
 		terraform.StatePush(),
@@ -48,6 +51,7 @@ func Unbind(ctx context.Context, b *bundle.Bundle, resourceType, resourceKey str
 	diags = diags.Extend(bundle.ApplySeq(ctx, b,
 		terraform.StatePull(),
 		terraform.Interpolate(),
+		resourcemutator.ConfigureDashboardSerializedDashboard(),
 		terraform.Write(),
 		terraform.Unbind(resourceType, resourceKey),
 		terraform.StatePush(),

bundle/phases/deploy.go

@@ -5,6 +5,8 @@ import (
 	"errors"
 	"slices"
 
+	"github.com/databricks/cli/bundle/config/mutator/resourcemutator"
+
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/apps"
 	"github.com/databricks/cli/bundle/artifacts"
@@ -209,6 +211,7 @@ func Deploy(ctx context.Context, b *bundle.Bundle, outputHandler sync.OutputHand
 		deploy.StatePush(),
 		permissions.ApplyWorkspaceRootPermissions(),
 		terraform.Interpolate(),
+		resourcemutator.ConfigureDashboardSerializedDashboard(),
 		terraform.Write(),
 		terraform.Plan(terraform.PlanGoal("deploy")),
 	)

bundle/phases/destroy.go

@@ -5,6 +5,8 @@ import (
 	"errors"
 	"net/http"
 
+	"github.com/databricks/cli/bundle/config/mutator/resourcemutator"
+
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/deploy/files"
 	"github.com/databricks/cli/bundle/deploy/lock"
@@ -118,6 +120,7 @@ func Destroy(ctx context.Context, b *bundle.Bundle) (diags diag.Diagnostics) {
 	diags = diags.Extend(bundle.ApplySeq(ctx, b,
 		terraform.StatePull(),
 		terraform.Interpolate(),
+		resourcemutator.ConfigureDashboardSerializedDashboard(),
 		terraform.Write(),
 		terraform.Plan(terraform.PlanGoal("destroy")),
 	))