Creating an Http State Store by rainkwan · Pull Request #602 · hashicorp/terraform-provider-http

rainkwan · 2026-03-17T14:49:04Z

Related Issue

Fixes #

Description

Moving Http from the backend in Terraform core to a state store

Rollback Plan

If a change needs to be reverted, we will roll out an update to the code within 7 days.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
No

… core version

…p-state-store

Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.79.2 to 1.79.3. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](grpc/grpc-go@v1.79.2...v1.79.3) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-version: 1.79.3 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

# Conflicts: # go.mod # go.sum

… core version

…p-state-store # Conflicts: # go.mod # go.sum # internal/provider/state_store_http.go # internal/provider/state_store_http_test.go

…rom backend and corresponding tests

austinvalle

Great work! Left some comments 🚀

austinvalle · 2026-03-23T19:09:13Z

+	return []func() statestore.StateStore{
+		func() statestore.StateStore { return NewHttpStateStore(p.terraformVersion) },
+	}


I'm going to consider this a nit because technically this currently works due to the order of RPC calls + the version data being hardcoded in to Terraform core.

We wouldn't typically recommend providers inject data from configure into these constructor's directly, since Framework doesn't have any control/contract with the provider developer that we are expecting them to use it this way, it's just an internal framework implementation detail.

If in the future we changed when we create state store implementations (as an example), we would expect provider developers to use the recommended provider.ConfigureResponse.StateStoreData -> statestore.InitializeResponse.StateStoreData -> statestore.ConfigureRequest.StateStoreData data flow, so it's possible we could break code like this without knowing. (hyrums law almost always bites us anyways, but if we can avoid it, usually preferable)

austinvalle · 2026-03-23T19:14:36Z

@@ -0,0 +1,5 @@
+kind: BREAKING CHANGES
+body: 'ProtocolV6: only Terraform 1.0+ is supported for this version of the provider. Earlier versions of Terraform will need to pin the provider version to 3.5.0'


nit: In relation to this change, looks like we have some other docs to update (maybe more, i didn't do a deep look through the repo) -> https://github.com/hashicorp/terraform-provider-http?tab=readme-ov-file#compatibility

austinvalle · 2026-03-23T19:40:45Z

+
+func (s *httpStateStore) Schema(ctx context.Context, req statestore.SchemaRequest, resp *statestore.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Description: "HTTP state store for managing Terraform state via HTTP endpoints",


We'll want to generate the documentation related to this new state store (not yet released in plugin-docs, but it is available on main via hashicorp/terraform-plugin-docs#570).

Once we do that, we should either add a template or update this description to have a little bit more detail about what exactly this state store does and more importantly what it expects the backing APIs to support. The existing HTTP backend is a good place to look to get an idea: https://developer.hashicorp.com/terraform/language/backend/http

In addition to that, we'll want to add some examples, as well as some documentation on migrating from the existing HTTP backend (which we might not be able to write yet until TF core has those exact commands/flags figured out)

austinvalle · 2026-03-23T19:46:27Z

+func (s *httpStateStore) Schema(ctx context.Context, req statestore.SchemaRequest, resp *statestore.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Description: "HTTP state store for managing Terraform state via HTTP endpoints",
+		Attributes: map[string]schema.Attribute{


Just a general note for all of these attributes, if there is an environment variable default, we should add it to the description (as well as any additional defaults not related to environment variables, see)

austinvalle · 2026-03-23T19:48:26Z

+				},
+			},
+			"lock_address": schema.StringAttribute{
+				Description: "The address of the HTTP endpoint for state locking. Optional.",


Plugin docs will add the optional portion of this message, so we can remove that.

If we want to add any wording, mentioning that locking will be disabled if this isn't provided might be useful 👍🏻

austinvalle · 2026-03-24T20:27:24Z

+	if req.LockID != "" && (s.client.lockID == "" || s.client.lockID != req.LockID || len(unlockData) == 0) {
+		fallbackUnlockInfo := httpLockInfo{
+			ID: req.LockID,
+		}
+		marshaledUnlockData, err := json.Marshal(fallbackUnlockInfo)
+		if err != nil {
+			resp.Diagnostics.AddError(
+				"Error marshaling unlock info",
+				fmt.Sprintf("Error marshaling unlock info to JSON: %s", err),
+			)
+			return
+		}
+		unlockData = marshaledUnlockData
+	}


This code is very strange and I'm wondering what it's purpose is 🤔

req.LockID should never be empty and if this saved s.client.lockID is not the same as req.LockID, then I would suspect something else has gone wrong. It may be necessary but I would suggest investigating and adding a comment to explain what the goal here is for future maintainers

austinvalle · 2026-03-24T20:29:07Z

+		return
+	}
+
+	httpReq.Header.Set("Content-Type", "application/json")


Similar comment to Write/Lock, missing content length + md5 headers

austinvalle · 2026-03-24T20:44:04Z

+	)
+}
+
+func (s *httpStateStore) DeleteState(ctx context.Context, req statestore.DeleteStateRequest, resp *statestore.DeleteStateResponse) {


This is a question that might need more investigation, but does DeleteState even get called for a state store like this, which doesn't support multiple workspaces....

I'm not sure if you're allowed to delete the default workspace 🤔 , if so, this might all be dead code 😅

austinvalle · 2026-03-24T20:47:49Z

This is a great chunk of tests that I think covers a good majority of the functionality provided (and more then what was originally tested in TF core!)

The only thing that could potentially be improved here is just some generally refactoring, sharing http test server implementations when possible, etc.

austinvalle and others added 3 commits February 26, 2026 14:16

first draft + todos

1f0d5a7

update

3dc990b

Adjusted the httpLockInfo struct to more closely align with terraform…

fa5ee1d

… core version

github-actions Bot added dependencies size/XL labels Mar 17, 2026

rainkwan and others added 19 commits March 17, 2026 10:54

Merge branch 'main' into av/http-state-store

9110e6c

Adding copywrite headers

5b28cf0

Merge remote-tracking branch 'origin/av/http-state-store' into av/htt…

50620bd

…p-state-store

Delete TODO.md

67dd0e6

updating with temporary testing branch

caeacf8

Merge remote-tracking branch 'origin/av/http-state-store' into av/htt…

34cabeb

…p-state-store

Added some of the todo tests

b52b704

appeasing the linter

c17e8c6

Toggle debug flag

93361ea

first draft + todos

5278551

# Conflicts: # go.mod # go.sum

Adjusted the httpLockInfo struct to more closely align with terraform…

7a384a9

… core version

Adding copywrite headers

a732071

Delete TODO.md

9a3e41e

Added some of the todo tests

4130754

appeasing the linter

3b12d3c

Toggle debug flag

16edca8

Did some changes to testing and tried to match terraform core moreso

bbf6ae9

Merge remote-tracking branch 'origin/av/http-state-store' into av/htt…

a2de6a0

…p-state-store # Conflicts: # go.mod # go.sum # internal/provider/state_store_http.go # internal/provider/state_store_http_test.go

rainkwan added this to the v3.6.0 milestone Mar 19, 2026

adjusted some documentation

d76ff41

rainkwan marked this pull request as ready for review March 19, 2026 17:35

rainkwan requested a review from a team as a code owner March 19, 2026 17:35

Added environment variable support to initialize to mimic configure f…

08fe976

…rom backend and corresponding tests

austinvalle reviewed Mar 24, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Creating an Http State Store#602

Creating an Http State Store#602
rainkwan wants to merge 24 commits intomainfrom
av/http-state-store

rainkwan commented Mar 17, 2026

Uh oh!

austinvalle left a comment •

edited

Loading

Uh oh!

austinvalle Mar 23, 2026

Uh oh!

austinvalle Mar 23, 2026

Uh oh!

austinvalle Mar 23, 2026

Uh oh!

austinvalle Mar 23, 2026

Uh oh!

austinvalle Mar 23, 2026

Uh oh!

austinvalle Mar 24, 2026

Uh oh!

austinvalle Mar 24, 2026

Uh oh!

austinvalle Mar 24, 2026

Uh oh!

Uh oh!

austinvalle Mar 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -0,0 +1,5 @@
		kind: BREAKING CHANGES
		body: 'ProtocolV6: only Terraform 1.0+ is supported for this version of the provider. Earlier versions of Terraform will need to pin the provider version to 3.5.0'

Conversation

rainkwan commented Mar 17, 2026

Related Issue

Description

Rollback Plan

Changes to Security Controls

Uh oh!

austinvalle left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

austinvalle left a comment •

edited

Loading