Rust: preserve ordering in rust generated code #19071
Merged
Conversation
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 is a small devex improvement to the rust code generator. Usage of `sorted` in `rustgen.py` was causing the generated code to be completely reshuffled on renames, which made diffs hard to follow. As an example see [this generated file diff](https://github.com/github/codeql/pull/19059/files#diff-c938ba77a3398dd4c633ada5702a03477705c24740a2f7d1e40d4b270d8c3f86). This will make the order deterministically based on the order of definitions in the schema file. This means that renames will find the same place in the generated file, and the place in the generated file will generally be more predictable with respect to the schema. However, that does mean this change is heavily reshuffling the generated code.
redsun82
force-pushed
the
redsun82/codegen-rust-ancestor-order
branch
from
9697503 to
4110636
Compare
There was a problem hiding this comment.
Pull Request Overview
This pull request improves the deterministic ordering of generated Rust code by preserving the order of definitions from the schema file. The change replaces a sorted set with a dictionary comprehension to remove duplicates while maintaining the insertion order.
- Change the generation of ancestor names from using sorted(set(...)) to using a dictionary comprehension for order preservation.
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
hvitved
approved these changes
Mar 20, 2025
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.
This is a small devex improvement to the rust code generator.
Usage of
sortedinrustgen.pywas causing the generated code to be completely reshuffled on renames, which made diffs hard to follow. As an example see this generated file diff.This will make the order deterministically based on the order of definitions in the schema file. This means that renames will find the same place in the generated file, and the place in the generated file will generally be more predictable with respect to the schema.
However, that does mean this change is heavily reshuffling the generated code.