Merge pull request #1788 from hashicorp/TF-27643-terraform-provider-tfe-gh-issue-1786-error-reading-workspace-over-tfe-workspace-settings-with-0-68-0

fix: invalid include value when reading workspace

Author: brandonc

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 BUG FIXES:
 * `r/tfe_workspace_settings`: remove the schema default for auto_apply in case it is managed by `r/tfe_workspace` [#1787](https://github.com/hashicorp/terraform-provider-tfe/pull/1787)
+* `r/tfe_workspace_settings`: fixes an error when reading the workspace about an invalid include value when used with some versions of Terraform Enterprise [#1788](https://github.com/hashicorp/terraform-provider-tfe/pull/1788)
 
 ## v0.68.0
 

internal/provider/resource_tfe_workspace_settings.go

@@ -461,17 +461,25 @@ func (r *workspaceSettings) Read(ctx context.Context, req resource.ReadRequest,
 }
 
 func (r *workspaceSettings) readSettings(ctx context.Context, workspaceID string) (*modelWorkspaceSettings, error) {
+	log.Printf("[DEBUG] Read configuration of workspace: %s", workspaceID)
 	ws, err := r.config.Client.Workspaces.ReadByIDWithOptions(ctx, workspaceID, &tfe.WorkspaceReadOptions{
 		Include: []tfe.WSIncludeOpt{tfe.WSEffectiveTagBindings},
 	})
-
-	if err != nil {
-		// If it's gone: that's not an error, but we are done.
+	if errors.Is(err, tfe.ErrResourceNotFound) {
+		log.Printf("[DEBUG] Workspace %s no longer exists", workspaceID)
+		return nil, errWorkspaceNoLongerExists
+	} else if errors.Is(err, tfe.ErrInvalidIncludeValue) {
+		log.Printf("[DEBUG] Workspace %s read failed due to unsupported Include; retrying without it", workspaceID)
+		ws, err = r.config.Client.Workspaces.ReadByID(ctx, workspaceID)
 		if errors.Is(err, tfe.ErrResourceNotFound) {
-			log.Printf("[DEBUG] Workspace %s no longer exists", workspaceID)
 			return nil, errWorkspaceNoLongerExists
+		} else if err != nil {
+			return nil, fmt.Errorf("Error reading workspace %s without include: %w", workspaceID, err)
 		}
-		return nil, fmt.Errorf("couldn't read workspace %s: %s", workspaceID, err.Error())
+	}
+
+	if err != nil {
+		return nil, fmt.Errorf("Error reading configuration of workspace %s: %w", workspaceID, err)
 	}
 
 	return r.workspaceSettingsModelFromTFEWorkspace(ws), nil
@@ -531,11 +539,15 @@ func (r *workspaceSettings) updateSettings(ctx context.Context, data *modelWorks
 	}
 
 	model, err := r.readSettings(ctx, ws.ID)
-	if err != nil {
-		return fmt.Errorf("couldn't read workspace %s after update: %w", workspaceID, err)
+	if errors.Is(err, errWorkspaceNoLongerExists) {
+		state.RemoveResource(ctx)
 	}
-	state.Set(ctx, model)
-	return nil
+
+	if err == nil {
+		state.Set(ctx, model)
+	}
+
+	return err
 }
 
 func (r *workspaceSettings) addAndRemoveRemoteStateConsumers(workspaceID string, newWorkspaceIDsSet types.Set, state *tfsdk.State) error {