direct: Fix state serialization for zero-value fields on deeply-embedded SDK specs#5782
Open
pietern wants to merge 2 commits into
Open
direct: Fix state serialization for zero-value fields on deeply-embedded SDK specs#5782pietern wants to merge 2 commits into
pietern wants to merge 2 commits into
Conversation
The dyn->typed ForceSendFields routing only handled one level of struct embedding. When a field declared in an SDK spec embedded two levels deep (e.g. PostgresProject -> PostgresProjectConfig -> ProjectSpec) was set to its zero value, its name was recorded in the wrong struct's ForceSendFields. The direct engine then failed to serialize the plan state with "field X cannot be found in struct Y". Route each field's ForceSendFields entry to the struct that actually declares it, at any embedding depth. This affected postgres_projects (enable_pg_native_login: false), postgres_branches, and postgres_endpoints (replace_existing: false). Terraform was unaffected (it serializes via dyn, not the SDK marshaler). Add a unit regression test for the deep-embedding case and a systemic guard that round-trips every registered resource type's zero-value fields, so any future resource using the embedded-spec wrapper pattern is covered automatically. Co-authored-by: Isaac
Contributor
Approval status: pending
|
Collaborator
Integration test reportCommit: 29cab63
25 interesting tests: 13 SKIP, 7 KNOWN, 4 flaky, 1 RECOVERED
Top 5 slowest tests (at least 2 minutes):
|
denik
reviewed
Jul 1, 2026
| ForceEmpty: make(map[string]bool), | ||
| GolangNames: make(map[string]string), | ||
| ForceSendFieldsStructKey: make(map[string]int), | ||
| ForceSendFieldsStructKey: make(map[string]string), |
Contributor
There was a problem hiding this comment.
why can't we keep precalculated index? the structs are static, so it should always resolve to the same index, right?
Contributor
Author
There was a problem hiding this comment.
Very good point, fixed on latest.
denik
reviewed
Jul 1, 2026
| my_project: | ||
| project_id: test-pg-proj-$UNIQUE_NAME | ||
| display_name: "Test Postgres Project" | ||
| enable_pg_native_login: false |
Contributor
There was a problem hiding this comment.
can we also add this to invariant tests?
Contributor
Author
There was a problem hiding this comment.
Included this in the project resource config for the invariant tests.
… at runtime Store the full reflect index path to each field's governing ForceSendFields slice, keyed by JSON name, instead of a single struct index. The previous map[string]int could only address a ForceSendFields one embed level down, so the deep-embedding fix walked the value at conversion time to relocate them. The location is static per type, so resolve it once in buildStructInfo and FieldByIndex into it from both consumers. Co-authored-by: Isaac
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The dyn→typed
ForceSendFieldsrouting only handled one level of struct embedding. When a field declared in an SDK spec embedded two levels deep (e.g.PostgresProject→PostgresProjectConfig→ProjectSpec) was set to its zero value, its name was recorded in the wrong struct'sForceSendFields. The direct engine then failed to serialize the plan state withfield X cannot be found in struct Y.Fix routes each field's
ForceSendFieldsentry to the struct that actually declares it, at any embedding depth. This affectedpostgres_projects(enable_pg_native_login: false),postgres_branches, andpostgres_endpoints(replace_existing: false). Terraform was unaffected (it serializes via dyn, not the SDK marshaler).Adds a unit regression test for the deep-embedding case and a systemic guard that round-trips every registered resource type's zero-value fields, so any future resource using the embedded-spec wrapper pattern is covered automatically.
This pull request and its description were written by Isaac.