Update proto file definition of Read/WriteStateBytes RPCs (#37529)

* Update Read/WriteStateBytes RPCs to match hashicorp/terraform-plugin-go#531

* Run `make protobuf`

* Run `make generate`

* Update use of `proto.ReadStateBytes_ResponseChunk` in tests

* Fix how diagnostics are handled alongside EOF error, update ReadStateBytes test

* More fixes - test setup was incorrect

I think? I assume that a response would be returned full of zero-values when EOF is encountered.

Author: SarahFrench

docs/plugin-protocol/tfplugin6.proto

@@ -426,7 +426,7 @@ service 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);
+    rpc ReadStateBytes(ReadStateBytes.Request) returns (stream ReadStateBytes.Response);
     // WriteStateBytes streams byte chunks of a given state file into a state store
     rpc WriteStateBytes(stream WriteStateBytes.RequestChunk) returns (WriteStateBytes.Response);
 
@@ -923,7 +923,6 @@ message ValidateListResourceConfig {
     }
 }
 
-
 message ValidateStateStore {
     message Request {
         string type_name = 1;
@@ -949,7 +948,7 @@ message ReadStateBytes {
         string type_name = 1;
         string state_id = 2;
     }
-    message ResponseChunk {
+    message Response {
         bytes bytes = 1;
         int64 total_length = 2;
         StateRange range = 3;
@@ -959,9 +958,11 @@ message ReadStateBytes {
 
 message WriteStateBytes {
     message RequestChunk {
+        // TODO: Can we decouple this outside of the stream?
         string type_name = 1;
-        bytes bytes = 2;
         string state_id = 3;
+
+        bytes bytes = 2;
         int64 total_length = 4;
         StateRange range = 5;
     }

internal/plugin6/grpc_provider.go

@@ -1516,6 +1516,7 @@ func (p *GRPCProvider) ReadStateBytes(r providers.ReadStateBytesRequest) (resp p
 		chunk, err := client.Recv()
 		if err == io.EOF {
 			// End of stream, we're done
+			resp.Diagnostics = resp.Diagnostics.Append(convert.ProtoToDiagnostics(chunk.Diagnostics))
 			break
 		}
 		if err != nil {

internal/plugin6/grpc_provider_test.go

@@ -3519,11 +3519,11 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 		chunks := []string{"hello", "world"}
 		totalLength := len(chunks[0]) + len(chunks[1])
 		mockResp := map[int]struct {
-			resp *proto.ReadStateBytes_ResponseChunk
+			resp *proto.ReadStateBytes_Response
 			err  error
 		}{
 			0: {
-				resp: &proto.ReadStateBytes_ResponseChunk{
+				resp: &proto.ReadStateBytes_Response{
 					Bytes:       []byte(chunks[0]),
 					TotalLength: int64(totalLength),
 					Range: &proto.StateRange{
@@ -3534,7 +3534,7 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 				err: nil,
 			},
 			1: {
-				resp: &proto.ReadStateBytes_ResponseChunk{
+				resp: &proto.ReadStateBytes_Response{
 					Bytes:       []byte(chunks[1]),
 					TotalLength: int64(totalLength),
 					Range: &proto.StateRange{
@@ -3545,12 +3545,12 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 				err: nil,
 			},
 			2: {
-				resp: nil,
+				resp: &proto.ReadStateBytes_Response{},
 				err:  io.EOF,
 			},
 		}
 		var count int
-		mockReadBytesClient.EXPECT().Recv().DoAndReturn(func() (*proto.ReadStateBytes_ResponseChunk, error) {
+		mockReadBytesClient.EXPECT().Recv().DoAndReturn(func() (*proto.ReadStateBytes_Response, error) {
 			ret := mockResp[count]
 			count++
 			return ret.resp, ret.err
@@ -3595,11 +3595,11 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 		var incorrectLength int64 = 999
 		correctLength := len(chunks[0]) + len(chunks[1])
 		mockResp := map[int]struct {
-			resp *proto.ReadStateBytes_ResponseChunk
+			resp *proto.ReadStateBytes_Response
 			err  error
 		}{
 			0: {
-				resp: &proto.ReadStateBytes_ResponseChunk{
+				resp: &proto.ReadStateBytes_Response{
 					Bytes:       []byte(chunks[0]),
 					TotalLength: incorrectLength,
 					Range: &proto.StateRange{
@@ -3610,7 +3610,7 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 				err: nil,
 			},
 			1: {
-				resp: &proto.ReadStateBytes_ResponseChunk{
+				resp: &proto.ReadStateBytes_Response{
 					Bytes:       []byte(chunks[1]),
 					TotalLength: incorrectLength,
 					Range: &proto.StateRange{
@@ -3621,12 +3621,12 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 				err: nil,
 			},
 			2: {
-				resp: nil,
+				resp: &proto.ReadStateBytes_Response{},
 				err:  io.EOF,
 			},
 		}
 		var count int
-		mockReadBytesClient.EXPECT().Recv().DoAndReturn(func() (*proto.ReadStateBytes_ResponseChunk, error) {
+		mockReadBytesClient.EXPECT().Recv().DoAndReturn(func() (*proto.ReadStateBytes_Response, error) {
 			ret := mockResp[count]
 			count++
 			return ret.resp, ret.err
@@ -3702,7 +3702,7 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 		).Return(mockReadBytesClient, nil)
 
 		// Define what will be returned by each call to Recv
-		mockReadBytesClient.EXPECT().Recv().Return(&proto.ReadStateBytes_ResponseChunk{
+		mockReadBytesClient.EXPECT().Recv().Return(&proto.ReadStateBytes_Response{
 			Diagnostics: []*proto.Diagnostic{
 				&proto.Diagnostic{
 					Severity: proto.Diagnostic_ERROR,
@@ -3752,15 +3752,15 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 		).Return(mockReadBytesClient, nil)
 
 		// Define what will be returned by each call to Recv
-		mockReadBytesClient.EXPECT().Recv().Return(&proto.ReadStateBytes_ResponseChunk{
+		mockReadBytesClient.EXPECT().Recv().Return(&proto.ReadStateBytes_Response{
 			Diagnostics: []*proto.Diagnostic{
 				&proto.Diagnostic{
 					Severity: proto.Diagnostic_WARNING,
 					Summary:  "Warning from test",
 					Detail:   "This warning is forced by the test case",
 				},
 			},
-		}, nil)
+		}, io.EOF)
 
 		// Act
 		request := providers.ReadStateBytesRequest{
@@ -3801,7 +3801,7 @@ func TestGRPCProvider_ReadStateBytes(t *testing.T) {
 		).Return(mockClient, nil)
 
 		mockError := errors.New("grpc error forced in test")
-		mockClient.EXPECT().Recv().Return(&proto.ReadStateBytes_ResponseChunk{}, mockError)
+		mockClient.EXPECT().Recv().Return(&proto.ReadStateBytes_Response{}, mockError)
 
 		// Act
 		request := providers.ReadStateBytesRequest{