do not try to populate mix options from cache when the project dir is not mix project

Fixes #1022

Author: lukaszsamson

apps/language_server/lib/language_server/providers/execute_command/apply_spec.ex

@@ -56,7 +56,7 @@ defmodule ElixirLS.LanguageServer.Providers.ExecuteCommand.ApplySpec do
     formatted =
       try do
         target_line_length =
-          case SourceFile.formatter_for(uri, state.project_dir) do
+          case SourceFile.formatter_for(uri, state.project_dir, true) do
             {:ok, {_, opts, _formatter_exs_dir}} ->
               Keyword.get(opts, :line_length, @default_target_line_length)
 

apps/language_server/lib/language_server/providers/formatting.ex

@@ -4,13 +4,13 @@ defmodule ElixirLS.LanguageServer.Providers.Formatting do
   alias ElixirLS.LanguageServer.SourceFile
   alias ElixirLS.LanguageServer.JsonRpc
 
-  def format(%SourceFile{} = source_file, uri = "file:" <> _, project_dir)
+  def format(%SourceFile{} = source_file, uri = "file:" <> _, project_dir, mix_project?)
       when is_binary(project_dir) do
     file_path = SourceFile.Path.absolute_from_uri(uri, project_dir)
     # file_path and project_dir are absolute paths with universal separators
     if SourceFile.Path.path_in_dir?(file_path, project_dir) do
       # file in project_dir we find formatter and options for file
-      case SourceFile.formatter_for(uri, project_dir) do
+      case SourceFile.formatter_for(uri, project_dir, mix_project?) do
         {:ok, {formatter, opts, formatter_exs_dir}} ->
           if should_format?(uri, formatter_exs_dir, opts[:inputs], project_dir) do
             do_format(source_file, formatter, opts)
@@ -46,7 +46,7 @@ defmodule ElixirLS.LanguageServer.Providers.Formatting do
   end
 
   # if project_dir is not set or schema is not file we format with default options
-  def format(%SourceFile{} = source_file, _uri, _project_dir) do
+  def format(%SourceFile{} = source_file, _uri, _project_dir, _mix_project?) do
     do_format(source_file, nil, [])
   end
 

apps/language_server/lib/language_server/server.ex

@@ -1001,7 +1001,7 @@ defmodule ElixirLS.LanguageServer.Server do
       !!get_in(state.client_capabilities, ["textDocument", "signatureHelp"])
 
     locals_without_parens =
-      case SourceFile.formatter_for(uri, state.project_dir) do
+      case SourceFile.formatter_for(uri, state.project_dir, state.mix_project?) do
         {:ok, {_, opts, _formatter_exs_dir}} -> Keyword.get(opts, :locals_without_parens, [])
         {:error, _} -> []
       end
@@ -1034,7 +1034,7 @@ defmodule ElixirLS.LanguageServer.Server do
 
   defp handle_request(formatting_req(_id, uri, _options), state = %__MODULE__{}) do
     source_file = get_source_file(state, uri)
-    fun = fn -> Formatting.format(source_file, uri, state.project_dir) end
+    fun = fn -> Formatting.format(source_file, uri, state.project_dir, state.mix_project?) end
     {:async, fun, state}
   end
 

apps/language_server/lib/language_server/source_file.ex

@@ -229,26 +229,34 @@ defmodule ElixirLS.LanguageServer.SourceFile do
     """
   end
 
-  @spec formatter_for(String.t(), String.t() | nil) ::
-          {:ok, {function | nil, keyword(), String.t()}} | :error
-  def formatter_for(uri = "file:" <> _, project_dir) when is_binary(project_dir) do
+  @spec formatter_for(String.t(), String.t() | nil, boolean) ::
+          {:ok, {function | nil, keyword(), String.t()}} | {:error, any}
+  def formatter_for(uri = "file:" <> _, project_dir, mix_project?) when is_binary(project_dir) do
     path = __MODULE__.Path.from_uri(uri)
 
     try do
       alias ElixirLS.LanguageServer.MixProject
 
-      if ElixirLS.LanguageServer.MixProject.loaded?() do
+      if mix_project? do
+        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
+      else
         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 ->
@@ -261,7 +269,7 @@ defmodule ElixirLS.LanguageServer.SourceFile do
     end
   end
 
-  def formatter_for(_, _), do: {:error, :project_dir_not_set}
+  def formatter_for(_, _, _), do: {:error, :project_dir_not_set}
 
   defp format_code(code, opts) do
     try do

apps/language_server/test/providers/formatting_test.exs

@@ -36,7 +36,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("no_mixfile"))
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, false)
 
       assert changes == [
                %TextEdit{
@@ -86,7 +86,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = nil
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, false)
 
       assert changes == [
                %TextEdit{
@@ -137,7 +137,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("formatter"))
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, true)
 
       assert changes == [
                %TextEdit{
@@ -190,7 +190,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("formatter"))
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, true)
 
       assert changes == [
                %TextEdit{
@@ -279,7 +279,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("formatter"))
 
       assert {:ok, []} =
-               Formatting.format(source_file, uri, project_dir)
+               Formatting.format(source_file, uri, project_dir, true)
     end)
   end
 
@@ -310,7 +310,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("formatter"))
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, true)
 
       assert changes == [
                %TextEdit{
@@ -365,7 +365,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("formatter"))
 
       assert {:ok, []} =
-               Formatting.format(source_file, uri, project_dir)
+               Formatting.format(source_file, uri, project_dir, true)
     end)
   end
 
@@ -388,7 +388,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = maybe_convert_path_separators("/project")
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, true)
 
       assert changes == [
                %TextEdit{
@@ -428,7 +428,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("formatter"))
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, true)
 
       assert changes == [
                %TextEdit{
@@ -468,7 +468,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
 
       project_dir = maybe_convert_path_separators(FixtureHelpers.get_path("formatter"))
 
-      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir)
+      assert {:ok, changes} = Formatting.format(source_file, uri, project_dir, true)
 
       assert changes == [
                %TextEdit{
@@ -495,40 +495,41 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
       store_mix_cache()
       project_dir = Path.expand(".")
 
-      assert_formatted("file.ex", project_dir)
+      assert_formatted("file.ex", project_dir, true)
 
       # test/.formatter.exs has [inputs: ["*.exs"]]
-      assert_formatted("test/file.exs", project_dir)
-      refute_formatted("test/file.ex", project_dir)
+      assert_formatted("test/file.exs", project_dir, true)
+      refute_formatted("test/file.ex", project_dir, true)
 
       unless is_windows() do
-        assert_formatted("symlink/file.exs", project_dir)
-        refute_formatted("symlink/file.ex", project_dir)
+        assert_formatted("symlink/file.exs", project_dir, true)
+        refute_formatted("symlink/file.ex", project_dir, true)
       end
 
       File.mkdir!("#{project_dir}/test/foo")
-      refute_formatted("test/foo/file.ex", project_dir)
+      refute_formatted("test/foo/file.ex", project_dir, true)
 
       # apps/foo/bar/.formatter.exs has [inputs: ["foo.ex"]]
-      assert_formatted("apps/foo/foo.ex", project_dir)
-      refute_formatted("apps/foo/bar.ex", project_dir)
-      refute_formatted("apps/foo.ex", project_dir)
+      assert_formatted("apps/foo/foo.ex", project_dir, true)
+      refute_formatted("apps/foo/bar.ex", project_dir, true)
+      refute_formatted("apps/foo.ex", project_dir, true)
     end)
   end
 
-  def assert_formatted(path, project_dir) do
+  def assert_formatted(path, project_dir, mix_file?) do
     assert match?(
              {:ok, [%ElixirLS.LanguageServer.Protocol.TextEdit{} | _]},
-             format(path, project_dir)
+             format(path, project_dir, mix_file?)
            ),
            "expected '#{path}' to be formatted"
   end
 
-  def refute_formatted(path, project_dir) do
-    assert match?({:ok, []}, format(path, project_dir)), "expected '#{path}' not to be formatted"
+  def refute_formatted(path, project_dir, mix_file?) do
+    assert match?({:ok, []}, format(path, project_dir, mix_file?)),
+           "expected '#{path}' not to be formatted"
   end
 
-  defp format(path, project_dir) do
+  defp format(path, project_dir, mix_project?) do
     project_dir =
       maybe_convert_path_separators(project_dir)
       |> Path.absname()
@@ -542,7 +543,7 @@ defmodule ElixirLS.LanguageServer.Providers.FormattingTest do
     }
 
     File.write!(path, " asd  = 1")
-    Formatting.format(source_file, SourceFile.Path.to_uri(path), project_dir)
+    Formatting.format(source_file, SourceFile.Path.to_uri(path), project_dir, mix_project?)
   end
 
   defp store_mix_cache() do