fixup json snaps and deser #692
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "id": "2e107c2c-aba9-4fc7-a7ea-87a9e259466d", | ||
| "type": "bugfix", | ||
| "description": "Don't serialize unset JSON documents as `nil` in structure members.", | ||
| "modules": [ | ||
| "." | ||
| ] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "id": "95eb0908-2109-4264-bc1c-5a718b3dc64a", | ||
| "type": "bugfix", | ||
| "description": "Fix a deserialization panic around collection members in recursive shape configs.", | ||
| "modules": [ | ||
| "." | ||
| ] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,9 @@ | |
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Set; | ||
| import software.amazon.smithy.aws.traits.protocols.AwsJson1_0Trait; | ||
| import software.amazon.smithy.aws.traits.protocols.AwsJson1_1Trait; | ||
| import software.amazon.smithy.aws.traits.protocols.RestJson1Trait; | ||
| import software.amazon.smithy.codegen.core.SymbolProvider; | ||
| import software.amazon.smithy.go.codegen.ChainWritable; | ||
| import software.amazon.smithy.go.codegen.GoDelegator; | ||
|
|
@@ -32,32 +35,37 @@ public void writeAdditionalFiles( | |
| goDelegator.useFileWriter("request_snapshot_test.go", settings.getModuleName(), writer -> { | ||
| writer.addBuildTag("request_snapshot"); | ||
| writer.write(commonSource()); | ||
| writer.write(bodyEqual(settings)); | ||
|
|
||
| var service = settings.getService(model); | ||
| var generator = new SnapshotInputGenerator(model, symbolProvider, settings, false); | ||
| writer.write(snapshotTests(model, service, symbolProvider, generator)); | ||
| writer.write(snapshotUpdaters(model, service, symbolProvider, generator)); | ||
| }); | ||
| } | ||
|
|
||
| // Emits serdeBodyEqual, the request-body comparator, per protocol. Every variant falls back to a byte compare | ||
| // when either side won't decode, so a malformed golden fails loudly rather than silently passing. | ||
| private Writable bodyEqual(GoSettings settings) { | ||
| var protocol = settings.getProtocol(); | ||
| if (Rpcv2CborTrait.ID.equals(protocol)) { | ||
| return cborBodyEqual(); | ||
| } else if (AwsJson1_0Trait.ID.equals(protocol) || AwsJson1_1Trait.ID.equals(protocol) | ||
| || RestJson1Trait.ID.equals(protocol)) { | ||
| return jsonBodyEqual(); | ||
| } | ||
| // restXml has the same member-ordering divergence in XML element form, and awsQuery/ec2Query bodies are | ||
| // form-urlencoded. Those are out of scope for now (JSON snapshots only), so they stay on a byte compare. | ||
| return goTemplate(""" | ||
| func serdeBodyEqual(got, expected []byte) bool { | ||
| return bytes.Equal(got, expected) | ||
| } | ||
| """); | ||
| } | ||
|
|
||
| // rpcv2Cbor encodes struct fields as a CBOR map and the encoder emits map entries in Go map iteration order, so | ||
| // the same input produces different byte orderings across runs. Comparing decoded values is order-independent. | ||
|
Contributor
There was a problem hiding this comment. we don't have to resolve it here, but this has also been a point of friction on JSON encoders. Since we are now taking more control of the encoders, would it be worth it to sort map entries?
Collaborator
Author
There was a problem hiding this comment. by default, a million percent no, it's bad for performance,
Contributor
There was a problem hiding this comment. ok, as an option it sounds good.
Can't argue with this, but we've had multiple issues with serialization not being deterministic being an issue even if it's not a guarantee for JSON, so it's definitely a tredoff. Interestingly, JSON v2 switched this behavior and now map keys are not deterministic by default and you have to pass a deterministic flag https://pkg.go.dev/encoding/json/v2#Deterministic |
||
| private Writable cborBodyEqual() { | ||
| return writer -> { | ||
| writer.addUseImports(SmithyGoDependency.REFLECT); | ||
| writer.addUseImports(SmithyGoDependency.SMITHY_CBOR); | ||
|
|
@@ -77,6 +85,43 @@ func serdeBodyEqual(got, expected []byte) bool { | |
| }; | ||
| } | ||
|
|
||
| // JSON object member order isn't semantically meaningful, and legacy serde orders members by ShapeId | ||
| // (case-insensitive, via TreeSet) while schema-serde orders them by member name (byte order). A byte compare | ||
| // therefore reports thousands of semantically identical bodies as mismatches for the whole legacy -> | ||
| // schema-serde transition. | ||
| private Writable jsonBodyEqual() { | ||
| return writer -> { | ||
| writer.addUseImports(SmithyGoDependency.REFLECT); | ||
| writer.addUseImports(SmithyGoDependency.JSON); | ||
| writer.write(""" | ||
| func serdeBodyEqual(got, expected []byte) bool { | ||
| if len(got) == 0 || len(expected) == 0 { | ||
| return bytes.Equal(got, expected) | ||
| } | ||
| gv, gok := serdeDecodeJSON(got) | ||
| ev, eok := serdeDecodeJSON(expected) | ||
| if !gok || !eok { | ||
| return bytes.Equal(got, expected) | ||
| } | ||
| return reflect.DeepEqual(gv, ev) | ||
| } | ||
|
|
||
| // serdeDecodeJSON decodes a body for structural comparison. Numbers are kept as | ||
| // json.Number rather than float64 so a large int64 doesn't lose precision (which would | ||
| // mask a real difference) and so numeric formatting differences still show up. | ||
| func serdeDecodeJSON(b []byte) (any, bool) { | ||
| d := json.NewDecoder(bytes.NewReader(b)) | ||
| d.UseNumber() | ||
| var v any | ||
| if err := d.Decode(&v); err != nil { | ||
| return nil, false | ||
| } | ||
| return v, true | ||
| } | ||
| """); | ||
| }; | ||
| } | ||
|
|
||
| private Writable commonSource() { | ||
| return writer -> { | ||
| writer.addUseImports(SmithyGoDependency.OS); | ||
|
|
||
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what's a malformed golden?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
golden = snapshot file