fix: sort YAML config files by name for deterministic schema order#1244
Open
benji07 wants to merge 1 commit intooverblog:masterfrom
Open
fix: sort YAML config files by name for deterministic schema order#1244benji07 wants to merge 1 commit intooverblog:masterfrom
benji07 wants to merge 1 commit intooverblog:masterfrom
Conversation
Symfony Finder returns files in filesystem readdir order, which differs between filesystems (APFS/VirtioFS on macOS Docker Desktop vs ext4 on a Linux CI runner). Running graphql:dump-schema on two different platforms can therefore produce two valid schemas that only differ in the order of fields and type declarations, which breaks 'git diff --exit-code' checks on schema.graphql even when no source change was made. Add ->sortByName() so the discovery order is stable and platform-independent.
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
1 participant
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.
ConfigParserPass::detectFilesByTypes()usesSymfony\Finderwithout sorting, so the discovery order of YAML/GraphQL config files follows the underlying filesystem's readdir order.This order differs between filesystems — notably between APFS (macOS) accessed via VirtioFS in Docker Desktop, and ext4 on a Linux CI runner. The resulting schemas are functionally identical but contain fields and types declared in a different order.
Impact
Teams running a
git diff --exit-code schema.graphqlcheck in CI see false positives: a developer regenerates the schema locally on macOS, commits it, and CI fails on Linux with a large reorder-only diff — even though no source change was made.Fix
Add
->sortByName()to the Finder so file discovery is alphabetical, stable, and platform-independent.