template_preset_variable diff not order-independent

[joelmarty]

Datadog Terraform Provider Version

3.44.1

Terraform Version

1.9.6

What resources or data sources are affected?

datadog_dashboard

Terraform Configuration Files

resource "datadog_dashboard" "test" {
  title = "test dashboard"

  layout_type = "ordered"
  reflow_type = "fixed"

  template_variable {
    name = "env"
    defaults = ["dev"]
    available_values = ["dev", "stage", "prod"]
  }

  template_variable {
    name = "realm"
    defaults = ["us1"]
    available_values = ["us1", "us2", "eu1"]
  }

  template_variable_preset {
    name = "dev-us1"
    template_variable {
      name = "env"
      values = ["dev"]
    }
    template_variable {
      name = "realm"
      values = ["us1"]
    }
  }

  template_variable_preset {
    name = "dev-us2"
    template_variable {
      name = "env"
      values = ["dev"]
    }
    template_variable {
      name = "realm"
      values = ["us2"]
    }
  }

  widget {
    note_definition {
      content = "This is a test"
    }
    widget_layout {
      height = 2
      width  = 12
      x      = 0
      y      = 0
    }
  }
}

Relevant debug or panic output

n/a

Expected Behavior

Adding a template variable preset before dev-us1 should detect the addition of a new preset

Actual Behavior

Adding a template variable preset before dev-us1 shows the diff as a modification of all presets:

  # datadog_dashboard.test will be updated in-place
  ~ resource "datadog_dashboard" "test" {
        id                      = "mt9-5tu-2nz"
        tags                    = []
        # (9 unchanged attributes hidden)

      ~ template_variable_preset {
          ~ name = "dev-us1" -> "dev-eu1"

          ~ template_variable {
                name   = "realm"
              ~ values = [
                  ~ "us1" -> "eu1",
                ]
                # (1 unchanged attribute hidden)
            }

            # (1 unchanged block hidden)
        }
      ~ template_variable_preset {
          ~ name = "dev-us2" -> "dev-us1"

          ~ template_variable {
                name   = "realm"
              ~ values = [
                  ~ "us2" -> "us1",
                ]
                # (1 unchanged attribute hidden)
            }

            # (1 unchanged block hidden)
        }
      + template_variable_preset {
          + name = "dev-us2"

          + template_variable {
              + name   = "env"
              + values = [
                  + "dev",
                ]
            }
          + template_variable {
              + name   = "realm"
              + values = [
                  + "us2",
                ]
            }
        }

        # (3 unchanged blocks hidden)
    }

Steps to Reproduce

1. terraform apply
2. Add the following preset on first position:

  template_variable_preset {
    name = "dev-eu1"
    template_variable {
      name = "env"
      values = ["dev"]
    }
    template_variable {
      name = "realm"
      values = ["eu1"]
    }
  }

3. terraform plan

Important Factoids

This is particularly problematic when the presets are generated through list comprehensions: unless you can apply a constant order to the for_each argument, you will always get changes

References

No response