Skip to content

[ty] Add panic-by-default await methods to TestServer #21451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MichaReiser merged 2 commits into from
Nov 14, 2025
Merged

[ty] Add panic-by-default await methods to TestServer #21451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37f4080
[ty] Add panic-by-default await methods to `TestServer`
MichaReiser Nov 14, 2025
6e4b15b
Use error in messages instead of repeating error handling all over th…
MichaReiser Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/ty_server/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ salsa = { workspace = true }
serde = { workspace = true }
serde_json = { workspace = true }
shellexpand = { workspace = true }
smallvec = { workspace=true }
thiserror = { workspace = true }
tracing = { workspace = true }
tracing-subscriber = { workspace = true, features = ["chrono"] }
Expand Down
8 changes: 4 additions & 4 deletions crates/ty_server/tests/e2e/commands.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ fn execute_command(
server: &mut TestServer,
command: String,
arguments: Vec<serde_json::Value>,
) -> anyhow::Result<Option<serde_json::Value>> {
) -> Option<serde_json::Value> {
let params = ExecuteCommandParams {
command,
arguments,
Expand All @@ -32,10 +32,10 @@ return 42
.with_workspace(workspace_root, None)?
.with_file(foo, foo_content)?
.enable_pull_diagnostics(false)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let response = execute_command(&mut server, "ty.printDebugInformation".to_string(), vec![])?;
let response = execute_command(&mut server, "ty.printDebugInformation".to_string(), vec![]);
let response = response.expect("expect server response");

let response = response
Expand Down
92 changes: 46 additions & 46 deletions crates/ty_server/tests/e2e/initialize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ use crate::TestServerBuilder;
#[test]
fn empty_workspace_folders() -> Result<()> {
let server = TestServerBuilder::new()?
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let initialization_result = server.initialization_result().unwrap();

Expand All @@ -24,8 +24,8 @@ fn single_workspace_folder() -> Result<()> {
let workspace_root = SystemPath::new("foo");
let server = TestServerBuilder::new()?
.with_workspace(workspace_root, None)?
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let initialization_result = server.initialization_result().unwrap();

Expand All @@ -47,12 +47,12 @@ fn workspace_diagnostic_registration_without_configuration() -> Result<()> {
.with_workspace(workspace_root, None)?
.enable_workspace_configuration(false)
.enable_diagnostic_dynamic_registration(true)
.build()?;
.build();

// No need to wait for workspaces to initialize as the client does not support workspace
// configuration.

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let [registration] = params.registrations.as_slice() else {
panic!(
"Expected a single registration, got: {:#?}",
Expand Down Expand Up @@ -90,12 +90,12 @@ fn open_files_diagnostic_registration_without_configuration() -> Result<()> {
.with_workspace(workspace_root, None)?
.enable_workspace_configuration(false)
.enable_diagnostic_dynamic_registration(true)
.build()?;
.build();

// No need to wait for workspaces to initialize as the client does not support workspace
// configuration.

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let [registration] = params.registrations.as_slice() else {
panic!(
"Expected a single registration, got: {:#?}",
Expand Down Expand Up @@ -131,10 +131,10 @@ fn workspace_diagnostic_registration_via_initialization() -> Result<()> {
)
.with_workspace(workspace_root, None)?
.enable_diagnostic_dynamic_registration(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let [registration] = params.registrations.as_slice() else {
panic!(
"Expected a single registration, got: {:#?}",
Expand Down Expand Up @@ -170,10 +170,10 @@ fn open_files_diagnostic_registration_via_initialization() -> Result<()> {
)
.with_workspace(workspace_root, None)?
.enable_diagnostic_dynamic_registration(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let [registration] = params.registrations.as_slice() else {
panic!(
"Expected a single registration, got: {:#?}",
Expand Down Expand Up @@ -209,10 +209,10 @@ fn workspace_diagnostic_registration() -> Result<()> {
Some(ClientOptions::default().with_diagnostic_mode(DiagnosticMode::Workspace)),
)?
.enable_diagnostic_dynamic_registration(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let [registration] = params.registrations.as_slice() else {
panic!(
"Expected a single registration, got: {:#?}",
Expand Down Expand Up @@ -248,10 +248,10 @@ fn open_files_diagnostic_registration() -> Result<()> {
Some(ClientOptions::default().with_diagnostic_mode(DiagnosticMode::OpenFilesOnly)),
)?
.enable_diagnostic_dynamic_registration(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let [registration] = params.registrations.as_slice() else {
panic!(
"Expected a single registration, got: {:#?}",
Expand Down Expand Up @@ -291,11 +291,11 @@ def foo() -> str:
.with_workspace(workspace_root, None)?
.enable_pull_diagnostics(true)
.with_file(foo, foo_content)?
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

server.open_text_document(foo, &foo_content, 1);
let hover = server.hover_request(foo, Position::new(0, 5))?;
let hover = server.hover_request(foo, Position::new(0, 5));

assert!(
hover.is_none(),
Expand Down Expand Up @@ -323,11 +323,11 @@ def foo() -> str:
)?
.enable_pull_diagnostics(true)
.with_file(foo, foo_content)?
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

server.open_text_document(foo, &foo_content, 1);
let hover = server.hover_request(foo, Position::new(0, 5))?;
let hover = server.hover_request(foo, Position::new(0, 5));

assert!(
hover.is_none(),
Expand Down Expand Up @@ -364,18 +364,18 @@ def bar() -> str:
.enable_pull_diagnostics(true)
.with_file(foo, foo_content)?
.with_file(bar, bar_content)?
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

server.open_text_document(foo, &foo_content, 1);
let hover_foo = server.hover_request(foo, Position::new(0, 5))?;
let hover_foo = server.hover_request(foo, Position::new(0, 5));
assert!(
hover_foo.is_none(),
"Expected no hover information for workspace A, got: {hover_foo:?}"
);

server.open_text_document(bar, &bar_content, 1);
let hover_bar = server.hover_request(bar, Position::new(0, 5))?;
let hover_bar = server.hover_request(bar, Position::new(0, 5));
assert!(
hover_bar.is_some(),
"Expected hover information for workspace B, got: {hover_bar:?}"
Expand All @@ -394,10 +394,10 @@ fn unknown_initialization_options() -> Result<()> {
.with_initialization_options(
ClientOptions::default().with_unknown([("bar".to_string(), Value::Null)].into()),
)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let show_message_params = server.await_notification::<ShowMessage>()?;
let show_message_params = server.await_notification::<ShowMessage>();

insta::assert_json_snapshot!(show_message_params, @r#"
{
Expand All @@ -419,10 +419,10 @@ fn unknown_options_in_workspace_configuration() -> Result<()> {
workspace_root,
Some(ClientOptions::default().with_unknown([("bar".to_string(), Value::Null)].into())),
)?
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let show_message_params = server.await_notification::<ShowMessage>()?;
let show_message_params = server.await_notification::<ShowMessage>();

insta::assert_json_snapshot!(show_message_params, @r#"
{
Expand All @@ -443,10 +443,10 @@ fn register_rename_capability_when_enabled() -> Result<()> {
.with_workspace(workspace_root, None)?
.with_initialization_options(ClientOptions::default().with_experimental_rename(true))
.enable_rename_dynamic_registration(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let [registration] = params.registrations.as_slice() else {
panic!(
"Expected a single registration, got: {:#?}",
Expand Down Expand Up @@ -477,8 +477,8 @@ fn rename_available_without_dynamic_registration() -> Result<()> {
.with_workspace(workspace_root, None)?
.with_initialization_options(ClientOptions::default().with_experimental_rename(true))
.enable_rename_dynamic_registration(false)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let initialization_result = server.initialization_result().unwrap();
insta::assert_json_snapshot!(initialization_result.capabilities.rename_provider, @r#"
Expand All @@ -500,8 +500,8 @@ fn not_register_rename_capability_when_disabled() -> Result<()> {
.with_workspace(workspace_root, None)?
.with_initialization_options(ClientOptions::default().with_experimental_rename(false))
.enable_rename_dynamic_registration(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

// The `Drop` implementation will make sure that the client did not receive any registration
// request.
Expand All @@ -525,10 +525,10 @@ fn register_multiple_capabilities() -> Result<()> {
)
.enable_rename_dynamic_registration(true)
.enable_diagnostic_dynamic_registration(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

let (_, params) = server.await_request::<RegisterCapability>()?;
let (_, params) = server.await_request::<RegisterCapability>();
let registrations = params.registrations;

assert_eq!(registrations.len(), 2);
Expand Down
16 changes: 8 additions & 8 deletions crates/ty_server/tests/e2e/inlay_hints.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ y = foo(1)
.with_workspace(workspace_root, None)?
.with_file(foo, foo_content)?
.enable_inlay_hints(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

server.open_text_document(foo, &foo_content, 1);
let _ = server.await_notification::<PublishDiagnostics>()?;
let _ = server.await_notification::<PublishDiagnostics>();

let hints = server
.inlay_hints_request(foo, Range::new(Position::new(0, 0), Position::new(6, 0)))?
.inlay_hints_request(foo, Range::new(Position::new(0, 0), Position::new(6, 0)))
.unwrap();

insta::assert_json_snapshot!(hints, @r#"
Expand Down Expand Up @@ -87,14 +87,14 @@ fn variable_inlay_hints_disabled() -> Result<()> {
.with_workspace(workspace_root, None)?
.with_file(foo, foo_content)?
.enable_inlay_hints(true)
.build()?
.wait_until_workspaces_are_initialized()?;
.build()
.wait_until_workspaces_are_initialized();

server.open_text_document(foo, &foo_content, 1);
let _ = server.await_notification::<PublishDiagnostics>()?;
let _ = server.await_notification::<PublishDiagnostics>();

let hints = server
.inlay_hints_request(foo, Range::new(Position::new(0, 0), Position::new(0, 5)))?
.inlay_hints_request(foo, Range::new(Position::new(0, 0), Position::new(0, 5)))
.unwrap();

assert!(
Expand Down
Loading