Implement ReadStateBytes + WriteStateBytes

radeksimko · radeksimko · commit f185ebe0ee03 · 2025-08-14T09:54:30.000+02:00
diff --git a/docs/plugin-protocol/tfplugin6.proto b/docs/plugin-protocol/tfplugin6.proto
@@ -425,6 +425,11 @@ service Provider {
     // ConfigureStateStore configures the state store, such as S3 connection in the context of already configured provider
     rpc ConfigureStateStore(ConfigureStateStore.Request) returns (ConfigureStateStore.Response);
 
+    // ReadStateBytes streams byte chunks of a given state file from a state store
+    rpc ReadStateBytes(ReadStateBytes.Request) returns (stream ReadStateBytes.ResponseChunk);
+    // WriteStateBytes streams byte chunks of a given state file into a state store
+    rpc WriteStateBytes(stream WriteStateBytes.RequestChunk) returns (stream WriteStateBytes.Response);
+
     // GetStates returns a list of all states (i.e. CE workspaces) managed by a given state store
     rpc GetStates(GetStates.Request) returns (GetStates.Response);
     // DeleteState instructs a given state store to delete a specific state (i.e. a CE workspace)
@@ -939,6 +944,37 @@ message ConfigureStateStore {
     }
 }
 
+message ReadStateBytes {
+    message Request {
+        string type_name = 1;
+        string state_id = 2;
+    }
+    message ResponseChunk {
+        bytes data = 1;
+        // supplied with the first chunk
+        optional StateMeta meta = 2;
+        repeated Diagnostic diagnostics = 3;
+    }
+}
+
+message WriteStateBytes {
+    message RequestChunk {
+        string type_name = 1;
+        bytes data = 2;
+        string state_id = 3;
+        // supplied with the first chunk
+        optional StateMeta meta = 4;
+    }
+    message Response {
+        repeated Diagnostic diagnostics = 1;
+    }
+}
+
+message StateMeta {
+	bytes checksum = 1;
+    int64 number_of_chunks = 2;
+}
+
 message GetStates {
 	message Request {
 		string type_name = 1;
diff --git a/internal/builtin/providers/terraform/provider.go b/internal/builtin/providers/terraform/provider.go
@@ -291,6 +291,18 @@ func (p *Provider) ConfigureStateStore(req providers.ConfigureStateStoreRequest)
 	return resp
 }
 
+func (p *Provider) ReadStateBytes(req providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {
+	var resp providers.ReadStateBytesResponseChunk
+	resp.Diagnostics.Append(fmt.Errorf("unsupported state store type %q", req.TypeName))
+	return resp
+}
+
+func (p *Provider) WriteStateBytes(req providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {
+	var resp providers.WriteStateBytesResponse
+	resp.Diagnostics.Append(fmt.Errorf("unsupported state store type %q", req.TypeName))
+	return resp
+}
+
 func (p *Provider) GetStates(req providers.GetStatesRequest) providers.GetStatesResponse {
 	var resp providers.GetStatesResponse
 	resp.Diagnostics.Append(fmt.Errorf("unsupported state store type %q", req.TypeName))
diff --git a/internal/grpcwrap/provider6.go b/internal/grpcwrap/provider6.go
@@ -918,6 +918,14 @@ func (p *provider6) ConfigureStateStore(ctx context.Context, req *tfplugin6.Conf
 	panic("not implemented")
 }
 
+func (p *provider6) ReadStateBytes(req *tfplugin6.ReadStateBytes_Request, srv tfplugin6.Provider_ReadStateBytesServer) error {
+	panic("not implemented")
+}
+
+func (p *provider6) WriteStateBytes(srv tfplugin6.Provider_WriteStateBytesServer) error {
+	panic("not implemented")
+}
+
 func (p *provider6) GetStates(ctx context.Context, req *tfplugin6.GetStates_Request) (*tfplugin6.GetStates_Response, error) {
 	panic("not implemented")
 }
diff --git a/internal/plugin/grpc_provider.go b/internal/plugin/grpc_provider.go
@@ -1418,6 +1418,14 @@ func (p *GRPCProvider) ConfigureStateStore(r providers.ConfigureStateStoreReques
 	panic("not implemented")
 }
 
+func (p *GRPCProvider) ReadStateBytes(r providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {
+	panic("not implemented")
+}
+
+func (p *GRPCProvider) WriteStateBytes(r providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {
+	panic("not implemented")
+}
+
 func (p *GRPCProvider) GetStates(r providers.GetStatesRequest) providers.GetStatesResponse {
 	panic("not implemented")
 }
diff --git a/internal/plugin6/grpc_provider.go b/internal/plugin6/grpc_provider.go
@@ -1478,6 +1478,22 @@ func (p *GRPCProvider) ConfigureStateStore(r providers.ConfigureStateStoreReques
 	return resp
 }
 
+func (p *GRPCProvider) ReadStateBytes(r providers.ReadStateBytesRequest) (resp providers.ReadStateBytesResponseChunk) {
+	logger.Trace("GRPCProvider.v6: ReadStateBytes")
+
+	// TODO
+
+	return resp
+}
+
+func (p *GRPCProvider) WriteStateBytes(r providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {
+	logger.Trace("GRPCProvider.v6: WriteStateBytes")
+
+	// TODO
+
+	return providers.WriteStateBytesResponse{}
+}
+
 func (p *GRPCProvider) GetStates(r providers.GetStatesRequest) (resp providers.GetStatesResponse) {
 	logger.Trace("GRPCProvider.v6: GetStates")
 
diff --git a/internal/plugin6/mock_proto/mock.go b/internal/plugin6/mock_proto/mock.go
diff --git a/internal/provider-simple-v6/provider.go b/internal/provider-simple-v6/provider.go
@@ -311,6 +311,14 @@ func (s simple) ConfigureStateStore(req providers.ConfigureStateStoreRequest) pr
 	panic("not implemented")
 }
 
+func (s simple) ReadStateBytes(req providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {
+	panic("not implemented")
+}
+
+func (s simple) WriteStateBytes(req providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {
+	panic("not implemented")
+}
+
 func (s simple) GetStates(req providers.GetStatesRequest) providers.GetStatesResponse {
 	panic("not implemented")
 }
diff --git a/internal/provider-simple/provider.go b/internal/provider-simple/provider.go
@@ -271,6 +271,14 @@ func (s simple) ConfigureStateStore(req providers.ConfigureStateStoreRequest) pr
 	panic("not implemented")
 }
 
+func (s simple) ReadStateBytes(req providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {
+	panic("not implemented")
+}
+
+func (s simple) WriteStateBytes(req providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {
+	panic("not implemented")
+}
+
 func (s simple) GetStates(req providers.GetStatesRequest) providers.GetStatesResponse {
 	// provider-simple uses protocol version 5, which does not include the RPC that maps to this method
 	panic("not implemented")
diff --git a/internal/providers/mock.go b/internal/providers/mock.go
@@ -432,6 +432,14 @@ func (m *Mock) ConfigureStateStore(req ConfigureStateStoreRequest) ConfigureStat
 	return m.Provider.ConfigureStateStore(req)
 }
 
+func (m *Mock) ReadStateBytes(req ReadStateBytesRequest) ReadStateBytesResponseChunk {
+	return m.Provider.ReadStateBytes(req)
+}
+
+func (m *Mock) WriteStateBytes(req WriteStateBytesRequestChunk) WriteStateBytesResponse {
+	return m.Provider.WriteStateBytes(req)
+}
+
 func (m *Mock) GetStates(req GetStatesRequest) GetStatesResponse {
 	return m.Provider.GetStates(req)
 }
diff --git a/internal/providers/provider.go b/internal/providers/provider.go
@@ -118,6 +118,11 @@ type Interface interface {
 	// ConfigureStateStore configures the state store, such as S3 connection in the context of already configured provider
 	ConfigureStateStore(ConfigureStateStoreRequest) ConfigureStateStoreResponse
 
+	// ReadStateBytes streams byte chunks of a given state file from a state store
+	ReadStateBytes(ReadStateBytesRequest) ReadStateBytesResponseChunk
+	// WriteStateBytes streams byte chunks of a given state file into a state store
+	WriteStateBytes(WriteStateBytesRequestChunk) WriteStateBytesResponse
+
 	// GetStates returns a list of all states (i.e. CE workspaces) managed by a given state store
 	GetStates(GetStatesRequest) GetStatesResponse
 	// DeleteState instructs a given state store to delete a specific state (i.e. a CE workspace)
@@ -850,6 +855,43 @@ type ConfigureStateStoreResponse struct {
 	Diagnostics tfdiags.Diagnostics
 }
 
+type ReadStateBytesRequest struct {
+	// TypeName is the name of the state store to read state from
+	TypeName string
+	// StateId is the ID of a state file to read
+	StateId string
+}
+
+type ReadStateBytesResponseChunk struct {
+	// Data is a chunk of bytes of the given state file being read
+	Data []byte
+	// Meta is metadata concerning the state file stream
+	Meta *StateMeta
+	// Diagnostics contains any warnings or errors from the method call.
+	Diagnostics tfdiags.Diagnostics
+}
+
+type WriteStateBytesRequestChunk struct {
+	// TypeName is the name of the state store to write state to
+	TypeName string
+	// Data is a chunk of bytes of the given state file being written
+	Data []byte
+	// StateId is the ID of a state file to write
+	StateId string
+	// Meta is metadata concerning the state file stream
+	Meta *StateMeta
+}
+
+type WriteStateBytesResponse struct {
+	// Diagnostics contains any warnings or errors from the method call.
+	Diagnostics tfdiags.Diagnostics
+}
+
+type StateMeta struct {
+	Checksum       []byte
+	NumberOfChunks int64
+}
+
 type GetStatesRequest struct {
 	// TypeName is the name of the state store to request the list of states from
 	TypeName string
diff --git a/internal/providers/testing/provider_mock.go b/internal/providers/testing/provider_mock.go
@@ -141,6 +141,16 @@ type MockProvider struct {
 	ConfigureStateStoreRequest  providers.ConfigureStateStoreRequest
 	ConfigureStateStoreFn       func(providers.ConfigureStateStoreRequest) providers.ConfigureStateStoreResponse
 
+	ReadStateBytesCalled   bool
+	ReadStateBytesRequest  providers.ReadStateBytesRequest
+	ReadStateBytesFn       func(providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk
+	ReadStateBytesResponse providers.ReadStateBytesResponseChunk
+
+	WriteStateBytesCalled   bool
+	WriteStateBytesRequest  providers.WriteStateBytesRequestChunk
+	WriteStateBytesFn       func(providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse
+	WriteStateBytesResponse providers.WriteStateBytesResponse
+
 	GetStatesCalled   bool
 	GetStatesResponse *providers.GetStatesResponse
 	GetStatesRequest  providers.GetStatesRequest
@@ -299,6 +309,32 @@ func (p *MockProvider) ValidateDataResourceConfig(r providers.ValidateDataResour
 	return resp
 }
 
+func (p *MockProvider) ReadStateBytes(r providers.ReadStateBytesRequest) (resp providers.ReadStateBytesResponseChunk) {
+	p.Lock()
+	defer p.Unlock()
+	p.ReadStateBytesCalled = true
+	p.ReadStateBytesRequest = r
+
+	if p.ReadStateBytesFn != nil {
+		return p.ReadStateBytesFn(r)
+	}
+
+	return p.ReadStateBytesResponse
+}
+
+func (p *MockProvider) WriteStateBytes(r providers.WriteStateBytesRequestChunk) (resp providers.WriteStateBytesResponse) {
+	p.Lock()
+	defer p.Unlock()
+	p.WriteStateBytesCalled = true
+	p.WriteStateBytesRequest = r
+
+	if p.WriteStateBytesFn != nil {
+		return p.WriteStateBytesFn(r)
+	}
+
+	return p.WriteStateBytesResponse
+}
+
 func (p *MockProvider) ValidateEphemeralResourceConfig(r providers.ValidateEphemeralResourceConfigRequest) (resp providers.ValidateEphemeralResourceConfigResponse) {
 	defer p.beginWrite()()
 
diff --git a/internal/refactoring/mock_provider.go b/internal/refactoring/mock_provider.go
@@ -130,6 +130,14 @@ func (provider *mockProvider) ConfigureStateStore(req providers.ConfigureStateSt
 	panic("not implemented in mock")
 }
 
+func (provider *mockProvider) ReadStateBytes(req providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {
+	panic("not implemented in mock")
+}
+
+func (provider *mockProvider) WriteStateBytes(req providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {
+	panic("not implemented in mock")
+}
+
 func (provider *mockProvider) GetStates(req providers.GetStatesRequest) providers.GetStatesResponse {
 	panic("not implemented in mock")
 }
diff --git a/internal/stacks/stackruntime/internal/stackeval/stubs/errored.go b/internal/stacks/stackruntime/internal/stackeval/stubs/errored.go
@@ -271,6 +271,34 @@ func (p *erroredProvider) ConfigureStateStore(providers.ConfigureStateStoreReque
 	}
 }
 
+// ReadStateBytes implements providers.Interface.
+func (p *erroredProvider) ReadStateBytes(providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {
+	var diags tfdiags.Diagnostics
+	diags = diags.Append(tfdiags.AttributeValue(
+		tfdiags.Error,
+		"Provider configuration is invalid",
+		"Cannot read state managed by this state store because its associated provider configuration is invalid.",
+		nil, // nil attribute path means the overall configuration block
+	))
+	return providers.ReadStateBytesResponseChunk{
+		Diagnostics: diags,
+	}
+}
+
+// WriteStateBytes implements providers.Interface.
+func (p *erroredProvider) WriteStateBytes(providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {
+	var diags tfdiags.Diagnostics
+	diags = diags.Append(tfdiags.AttributeValue(
+		tfdiags.Error,
+		"Provider configuration is invalid",
+		"Cannot write state managed by this state store because its associated provider configuration is invalid.",
+		nil, // nil attribute path means the overall configuration block
+	))
+	return providers.WriteStateBytesResponse{
+		Diagnostics: diags,
+	}
+}
+
 // GetStates implements providers.Interface.
 func (p *erroredProvider) GetStates(providers.GetStatesRequest) providers.GetStatesResponse {
 	var diags tfdiags.Diagnostics
diff --git a/internal/stacks/stackruntime/internal/stackeval/stubs/offline.go b/internal/stacks/stackruntime/internal/stackeval/stubs/offline.go
diff --git a/internal/stacks/stackruntime/internal/stackeval/stubs/unknown.go b/internal/stacks/stackruntime/internal/stackeval/stubs/unknown.go
diff --git a/internal/tfplugin6/tfplugin6.pb.go b/internal/tfplugin6/tfplugin6.pb.go

Original file line number	Diff line number	Diff line change
`@@ -918,6 +918,14 @@ func (p provider6) ConfigureStateStore(ctx context.Context, req tfplugin6.Conf`
`918`	`918`	`panic("not implemented")`
`919`	`919`	`}`
`920`	`920`
	`921`	`+func (p provider6) ReadStateBytes(req tfplugin6.ReadStateBytes_Request, srv tfplugin6.Provider_ReadStateBytesServer) error {`
	`922`	`+ panic("not implemented")`
	`923`	`+}`
	`924`	`+`
	`925`	`+func (p *provider6) WriteStateBytes(srv tfplugin6.Provider_WriteStateBytesServer) error {`
	`926`	`+ panic("not implemented")`
	`927`	`+}`
	`928`	`+`
`921`	`929`	`func (p provider6) GetStates(ctx context.Context, req tfplugin6.GetStates_Request) (*tfplugin6.GetStates_Response, error) {`
`922`	`930`	`panic("not implemented")`
`923`	`931`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1418,6 +1418,14 @@ func (p *GRPCProvider) ConfigureStateStore(r providers.ConfigureStateStoreReques`
`1418`	`1418`	`panic("not implemented")`
`1419`	`1419`	`}`
`1420`	`1420`
	`1421`	`+func (p *GRPCProvider) ReadStateBytes(r providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {`
	`1422`	`+ panic("not implemented")`
	`1423`	`+}`
	`1424`	`+`
	`1425`	`+func (p *GRPCProvider) WriteStateBytes(r providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {`
	`1426`	`+ panic("not implemented")`
	`1427`	`+}`
	`1428`	`+`
`1421`	`1429`	`func (p *GRPCProvider) GetStates(r providers.GetStatesRequest) providers.GetStatesResponse {`
`1422`	`1430`	`panic("not implemented")`
`1423`	`1431`	`}`
Original file line number	Diff line number	Diff line change
`@@ -311,6 +311,14 @@ func (s simple) ConfigureStateStore(req providers.ConfigureStateStoreRequest) pr`
`311`	`311`	`panic("not implemented")`
`312`	`312`	`}`
`313`	`313`
	`314`	`+func (s simple) ReadStateBytes(req providers.ReadStateBytesRequest) providers.ReadStateBytesResponseChunk {`
	`315`	`+ panic("not implemented")`
	`316`	`+}`
	`317`	`+`
	`318`	`+func (s simple) WriteStateBytes(req providers.WriteStateBytesRequestChunk) providers.WriteStateBytesResponse {`
	`319`	`+ panic("not implemented")`
	`320`	`+}`
	`321`	`+`
`314`	`322`	`func (s simple) GetStates(req providers.GetStatesRequest) providers.GetStatesResponse {`
`315`	`323`	`panic("not implemented")`
`316`	`324`	`}`
Original file line number	Diff line number	Diff line change
`@@ -432,6 +432,14 @@ func (m *Mock) ConfigureStateStore(req ConfigureStateStoreRequest) ConfigureStat`
`432`	`432`	`return m.Provider.ConfigureStateStore(req)`
`433`	`433`	`}`
`434`	`434`
	`435`	`+func (m *Mock) ReadStateBytes(req ReadStateBytesRequest) ReadStateBytesResponseChunk {`
	`436`	`+ return m.Provider.ReadStateBytes(req)`
	`437`	`+}`
	`438`	`+`
	`439`	`+func (m *Mock) WriteStateBytes(req WriteStateBytesRequestChunk) WriteStateBytesResponse {`
	`440`	`+ return m.Provider.WriteStateBytes(req)`
	`441`	`+}`
	`442`	`+`
`435`	`443`	`func (m *Mock) GetStates(req GetStatesRequest) GetStatesResponse {`
`436`	`444`	`return m.Provider.GetStates(req)`
`437`	`445`	`}`