PSS: Implement ReadStateBytes + WriteStateBytes
#37440
Merged
+2,840
−488
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
radeksimko
added
the
no-changelog-needed
radeksimko
force-pushed
the
radek/pss-read-write
branch
3 times, most recently
from
f185ebe to
74fd3bc
Compare
SarahFrench
reviewed
Aug 19, 2025
SarahFrench
reviewed
Aug 22, 2025
3 tasks
SarahFrench
reviewed
Sep 9, 2025
radeksimko
force-pushed
the
radek/pss-read-write
branch
from
a578ac2 to
d7a4964
Compare
radeksimko
commented
Sep 23, 2025
radeksimko
commented
Sep 23, 2025
radeksimko
force-pushed
the
radek/pss-read-write
branch
6 times, most recently
from
85d8bf2 to
ac83419
Compare
* 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 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.
* 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
radeksimko
force-pushed
the
radek/pss-read-write
branch
from
ac83419 to
bc638ec
Compare
radeksimko
changed the title
ReadStateBytes + WriteStateBytes
SarahFrench
reviewed
Sep 26, 2025
radeksimko
force-pushed
the
radek/pss-read-write
branch
from
df824cf to
3198f81
Compare
SarahFrench
approved these changes
Sep 26, 2025
There was a problem hiding this comment.
This looks great to me!
Reviewing this was a bit daunting as I'm quite close to the code and felt I might miss something, but luckily the newly-added tests have taken on the heavy lifting with finding bugs. And we always have the opportunity to iterate a little once we begin implementing features of init using this code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This introduces two new RPC methods
ReadStateByetsandWriteStateBytes. It also introduces chunk size negotiation intoConfigureStateStore.One piece of code I avoided attaching here though is validation of chunk size during
ConfigureStateStoreas it would be a bit difficult without all the other changes in the other branch impacting thecommandpackage.It's currently part of 6468225 where we can cherry pick it from later if needed.
Target Release
1.14.x
Rollback Plan
Changes to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
CHANGELOG entry