dashboard: ForceNew on folder parameter not needed (anymore)?

[wotolom]

Terraform Version

• Terraform: ...
• Terraform Grafana Provider: 2.3.3
• Grafana: v10.0.2

Affected Resource(s)

Please list the resources as a list, for example:

• grafana_dashboard

Issue

Currently the parameter folder of the dashboard resource has the ForceNew: true set:

terraform-provider-grafana/internal/resources/grafana/resource_dashboard.go

Lines 65 to 68 in 2ab68d4

	"folder": {
	Type: schema.TypeString,
	Optional: true,
	ForceNew: true,

For the crossplane provider-grafana this can be annoying as it makes the field folder practically immutable. See this upjet issue discussing how to handle fields with ForceNew: true.

Nonetheless in this case I actually have difficulty to understand why changing folder needs ForceNew: true set.

relevant history check of dashboard resource:

• implementation of the update functionality: Update dashboards with correct ForceNew on folder #52
• first try of that enhancement with discussion about not being able to move folders as expected: grafana_dashboard updates / imports #38 (comment)

However when testing - with curl or the grafana-api-golang-client - to move a dashboard between 2 folders, I actually did not ran into any problems.

Here my go code used for testing:

package main

import (
	log "log"

	gapi "github.com/grafana/grafana-api-golang-client"
)

func main() {

	// Create a new client
	c, err := gapi.New("<INSERT_GRAFANA_URL>", gapi.Config{
		APIKey: "<INSERT_APIKEY_OR_SERVICEACCOUNTTOKEN>",
	})
	if err != nil {
		log.Fatal(err)
	}

	// create folders
	folder1 := "golang-folder1"
	respFolder1, err := c.NewFolder(folder1, folder1)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("create folder action response: %v", respFolder1)
	folder2 := "golang-folder2"
	respFolder2, err := c.NewFolder(folder2, folder2)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("create folder action response: %v", respFolder2)

	// create dashboard
	dash := "golang-api-test"
	respDash1, err := c.NewDashboard(gapi.Dashboard{
		Overwrite: true, // needed to update
		Model: map[string]interface{}{
			"title":   dash,
			"uid":     dash,
			"version": "1", // seems to be ignored
		},
		FolderUID: folder1,
	})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("create dashboard action response: %v", respDash1)

	// check dashboard folder location
	resp1, err := c.DashboardByUID(dash)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("check dashboard action response: %v", resp1)

	// "update" dashboard
	respDash2, err := c.NewDashboard(gapi.Dashboard{
		Overwrite: true, // needed to update
		Model: map[string]interface{}{
			"title":   dash,
			"uid":     dash,
			"version": "1", // seems to be ignored
		},
		FolderUID: folder2,
	})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("update dashboard action response: %v", respDash2) // accepts changes, version will go up

	// check dashboard folder location
	resp2, err := c.DashboardByUID(dash)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("check dashboard action response: %v", resp2)

	// delete folders + dashboard
	log.Print("delete dashboard ...")
	err = c.DeleteDashboardByUID(dash)
	if err != nil {
		log.Fatal(err)
	}
	log.Print("delete folder1 ...")
	err = c.DeleteFolder(folder1) // wants uid not id ...
	if err != nil {
		log.Fatal(err)
	}
	log.Print("delete folder2 ...")
	err = c.DeleteFolder(folder2) // wants uid not id ...
	if err != nil {
		log.Fatal(err)
	}
}

Produced output logs:

2023/10/26 11:27:27 create folder action response: {1994 golang-folder1 golang-folder1 /dashboards/f/golang-folder1/golang-folder1}
2023/10/26 11:27:27 create folder action response: {1995 golang-folder2 golang-folder2 /dashboards/f/golang-folder2/golang-folder2}
2023/10/26 11:27:28 create dashboard action response: &{golang-api-test 1996 golang-api-test success 1}
2023/10/26 11:27:28 check dashboard action response: &{map[id:1996 title:golang-api-test uid:golang-api-test version:1] 1994 {false golang-api-test 1994 golang-folder1 /d/golang-api-test/golang-api-test} false  }
2023/10/26 11:27:28 update dashboard action response: &{golang-api-test 1996 golang-api-test success 2}
2023/10/26 11:27:28 check dashboard action response: &{map[id:1996 title:golang-api-test uid:golang-api-test version:2] 1995 {false golang-api-test 1995 golang-folder2 /d/golang-api-test/golang-api-test} false  }
2023/10/26 11:27:28 delete dashboard ...
2023/10/26 11:27:28 delete folder1 ...
2023/10/26 11:27:28 delete folder2 ...