Remove workspace includes from policy set reads

[jbonhag]

Description

This PR speeds up policy set refreshes by removing the include=workspaces query param from those calls. It takes extra time to serialize the workspace record on the backend and it doesn't seem like any workspace data besides the id is necessary to manage tfe_workspace_policy_set resources in the provider. This is especially noticeable for a policy set attached to a large number of workspaces.

Note that we do still need need the workspace records here, so we can find a workspace associated with the policy set by name:

terraform-provider-tfe/internal/provider/resource_tfe_workspace_policy_set.go

Line 139 in ac43481

options := &tfe.PolicySetListOptions{Include: []tfe.PolicySetIncludeOpt{tfe.PolicySetWorkspaces}}

Remember to:

• Update the Change Log
• Update the Documentation

Testing plan

1. Create a policy set and attach it to a large number of workspaces
2. Run a simple TF config to create additional workspaces and attach the existing policy set to them
3. The TF apply should succeed and be faster than provider v0.48.0.

Example: creating some new workspaces and attaching them to an existing policy set:

resource "tfe_workspace" "this" {
  count = 5
  name = "my-workspace-${count.index}"
}

data "tfe_policy_set" "this" {
  name         = "my-policy-set"
}

resource "tfe_workspace_policy_set" "this" {
  count = 5 
  policy_set_id = data.tfe_policy_set.this.id
  workspace_id  = tfe_workspace.this[count.index].id
}

This config can take a very long time to run, depending on how many workspaces this policy set is already attached to. On my local environment with my-policy-set already attached to 1000 workspaces, it took about 1m15s to apply the above config due to the include=workspaces query parameter when refreshing a policy set. Without the include=workspaces query parameter it takes about 10s.

Output from acceptance tests

Please run applicable acceptance tests locally and include the output here. See testing.md to learn how to run acceptance tests.

If you are an external contributor, your contribution(s) will first be reviewed before running them against the project's CI pipeline.

$ ❯ ENABLE_BETA=1 TFE_ADMIN_PROVISION_LICENSES_TOKEN=xxx TFE_HOSTNAME=xxx TFE_TOKEN=xxx TESTARGS="-run TestAccTFEWorkspacePolicySet" make testacc
TF_ACC=1 TF_LOG_SDK_PROTO=OFF go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEWorkspacePolicySet -timeout 15m
=== RUN   TestAccTFEWorkspacePolicySetExclusion_basic
--- PASS: TestAccTFEWorkspacePolicySetExclusion_basic (7.01s)
=== RUN   TestAccTFEWorkspacePolicySetExclusion_incorrectImportSyntax
--- PASS: TestAccTFEWorkspacePolicySetExclusion_incorrectImportSyntax (5.80s)
=== RUN   TestAccTFEWorkspacePolicySet_basic
--- PASS: TestAccTFEWorkspacePolicySet_basic (7.29s)
=== RUN   TestAccTFEWorkspacePolicySet_incorrectImportSyntax
--- PASS: TestAccTFEWorkspacePolicySet_incorrectImportSyntax (5.63s)
PASS
ok  	github.com/hashicorp/terraform-provider-tfe/internal/provider	26.028s
?   	github.com/hashicorp/terraform-provider-tfe/version	[no test files]

[brandonc]

Nice!