Read dashboard definition from file_path via filer interface

acceptance/bundle/debug/out.stderr.txt

@@ -39,6 +39,7 @@
 10:07:59 Debug: Apply pid=12345 mutator=ResolveResourceReferences
 10:07:59 Debug: Apply pid=12345 mutator=ResolveVariableReferences
 10:07:59 Debug: Apply pid=12345 mutator=ApplyTargetMode
+10:07:59 Debug: Apply pid=12345 mutator=ConfigureWSFS
 10:07:59 Debug: Apply pid=12345 mutator=ProcessStaticResources
 10:07:59 Debug: Apply pid=12345 mutator=ProcessStaticResources mutator=ResolveVariableReferences(resources)
 10:07:59 Debug: Apply pid=12345 mutator=ProcessStaticResources mutator=NormalizePaths
@@ -47,7 +48,6 @@
 10:07:59 Debug: Apply pid=12345 mutator=PythonMutator(load_resources)
 10:07:59 Debug: Apply pid=12345 mutator=PythonMutator(apply_mutators)
 10:07:59 Debug: Apply pid=12345 mutator=CheckPermissions
-10:07:59 Debug: Apply pid=12345 mutator=ConfigureWSFS
 10:07:59 Debug: Apply pid=12345 mutator=TranslatePaths
 10:07:59 Debug: Apply pid=12345 mutator=PythonWrapperWarning
 10:07:59 Debug: Apply pid=12345 mutator=artifacts.Prepare

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

@@ -0,0 +1,11 @@
+bundle:
+ name: deploy-dashboard-test-$UNIQUE_NAME
+
+resources:
+ dashboards:
+ dashboard1:
+ display_name: $DASHBOARD_DISPLAY_NAME
+ warehouse_id: $TEST_DEFAULT_WAREHOUSE_ID
+ embed_credentials: true
+ file_path: "sample-dashboard.lvdash.json"
+ parent_path: /Users/$CURRENT_USER_NAME

acceptance/bundle/deploy/dashboard/output.txt

@@ -0,0 +1,23 @@
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-dashboard-test-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] lakeview get [DASHBOARD_ID]
+{
+ "lifecycle_state": "ACTIVE",
+ "parent_path": "/Users/[USERNAME]",
+ "path": "/Users/[USERNAME]/test bundle-deploy-dashboard [UUID].lvdash.json",
+ "serialized_dashboard": "{\"pages\":[{\"name\":\"02724bf2\",\"displayName\":\"Dashboard test bundle-deploy-dashboard\"}]}"
+}
+
+>>> [CLI] bundle destroy --auto-approve
+The following resources will be deleted:
+ delete dashboard dashboard1
+
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/deploy-dashboard-test-[UNIQUE_NAME]/default
+
+Deleting files...
+Destroy complete!

acceptance/bundle/deploy/dashboard/sample-dashboard.lvdash.json

@@ -0,0 +1 @@
+{"pages":[{"name":"02724bf2","displayName":"Dashboard test bundle-deploy-dashboard"}]}

acceptance/bundle/deploy/dashboard/script

@@ -0,0 +1,17 @@
+DASHBOARD_DISPLAY_NAME="test bundle-deploy-dashboard $(uuid)"
+if [ -z "$CLOUD_ENV" ]; then
+ DASHBOARD_DISPLAY_NAME="test bundle/deploy/ 6260d50f-e8ff-4905-8f28-812345678903" # use hard-coded uuid when running locally
+ export TEST_DEFAULT_WAREHOUSE_ID="warehouse-1234"
+fi
+
+export DASHBOARD_DISPLAY_NAME
+envsubst < databricks.yml.tmpl > databricks.yml
+
+cleanup() {
+ trace $CLI bundle destroy --auto-approve
+}
+trap cleanup EXIT
+
+trace $CLI bundle deploy
+DASHBOARD_ID=$($CLI bundle summary --output json | jq -r '.resources.dashboards.dashboard1.id')
+trace $CLI lakeview get $DASHBOARD_ID | jq '{lifecycle_state, parent_path, path, serialized_dashboard}'

acceptance/bundle/deploy/dashboard/test.toml

@@ -0,0 +1,38 @@
+Local = true
+Cloud = true
+RequiresWarehouse = true
+
+Ignore = [
+ "databricks.yml",
+]
+
+[[Repls]]
+Old = "[0-9a-f]{32}"
+New = "[DASHBOARD_ID]"
+
+[[Server]]
+Pattern = "POST /api/2.0/lakeview/dashboards"
+Response.Body = '''
+{
+ "dashboard_id":"1234567890abcdef1234567890abcdef"
+}
+'''
+
+[[Server]]
+Pattern = "POST /api/2.0/lakeview/dashboards/{dashboard_id}/published"
+
+[[Server]]
+Pattern = "GET /api/2.0/lakeview/dashboards/{dashboard_id}"
+Response.Body = '''
+{
+ "dashboard_id":"1234567890abcdef1234567890abcdef",
+ "display_name": "test dashboard 6260d50f-e8ff-4905-8f28-812345678903",
+ "lifecycle_state": "ACTIVE",
+ "path": "/Users/[USERNAME]/test bundle-deploy-dashboard 6260d50f-e8ff-4905-8f28-812345678903.lvdash.json",
+ "parent_path": "/Users/tester@databricks.com",
+ "serialized_dashboard": "{\"pages\":[{\"name\":\"02724bf2\",\"displayName\":\"Dashboard test bundle-deploy-dashboard\"}]}"
+}
+'''
+
+[[Server]]
+Pattern = "DELETE /api/2.0/lakeview/dashboards/{dashboard_id}"

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/paths/translation_mode.go

@@ -13,10 +13,6 @@ const (
 	// TranslateModeDirectory translates a path to a remote directory.
 	TranslateModeDirectory
 
-	// TranslateModeLocalAbsoluteFile translates a path to the local absolute file path.
-	// It returns an error if the path does not exist or is a directory.
-	TranslateModeLocalAbsoluteFile
-
 	// TranslateModeLocalAbsoluteDirectory translates a path to the local absolute directory path.
 	// It returns an error if the path does not exist or is not a directory.
 	TranslateModeLocalAbsoluteDirectory

bundle/config/mutator/resourcemutator/configure_dashboards_serialized_dashboard.go

@@ -0,0 +1,76 @@
+package resourcemutator
+
+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"
+)
+
+type configureDashboardSerializedDashboard struct{}
+
+func ConfigureDashboardSerializedDashboard() bundle.Mutator {
+	return &configureDashboardSerializedDashboard{}
+}
+
+func (c configureDashboardSerializedDashboard) Name() string {
+	return "ConfigureDashboardSerializedDashboard"
+}
+
+func (c configureDashboardSerializedDashboard) Apply(_ context.Context, b *bundle.Bundle) diag.Diagnostics {
+	var diags diag.Diagnostics
+
+	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 be able to read file contents in Databricks Workspace (reading a dashboard file via file system fails there)
+ 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) {
+ return v, dyn.ErrDrop
+ }
+ }
+
+ // Skip everything else.
+ return v, dyn.ErrSkip
+ })
+ })
+	})
+
+	diags = diags.Extend(diag.FromErr(err))
+	return diags
+}

bundle/config/mutator/resourcemutator/resource_mutator.go

@@ -125,6 +125,11 @@ func applyNormalizeMutators(ctx context.Context, b *bundle.Bundle) diag.Diagnost
  // Updates (typed): resources.pipelines.*.{schema,target}, resources.volumes.*.schema_name (converts implicit schema references to explicit ${resources.schemas.<schema_key>.name} syntax)
  // Translates implicit schema references in DLT pipelines or UC Volumes to explicit syntax to capture dependencies
  CaptureSchemaDependency(),
+
+ // Reads (dynamic): resources.dashboards.*.file_path
+ // Updates (dynamic): resources.dashboards.*.serialized_dashboard
+ // Drops (dynamic): resources.dashboards.*.file_path
+ ConfigureDashboardSerializedDashboard(),
 	)
 }
 

bundle/config/mutator/translate_paths.go

@@ -141,8 +141,6 @@ func (t *translateContext) rewritePath(
  interp, err = t.translateFilePath(ctx, input, localPath, localRelPath)
 	case paths.TranslateModeDirectory:
  interp, err = t.translateDirectoryPath(ctx, input, localPath, localRelPath)
-	case paths.TranslateModeLocalAbsoluteFile:
- interp, err = t.translateLocalAbsoluteFilePath(ctx, input, localPath, localRelPath)
 	case paths.TranslateModeLocalAbsoluteDirectory:
  interp, err = t.translateLocalAbsoluteDirectoryPath(ctx, input, localPath, localRelPath)
 	case paths.TranslateModeLocalRelative:
@@ -232,20 +230,6 @@ func (t *translateContext) translateDirectoryPath(ctx context.Context, literal,
 	return path.Join(t.remoteRoot, localRelPath), nil
 }
 
-func (t *translateContext) translateLocalAbsoluteFilePath(ctx context.Context, literal, localFullPath, localRelPath string) (string, error) {
-	info, err := t.b.SyncRoot.Stat(localRelPath)
-	if errors.Is(err, fs.ErrNotExist) {
- return "", fmt.Errorf("file %s not found", literal)
-	}
-	if err != nil {
- return "", fmt.Errorf("unable to determine if %s is a file: %w", filepath.FromSlash(localFullPath), err)
-	}
-	if info.IsDir() {
- return "", fmt.Errorf("expected %s to be a file but found a directory", literal)
-	}
-	return localFullPath, nil
-}
-
 func (t *translateContext) translateLocalAbsoluteDirectoryPath(ctx context.Context, literal, localFullPath, _ string) (string, error) {
 	info, err := os.Stat(filepath.FromSlash(localFullPath))
 	if errors.Is(err, fs.ErrNotExist) {

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/deploy/terraform/tfdyn/convert_dashboard.go

@@ -12,7 +12,6 @@ import (
 )
 
 const (
-	filePathFieldName = "file_path"
 	serializedDashboardFieldName = "serialized_dashboard"
 )
 
@@ -48,33 +47,6 @@ func convertDashboardResource(ctx context.Context, vin dyn.Value) (dyn.Value, er
  log.Debugf(ctx, "dashboard normalization diagnostic: %s", diag.Summary)
 	}
 
-	// Include "serialized_dashboard" field if "file_path" is set.
-	// Note: the Terraform resource supports "file_path" natively, but its
-	// change detection mechanism doesn't work as expected at the time of writing (Sep 30).
-	if path, ok := vout.Get(filePathFieldName).AsString(); ok {
- vout, err = dyn.Set(vout, serializedDashboardFieldName, dyn.V(fmt.Sprintf("${file(%q)}", path)))
- 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".
- vout, err = dyn.Walk(vout, 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) {
- return v, dyn.ErrDrop
- }
- }
-
- // Skip everything else.
- return v, dyn.ErrSkip
- })
- if err != nil {
- return dyn.InvalidValue, fmt.Errorf("failed to drop file_path: %w", err)
- }
-	}
-
 	// Marshal "serialized_dashboard" as JSON if it is set in the input but not in the output.
 	vout, err = marshalSerializedDashboard(vin, vout)
 	if err != nil {

bundle/deploy/terraform/tfdyn/convert_dashboard_test.go

@@ -59,54 +59,6 @@ func TestConvertDashboard(t *testing.T) {
 	}, out.Permissions["dashboard_my_dashboard"])
 }
 
-func TestConvertDashboardFilePath(t *testing.T) {
-	src := resources.Dashboard{
- FilePath: "some/path",
-	}
-
-	vin, err := convert.FromTyped(src, dyn.NilValue)
-	require.NoError(t, err)
-
-	ctx := context.Background()
-	out := schema.NewResources()
-	err = dashboardConverter{}.Convert(ctx, "my_dashboard", vin, out)
-	require.NoError(t, err)
-
-	// Assert that the "serialized_dashboard" is included.
-	assert.Subset(t, out.Dashboard["my_dashboard"], map[string]any{
- "serialized_dashboard": "${file(\"some/path\")}",
-	})
-
-	// Assert that the "file_path" doesn't carry over.
-	assert.NotSubset(t, out.Dashboard["my_dashboard"], map[string]any{
- "file_path": "some/path",
-	})
-}
-
-func TestConvertDashboardFilePathQuoted(t *testing.T) {
-	src := resources.Dashboard{
- FilePath: `C:\foo\bar\baz\dashboard.lvdash.json`,
-	}
-
-	vin, err := convert.FromTyped(src, dyn.NilValue)
-	require.NoError(t, err)
-
-	ctx := context.Background()
-	out := schema.NewResources()
-	err = dashboardConverter{}.Convert(ctx, "my_dashboard", vin, out)
-	require.NoError(t, err)
-
-	// Assert that the "serialized_dashboard" is included.
-	assert.Subset(t, out.Dashboard["my_dashboard"], map[string]any{
- "serialized_dashboard": `${file("C:\\foo\\bar\\baz\\dashboard.lvdash.json")}`,
-	})
-
-	// Assert that the "file_path" doesn't carry over.
-	assert.NotSubset(t, out.Dashboard["my_dashboard"], map[string]any{
- "file_path": `C:\foo\bar\baz\dashboard.lvdash.json`,
-	})
-}
-
 func TestConvertDashboardSerializedDashboardString(t *testing.T) {
 	src := resources.Dashboard{
  SerializedDashboard: `{ "json": true }`,

bundle/phases/initialize.go

@@ -119,6 +119,11 @@ func Initialize(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
  // ApplyPresets through ResourceProcessor.
  resourcemutator.ApplyTargetMode(),
 
+ // Reads (typed): b.SyncRoot (checks if bundle root is in /Workspace/)
+ // Updates (typed): b.SyncRoot (replaces with extension-aware path when running on Databricks Runtime)
+ // Configure use of WSFS for reads if the CLI is running on Databricks.
+ mutator.ConfigureWSFS(),
+
  // Static resources (e.g. YAML) are already loaded, we initialize and normalize them before Python
  resourcemutator.ProcessStaticResources(),
 
@@ -136,11 +141,6 @@ func Initialize(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
  // Provides diagnostic recommendations if the current deployment identity isn't explicitly granted CAN_MANAGE permissions
  permissions.PermissionDiagnostics(),
 
- // Reads (typed): b.SyncRoot (checks if bundle root is in /Workspace/)
- // Updates (typed): b.SyncRoot (replaces with extension-aware path when running on Databricks Runtime)
- // Configure use of WSFS for reads if the CLI is running on Databricks.
- mutator.ConfigureWSFS(),
-
  mutator.TranslatePaths(),
 
  // Reads (typed): b.Config.Experimental.PythonWheelWrapper, b.Config.Presets.SourceLinkedDeployment (checks Python wheel wrapper and deployment mode settings)