Split enum value sorting from field sorting - #9711
#9711Merged
Merged
Split enum value sorting from field sorting#9711
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes regression where SortFieldsByName = true also sorted enum values in v16. Introduces a separate SortEnumValuesByName option (default false), restoring v15 behavior while still allowing opt-in enum sorting.
Changes:
- Adds
SortEnumValuesByNametoIReadOnlySchemaOptions/SchemaOptionsand a correspondingOrderEnumValuesByNametoSchemaFormatterOptions. - Updates
EnumTypeinitialization andSchemaFormatterto sort enum values based on the new option (decoupled from field sorting). - Adds tests and an introspection snapshot covering the new behavior.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/HotChocolate/Core/src/Types/IReadOnlySchemaOptions.cs | Adds SortEnumValuesByName to the read-only options interface. |
| src/HotChocolate/Core/src/Types/SchemaOptions.cs | Adds the mutable property and propagates it in FromOptions. |
| src/HotChocolate/Core/src/Types/StoreGlobalSchemaOptionsTypeInterceptor.cs | Forwards the new option into SchemaFormatterOptions. |
| src/HotChocolate/Core/src/Types/Types/EnumType.Initialization.cs | Sorts enum values during type completion only when the new option is true. |
| src/HotChocolate/Core/src/Types.Abstractions/Serialization/SchemaFormatterOptions.cs | Adds OrderEnumValuesByName and updates OrderFieldsByName doc. |
| src/HotChocolate/Core/src/Types.Abstractions/Serialization/SchemaFormatter.cs | Uses the new option when ordering enum values during formatting. |
| src/HotChocolate/Core/test/Types.Tests/Types/EnumTypeTests.cs | Adds tests for the new option (incl. introspection). |
| src/HotChocolate/Core/test/Types.Tests/Types/snapshots/EnumTypeTests.SortEnumValuesByName_Should_SortIntrospectionResult.md | Snapshot for sorted introspection result. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced May 20, 2026
This was referenced May 27, 2026
This was referenced Jun 4, 2026
This was referenced Jun 8, 2026
This was referenced Jun 16, 2026
This was referenced Jun 26, 2026
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
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.
Fixes #9708