tfprotov6: Add protocol support for pluggable state storage (#563)

* Add protocol support for pluggable state stores

* Implement ValidateStateStoreConfig + ConfigureStateStore methods

* implement ReadStateBytes

* implement WriteStateBytes

* Use iter.Seq2 to allow errors to be accessed by calling code in downstream provider implementation

* Stop iterator using return instead of break

* Formatting

* Update `WriteStateBytesStream` to not use Seq2, instead iterate over 'messages' that contain both chunk data and any raised grpc errors

* Seeing what it looks like to use 'message' as name

* Seeing what it looks like to avoid 'messages' name

* Update WriteStateBytesStreamMsg => WriteStateBytesChunk

* implement state chunk size negotiation

* handle metadata in WriteStateBytes correctly

* Add LockState and UnlockState methods to .proto file for Protocol v6

* Run `make protobuf`

* Add handwritten code related to LockState and UnlockState RPCs

* Running `make protobuf` after rebasing onto main

* Add missing (Lock/Unlock)State related code

* add LockId mapping :P

---------

Co-authored-by: Sarah French <[email protected]>

Author: radeksimko

internal/logging/context.go

@@ -109,6 +109,15 @@ func ActionContext(ctx context.Context, action string) context.Context {
 	return ctx
 }
 
+// StateStoreContext injects the state store type into logger contexts.
+func StateStoreContext(ctx context.Context, stateStore string) context.Context {
+	ctx = tfsdklog.SetField(ctx, KeyStateStoreType, stateStore)
+	ctx = tfsdklog.SubsystemSetField(ctx, SubsystemProto, KeyStateStoreType, stateStore)
+	ctx = tflog.SetField(ctx, KeyStateStoreType, stateStore)
+
+	return ctx
+}
+
 // RpcContext injects the RPC name into logger contexts.
 func RpcContext(ctx context.Context, rpc string) context.Context {
 	ctx = tfsdklog.SetField(ctx, KeyRPC, rpc)

internal/logging/keys.go

@@ -66,6 +66,9 @@ const (
 	// The action being operated on
 	KeyActionType = "tf_action_type"
 
+	// The type of state store being operated on, such as "terraform_fs"
+	KeyStateStoreType = "tf_state_store_type"
+
 	// Path to protocol data file, such as "/tmp/example.json"
 	KeyProtocolDataFile = "tf_proto_data_file"
 

tfprotov6/internal/fromproto/state_store.go

@@ -0,0 +1,90 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package fromproto
+
+import (
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6/internal/tfplugin6"
+)
+
+func ValidateStateStoreRequest(in *tfplugin6.ValidateStateStore_Request) *tfprotov6.ValidateStateStoreRequest {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov6.ValidateStateStoreRequest{
+		TypeName: in.TypeName,
+		Config:   DynamicValue(in.Config),
+	}
+}
+
+func ConfigureStateStoreRequest(in *tfplugin6.ConfigureStateStore_Request) *tfprotov6.ConfigureStateStoreRequest {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov6.ConfigureStateStoreRequest{
+		TypeName: in.TypeName,
+		Config:   DynamicValue(in.Config),
+		Capabilities: tfprotov6.StateStoreClientCapabilities{
+			ChunkSize: in.Capabilities.ChunkSize,
+		},
+	}
+}
+
+func ReadStateBytesRequest(in *tfplugin6.ReadStateBytes_Request) *tfprotov6.ReadStateBytesRequest {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov6.ReadStateBytesRequest{
+		TypeName: in.TypeName,
+		StateId:  in.StateId,
+	}
+}
+
+func GetStatesRequest(in *tfplugin6.GetStates_Request) *tfprotov6.GetStatesRequest {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov6.GetStatesRequest{
+		TypeName: in.TypeName,
+	}
+}
+
+func DeleteStateRequest(in *tfplugin6.DeleteState_Request) *tfprotov6.DeleteStateRequest {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov6.DeleteStateRequest{
+		TypeName: in.TypeName,
+		StateId:  in.StateId,
+	}
+}
+
+func LockStateRequest(in *tfplugin6.LockState_Request) *tfprotov6.LockStateRequest {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov6.LockStateRequest{
+		TypeName:  in.TypeName,
+		StateId:   in.StateId,
+		Operation: in.Operation,
+	}
+}
+
+func UnlockStateRequest(in *tfplugin6.UnlockState_Request) *tfprotov6.UnlockStateRequest {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov6.UnlockStateRequest{
+		TypeName: in.TypeName,
+		StateId:  in.StateId,
+		LockId:   in.LockId,
+	}
+}