Debug

Author: vinistock

Diff for: lib/ruby_lsp/requests/formatting.rb

@@ -16,12 +16,13 @@ def provider
         end
       end
 
-      #: (GlobalState global_state, RubyDocument document) -> void
-      def initialize(global_state, document)
+      #: (GlobalState global_state, RubyDocument document, Thread::Queue outgoing_queue) -> void
+      def initialize(global_state, document, outgoing_queue)
         super()
         @document = document
         @active_formatter = global_state.active_formatter #: Support::Formatter?
         @uri = document.uri #: URI::Generic
+        @queue = outgoing_queue
       end
 
       # @override
@@ -33,12 +34,28 @@ def perform
         # We don't format erb documents yet
 
         formatted_text = @active_formatter.run_formatting(@uri, @document)
-        return unless formatted_text
+        unless formatted_text
+          @queue << Notification.window_log_message("No text returned by formatter")
+          return
+        end
 
         lines = @document.source.lines
         size = @document.source.size
 
-        return if formatted_text.size == size && formatted_text == @document.source
+        if formatted_text.size == size && formatted_text == @document.source
+          @queue << Notification.window_log_message(<<~MESSAGE)
+            No changes made to the document.
+
+            Original:
+
+            #{@document.source}
+
+            Formatted:
+
+            #{formatted_text}
+          MESSAGE
+          return
+        end
 
         [
           Interface::TextEdit.new(

Diff for: lib/ruby_lsp/server.rb

@@ -653,7 +653,7 @@ def text_document_formatting(message)
         return
       end
 
-      response = Requests::Formatting.new(@global_state, document).perform
+      response = Requests::Formatting.new(@global_state, document, @outgoing_queue).perform
       send_message(Result.new(id: message[:id], response: response))
     rescue Requests::Request::InvalidFormatter => error
       send_message(Notification.window_show_message(

Diff for: test/requests/formatting_expectations_test.rb

@@ -19,7 +19,7 @@ def run_expectations(source)
       uri: URI::Generic.from_path(path: __FILE__),
       global_state: @global_state,
     )
-    RubyLsp::Requests::Formatting.new(@global_state, document).perform&.first&.new_text
+    RubyLsp::Requests::Formatting.new(@global_state, document, Thread::Queue.new).perform&.first&.new_text
   rescue RubyLsp::Requests::Support::InternalRuboCopError
     skip("Fixture requires a fix from Rubocop")
   end

Diff for: test/requests/formatting_test.rb

@@ -50,7 +50,7 @@ def test_does_not_format_with_formatter_is_none
     original_formatter = @global_state.formatter
     @global_state.formatter = "none"
     document = RubyLsp::RubyDocument.new(source: "def foo", version: 1, uri: @uri, global_state: @global_state)
-    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
+    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document, Thread::Queue.new).perform)
   ensure
     @global_state.formatter = original_formatter
   end
@@ -89,7 +89,7 @@ def test_syntax_tree_formatting_ignores_syntax_invalid_documents
     require "ruby_lsp/requests/formatting"
     @global_state.formatter = "syntax_tree"
     document = RubyLsp::RubyDocument.new(source: "def foo", version: 1, uri: @uri, global_state: @global_state)
-    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
+    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document, Thread::Queue.new).perform)
   end
 
   def test_syntax_tree_formatting_returns_nil_if_file_matches_ignore_files_options_from_streerc
@@ -110,7 +110,7 @@ def foo
 
   def test_rubocop_formatting_ignores_syntax_invalid_documents
     document = RubyLsp::RubyDocument.new(source: "def foo", version: 1, uri: @uri, global_state: @global_state)
-    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
+    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document, Thread::Queue.new).perform)
   end
 
   def test_returns_nil_if_document_is_already_formatted
@@ -123,7 +123,7 @@ def foo
         end
       end
     RUBY
-    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
+    assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document, Thread::Queue.new).perform)
   end
 
   def test_allows_specifying_formatter
@@ -163,7 +163,7 @@ def test_returns_nil_when_formatter_is_none
 
   def formatted_document(formatter)
     @global_state.formatter = formatter
-    RubyLsp::Requests::Formatting.new(@global_state, @document).perform&.first&.new_text
+    RubyLsp::Requests::Formatting.new(@global_state, @document, Thread::Queue.new).perform&.first&.new_text
   end
 
   def with_syntax_tree_config_file(contents)

Diff for: vscode/src/test/suite/client.test.ts

@@ -24,6 +24,7 @@ import {
   TextDocumentFilter,
   ShowMessageParams,
   MessageType,
+  LogMessageNotification,
 } from "vscode-languageclient/node";
 import { after, afterEach, before, setup } from "mocha";
 
@@ -431,7 +432,8 @@ suite("Client", () => {
   }).timeout(20000);
 
   test("formatting", async () => {
-    const text = ["", "foo()"].join("\n").trim();
+    const lineBreak = os.platform() === "win32" ? "\r\n" : "\n";
+    const text = ["", "foo()"].join(lineBreak).trim();
 
     await client.sendNotification("textDocument/didOpen", {
       textDocument: {
@@ -440,6 +442,15 @@ suite("Client", () => {
         text,
       },
     });
+
+    const disposable = client.onNotification(
+      LogMessageNotification.type,
+      (params) => {
+        // eslint-disable-next-line no-console
+        console.log(params.message);
+      },
+    );
+
     const response: TextEdit[] = await client.sendRequest(
       "textDocument/formatting",
       {
@@ -449,8 +460,10 @@ suite("Client", () => {
       },
     );
 
+    disposable.dispose();
+
     const expected = ["# frozen_string_literal: true", "", "foo"]
-      .join("\n")
+      .join(lineBreak)
       .trim();
 
     assert.strictEqual(response[0].newText.trim(), expected);