mirror of https://github.com/astral-sh/ruff
[ty] ty_ide: Hotfix for `expression_scope_id` panics (#18455)
## Summary Implement a hotfix for the playground/LSP crashes related to missing `expression_scope_id`s. relates to: https://github.com/astral-sh/ty/issues/572 ## Test Plan * Regression tests from https://github.com/astral-sh/ruff/pull/18441 * Ran the playground locally to check if panics occur / completions still work. --------- Co-authored-by: Andrew Gallant <andrew@astral.sh>
This commit is contained in:
parent
9f8c3de462
commit
11db567b0b
|
|
@ -4,6 +4,10 @@ extend-exclude = [
|
||||||
"crates/ty_vendored/vendor/**/*",
|
"crates/ty_vendored/vendor/**/*",
|
||||||
"**/resources/**/*",
|
"**/resources/**/*",
|
||||||
"**/snapshots/**/*",
|
"**/snapshots/**/*",
|
||||||
|
# Completion tests tend to have a lot of incomplete
|
||||||
|
# words naturally. It's annoying to have to make all
|
||||||
|
# of them actually words. So just ignore typos here.
|
||||||
|
"crates/ty_ide/src/completion.rs",
|
||||||
]
|
]
|
||||||
|
|
||||||
[default.extend-words]
|
[default.extend-words]
|
||||||
|
|
|
||||||
|
|
@ -861,6 +861,162 @@ print(f\"{some<CURSOR>
|
||||||
");
|
");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_function_identifier1() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
def m<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_function_identifier2() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
def m<CURSOR>(): pass
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn fscope_id_missing_function_identifier3() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
def m(): pass
|
||||||
|
<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @r"
|
||||||
|
m
|
||||||
|
");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_class_identifier1() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
class M<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_type_alias1() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
Fo<CURSOR> = float
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @r"
|
||||||
|
Fo
|
||||||
|
float
|
||||||
|
");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_import1() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
import fo<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_import2() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
import foo as ba<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_from_import1() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
from fo<CURSOR> import wat
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_from_import2() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
from foo import wa<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_from_import3() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
from foo import wat as ba<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_try_except1() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
try:
|
||||||
|
pass
|
||||||
|
except Type<CURSOR>:
|
||||||
|
pass
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @r"
|
||||||
|
Type
|
||||||
|
");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ref: https://github.com/astral-sh/ty/issues/572
|
||||||
|
#[test]
|
||||||
|
fn scope_id_missing_global1() {
|
||||||
|
let test = cursor_test(
|
||||||
|
"\
|
||||||
|
def _():
|
||||||
|
global fo<CURSOR>
|
||||||
|
",
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_snapshot!(test.completions(), @"<No completions found>");
|
||||||
|
}
|
||||||
|
|
||||||
impl CursorTest {
|
impl CursorTest {
|
||||||
fn completions(&self) -> String {
|
fn completions(&self) -> String {
|
||||||
let completions = completion(&self.db, self.file, self.cursor_offset);
|
let completions = completion(&self.db, self.file, self.cursor_offset);
|
||||||
|
|
|
||||||
|
|
@ -259,6 +259,14 @@ impl<'db> SemanticIndex<'db> {
|
||||||
self.scopes_by_expression[&expression.into()]
|
self.scopes_by_expression[&expression.into()]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Returns the ID of the `expression`'s enclosing scope.
|
||||||
|
pub(crate) fn try_expression_scope_id(
|
||||||
|
&self,
|
||||||
|
expression: impl Into<ExpressionNodeKey>,
|
||||||
|
) -> Option<FileScopeId> {
|
||||||
|
self.scopes_by_expression.get(&expression.into()).copied()
|
||||||
|
}
|
||||||
|
|
||||||
/// Returns the [`Scope`] of the `expression`'s enclosing scope.
|
/// Returns the [`Scope`] of the `expression`'s enclosing scope.
|
||||||
#[allow(unused)]
|
#[allow(unused)]
|
||||||
#[track_caller]
|
#[track_caller]
|
||||||
|
|
|
||||||
|
|
@ -47,15 +47,22 @@ impl<'db> SemanticModel<'db> {
|
||||||
/// scope of this model's `File` are returned.
|
/// scope of this model's `File` are returned.
|
||||||
pub fn completions(&self, node: ast::AnyNodeRef<'_>) -> Vec<Name> {
|
pub fn completions(&self, node: ast::AnyNodeRef<'_>) -> Vec<Name> {
|
||||||
let index = semantic_index(self.db, self.file);
|
let index = semantic_index(self.db, self.file);
|
||||||
let file_scope = match node {
|
|
||||||
ast::AnyNodeRef::Identifier(identifier) => index.expression_scope_id(identifier),
|
// TODO: We currently use `try_expression_scope_id` here as a hotfix for [1].
|
||||||
|
// Revert this to use `expression_scope_id` once a proper fix is in place.
|
||||||
|
//
|
||||||
|
// [1] https://github.com/astral-sh/ty/issues/572
|
||||||
|
let Some(file_scope) = (match node {
|
||||||
|
ast::AnyNodeRef::Identifier(identifier) => index.try_expression_scope_id(identifier),
|
||||||
node => match node.as_expr_ref() {
|
node => match node.as_expr_ref() {
|
||||||
// If we couldn't identify a specific
|
// If we couldn't identify a specific
|
||||||
// expression that we're in, then just
|
// expression that we're in, then just
|
||||||
// fall back to the global scope.
|
// fall back to the global scope.
|
||||||
None => FileScopeId::global(),
|
None => Some(FileScopeId::global()),
|
||||||
Some(expr) => index.expression_scope_id(expr),
|
Some(expr) => index.try_expression_scope_id(expr),
|
||||||
},
|
},
|
||||||
|
}) else {
|
||||||
|
return vec![];
|
||||||
};
|
};
|
||||||
let mut symbols = vec![];
|
let mut symbols = vec![];
|
||||||
for (file_scope, _) in index.ancestor_scopes(file_scope) {
|
for (file_scope, _) in index.ancestor_scopes(file_scope) {
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue