correctly handle non standard deps_path in tracer

Author: lukaszsamson

apps/language_server/lib/language_server/build.ex

@@ -133,6 +133,7 @@ defmodule ElixirLS.LanguageServer.Build do
           }
 
           ElixirLS.LanguageServer.MixProjectCache.store(state)
+          Tracer.notify_deps_path(Mix.Project.deps_path(state.config))
 
           :ok
         catch

apps/language_server/lib/language_server/tracer.ex

@@ -21,6 +21,10 @@ defmodule ElixirLS.LanguageServer.Tracer do
     GenServer.cast(__MODULE__, {:notify_settings_stored, project_dir})
   end
 
+  def notify_deps_path(deps_path) do
+    GenServer.cast(__MODULE__, {:notify_deps_path, deps_path})
+  end
+
   defp get_project_dir() do
     case Process.get(:elixir_ls_project_dir) do
       nil ->
@@ -33,6 +37,18 @@ defmodule ElixirLS.LanguageServer.Tracer do
     end
   end
 
+  defp get_deps_path() do
+    case Process.get(:elixir_ls_deps_path) do
+      nil ->
+        deps_path = GenServer.call(__MODULE__, :get_deps_path)
+        Process.put(:elixir_ls_deps_path, deps_path)
+        deps_path
+
+      deps_path ->
+        deps_path
+    end
+  end
+
   def notify_file_deleted(file) do
     GenServer.cast(__MODULE__, {:notify_file_deleted, file})
   end
@@ -50,7 +66,7 @@ defmodule ElixirLS.LanguageServer.Tracer do
       ])
     end
 
-    state = %{project_dir: nil}
+    state = %{project_dir: nil, deps_path: nil}
 
     {:ok, state}
   end
@@ -60,6 +76,10 @@ defmodule ElixirLS.LanguageServer.Tracer do
     {:reply, project_dir, state}
   end
 
+  def handle_call(:get_deps_path, _from, %{deps_path: deps_path} = state) do
+    {:reply, deps_path, state}
+  end
+
   @impl true
   def handle_cast({:notify_settings_stored, project_dir}, state) do
     for table <- @tables do
@@ -70,6 +90,10 @@ defmodule ElixirLS.LanguageServer.Tracer do
     {:noreply, %{state | project_dir: project_dir}}
   end
 
+  def handle_cast({:notify_deps_path, deps_path}, state) do
+    {:noreply, %{state | deps_path: deps_path}}
+  end
+
   def handle_cast({:notify_file_deleted, file}, state) do
     delete_modules_by_file(file)
     delete_calls_by_file(file)
@@ -283,15 +307,21 @@ defmodule ElixirLS.LanguageServer.Tracer do
 
   defp in_project_sources?(path) do
     project_dir = get_project_dir()
+    deps_path = get_deps_path()
 
     if project_dir != nil do
-      topmost_path_segment =
-        path
-        |> Path.relative_to(project_dir)
-        |> Path.split()
-        |> hd
+      cond do
+        deps_path && Path.relative_to(path, deps_path) != path ->
+          # path is in deps_path
+          false
+
+        Path.relative_to(path, project_dir) == path ->
+          # path not in project_dir, probably a path dep
+          false
 
-      topmost_path_segment != "deps"
+        true ->
+          true
+      end
     else
       false
     end

apps/language_server/test/tracer_test.exs

@@ -17,13 +17,23 @@ defmodule ElixirLS.LanguageServer.TracerTest do
     assert GenServer.call(Tracer, :get_project_dir) == project_path
   end
 
+  test "set deps path" do
+    project_path = FixtureHelpers.get_path("")
+    deps_path = Path.join(project_path, "deps")
+
+    Tracer.notify_deps_path(deps_path)
+
+    assert GenServer.call(Tracer, :get_deps_path) == deps_path
+  end
+
   describe "call trace" do
     setup context do
       project_path = FixtureHelpers.get_path("")
       Tracer.notify_settings_stored(project_path)
+      Tracer.notify_deps_path(Path.join(project_path, "deps"))
       GenServer.call(Tracer, :get_project_dir)
 
-      {:ok, context}
+      {:ok, context |> Map.put(:project_path, project_path)}
     end
 
     defp sorted_calls() do
@@ -34,99 +44,101 @@ defmodule ElixirLS.LanguageServer.TracerTest do
       assert sorted_calls() == []
     end
 
-    test "registers calls same function different files" do
+    test "registers calls same function different files", %{project_path: project_path} do
       Tracer.trace(
         {:remote_function, [line: 12, column: 2], CalledModule, :called, 1},
         %Macro.Env{
           module: CallingModule,
-          file: "calling_module.ex"
+          file: Path.join(project_path, "calling_module.ex")
         }
       )
 
       Tracer.trace(
         {:remote_function, [line: 13, column: 3], CalledModule, :called, 1},
         %Macro.Env{
           module: OtherCallingModule,
-          file: "other_calling_module.ex"
+          file: Path.join(project_path, "other_calling_module.ex")
         }
       )
 
       assert [
-               {{CalledModule, :called, 1}, "calling_module.ex", 12, 2},
-               {{CalledModule, :called, 1}, "other_calling_module.ex", 13, 3}
+               {{CalledModule, :called, 1}, Path.join(project_path, "calling_module.ex"), 12, 2},
+               {{CalledModule, :called, 1}, Path.join(project_path, "other_calling_module.ex"),
+                13, 3}
              ] == sorted_calls()
     end
 
-    test "registers calls same function in one file" do
+    test "registers calls same function in one file", %{project_path: project_path} do
       Tracer.trace(
         {:remote_function, [line: 12, column: 2], CalledModule, :called, 1},
         %Macro.Env{
           module: CallingModule,
-          file: "calling_module.ex"
+          file: Path.join(project_path, "calling_module.ex")
         }
       )
 
       Tracer.trace(
         {:remote_function, [line: 13, column: 3], CalledModule, :called, 1},
         %Macro.Env{
           module: CallingModule,
-          file: "calling_module.ex"
+          file: Path.join(project_path, "calling_module.ex")
         }
       )
 
       assert [
-               {{CalledModule, :called, 1}, "calling_module.ex", 12, 2},
-               {{CalledModule, :called, 1}, "calling_module.ex", 13, 3}
+               {{CalledModule, :called, 1}, Path.join(project_path, "calling_module.ex"), 12, 2},
+               {{CalledModule, :called, 1}, Path.join(project_path, "calling_module.ex"), 13, 3}
              ] == sorted_calls()
     end
 
-    test "registers calls different functions" do
+    test "registers calls different functions", %{project_path: project_path} do
       Tracer.trace(
         {:remote_function, [line: 12, column: 2], CalledModule, :called, 1},
         %Macro.Env{
           module: CallingModule,
-          file: "calling_module.ex"
+          file: Path.join(project_path, "calling_module.ex")
         }
       )
 
       Tracer.trace(
         {:remote_function, [line: 13, column: 3], CalledModule, :other_called, 1},
         %Macro.Env{
           module: OtherCallingModule,
-          file: "other_calling_module.ex"
+          file: Path.join(project_path, "other_calling_module.ex")
         }
       )
 
       assert [
-               {{CalledModule, :called, 1}, "calling_module.ex", 12, 2},
-               {{CalledModule, :other_called, 1}, "other_calling_module.ex", 13, 3}
+               {{CalledModule, :called, 1}, Path.join(project_path, "calling_module.ex"), 12, 2},
+               {{CalledModule, :other_called, 1},
+                Path.join(project_path, "other_calling_module.ex"), 13, 3}
              ] == sorted_calls()
     end
 
-    test "deletes calls by file" do
+    test "deletes calls by file", %{project_path: project_path} do
       Tracer.trace(
         {:remote_function, [line: 12, column: 2], CalledModule, :called, 1},
         %Macro.Env{
           module: CallingModule,
-          file: "calling_module.ex"
+          file: Path.join(project_path, "calling_module.ex")
         }
       )
 
       Tracer.trace(
         {:remote_function, [line: 13, column: 3], CalledModule, :called, 1},
         %Macro.Env{
           module: OtherCallingModule,
-          file: "other_calling_module.ex"
+          file: Path.join(project_path, "other_calling_module.ex")
         }
       )
 
-      Tracer.delete_calls_by_file("other_calling_module.ex")
+      Tracer.delete_calls_by_file(Path.join(project_path, "other_calling_module.ex"))
 
       assert [
-               {{CalledModule, :called, 1}, "calling_module.ex", 12, 2}
+               {{CalledModule, :called, 1}, Path.join(project_path, "calling_module.ex"), 12, 2}
              ] == sorted_calls()
 
-      Tracer.delete_calls_by_file("calling_module.ex")
+      Tracer.delete_calls_by_file(Path.join(project_path, "calling_module.ex"))
 
       assert [] == sorted_calls()
     end