Update proto file definition of Read/WriteStateBytes RPCs #37529

SarahFrench · 2025-08-29T13:42:33Z

Updates the base branch to include proto changes introduced in hashicorp/terraform-plugin-go#531

Target Release

N/A

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.

CHANGELOG entry

This change is user-facing and I added a changelog entry.
This change is not user-facing.

…go#531

…Bytes test

SarahFrench · 2025-08-29T16:46:29Z

In f705ad7 I was fixing this test failure:

--- FAIL: TestGRPCProvider_ReadStateBytes (0.00s)
    --- FAIL: TestGRPCProvider_ReadStateBytes/warning_diagnostics_from_the_provider_are_returned (0.00s)
        grpc_provider.go:1516: Unexpected call to *mock_tfplugin6.MockProvider_ReadStateBytesClient.Recv([]) at /home/runner/work/terraform/terraform/internal/plugin6/grpc_provider.go:1516 because: 
            expected call at /home/runner/work/terraform/terraform/internal/plugin6/grpc_provider_test.go:3755 has already been called the max number of times
FAIL
coverage: 60.5% of statements

...and I found that diagnostics returned with the EOF were not being passed through.

I think this was missed when merging tests into the base branch in the past? Not sure.

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

* 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.

* Implement ReadStateBytes + WriteStateBytes * [WIP] - Testing ReadStateBytes and WriteStateBytes (#37464) * Fix nil pointer error * Add WIP test for ReadStateBytes * Move test mock to separate testing file * Update mock to send unexpected EOF when there's a problem returning data and it's not a true EOF * Add test case for when length != expected length * Add test for when trying to read state from a store type that doesn't exist * Change symbol names to lowercase * Add ability to force a diagnostic to be returned from `mockReadStateBytesClient`'s `Recv` method * Add test showing error diagnostics raised by the ReadStateBytes client are returned * Add missing header * Simplify mock by using an embedded type * Rename `mockOpts` to `mockReadStateBytesOpts` * Update existing tests to assert what arguments are passed to the RPC method call * Add mock WriteStateBytesClient which uses `go.uber.org/mock/gomock` to enable assertions about calls to Send * Add a test for WriteStateBytes that makes assertions about calls to the Send method * Update test case to explicitly test writing data smaller than the chunk size * Implement chunking in WriteStateBytes, add test case to assert expected chunking behaviour * Add generated mock for Provider_WriteStateBytesClient in protocol v6 * Update tests to use new `MockProvider_WriteStateBytesClient`, remove handwritten mock * Update code comments in test * Add tests for diagnostics and errors returned during WriteStateBytes * Add generated mock for Provider_ReadStateBytesClient in protocol v6, replace old mock * Add test case for grpc errors in ReadStateBytes, fix how error is returned * Typo in comment * Add missing warning test, rename some test cases * 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. * WIP - avoid crash if chunk is nil * Sarah's updates to radek/pss-read-write (#37642) * Update code to not expect a chunk when EOF encountered * Return early if any grpc errors are encountered during ReadStateBytes * Close the stream with CloseSend once everything's read without error. Add test case about handling grpc errors from CloseSend. * Fix test case about warnings: We would expect to receive a chunk with data alongside the warning and have a normal closing of the stream after EOF * Add log line, remove unneeded type info * Implement configurable state chunk size * handle metadata in WriteStateBytes correctly * validate chunk sizes received from provider * ReadStateBytes: avoid early return on warnings --------- Co-authored-by: Sarah French <[email protected]>

* 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.

github-actions · 2025-10-03T02:15:02Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

SarahFrench added 3 commits August 29, 2025 14:36

Update Read/WriteStateBytes RPCs to match hashicorp/terraform-plugin-…

60cb773

…go#531

Run make protobuf

1a80026

Run make generate

167ea42

SarahFrench added the no-changelog-needed Add this to your PR if the change does not require a changelog entry label Aug 29, 2025

Update use of proto.ReadStateBytes_ResponseChunk in tests

7f987b6

SarahFrench requested a review from radeksimko August 29, 2025 16:25

Fix how diagnostics are handled alongside EOF error, update ReadState…

f705ad7

…Bytes test

SarahFrench marked this pull request as ready for review August 29, 2025 16:46

SarahFrench requested a review from a team as a code owner August 29, 2025 16:46

More fixes - test setup was incorrect

4852374

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

radeksimko approved these changes Sep 2, 2025

View reviewed changes

SarahFrench merged commit ef58611 into radek/pss-read-write Sep 2, 2025
7 checks passed

SarahFrench deleted the sarah/update-proto-read-write branch September 2, 2025 15:31

github-actions bot locked as resolved and limited conversation to collaborators Oct 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update proto file definition of Read/WriteStateBytes RPCs #37529

Update proto file definition of Read/WriteStateBytes RPCs #37529

SarahFrench commented Aug 29, 2025

Uh oh!

SarahFrench commented Aug 29, 2025

Uh oh!

Uh oh!

github-actions bot commented Oct 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update proto file definition of Read/WriteStateBytes RPCs #37529

Update proto file definition of Read/WriteStateBytes RPCs #37529

Conversation

SarahFrench commented Aug 29, 2025

Target Release

Rollback Plan

Changes to Security Controls

CHANGELOG entry

Uh oh!

SarahFrench commented Aug 29, 2025

Uh oh!

Uh oh!

github-actions bot commented Oct 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants