mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-05-30 15:02:56 +00:00
HackStudio: Restart LanguageServer if it crashes
We now restart the language server transparently if it crashes. If the language server crashes too frequently (current threshold is twice within 3 seconds), we give up and will not attempt to restart it again. HackStudio will still work fine, but features that depend on the language server will not function. To support this change we use a new class, 'ServerConnectionWrapper', that holds the actual ServerConnection and is responsible for restarting the language-server if it crashes. Closes #5574.
This commit is contained in:
Itamar
Andreas Kling
parent
4223f03b2b
commit
cfa100cb65
Notes:
sideshowbarker
2024-07-18 21:41:05 +09:00
Author: https://github.com/itamar8910
Commit: cfa100cb65
Pull-request: https://github.com/SerenityOS/serenity/pull/5654
Issue: https://github.com/SerenityOS/serenity/issues/5569
Issue: https://github.com/SerenityOS/serenity/issues/5574
Issue: https://github.com/SerenityOS/serenity/issues/5634
3 changed files with 213 additions and 96 deletions
|
|
@ -36,67 +36,67 @@ namespace HackStudio {
|
|||
|
||||
void ServerConnection::handle(const Messages::LanguageClient::AutoCompleteSuggestions& message)
|
||||
{
|
||||
if (!m_language_client) {
|
||||
if (!m_current_language_client) {
|
||||
dbgln("Language Server connection has no attached language client");
|
||||
return;
|
||||
}
|
||||
m_language_client->provide_autocomplete_suggestions(message.suggestions());
|
||||
m_current_language_client->provide_autocomplete_suggestions(message.suggestions());
|
||||
}
|
||||
|
||||
void ServerConnection::handle(const Messages::LanguageClient::DeclarationLocation& message)
|
||||
{
|
||||
if (!m_language_client) {
|
||||
if (!m_current_language_client) {
|
||||
dbgln("Language Server connection has no attached language client");
|
||||
return;
|
||||
}
|
||||
m_language_client->declaration_found(message.location().file, message.location().line, message.location().column);
|
||||
m_current_language_client->declaration_found(message.location().file, message.location().line, message.location().column);
|
||||
}
|
||||
|
||||
void ServerConnection::die()
|
||||
{
|
||||
dbgln("ServerConnection::die()");
|
||||
if (!m_language_client)
|
||||
return;
|
||||
m_language_client->on_server_crash();
|
||||
VERIFY(m_wrapper);
|
||||
// Wrapper destructs us here
|
||||
m_wrapper->on_crash();
|
||||
}
|
||||
|
||||
void LanguageClient::open_file(const String& path, int fd)
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
m_server_connection->post_message(Messages::LanguageServer::FileOpened(path, fd));
|
||||
m_connection_wrapper.connection()->post_message(Messages::LanguageServer::FileOpened(path, fd));
|
||||
}
|
||||
|
||||
void LanguageClient::set_file_content(const String& path, const String& content)
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
m_server_connection->post_message(Messages::LanguageServer::SetFileContent(path, content));
|
||||
m_connection_wrapper.connection()->post_message(Messages::LanguageServer::SetFileContent(path, content));
|
||||
}
|
||||
|
||||
void LanguageClient::insert_text(const String& path, const String& text, size_t line, size_t column)
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
m_server_connection->post_message(Messages::LanguageServer::FileEditInsertText(path, text, line, column));
|
||||
// set_active_client();
|
||||
m_connection_wrapper.connection()->post_message(Messages::LanguageServer::FileEditInsertText(path, text, line, column));
|
||||
}
|
||||
|
||||
void LanguageClient::remove_text(const String& path, size_t from_line, size_t from_column, size_t to_line, size_t to_column)
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
m_server_connection->post_message(Messages::LanguageServer::FileEditRemoveText(path, from_line, from_column, to_line, to_column));
|
||||
m_connection_wrapper.connection()->post_message(Messages::LanguageServer::FileEditRemoveText(path, from_line, from_column, to_line, to_column));
|
||||
}
|
||||
|
||||
void LanguageClient::request_autocomplete(const String& path, size_t cursor_line, size_t cursor_column)
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
set_active_client();
|
||||
m_server_connection->post_message(Messages::LanguageServer::AutoCompleteSuggestions(GUI::AutocompleteProvider::ProjectLocation { path, cursor_line, cursor_column }));
|
||||
m_connection_wrapper.connection()->post_message(Messages::LanguageServer::AutoCompleteSuggestions(GUI::AutocompleteProvider::ProjectLocation { path, cursor_line, cursor_column }));
|
||||
}
|
||||
|
||||
void LanguageClient::provide_autocomplete_suggestions(const Vector<GUI::AutocompleteProvider::Entry>& suggestions)
|
||||
void LanguageClient::provide_autocomplete_suggestions(const Vector<GUI::AutocompleteProvider::Entry>& suggestions) const
|
||||
{
|
||||
if (on_autocomplete_suggestions)
|
||||
on_autocomplete_suggestions(suggestions);
|
||||
|
|
@ -106,44 +106,20 @@ void LanguageClient::provide_autocomplete_suggestions(const Vector<GUI::Autocomp
|
|||
|
||||
void LanguageClient::set_autocomplete_mode(const String& mode)
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
m_server_connection->post_message(Messages::LanguageServer::SetAutoCompleteMode(mode));
|
||||
m_connection_wrapper.connection()->post_message(Messages::LanguageServer::SetAutoCompleteMode(mode));
|
||||
}
|
||||
|
||||
void LanguageClient::set_active_client()
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
m_server_connection->attach(*this);
|
||||
m_connection_wrapper.set_active_client(*this);
|
||||
}
|
||||
|
||||
void LanguageClient::on_server_crash()
|
||||
{
|
||||
VERIFY(m_server_connection);
|
||||
auto project_path = m_server_connection->project_path();
|
||||
ServerConnection::remove_instance_for_language(project_path);
|
||||
m_server_connection = nullptr;
|
||||
HashMap<String, NonnullOwnPtr<ServerConnectionWrapper>> ServerConnectionInstances::s_instance_for_language;
|
||||
|
||||
auto notification = GUI::Notification::construct();
|
||||
|
||||
notification->set_icon(Gfx::Bitmap::load_from_file("/res/icons/32x32/app-hack-studio.png"));
|
||||
notification->set_title("Oops!");
|
||||
notification->set_text(String::formatted("LanguageServer for {} crashed", project_path));
|
||||
notification->show();
|
||||
}
|
||||
|
||||
HashMap<String, NonnullRefPtr<ServerConnection>> ServerConnection::s_instance_for_language;
|
||||
|
||||
void ServerConnection::set_instance_for_project(const String& language_name, NonnullRefPtr<ServerConnection>&& instance)
|
||||
{
|
||||
s_instance_for_language.set(language_name, move(instance));
|
||||
}
|
||||
|
||||
void ServerConnection::remove_instance_for_language(const String& language_name)
|
||||
{
|
||||
s_instance_for_language.remove(language_name);
|
||||
}
|
||||
void ServerConnection::handle(const Messages::LanguageClient::DeclarationsInDocument& message)
|
||||
{
|
||||
locator().set_declared_symbols(message.filename(), message.declarations());
|
||||
|
|
@ -151,13 +127,13 @@ void ServerConnection::handle(const Messages::LanguageClient::DeclarationsInDocu
|
|||
|
||||
void LanguageClient::search_declaration(const String& path, size_t line, size_t column)
|
||||
{
|
||||
if (!m_server_connection)
|
||||
if (!m_connection_wrapper.connection())
|
||||
return;
|
||||
set_active_client();
|
||||
m_server_connection->post_message(Messages::LanguageServer::FindDeclaration(GUI::AutocompleteProvider::ProjectLocation { path, line, column }));
|
||||
m_connection_wrapper.connection()->post_message(Messages::LanguageServer::FindDeclaration(GUI::AutocompleteProvider::ProjectLocation { path, line, column }));
|
||||
}
|
||||
|
||||
void LanguageClient::declaration_found(const String& file, size_t line, size_t column)
|
||||
void LanguageClient::declaration_found(const String& file, size_t line, size_t column) const
|
||||
{
|
||||
if (!on_declaration_found) {
|
||||
dbgln("on_declaration_found callback is not set");
|
||||
|
|
@ -166,4 +142,107 @@ void LanguageClient::declaration_found(const String& file, size_t line, size_t c
|
|||
on_declaration_found(file, line, column);
|
||||
}
|
||||
|
||||
void ServerConnectionInstances::set_instance_for_language(const String& language_name, NonnullOwnPtr<ServerConnectionWrapper>&& connection_wrapper)
|
||||
{
|
||||
s_instance_for_language.set(language_name, move(connection_wrapper));
|
||||
}
|
||||
|
||||
void ServerConnectionInstances::remove_instance_for_language(const String& language_name)
|
||||
{
|
||||
s_instance_for_language.remove(language_name);
|
||||
}
|
||||
|
||||
ServerConnectionWrapper* ServerConnectionInstances::get_instance_wrapper(const String& language_name)
|
||||
{
|
||||
if (auto instance = s_instance_for_language.get(language_name); instance.has_value()) {
|
||||
return const_cast<ServerConnectionWrapper*>(instance.value());
|
||||
}
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void ServerConnectionWrapper::on_crash()
|
||||
{
|
||||
show_crash_notification();
|
||||
m_connection.clear();
|
||||
|
||||
static constexpr int max_crash_frequency_seconds = 3;
|
||||
if (m_last_crash_timer.is_valid() && m_last_crash_timer.elapsed() / 1000 < max_crash_frequency_seconds) {
|
||||
dbgln("LanguageServer crash frequency is too high");
|
||||
m_respawn_allowed = false;
|
||||
|
||||
show_frequenct_crashes_notification();
|
||||
} else {
|
||||
m_last_crash_timer.start();
|
||||
try_respawn_connection();
|
||||
}
|
||||
}
|
||||
void ServerConnectionWrapper::show_frequenct_crashes_notification() const
|
||||
{
|
||||
auto notification = GUI::Notification::construct();
|
||||
notification->set_icon(Gfx::Bitmap::load_from_file("/res/icons/32x32/app-hack-studio.png"));
|
||||
notification->set_title("LanguageServer Crashes too much!");
|
||||
notification->set_text("LanguageServer aided features will not be available in this session");
|
||||
notification->show();
|
||||
}
|
||||
void ServerConnectionWrapper::show_crash_notification() const
|
||||
{
|
||||
auto notification = GUI::Notification::construct();
|
||||
notification->set_icon(Gfx::Bitmap::load_from_file("/res/icons/32x32/app-hack-studio.png"));
|
||||
notification->set_title("Oops!");
|
||||
notification->set_text(String::formatted("LanguageServer has crashed"));
|
||||
notification->show();
|
||||
}
|
||||
|
||||
ServerConnectionWrapper::ServerConnectionWrapper(const String& language_name, Function<NonnullRefPtr<ServerConnection>()> connection_creator)
|
||||
: m_language(language_from_name(language_name))
|
||||
, m_connection_creator(move(connection_creator))
|
||||
{
|
||||
create_connection();
|
||||
}
|
||||
|
||||
void ServerConnectionWrapper::create_connection()
|
||||
{
|
||||
VERIFY(m_connection.is_null());
|
||||
m_connection = m_connection_creator();
|
||||
m_connection->set_wrapper(*this);
|
||||
m_connection->handshake();
|
||||
}
|
||||
|
||||
ServerConnection* ServerConnectionWrapper::connection()
|
||||
{
|
||||
return m_connection.ptr();
|
||||
}
|
||||
|
||||
void ServerConnectionWrapper::attach(LanguageClient& client)
|
||||
{
|
||||
m_connection->m_current_language_client = &client;
|
||||
}
|
||||
|
||||
void ServerConnectionWrapper::detach()
|
||||
{
|
||||
m_connection->m_current_language_client.clear();
|
||||
}
|
||||
|
||||
void ServerConnectionWrapper::set_active_client(LanguageClient& client)
|
||||
{
|
||||
m_connection->m_current_language_client = &client;
|
||||
}
|
||||
|
||||
void ServerConnectionWrapper::try_respawn_connection()
|
||||
{
|
||||
if (!m_respawn_allowed)
|
||||
return;
|
||||
|
||||
dbgln("Respawning ServerConnection");
|
||||
create_connection();
|
||||
|
||||
// After respawning the language-server, we have to flush the content of the project files
|
||||
// so the server's FileDB will be up-to-date.
|
||||
project().for_each_text_file([this](const ProjectFile& file) {
|
||||
if (file.code_document().language() != m_language)
|
||||
return;
|
||||
m_connection->post_message(Messages::LanguageServer::SetFileContent(file.code_document().file_path(), file.document().text()));
|
||||
});
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue