fix(dashboards): Detect content changes for file_path attribute #5168

YashashGaurav · 2025-10-31T01:08:44Z

Changes

This PR fixes a bug where the databricks_dashboard resource would not detect content changes when using the file_path attribute. It only detected changes to the path string itself.

The Problem: When we modified the dashboard JSON file locally, terraform plan would show no changes, and the dashboard would not be updated on apply.

The suggested Solution: This fix applies the same content-hashing CustomSuppressDiff logic (now refactored into customDiffDashboardContent) to the file_path attribute that was already in use for serialized_dashboard.

This ensures that any change to the file's content will trigger a resource update, as intended.

Tests

We used the repository's Makefile targets (make fmt, make lint, make ws) for code quality checks, and the Go test command (go test -v ./dashboards) to run the unit tests for the dashboards package.

make test run locally
relevant change in docs/ folder
covered with integration tests in internal/acceptance
using Go SDK
using TF Plugin Framework
has entry in NEXT_CHANGELOG.md file

Copilot

Pull Request Overview

This PR fixes a bug where the databricks_dashboard resource failed to detect content changes when using the file_path attribute, only detecting changes to the path string itself. The fix refactors the existing content-hashing logic into a shared function and applies it to both serialized_dashboard and file_path attributes.

Key changes:

Renamed customDiffSerializedDashboard to customDiffDashboardContent and refactored it to read both serialized_dashboard and file_path from the resource data
Applied the custom diff suppression logic to the file_path attribute to enable content change detection

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-31T08:44:38Z

dashboards/resource_dashboard.go

+	// Read both serialized_dashboard and file_path from the new config
+	serializedDashboard := d.Get("serialized_dashboard").(string)
+	filePath := d.Get("file_path").(string)
+


The function ignores the new parameter passed to it and always reads from d.Get(). This means when the file_path attribute changes, the function will still read the old path value from the resource data instead of the new value. Consider using the new parameter when k is 'file_path' to ensure the updated file content is read: if k == \"file_path\" { filePath = new }

Suggested change

// Read both serialized_dashboard and file_path from the new config

serializedDashboard := d.Get("serialized_dashboard").(string)

filePath := d.Get("file_path").(string)

// Use the new value for the attribute being diffed

serializedDashboard := d.Get("serialized_dashboard").(string)

filePath := d.Get("file_path").(string)

// If the diff is for serialized_dashboard or file_path, use the new value

if k == "serialized_dashboard" {

serializedDashboard = new

}

if k == "file_path" {

filePath = new

}

@YashashGaurav please address this comment...

alexott

From quick look, looks good. Two things:

Add NEXT_CHANGELOG entry
Add a unit test that will test that it works for file_path as well

…ent changes for `file_path` attribute

…h temporary JSON file

YashashGaurav · 2025-10-31T19:35:53Z

Hey @alexott - Thanks for the feedback. I have added the test as you asked for. Though I am definitely not a go ninja by any means and trying to help out in the best way I can.

I am wary of the fact that the new test has to add a temp file that can then be loaded for testing. If you are okay with that being in the unit tests, all good.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-12T09:08:50Z

dashboards/resource_dashboard_test.go

+func TestDashboardCreateWithFilePath(t *testing.T) {
+	// Create a temporary file with dashboard JSON content
+	tmpFile, err := os.CreateTemp("", "dashboard-*.json")
+	assert.NoError(t, err)
+	defer os.Remove(tmpFile.Name())
+
+	_, err = tmpFile.WriteString("serialized_json")
+	assert.NoError(t, err)
+	tmpFile.Close()
+
+	qa.ResourceFixture{
+		MockWorkspaceClientFunc: func(w *mocks.MockWorkspaceClient) {
+			e := w.GetMockLakeviewAPI().EXPECT()
+			e.Create(mock.Anything, dashboards.CreateDashboardRequest{
+				Dashboard: dashboards.Dashboard{
+					DisplayName:         "Dashboard name",
+					WarehouseId:         "abc",
+					ParentPath:          "/path",
+					SerializedDashboard: "serialized_json",
+				},
+			}).Return(&dashboards.Dashboard{
+				DashboardId:         "xyz",
+				DisplayName:         "Dashboard name",
+				SerializedDashboard: "serialized_json_2",
+				WarehouseId:         "abc",
+				UpdateTime:          "2125678",
+			}, nil)
+			e.Publish(mock.Anything, dashboards.PublishRequest{
+				EmbedCredentials: true,
+				WarehouseId:      "abc",
+				DashboardId:      "xyz",
+				ForceSendFields:  []string{"EmbedCredentials"},
+			}).Return(&dashboards.PublishedDashboard{
+				EmbedCredentials:   true,
+				WarehouseId:        "abc",
+				DisplayName:        "Dashboard name",
+				RevisionCreateTime: "823828",
+			}, nil)
+			e.Get(mock.Anything, dashboards.GetDashboardRequest{
+				DashboardId: "xyz",
+			}).Return(&dashboards.Dashboard{
+				DashboardId:         "xyz",
+				DisplayName:         "Dashboard name",
+				SerializedDashboard: "serialized_json_2",
+				WarehouseId:         "abc",
+				UpdateTime:          "2125678",
+			}, nil)
+		},
+		Resource: ResourceDashboard(),
+		Create:   true,
+		HCL: fmt.Sprintf(`
+			display_name = "Dashboard name"
+			warehouse_id = "abc"
+			parent_path = "/path"
+			file_path = "%s"
+		`, tmpFile.Name()),
+	}.ApplyAndExpectData(t, map[string]any{
+		"id":           "xyz",
+		"display_name": "Dashboard name",
+	})
+}


The new test TestDashboardCreateWithFilePath validates that a dashboard can be created using a file path, but it doesn't test the actual diff detection functionality that this PR is meant to fix. Consider adding a test that:

Creates a dashboard with a file_path

Modifies the file content

Verifies that terraform detects the change (i.e., the customDiffDashboardContent function returns false to show the diff)

This would provide better coverage for the bug fix described in the PR.

alexott · 2026-01-12T09:15:25Z

dashboards/resource_dashboard.go

+	// Read both serialized_dashboard and file_path from the new config
+	serializedDashboard := d.Get("serialized_dashboard").(string)
+	filePath := d.Get("file_path").(string)
+


@YashashGaurav please address this comment...

dashboards/resource_dashboard_test.go

…ect unit tests

github-actions · 2026-01-12T15:41:56Z

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/terraform

Inputs:

PR number: 5168
Commit SHA: 4960a84bb023efa97e239cb6c99bbe4f78596545

Checks will be approved automatically on success.

fix(dashboards): Detect content changes for file_path attribute

cf7bc3d

YashashGaurav requested review from a team as code owners October 31, 2025 01:08

YashashGaurav requested review from Divyansh-db and removed request for a team October 31, 2025 01:08

alexott requested a review from Copilot October 31, 2025 08:43

Copilot AI reviewed Oct 31, 2025

View reviewed changes

alexott requested changes Oct 31, 2025

View reviewed changes

rippling-yash and others added 3 commits October 31, 2025 11:27

fix(changelog): Update databricks_dashboard resource to detect cont…

b457c79

…ent changes for `file_path` attribute

feat(dashboards): Add test for dashboard creation using file path wit…

ec8a692

…h temporary JSON file

Merge branch 'main' into fix/dashboard-filepath-content-detection

6e10be9

YashashGaurav temporarily deployed to test-trigger-is November 12, 2025 07:30 — with GitHub Actions Inactive

YashashGaurav and others added 2 commits November 18, 2025 17:33

Merge branch 'main' into fix/dashboard-filepath-content-detection

560b15d

Merge branch 'main' into fix/dashboard-filepath-content-detection

091cad4

rauchy temporarily deployed to test-trigger-is January 5, 2026 12:23 — with GitHub Actions Inactive

Merge branch 'main' into fix/dashboard-filepath-content-detection

d28fb74

rauchy temporarily deployed to test-trigger-is January 8, 2026 12:39 — with GitHub Actions Inactive

rauchy enabled auto-merge January 9, 2026 08:58

alexott requested a review from Copilot January 12, 2026 09:02

Copilot started reviewing on behalf of alexott January 12, 2026 09:03 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

alexott reviewed Jan 12, 2026

View reviewed changes

fix customDiffDashboardContent to use new parameter value and add dir…

4960a84

…ect unit tests

rauchy temporarily deployed to test-trigger-is January 12, 2026 15:42 — with GitHub Actions Inactive

alexott approved these changes Jan 13, 2026

View reviewed changes

rauchy added this pull request to the merge queue Jan 13, 2026

Merged via the queue into databricks:main with commit 4e949ee Jan 13, 2026
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(dashboards): Detect content changes for file_path attribute #5168

fix(dashboards): Detect content changes for file_path attribute #5168

Uh oh!

YashashGaurav commented Oct 31, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 31, 2025

Uh oh!

alexott Jan 12, 2026

Uh oh!

alexott left a comment

Uh oh!

YashashGaurav commented Oct 31, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

alexott Jan 12, 2026

Uh oh!

Uh oh!

github-actions bot commented Jan 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-	// Read both serialized_dashboard and file_path from the new config
-	serializedDashboard := d.Get("serialized_dashboard").(string)
-	filePath := d.Get("file_path").(string)
+	// Use the new value for the attribute being diffed
+	serializedDashboard := d.Get("serialized_dashboard").(string)
+	filePath := d.Get("file_path").(string)
+	// If the diff is for serialized_dashboard or file_path, use the new value
+	if k == "serialized_dashboard" {
+		serializedDashboard = new
+	}
+	if k == "file_path" {
+		filePath = new
+	}

fix(dashboards): Detect content changes for file_path attribute #5168

fix(dashboards): Detect content changes for file_path attribute #5168

Uh oh!

Conversation

YashashGaurav commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

alexott Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

alexott left a comment

Choose a reason for hiding this comment

Uh oh!

YashashGaurav commented Oct 31, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

alexott Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jan 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

YashashGaurav commented Oct 31, 2025 •

edited

Loading