Added clearer typing for requests and notifications

Prior, the lsp and elixir versions said they were the same type, this
made it harder for users to tell which type they were dealing with.

Author: scohen

apps/language_server/lib/language_server/experimental/protocol/proto/macros/struct.ex

@@ -25,6 +25,8 @@ defmodule ElixirLS.LanguageServer.Experimental.Protocol.Proto.Macros.Struct do
       def new(opts \\ []) do
         struct(__MODULE__, opts)
       end
+
+      defoverridable new: 0, new: 1
     end
   end
 end

apps/language_server/lib/language_server/experimental/protocol/proto/notification.ex

@@ -16,17 +16,23 @@ defmodule ElixirLS.LanguageServer.Experimental.Protocol.Proto.Notification do
 
     quote location: :keep do
       defmodule LSP do
-        unquote(Message.build(:notification, method, lsp_types, param_names))
+        unquote(Message.build({:notification, :lsp}, method, lsp_types, param_names))
       end
 
       alias ElixirLS.LanguageServer.Experimental.Protocol.Proto.Convert
 
       unquote(
-        Message.build(:notification, method, elixir_types, param_names, include_parse?: false)
+        Message.build({:notification, :elixir}, method, elixir_types, param_names,
+          include_parse?: false
+        )
       )
 
       unquote(build_parse(method))
 
+      def new(opts \\ []) do
+        %__MODULE__{lsp: LSP.new(opts)}
+      end
+
       def to_elixir(%__MODULE__{} = request) do
         Convert.to_elixir(request)
       end

apps/language_server/lib/language_server/experimental/protocol/proto/request.ex

@@ -22,16 +22,24 @@ defmodule ElixirLS.LanguageServer.Experimental.Protocol.Proto.Request do
 
     quote location: :keep do
       defmodule LSP do
-        unquote(Message.build(:request, method, lsp_types, param_names))
+        unquote(Message.build({:request, :lsp}, method, lsp_types, param_names))
       end
 
       alias ElixirLS.LanguageServer.Experimental.Protocol.Proto.Convert
       alias ElixirLS.LanguageServer.Experimental.Protocol.Types
 
-      unquote(Message.build(:request, method, elixir_types, param_names, include_parse?: false))
+      unquote(
+        Message.build({:request, :elixir}, method, elixir_types, param_names,
+          include_parse?: false
+        )
+      )
 
       unquote(build_parse(method))
 
+      def new(opts \\ []) do
+        %__MODULE__{lsp: LSP.new(opts)}
+      end
+
       def to_elixir(%__MODULE__{} = request) do
         Convert.to_elixir(request)
       end

apps/language_server/lib/language_server/experimental/server/state.ex

@@ -17,7 +17,7 @@ defmodule ElixirLS.LanguageServer.Experimental.Server.State do
     %__MODULE__{}
   end
 
-  def apply(%__MODULE__{} = state, %DidChange{} = event) do
+  def apply(%__MODULE__{} = state, %DidChange{lsp: event}) do
     uri = event.text_document.uri
     version = event.text_document.version
 
@@ -30,7 +30,7 @@ defmodule ElixirLS.LanguageServer.Experimental.Server.State do
     end
   end
 
-  def apply(%__MODULE__{} = state, %DidOpen{} = event) do
+  def apply(%__MODULE__{} = state, %DidOpen{lsp: event}) do
     %TextDocument{text: text, uri: uri, version: version} = text_document = event.text_document
 
     case SourceFile.Store.open(uri, text, version) do
@@ -44,7 +44,7 @@ defmodule ElixirLS.LanguageServer.Experimental.Server.State do
     end
   end
 
-  def apply(%__MODULE__{} = state, %DidClose{} = event) do
+  def apply(%__MODULE__{} = state, %DidClose{lsp: event}) do
     uri = event.text_document.uri
 
     case SourceFile.Store.close(uri) do
@@ -57,7 +57,7 @@ defmodule ElixirLS.LanguageServer.Experimental.Server.State do
     end
   end
 
-  def apply(%__MODULE__{} = state, %DidSave{} = event) do
+  def apply(%__MODULE__{} = state, %DidSave{lsp: event}) do
     uri = event.text_document.uri
 
     case SourceFile.Store.save(uri) do

apps/language_server/test/support/fixtures/lsp_protocol.ex

@@ -29,7 +29,7 @@ defmodule ElixirLS.LanguageServer.Fixtures.LspProtocol do
                 args
             end
 
-          {:ok, struct(type, args)}
+          {:ok, type.new(args)}
 
         {:error, _} = err ->
           err
@@ -51,24 +51,36 @@ defmodule ElixirLS.LanguageServer.Fixtures.LspProtocol do
   end
 
   defp maybe_wrap_with_json_rpc(%proto_module{} = proto, opts) do
+    proto_struct =
+      case proto_module.__meta__(:type) do
+        {message_type, :lsp} when message_type in [:notification, :request] ->
+          proto
+
+        {message_type, :elixir} when message_type in [:notification, :request] ->
+          proto.lsp
+
+        other ->
+          other
+      end
+
     case proto_module.__meta__(:type) do
-      :notification ->
+      {:notification, _} ->
         %{
           jsonrpc: Keyword.get(opts, :jsonrpc, "2.0"),
           method: proto_module.__meta__(:method_name),
-          params: extract_params(proto)
+          params: extract_params(proto_struct)
         }
 
-      :request ->
+      {:request, _} ->
         %{
           jsonrpc: Keyword.get(opts, :jsonrpc, "2.0"),
           method: proto_module.__meta__(:method_name),
-          params: extract_params(proto),
+          params: extract_params(proto_struct),
           id: Keyword.get(opts, :id, next_int())
         }
 
       _other ->
-        proto
+        proto_struct
     end
   end