Purge consolidated protocols before compilation (elixir-editors#406)

* Purge consolidated protocols before compilation

Fixes elixir-editors#395

* move to dialyzer_test.exs

* add comments

* warn if ls fails

Author: lukaszsamson

apps/language_server/lib/language_server/build.ex

@@ -24,6 +24,8 @@ defmodule ElixirLS.LanguageServer.Build do
                     fetch_deps()
                   end
 
+                  # if we won't do it elixir >= 1.11 warns that protocols have already been consolidated
+                  purge_consolidated_protocols()
                   {status, diagnostics} = compile()
 
                   if status in [:ok, :noop] and Keyword.get(opts, :load_all_modules?) do
@@ -123,8 +125,7 @@ defmodule ElixirLS.LanguageServer.Build do
         %{file: ^mixfile, name: module} ->
           # FIXME: Private API
           Mix.Project.pop()
-          :code.purge(module)
-          :code.delete(module)
+          purge_module(module)
 
         _ ->
           :ok
@@ -207,6 +208,30 @@ defmodule ElixirLS.LanguageServer.Build do
     end
   end
 
+  defp purge_consolidated_protocols do
+    config = Mix.Project.config()
+    path = Mix.Project.consolidation_path(config)
+
+    with {:ok, beams} <- File.ls(path) do
+      Enum.map(beams, &(&1 |> Path.rootname(".beam") |> String.to_atom() |> purge_module()))
+    else
+      {:error, reason} ->
+        JsonRpc.show_message(
+          :warning,
+          "Unable to purge consolidated protocols from #{path}: #{inspect(reason)}"
+        )
+    end
+
+    # NOTE this implementation is based on https://github.com/phoenixframework/phoenix/commit/b5580e9
+    # calling `Code.delete_path(path)` may be unnecessary in our case
+    Code.delete_path(path)
+  end
+
+  defp purge_module(module) do
+    :code.purge(module)
+    :code.delete(module)
+  end
+
   defp cached_deps do
     try do
       # FIXME: Private API

apps/language_server/test/dialyzer_test.exs

@@ -347,4 +347,81 @@ defmodule ElixirLS.LanguageServer.DialyzerTest do
       end)
     end)
   end
+
+  test "protocol rebuild does not trigger consolidation warnings", %{server: server} do
+    in_fixture(__DIR__, "protocols", fn ->
+      root_uri = SourceFile.path_to_uri(File.cwd!())
+      uri = SourceFile.path_to_uri(Path.absname("lib/implementations.ex"))
+
+      Server.receive_packet(server, initialize_req(1, root_uri, %{}))
+      Server.receive_packet(server, notification("initialized"))
+
+      Server.receive_packet(
+        server,
+        did_change_configuration(%{"elixirLS" => %{"dialyzerEnabled" => true}})
+      )
+
+      assert_receive notification("window/logMessage", %{"message" => "Compile took" <> _}), 5000
+
+      assert_receive notification("window/logMessage", %{
+                       "message" => "[ElixirLS Dialyzer] Done writing manifest" <> _
+                     }),
+                     30000
+
+      v2_text = """
+      defimpl Protocols.Example, for: List do
+        def some(t), do: t
+      end
+
+      defimpl Protocols.Example, for: String do
+        def some(t), do: t
+      end
+
+      defimpl Protocols.Example, for: Map do
+        def some(t), do: t
+      end
+      """
+
+      Server.receive_packet(server, did_open(uri, "elixir", 1, v2_text))
+      File.write!("lib/implementations.ex", v2_text)
+      Server.receive_packet(server, did_save(uri))
+
+      assert_receive notification("window/logMessage", %{"message" => "Compile took" <> _}), 5000
+
+      assert_receive notification("textDocument/publishDiagnostics", %{"diagnostics" => []}),
+                     30000
+
+      Process.sleep(2000)
+
+      v2_text = """
+      defimpl Protocols.Example, for: List do
+        def some(t), do: t
+      end
+
+      defimpl Protocols.Example, for: String do
+        def some(t), do: t
+      end
+
+      defimpl Protocols.Example, for: Map do
+        def some(t), do: t
+      end
+
+      defimpl Protocols.Example, for: Atom do
+        def some(t), do: t
+      end
+      """
+
+      Server.receive_packet(server, did_open(uri, "elixir", 1, v2_text))
+      File.write!("lib/implementations.ex", v2_text)
+      Server.receive_packet(server, did_save(uri))
+
+      assert_receive notification("window/logMessage", %{"message" => "Compile took" <> _}), 5000
+
+      assert_receive notification("textDocument/publishDiagnostics", %{"diagnostics" => []}),
+                     30000
+
+      # we should not receive Protocol has already been consolidated warnings here
+      refute_receive notification("textDocument/publishDiagnostics", _), 3000
+    end)
+  end
 end

apps/language_server/test/fixtures/protocols/lib/example.ex

@@ -0,0 +1,4 @@
+defprotocol Protocols.Example do
+  @spec some(t) :: any
+  def some(t)
+end

apps/language_server/test/fixtures/protocols/lib/implementations.ex

@@ -0,0 +1,7 @@
+defimpl Protocols.Example, for: List do
+  def some(t), do: t
+end
+
+defimpl Protocols.Example, for: String do
+  def some(t), do: t
+end

apps/language_server/test/fixtures/protocols/mix.exs

@@ -0,0 +1,14 @@
+defmodule Protocols.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :protocols,
+      version: "0.1.0"
+    ]
+  end
+
+  def application do
+    []
+  end
+end