Cloud 3819 by mtahasylmz · Pull Request #52 · upstash/terraform-provider-upstash

mtahasylmz · 2026-02-18T06:40:03Z

No description provided.

linear · 2026-02-18T06:40:06Z

CLOUD-3819 Update Terraform Provider To Accept "platform" field when CreateDB

Copilot

Pull request overview

This PR introduces a new platform field to the Redis database resource while deprecating the existing region field. The change allows users to specify the cloud platform (AWS or GCP) for global databases instead of using specific region strings.

Changes:

Added platform field to CreateDatabaseRequest struct with omitempty JSON tag
Modified resource schema to add platform as optional/computed field and deprecate region field
Implemented platform inference logic in read operation based on region values ("gcp-global" → "gcp", "global" → "aws")
Updated .gitignore to exclude .env and dev.tfrc files

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 7 comments.

File	Description
upstash/redis/database/types.go	Added Platform field to CreateDatabaseRequest struct with omitempty tag
upstash/redis/database/resource.go	Added platform schema field definition, deprecated region field, added AtLeastOneOf validation
upstash/redis/database/crud.go	Added platform inference logic in resourceDatabaseRead and platform field passing in resourceDatabaseCreate
.gitignore	Added exclusions for .env and dev.tfrc development files

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-18T08:25:08Z

upstash/redis/database/resource.go

+				Type:       schema.TypeString,
+				Optional:   true,
+				ForceNew:   true,
+				Computed:   true,
+				Deprecated: "The 'region' field is deprecated. Use 'platform' field instead.",


The deprecation message for the region field is misleading. It states "Use 'platform' field instead", but the platform field serves a different purpose - it specifies whether to use AWS or GCP, not the specific region. The region field specified actual regions like "us-east-1", "global", "gcp-global", etc. Users migrating from region to platform will lose the ability to specify a specific region, which appears to be a breaking change. The deprecation message should clarify the relationship between these fields and explain the migration path more clearly.

Suggested change

Type: schema.TypeString,

Optional: true,

ForceNew: true,

Computed: true,

Deprecated: "The 'region' field is deprecated. Use 'platform' field instead.",

Type: schema.TypeString,

Optional: true,

ForceNew: true,

Computed: true,

Deprecated: "The 'region' field is deprecated and no longer used to select a specific region. Use the 'platform' field to choose the cloud provider (aws or gcp); the actual region is now determined automatically by Upstash and cannot be configured via this field.",

Copilot · 2026-02-18T08:25:09Z

upstash/redis/database/resource.go

+			"platform": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				Computed:     true,
+				ForceNew:     true,
+				Description:  "Platform of the database. Can be one of [aws, gcp]",
+				AtLeastOneOf: []string{"platform", "region"},
+			},


The new platform field and the region deprecation should be covered by integration tests. The existing test in integrationtesting/upstash_redis_database_test.go uses the region field, but there are no tests for the new platform field. Consider adding test cases that use the platform field to ensure the new functionality works correctly and that backward compatibility with the region field is maintained.

Copilot · 2026-02-18T08:25:09Z

upstash/redis/database/resource.go

+				Optional:     true,
+				Computed:     true,
+				ForceNew:     true,
+				Description:  "Platform of the database. Can be one of [aws, gcp]",


The description states the platform can be "one of [aws, gcp]" but uses non-standard documentation format. For consistency with Terraform schema conventions, consider using a format like "Possible values: aws, gcp" or listing them on separate lines. This makes the documentation clearer and more consistent with typical Terraform provider documentation patterns.

Suggested change

Description: "Platform of the database. Can be one of [aws, gcp]",

Description: "Platform of the database. Possible values: `aws`, `gcp`.",

Copilot · 2026-02-18T08:25:09Z

upstash/redis/database/crud.go

+	var platform string
+	switch database.Region {
+	case "gcp-global":
+		platform = "gcp"
+	case "global":
+		platform = "aws"
+	}


The platform inference logic only handles "gcp-global" and "global" cases. When database.Region is neither of these (e.g., specific regions like "us-east-1", "eu-west-1"), the platform variable will be an empty string. This will set the platform field to an empty string in the state, which could break existing configurations or cause confusion for users with regional databases. The logic should handle all region cases to properly infer the platform.

Copilot · 2026-02-18T08:25:10Z

upstash/redis/database/resource.go

+				Type:         schema.TypeString,
+				Optional:     true,
+				Computed:     true,
+				ForceNew:     true,
+				Description:  "Platform of the database. Can be one of [aws, gcp]",
+				AtLeastOneOf: []string{"platform", "region"},


The AtLeastOneOf constraint requires that either "platform" or "region" must be provided. However, the "region" field is marked as deprecated. This creates a confusing situation where users must still provide a deprecated field if they don't provide the platform field. A better approach would be to make platform Required (not Optional) and remove the AtLeastOneOf constraint, or ensure proper validation that guides users to use platform instead of region for new resources.

Suggested change

Type: schema.TypeString,

Optional: true,

Computed: true,

ForceNew: true,

Description: "Platform of the database. Can be one of [aws, gcp]",

AtLeastOneOf: []string{"platform", "region"},

Type: schema.TypeString,

Required: true,

ForceNew: true,

Description: "Platform of the database. Can be one of [aws, gcp]",

yes. No need to use AtLeastOneOf. marking the other as deprecated should be enough

Copilot · 2026-02-18T08:25:10Z

upstash/redis/database/resource.go

+			"platform": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				Computed:     true,
+				ForceNew:     true,
+				Description:  "Platform of the database. Can be one of [aws, gcp]",
+				AtLeastOneOf: []string{"platform", "region"},
+			},


The platform field lacks input validation. According to the description, it should be one of "aws" or "gcp", but there's no ValidateFunc or ValidateDiagFunc to enforce this. Users could provide invalid values like "azure" or "aws-east" which would likely cause API errors. Add validation to ensure only valid platform values are accepted.

Copilot · 2026-02-18T08:25:10Z

upstash/redis/database/resource.go

+				Type:       schema.TypeString,
+				Optional:   true,
+				ForceNew:   true,
+				Computed:   true,
+				Deprecated: "The 'region' field is deprecated. Use 'platform' field instead.",


When both "region" and "platform" are provided by the user, there's no validation to ensure they are compatible. For example, a user could specify platform="gcp" with region="us-east-1" (an AWS region), or platform="aws" with region="gcp-global". This could lead to API errors or unexpected behavior. Consider adding validation to ensure the platform and region values are consistent when both are provided.

Suggested change

Type: schema.TypeString,

Optional: true,

ForceNew: true,

Computed: true,

Deprecated: "The 'region' field is deprecated. Use 'platform' field instead.",

Type: schema.TypeString,

Optional: true,

ForceNew: true,

Computed: true,

Deprecated: "The 'region' field is deprecated. Use 'platform' field instead.",

ConflictsWith: []string{"platform"},

burak-upstash · 2026-02-18T08:25:24Z

upstash/redis/database/resource.go

+			"platform": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				Computed:     true,


it is not computed, given by user input

it was specifically set to be computed since, if, a user wants to use the new field instead of region, now platform field is changed from empty to some value like aws, since it has ForceNew field, terraform will destroy the existing and create a new one even the existing one was already in aws.

as a workaround, i will write a custom diff checker for terraform, it will check if the platform actually changed and then make a plan. but if it seems too complex for this, we can go back to computed: true

burak-upstash

We need to update the docs related to the change. Please check readme to see how it can be done

burak-upstash

Additional note (not in diff): resource.go:100 and resource.go:108 — the primary_region and read_regions descriptions still reference region='global', but region is now deprecated. Users following the new platform field guidance won't know these fields apply to them.

Consider updating to something like:

"Primary region for the database (Only works if platform is set or region='global'. Can be one of [...])"

burak-upstash · 2026-03-03T09:03:00Z

upstash/redis/database/crud.go

+	if _, ok := data.GetOk("platform"); ok {
+		var platform string
+		switch database.Region {
+		case "gcp-global":
+			platform = "gcp"
+		case "global":
+			platform = "aws"
+		}
+		mapping["platform"] = platform
+	}


Bug: When data.GetOk("platform") is true but the database region is not "global" or "gcp-global" (e.g. a legacy single-region DB with region "us-east-1"), the switch has no matching case and platform stays "". This empty string gets written to state via mapping["platform"] = platform, causing a perpetual plan diff on every run (config says "aws", state says "").

Fix — only set platform in the mapping when the inferred value is non-empty:

if _, ok := data.GetOk("platform"); ok { var platform string switch database.Region { case "gcp-global": platform = "gcp" case "global": platform = "aws" } if platform != "" { mapping["platform"] = platform } }

burak-upstash · 2026-03-03T09:03:00Z

upstash/redis/database/data_source.go

+	region := data.Get("region").(string)
+	var platform string
+	switch region {
+	case "gcp-global":
+		platform = "gcp"
+	case "global":
+		platform = "aws"
+	}


Minor: this region-to-platform switch logic is duplicated in crud.go:136-142. Consider extracting a shared helper so both stay in sync if the mapping ever changes (e.g. a new platform is added).

mtahasylmz added 2 commits December 23, 2025 18:17

cloud-3819-update-gitignore

c8dfd11

cloud-3819-deprecate-region-field-bring-platform

8f46a52

burak-upstash requested a review from Copilot February 18, 2026 08:21

Copilot started reviewing on behalf of burak-upstash February 18, 2026 08:21 View session

Copilot AI reviewed Feb 18, 2026

View reviewed changes

burak-upstash reviewed Feb 18, 2026

View reviewed changes

mtahasylmz added 5 commits February 25, 2026 07:40

cloud-3819-add-docs-and-fix-for-pr-review

ef664a9

cloud-3819

7c4a6cb

cloud-3819

f9fd44d

cloud-3819

aff1887

cloud-3819-fix-terraformrc-for-local-dev

ded98c7

burak-upstash reviewed Mar 3, 2026

View reviewed changes

	Description: "Platform of the database. Can be one of [aws, gcp]",
	Description: "Platform of the database. Possible values: `aws`, `gcp`.",

Conversation

mtahasylmz commented Feb 18, 2026

Uh oh!

linear bot commented Feb 18, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

burak-upstash Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

burak-upstash Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

mtahasylmz Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

burak-upstash left a comment

Choose a reason for hiding this comment

Uh oh!

burak-upstash left a comment

Choose a reason for hiding this comment

Uh oh!

burak-upstash Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

burak-upstash Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants