Merge branch 'master' of https://github.com/elixir-lsp/elixir-ls into test_code_lens

Author: Étienne Lévesque

.github/workflows/release-asset.yml

@@ -0,0 +1,89 @@
+name: Elixir CI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    name: Create draft release
+    runs-on: ubuntu-latest
+    outputs:
+      upload_url: ${{steps.create_release.outputs.upload_url}}
+
+    steps:
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          draft: true
+          prerelease: false
+
+  build:
+    name: Build and publish release asset
+    runs-on: ubuntu-latest
+    needs: release
+
+    strategy:
+      matrix:
+        include:
+          - elixir-version: '1.11'
+            otp-version: '23.1'
+          - elixir-version: '1.10.4'
+            otp-version: '23.1'
+          - elixir-version: '1.9'
+            otp-version: '22.3'
+          - elixir-version: '1.8.2'
+            otp-version: '21.3'
+            default: true
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Elixir
+        uses: actions/setup-elixir@v1
+        with:
+          elixir-version: ${{ matrix.elixir-version }}
+          otp-version: ${{ matrix.otp-version }}
+
+      - name: Restore dependencies cache
+        uses: actions/cache@v2
+        with:
+          path: deps
+          key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
+          restore-keys: ${{ runner.os }}-mix-
+
+      - name: Install dependencies
+        run: mix deps.get
+
+      - name: Build release
+        run: |
+          mkdir ./release
+          mix compile
+          MIX_ENV=prod mix elixir_ls.release -o ./release
+          zip -jr elixir-ls.zip ./release
+
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release.outputs.upload_url }}
+          asset_path: ./elixir-ls.zip
+          asset_name: elixir-ls-${{ matrix.elixir-version }}.zip
+          asset_content_type: application/zip
+
+      - name: Upload Default Release Asset
+        if: ${{ matrix.default == true }}
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release.outputs.upload_url }}
+          asset_path: ./elixir-ls.zip
+          asset_name: elixir-ls.zip
+          asset_content_type: application/zip

.travis.yml

@@ -30,8 +30,10 @@ matrix:
       elixir: 1.8.2
     - otp_release: 22.3
       elixir: 1.9.4
-    - otp_release: 23.0.3
-      elixir: 1.10.3
+    - otp_release: 23.0.4
+      elixir: 1.10.4
+    - otp_release: 23.0.4
+      elixir: 1.11.1
       env:
         - CHECK_FORMATTED=1
         - RUN_DIALYZER=1

CHANGELOG.md

@@ -1,5 +1,29 @@
 ### Unreleased
 
+### v0.6.2: 15 November 2020
+
+Improvements:
+- Add setup.bat support for windows (thanks [E14](https://github.com/E14)) [#374](https://github.com/elixir-lsp/elixir-ls/pull/374)
+- Add a message when done fetching deps [#380](https://github.com/elixir-lsp/elixir-ls/pull/380)
+
+Changes:
+- Remove query prefixes from workspace symbol search (the functionality is now longer supported by VSCode) (thanks [Łukasz Samson](https://github.com/lukaszsamson)) [#396](https://github.com/elixir-lsp/elixir-ls/pull/396)
+
+Bug Fixes:
+- Fix formatting on windows (thanks [Po Chen](https://github.com/princemaple)) [#375](https://github.com/elixir-lsp/elixir-ls/pull/375)
+- Improve formatting speed (thanks [Matt Baker](https://github.com/mattbaker)) [#390](https://github.com/elixir-lsp/elixir-ls/pull/390)
+- Fix warnings and errors around starting wx (thanks [Łukasz Samson](https://github.com/lukaszsamson)) [#388](https://github.com/elixir-lsp/elixir-ls/pull/388)
+  - This fixes an issue when running ElixirLS in VSCode remote dev containers
+
+Housekeeping:
+- Add GitHub action to auto-publish releases (thanks [Po Chen](https://github.com/princemaple)) [#384](https://github.com/elixir-lsp/elixir-ls/pull/384)
+- Spec compliance, race condition fixes, and more tests (thanks [Łukasz Samson](https://github.com/lukaszsamson)) [#399](https://github.com/elixir-lsp/elixir-ls/pull/399)
+
+VSCode:
+- Bump deps and switch to newer vscode platform version (thanks [Łukasz Samson](https://github.com/lukaszsamson)) [#148](https://github.com/elixir-lsp/vscode-elixir-ls/pull/148)
+- Subscribe Copy Debug Info command for disposal (thanks [Tan Jay Jun](https://github.com/jayjun)) [#149](https://github.com/elixir-lsp/vscode-elixir-ls/pull/149)
+- Turn files in stack traces into clickable links (thanks [Tan Jay Jun](https://github.com/jayjun)) [#152](https://github.com/elixir-lsp/vscode-elixir-ls/pull/152)
+
 ### v0.6.1: 4 October 2020
 
 VSCode:

README.md

@@ -41,6 +41,7 @@ Note: On first run Dialyzer will build a PLT cache which will take a considerabl
 | Emacs        | [eglot](https://github.com/joaotavora/eglot)                                  |                                                |
 | Kate         | [built-in LSP Client plugin](https://kate-editor.org/post/2020/2020-01-01-kate-lsp-client-status/) | Does not support debugger |
 | Sublime Text | [LSP-elixir](https://github.com/sublimelsp/LSP-elixir)                        | Does not support debugger                      |
+| Nova         | [nova-elixir-ls](https://github.com/raulchedrese/nova-elixir-ls)              |                                                |
 
 Feel free to create and publish your own client packages and add them to this list!
 
@@ -117,6 +118,44 @@ In order to debug modules in `.exs` files (such as tests), they must be specifie
 }
 ```
 
+In order to debug a single test or a single test file it is currently necessary to modify `taskArgs` and make sure no other tests are requred in `requireFiles`.
+
+```
+{
+  "type": "mix_task",
+  "name": "mix test",
+  "request": "launch",
+  "task": "test",
+  "taskArgs": ["tests/some_test.exs:123"],
+  "projectDir": "${workspaceRoot}",
+  "requireFiles": [
+    "test/**/test_helper.exs",
+    "test/some_test.exs"
+  ]
+}
+```
+
+Please note that due to `:int` limitation NIF modules cannot be interpreted and need to be excluded via `excludeModules` option. This option can be also used to disable interpreting for some modules when it is not desirable e.g. when performance is not satisfactory.
+
+```
+{
+  "type": "mix_task",
+  "name": "mix test",
+  "request": "launch",
+  "task": "test",
+  "taskArgs": ["--trace"],
+  "projectDir": "${workspaceRoot}",
+  "requireFiles": [
+    "test/**/test_helper.exs",
+    "test/**/*_test.exs"
+  ],
+  "excludeModules": [
+    ":some_nif",
+    "Some.SlowModule"
+  ]
+}
+```
+
 ## Automatic builds and error reporting
 
 Builds are performed automatically when files are saved. If you want this to happen automatically when you type, you can turn on "autosave" in your IDE.
@@ -158,25 +197,7 @@ The completions include:
 
 ## Workspace Symbols
 
-With Dialyzer integration enabled ElixirLS will build an index of symbols (modules, functions, types and callbacks). The symbols are taken from the current workspace, all dependencies and stdlib (Elixir and erlang). This feature enables quick navigation to symbol definitions. However due to sheer number of different symbols and fuzzy search utilized by the provider, ElixirLS uses query prefixes to improve search results relevance.
-
-Use the following rules when navigating to workspace symbols:
-* no prefix - search for modules
-  * `:erl`
-  * `Enu`
-* `f ` prefix - search for functions
-  * `f inse`
-  * `f :ets.inse`
-  * `f Enum.cou`
-  * `f count/0`
-* `t ` prefix - search for types
-  * `t t/0`
-  * `t :erlang.time_u`
-  * `t DateTime.`
-* `c ` prefix - search for callbacks
-  * `c handle_info`
-  * `c GenServer.in`
-  * `c :gen_statem`
+With Dialyzer integration enabled ElixirLS will build an index of symbols (modules, functions, types and callbacks). The symbols are taken from the current workspace, all dependencies and stdlib (Elixir and erlang). This feature enables quick navigation to symbol definitions.
 
 ## Troubleshooting
 
@@ -196,6 +217,8 @@ If you get an error like the following immediately on startup:
 
 and you installed Elixir and Erlang from the Erlang Solutions repository, you may not have a full installation of erlang. This can be solved with `sudo apt-get install esl-erlang`. Originally reported in [#208](https://github.com/elixir-lsp/elixir-ls/issues/208).
 
+On fedora if you only install the elixir package you will not have a full erlang installation, this can be fixed by running `sudo dnf install erlang` (reported in [#231](https://github.com/elixir-lsp/elixir-ls/issues/231))
+
 ## Known Issues/Limitations
 
 * `.exs` files don't return compilation errors
@@ -221,6 +244,8 @@ if available, but that may not be what you want or need. Therefore, prior to exe
 `$XDG_CONFIG_HOME/elixir_ls/setup.sh` (e.g. `~/.config/elixir_ls/setup.sh`), if available. The environment variable
 `ELS_MODE` is set to either `debugger` or `language_server` to help you decide what to do inside the script, if needed.
 
+Note: for windows the local setup script path is `%APPDATA%/elixir_ls/setup.bat` (which is often `C:\Users\<username>\AppData\Roaming\elixir_ls`)
+
 ## Acknowledgements and related projects
 
 ElixirLS isn't the first frontend-independent server for Elixir language support. The original was [Alchemist Server](https://github.com/tonini/alchemist-server/), which powers the [Alchemist](https://github.com/tonini/alchemist.el) plugin for Emacs. Another project, [Elixir Sense](https://github.com/elixir-lsp/elixir_sense), builds upon Alchemist and powers the [Elixir plugin for Atom](https://github.com/msaraiva/atom-elixir) as well as another VS Code plugin, [VSCode Elixir](https://github.com/fr1zle/vscode-elixir). ElixirLS uses Elixir Sense for several code insight features. Credit for those projects goes to their respective authors.

apps/elixir_ls_debugger/lib/debugger/server.ex

@@ -64,11 +64,33 @@ defmodule ElixirLS.Debugger.Server do
   end
 
   @impl GenServer
+  def handle_cast({:receive_packet, request(_, "disconnect") = packet}, state) do
+    Output.send_response(packet, %{})
+    {:noreply, state, {:continue, :disconnect}}
+  end
+
   def handle_cast({:receive_packet, request(_, _) = packet}, state) do
     try do
-      {response_body, state} = handle_request(packet, state)
-      Output.send_response(packet, response_body)
-      {:noreply, state}
+      if state.client_info == nil do
+        case packet do
+          request(_, "initialize") ->
+            {response_body, state} = handle_request(packet, state)
+            Output.send_response(packet, response_body)
+            {:noreply, state}
+
+          request(_, command) ->
+            raise ServerError,
+              message: "invalidRequest",
+              format: "Debugger request {command} was not expected",
+              variables: %{
+                "command" => command
+              }
+        end
+      else
+        {response_body, state} = handle_request(packet, state)
+        Output.send_response(packet, response_body)
+        {:noreply, state}
+      end
     rescue
       e in ServerError ->
         Output.send_error_response(packet, e.message, e.format, e.variables)
@@ -112,11 +134,16 @@ defmodule ElixirLS.Debugger.Server do
     {:noreply, %{state | task_ref: nil}}
   end
 
-  # If we get the disconnect request from the client, we send :disconnect to the server so it will
+  # If we get the disconnect request from the client, we continue with :disconnect so the server will
   # die right after responding to the request
   @impl GenServer
-  def handle_info(:disconnect, state) do
-    System.halt(0)
+  def handle_continue(:disconnect, state) do
+    unless Application.get_env(:elixir_ls_debugger, :test_mode) do
+      System.halt(0)
+    else
+      Process.exit(self(), {:exit_code, 0})
+    end
+
     {:noreply, state}
   end
 
@@ -129,10 +156,19 @@ defmodule ElixirLS.Debugger.Server do
 
   ## Helpers
 
-  defp handle_request(initialize_req(_, client_info), state) do
+  defp handle_request(initialize_req(_, client_info), %{client_info: nil} = state) do
     {capabilities(), %{state | client_info: client_info}}
   end
 
+  defp handle_request(initialize_req(_, _client_info), _state) do
+    raise ServerError,
+      message: "invalidRequest",
+      format: "Debugger request {command} was not expected",
+      variables: %{
+        "command" => "initialize"
+      }
+  end
+
   defp handle_request(launch_req(_, config), state) do
     {_, ref} = spawn_monitor(fn -> initialize(config) end)
 
@@ -293,11 +329,6 @@ defmodule ElixirLS.Debugger.Server do
     {%{"result" => inspect(result), "variablesReference" => 0}, state}
   end
 
-  defp handle_request(request(_, "disconnect"), state) do
-    send(self(), :disconnect)
-    {%{}, state}
-  end
-
   defp handle_request(continue_req(_, thread_id), state) do
     pid = state.threads[thread_id]
     state = remove_paused_process(state, pid)
@@ -383,6 +414,10 @@ defmodule ElixirLS.Debugger.Server do
   defp evaluate_code_expression(expr, bindings, timeout) do
     task =
       Task.async(fn ->
+        receive do
+          :continue -> :ok
+        end
+
         try do
           {term, _bindings} = Code.eval_string(expr, bindings)
           term
@@ -392,6 +427,7 @@ defmodule ElixirLS.Debugger.Server do
       end)
 
     Process.unlink(task.pid)
+    send(task.pid, :continue)
 
     result = Task.yield(task, timeout) || Task.shutdown(task)
 

apps/elixir_ls_debugger/mix.exs

@@ -4,7 +4,7 @@ defmodule ElixirLS.Debugger.Mixfile do
   def project do
     [
       app: :elixir_ls_debugger,
-      version: "0.6.0",
+      version: "0.6.2",
       build_path: "../../_build",
       config_path: "../../config/config.exs",
       deps_path: "../../deps",