Skip to content

Serialize structure members in schema order, not declaration order #1344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adwsingh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Serialize structure members in schema order, not declaration order #1344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ain/java/software/amazon/smithy/java/codegen/generators/StructureSerializerGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public void serializeMembers(${shapeSerializer:T} serializer) {
private void writeMemberSerialization(JavaWriter writer) {
boolean isError = shape.hasTrait(ErrorTrait.class);

for (var member : shape.members()) {
for (var member : CodegenUtils.getSortedMembers(shape)) {

@mtdowling mtdowling Aug 30, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this alphanumerically sort structure and union members? Or does it return those in model order / idx order if available?

var memberName = symbolProvider.toMemberName(member);
// if the shape is an error we need to use the `getMessage()` method for message field.
if (isError && memberName.equalsIgnoreCase("message")) {
Expand Down
8 changes: 4 additions & 4 deletions ...tware/amazon/smithy/java/codegen/types/test-cases/jspecify/expected/CollectionStruct.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,22 +200,22 @@ public Schema schema() {

@Override
public void serializeMembers(ShapeSerializer serializer) {
serializer.writeList($SCHEMA_SPARSE_LIST, sparseList, sparseList.size(), SharedSerde.SparseStringListSerializer.INSTANCE);
serializer.writeMap($SCHEMA_SPARSE_MAP, sparseMap, sparseMap.size(), SharedSerde.SparseStringMapSerializer.INSTANCE);
serializer.writeList($SCHEMA_SPARSE_LIST_OF_SPARSE_MAP, sparseListOfSparseMap, sparseListOfSparseMap.size(), SharedSerde.SparseListOfSparseMapSerializer.INSTANCE);
serializer.writeList($SCHEMA_NON_SPARSE_LIST_OF_NON_SPARSE_MAP, nonSparseListOfNonSparseMap, nonSparseListOfNonSparseMap.size(), SharedSerde.NonSparseListOfNonSparseMapSerializer.INSTANCE);
if (nonSparseList != null) {
serializer.writeList($SCHEMA_NON_SPARSE_LIST, nonSparseList, nonSparseList.size(), SharedSerde.NonSparseStringListSerializer.INSTANCE);
}
serializer.writeList($SCHEMA_SPARSE_LIST, sparseList, sparseList.size(), SharedSerde.SparseStringListSerializer.INSTANCE);
if (nonSparseMap != null) {
serializer.writeMap($SCHEMA_NON_SPARSE_MAP, nonSparseMap, nonSparseMap.size(), SharedSerde.NonSparseStringMapSerializer.INSTANCE);
}
serializer.writeMap($SCHEMA_SPARSE_MAP, sparseMap, sparseMap.size(), SharedSerde.SparseStringMapSerializer.INSTANCE);
if (nonSparseListOfSparseMap != null) {
serializer.writeList($SCHEMA_NON_SPARSE_LIST_OF_SPARSE_MAP, nonSparseListOfSparseMap, nonSparseListOfSparseMap.size(), SharedSerde.NonSparseListOfSparseMapSerializer.INSTANCE);
}
serializer.writeList($SCHEMA_SPARSE_LIST_OF_SPARSE_MAP, sparseListOfSparseMap, sparseListOfSparseMap.size(), SharedSerde.SparseListOfSparseMapSerializer.INSTANCE);
if (sparseMapOfNonSparseList != null) {
serializer.writeMap($SCHEMA_SPARSE_MAP_OF_NON_SPARSE_LIST, sparseMapOfNonSparseList, sparseMapOfNonSparseList.size(), SharedSerde.SparseMapOfNonSparseListSerializer.INSTANCE);
}
serializer.writeList($SCHEMA_NON_SPARSE_LIST_OF_NON_SPARSE_MAP, nonSparseListOfNonSparseMap, nonSparseListOfNonSparseMap.size(), SharedSerde.NonSparseListOfNonSparseMapSerializer.INSTANCE);
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion ...oftware/amazon/smithy/java/codegen/types/test-cases/jspecify/expected/JSpecifyStruct.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ public Schema schema() {
@Override
public void serializeMembers(ShapeSerializer serializer) {
serializer.writeString($SCHEMA_REQUIRED_STRING, requiredString);
serializer.writeBoolean($SCHEMA_REQUIRED_PRIMITIVE, requiredPrimitive);
if (optionalString != null) {
serializer.writeString($SCHEMA_OPTIONAL_STRING, optionalString);
}
serializer.writeBoolean($SCHEMA_REQUIRED_PRIMITIVE, requiredPrimitive);
if (sparseList != null) {
serializer.writeList($SCHEMA_SPARSE_LIST, sparseList, sparseList.size(), SharedSerde.SparseStringListSerializer.INSTANCE);
}
Expand Down
Loading