chore: consistently validate workspace_id

Consistently checks if `workspace_id` is configured for endpoints that use that field. Adds a helper function to consistently provide this check. Closes https://linear.app/prefect/issue/PLA-405/consistently-handle-resources-that-require-a-workspace-id
PrefectHQ · Dec 13, 2024 · e178f5c · e178f5c
1 parent 3fa3161
commit e178f5c
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 23 deletions.
diff --git a/internal/client/automations.go b/internal/client/automations.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/prefecthq/terraform-provider-prefect/internal/api"
-	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 var _ = api.AutomationsClient(&AutomationsClient{})
@@ -30,8 +29,8 @@ func (c *Client) Automations(accountID uuid.UUID, workspaceID uuid.UUID) (api.Au
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &AutomationsClient{

diff --git a/internal/client/block_documents.go b/internal/client/block_documents.go
@@ -8,7 +8,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/prefecthq/terraform-provider-prefect/internal/api"
-	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 var _ = api.BlockDocumentClient(&BlockDocumentClient{})
@@ -31,8 +30,8 @@ func (c *Client) BlockDocuments(accountID uuid.UUID, workspaceID uuid.UUID) (api
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &BlockDocumentClient{

diff --git a/internal/client/block_schemas.go b/internal/client/block_schemas.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/prefecthq/terraform-provider-prefect/internal/api"
-	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 // BlockSchemaClient is a client for working with block schemas.
@@ -28,8 +27,8 @@ func (c *Client) BlockSchemas(accountID uuid.UUID, workspaceID uuid.UUID) (api.B
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &BlockSchemaClient{

diff --git a/internal/client/block_types.go b/internal/client/block_types.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/prefecthq/terraform-provider-prefect/internal/api"
-	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 var _ = api.BlockTypeClient(&BlockTypeClient{})
@@ -30,8 +29,8 @@ func (c *Client) BlockTypes(accountID uuid.UUID, workspaceID uuid.UUID) (api.Blo
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &BlockTypeClient{

diff --git a/internal/client/collections.go b/internal/client/collections.go
@@ -30,8 +30,8 @@ func (c *Client) Collections(accountID, workspaceID uuid.UUID) (api.CollectionsC
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &CollectionsClient{

diff --git a/internal/client/deployment_access.go b/internal/client/deployment_access.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/prefecthq/terraform-provider-prefect/internal/api"
-	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 var _ = api.DeploymentAccessClient(&DeploymentAccessClient{})
@@ -30,8 +29,8 @@ func (c *Client) DeploymentAccess(accountID uuid.UUID, workspaceID uuid.UUID) (a
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &DeploymentAccessClient{

diff --git a/internal/client/deployment_schedule.go b/internal/client/deployment_schedule.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/prefecthq/terraform-provider-prefect/internal/api"
-	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 var _ = api.DeploymentScheduleClient(&DeploymentScheduleClient{})
@@ -30,8 +29,8 @@ func (c *Client) DeploymentSchedule(accountID, workspaceID uuid.UUID) (api.Deplo
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &DeploymentScheduleClient{

diff --git a/internal/client/deployments.go b/internal/client/deployments.go
@@ -31,6 +31,10 @@ func (c *Client) Deployments(accountID uuid.UUID, workspaceID uuid.UUID) (api.De
 		workspaceID = c.defaultWorkspaceID
 	}
 
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
+	}
+
 	return &DeploymentsClient{
 		hc:          c.hc,
 		routePrefix: getWorkspaceScopedURL(c.endpoint, accountID, workspaceID, "deployments"),

diff --git a/internal/client/flows.go b/internal/client/flows.go
@@ -31,6 +31,10 @@ func (c *Client) Flows(accountID uuid.UUID, workspaceID uuid.UUID) (api.FlowsCli
 		workspaceID = c.defaultWorkspaceID
 	}
 
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
+	}
+
 	return &FlowsClient{
 		hc:          c.hc,
 		routePrefix: getWorkspaceScopedURL(c.endpoint, accountID, workspaceID, "flows"),

diff --git a/internal/client/util.go b/internal/client/util.go
@@ -10,6 +10,7 @@ import (
 	"strings"
 
 	"github.com/google/uuid"
+	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 // getAccountScopedURL constructs a URL for an account-scoped route.
@@ -64,6 +65,16 @@ func setDefaultHeaders(request *http.Request, apiKey string) {
 	request.Header.Set("Accept", "application/json")
 }
 
+// validateCloudEndpoint validates that proper configuration is provided
+// when the endpoint points to Prefect Cloud.
+func validateCloudEndpoint(endpoint string, accountID, workspaceID uuid.UUID) error {
+	if helpers.IsCloudEndpoint(endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
+		return fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	}
+
+	return nil
+}
+
 // requestConfig is a configuration object for an HTTP request.
 type requestConfig struct {
 	method string

diff --git a/internal/client/variables.go b/internal/client/variables.go
@@ -26,10 +26,15 @@ func (c *Client) Variables(accountID uuid.UUID, workspaceID uuid.UUID) (api.Vari
 	if accountID == uuid.Nil {
 		accountID = c.defaultAccountID
 	}
+
 	if workspaceID == uuid.Nil {
 		workspaceID = c.defaultWorkspaceID
 	}
 
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
+	}
+
 	return &VariablesClient{
 		hc:          c.hc,
 		apiKey:      c.apiKey,

diff --git a/internal/client/work_pools.go b/internal/client/work_pools.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/prefecthq/terraform-provider-prefect/internal/api"
-	"github.com/prefecthq/terraform-provider-prefect/internal/provider/helpers"
 )
 
 var _ = api.WorkPoolsClient(&WorkPoolsClient{})
@@ -31,8 +30,8 @@ func (c *Client) WorkPools(accountID uuid.UUID, workspaceID uuid.UUID) (api.Work
 		workspaceID = c.defaultWorkspaceID
 	}
 
-	if helpers.IsCloudEndpoint(c.endpoint) && (accountID == uuid.Nil || workspaceID == uuid.Nil) {
-		return nil, fmt.Errorf("prefect Cloud endpoints require an account_id and workspace_id to be set on either the provider or the resource")
+	if err := validateCloudEndpoint(c.endpoint, accountID, workspaceID); err != nil {
+		return nil, err
 	}
 
 	return &WorkPoolsClient{