make server more stable with autoBuild disabled

Author: lukaszsamson

apps/language_server/lib/language_server/build.ex

@@ -28,11 +28,16 @@ defmodule ElixirLS.LanguageServer.Build do
                       fetch_deps(current_deps)
                     end
 
-                    {status, diagnostics} = run_mix_compile()
-
-                    diagnostics = Diagnostics.normalize(diagnostics, root_path)
-                    Server.build_finished(parent, {status, mixfile_diagnostics ++ diagnostics})
-                    :"mix_compile_#{status}"
+                    if Keyword.get(opts, :compile?) do
+                      {status, diagnostics} = run_mix_compile()
+
+                      diagnostics = Diagnostics.normalize(diagnostics, root_path)
+                      Server.build_finished(parent, {status, mixfile_diagnostics ++ diagnostics})
+                      :"mix_compile_#{status}"
+                    else
+                      Server.build_finished(parent, {:ok, mixfile_diagnostics})
+                      :mix_compile_disabled
+                    end
                   catch
                     kind, payload ->
                       {payload, stacktrace} = Exception.blame(kind, payload, __STACKTRACE__)
@@ -60,8 +65,12 @@ defmodule ElixirLS.LanguageServer.Build do
               end
             end)
 
-          Tracer.save()
-          Logger.info("Compile took #{div(us, 1000)} milliseconds")
+          if Keyword.get(opts, :compile?) do
+            Tracer.save()
+            Logger.info("Compile took #{div(us, 1000)} milliseconds")
+          else
+            Logger.info("Mix project load took #{div(us, 1000)} milliseconds")
+          end
 
           JsonRpc.telemetry("build", %{"elixir_ls.build_result" => result}, %{
             "elixir_ls.build_time" => div(us, 1000)

apps/language_server/lib/language_server/mix_project.ex

@@ -14,6 +14,10 @@ defmodule ElixirLS.LanguageServer.MixProject do
     GenServer.call(__MODULE__, :store)
   end
 
+  def loaded? do
+    GenServer.call(__MODULE__, :loaded?)
+  end
+
   @spec get() :: module | nil
   def get do
     GenServer.call(__MODULE__, {:get, :get})
@@ -154,4 +158,8 @@ defmodule ElixirLS.LanguageServer.MixProject do
 
     {:reply, :ok, state}
   end
+
+  def handle_call(:loaded?, _from, state) do
+    {:reply, is_map(state), state}
+  end
 end

apps/language_server/lib/language_server/server.ex

@@ -587,8 +587,7 @@ defmodule ElixirLS.LanguageServer.Server do
     end
   end
 
-  defp handle_notification(did_change_watched_files(changes), state = %__MODULE__{})
-       when is_binary(state.project_dir) do
+  defp handle_notification(did_change_watched_files(changes), state = %__MODULE__{mix_project?: true}) do
     changes = Enum.filter(changes, &match?(%{"uri" => "file:" <> _}, &1))
 
     # `settings` may not always be available here, like during testing
@@ -657,7 +656,7 @@ defmodule ElixirLS.LanguageServer.Server do
   end
 
   defp handle_notification(did_change_watched_files(_changes), state = %__MODULE__{}) do
-    # swallow notification if project_dir is not yet set
+    # swallow notification if we are not in mix_project
     state
   end
 
@@ -1127,17 +1126,19 @@ defmodule ElixirLS.LanguageServer.Server do
   end
 
   defp get_spec_code_lenses(state = %__MODULE__{}, uri, source_file) do
-    if is_binary(state.project_dir) and dialyzer_enabled?(state) and !!state.settings["suggestSpecs"] do
+    enabled? = Map.get(state.settings || {}, "suggestSpecs", true)
+    if state.mix_project? and dialyzer_enabled?(state) and enabled? do
       CodeLens.spec_code_lens(state.server_instance_id, uri, source_file.text)
     else
       {:ok, []}
     end
   end
 
   defp get_test_code_lenses(state = %__MODULE__{}, uri, source_file) do
-    enabled = state.settings["enableTestLenses"] || false
+    # TODO check why test run from lense fails when autoBuild is disabled
+    enabled? = Map.get(state.settings || {}, "autoBuild", true) and Map.get(state.settings || {}, "enableTestLenses", false)
 
-    if is_binary(state.project_dir) and enabled do
+    if state.mix_project? and enabled? and ElixirLS.LanguageServer.MixProject.loaded? do
       get_test_code_lenses(
         state,
         uri,
@@ -1232,19 +1233,20 @@ defmodule ElixirLS.LanguageServer.Server do
   # Build
 
   defp trigger_build(state = %__MODULE__{project_dir: project_dir}) do
-    build_automatically = Map.get(state.settings || %{}, "autoBuild", true)
-
     cond do
-      not build_enabled?(state) ->
+      not state.mix_project? ->
         state
 
-      not state.build_running? and build_automatically ->
-        fetch_deps? = Map.get(state.settings || %{}, "fetchDeps", false)
+      not state.build_running? ->
+        opts = [
+        fetch_deps?: Map.get(state.settings || %{}, "fetchDeps", false),
+        compile?: Map.get(state.settings || %{}, "autoBuild", true)
+        ]
 
         {_pid, build_ref} = case File.cwd() do
           {:ok, cwd} ->
             if Path.absname(cwd) == Path.absname(project_dir) do
-              Build.build(self(), project_dir, fetch_deps?: fetch_deps?)
+              Build.build(self(), project_dir, opts)
             else
               Logger.info("Skipping build because cwd changed from #{project_dir} to #{cwd}")
               {nil, nil}
@@ -1255,7 +1257,7 @@ defmodule ElixirLS.LanguageServer.Server do
             # try to change back to project dir
             case File.cd(project_dir) do
               :ok ->
-                Build.build(self(), project_dir, fetch_deps?: fetch_deps?)
+                Build.build(self(), project_dir, opts)
               {:error, reason} ->
                 message = "Cannot change directory to project dir #{project_dir}: #{inspect(reason)}"
                 Logger.error(message)
@@ -1273,6 +1275,7 @@ defmodule ElixirLS.LanguageServer.Server do
         }
 
       true ->
+        # build already running, schedule another one
         %__MODULE__{state | needs_build?: true, analysis_ready?: false}
     end
   end
@@ -1373,10 +1376,6 @@ defmodule ElixirLS.LanguageServer.Server do
     end
   end
 
-  defp build_enabled?(state = %__MODULE__{}) do
-    is_binary(state.project_dir)
-  end
-
   defp dialyzer_enabled?(state = %__MODULE__{}) do
     state.dialyzer_sup != nil
   end
@@ -1471,7 +1470,7 @@ defmodule ElixirLS.LanguageServer.Server do
 
   defp set_settings(state = %__MODULE__{}, settings) do
     enable_dialyzer =
-      Dialyzer.check_support() == :ok && Map.get(settings, "dialyzerEnabled", true)
+      Dialyzer.check_support() == :ok and Map.get(settings, "autoBuild", true) and Map.get(settings, "dialyzerEnabled", true)
 
     env_vars = Map.get(settings, "envVariables")
     mix_env = Map.get(settings, "mixEnv")
@@ -1584,11 +1583,11 @@ defmodule ElixirLS.LanguageServer.Server do
 
   defp set_dialyzer_enabled(state = %__MODULE__{}, enable_dialyzer) do
     cond do
-      enable_dialyzer and state.dialyzer_sup == nil and is_binary(state.project_dir) ->
+      enable_dialyzer and state.mix_project? and state.dialyzer_sup == nil  ->
         {:ok, pid} = Dialyzer.Supervisor.start_link(state.project_dir)
-        %{state | dialyzer_sup: pid}
+        %{state | dialyzer_sup: pid, analysis_ready?: false}
 
-      not enable_dialyzer and state.dialyzer_sup != nil ->
+      not (enable_dialyzer and state.mix_project?) and state.dialyzer_sup != nil ->
         Process.exit(state.dialyzer_sup, :normal)
         %{state | dialyzer_sup: nil, analysis_ready?: false}
 

apps/language_server/lib/language_server/source_file.ex

@@ -235,14 +235,18 @@ defmodule ElixirLS.LanguageServer.SourceFile do
 
     try do
       alias ElixirLS.LanguageServer.MixProject
-      opts = [
-      deps_paths: MixProject.deps_paths(),
-      manifest_path: MixProject.manifest_path(),
-      config_mtime: MixProject.config_mtime(),
-      mix_project: MixProject.get(),
-      root: project_dir
-      ]
-      {:ok, Mix.Tasks.ElixirLSFormat.formatter_for_file(path, opts)}
+      if ElixirLS.LanguageServer.MixProject.loaded? do
+        opts = [
+        deps_paths: MixProject.deps_paths(),
+        manifest_path: MixProject.manifest_path(),
+        config_mtime: MixProject.config_mtime(),
+        mix_project: MixProject.get(),
+        root: project_dir
+        ]
+        {:ok, Mix.Tasks.ElixirLSFormat.formatter_for_file(path, opts)}
+      else
+        {:error, :project_not_loaded}
+      end
     catch
       kind, payload ->
         {payload, stacktrace} = Exception.blame(kind, payload, __STACKTRACE__)