[ty] Sort collected diagnostics before snapshotting them in mdtest#17926
Merged
AlexWaygood merged 2 commits intomainfrom May 7, 2025
Merged
[ty] Sort collected diagnostics before snapshotting them in mdtest#17926AlexWaygood merged 2 commits intomainfrom
AlexWaygood merged 2 commits intomainfrom
Conversation
AlexWaygood
requested review from
MichaReiser,
carljm,
dcreager and
sharkdp
as code owners
Member
|
Thank you! I noticed this a couple of times and I was going to open an issue for it. |
Contributor
|
MichaReiser
approved these changes
May 7, 2025
Comment on lines
236
to
246
| /// Returns a key that can be used to sort two diagnostics into the canonical order | ||
| /// in which they should appear when rendered. | ||
| pub fn rendering_sort_key<'a, 'db>(&'a self, db: &'db dyn Db) -> impl Ord + 'a | ||
| where | ||
| 'db: 'a, | ||
| { | ||
| RenderingSortKey { | ||
| db, | ||
| diagnostic: self, | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Nit: I sort of like how TextRange solved this. It has a ordering method. It could help reduce some complexity (no need for an extra struct, less lifetimes)
pub fn ordering(&self, db: &dyn Db, other: &Self) -> Ordering {
if let (Some(span1), Some(span2)) = (
self.primary_span(),
other.primary_span(),
) {
let order = span1
.file()
.path(self.db)
.as_str()
.cmp(span2.file().path(self.db).as_str());
if order.is_ne() {
return order;
}
if let (Some(range1), Some(range2)) = (span1.range(), span2.range()) {
let order = range1.start().cmp(&range2.start());
if order.is_ne() {
return order;
}
}
}
// Reverse so that, e.g., Fatal sorts before Info.
let order = self
.severity()
.cmp(&other.severity())
.reverse();
if order.is_ne() {
return order;
}
self.id().cmp(&other.id())
}
Member
Author
There was a problem hiding this comment.
I realised I could simplify it to a single lifetime (pushed the change). I weakly prefer encapsulating the sorting logic into a struct that represents the key (the way I have it now), but no strong opinion; happy to revisit this in a followup if others agree!
Member
There was a problem hiding this comment.
I don't feel too strongly personally. I'm fine with either approach given that these aren't semver boundaries.
dcreager
added a commit
that referenced
this pull request
May 7, 2025
…lass * origin/main: [`pylint`] add fix safety section (`PLC2801`) (#17825) Add instructions on how to upgrade to a newer Rust version (#17928) [parser] Flag single unparenthesized generator expr with trailing comma in arguments. (#17893) [ty] Ensure that `T` is disjoint from `~T` even when `T` is a TypeVar (#17922) [ty] Sort collected diagnostics before snapshotting them in mdtest (#17926) [ty] Add basic file watching to server (#17912) Make completions an opt-in LSP feature (#17921) Add link to `ty` issue tracker (#17924) [ty] Add support for `__all__` (#17856) [ty] fix assigning a typevar to a union with itself (#17910) [ty] Improve UX for `[duplicate-base]` diagnostics (#17914) Clean up some Ruff references in the ty server (#17920)
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
4 participants
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.
Summary
ty's diagnostics are always sorted into a stable order when ty is executed on the command line. However, this sorting is not applied when the diagnostics are collected by mdtests, which can result in them being snapshotted in our tests in a different order than they would appear to users. That's quite confusing.
This PR fixes that by sorting the diagnostics collected by mdtest in the same way that we sort them when
tyis actually executed on the command line.Test Plan
cargo test -p ty_python_semanticcargo test -p ty_project