solargraph 0.46.0 → 0.54.5

data/lib/solargraph/language_server/host/diagnoser.rb

@@ -1,89 +1,89 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    class Host
-      # An asynchronous diagnosis reporter.
-      #
-      class Diagnoser
-        # @param host [Host]
-        def initialize host
-          @host = host
-          @mutex = Mutex.new
-          @queue = []
-          @stopped = true
-        end
-
-        # Schedule a file to be diagnosed.
-        #
-        # @param uri [String]
-        # @return [void]
-        def schedule uri
-          mutex.synchronize { queue.push uri }
-        end
-
-        # Stop the diagnosis thread.
-        #
-        # @return [void]
-        def stop
-          @stopped = true
-        end
-
-        # True is the diagnoser is stopped.
-        #
-        # @return [Boolean]
-        def stopped?
-          @stopped
-        end
-
-        # Start the diagnosis thread.
-        #
-        # @return [self]
-        def start
-          return unless @stopped
-          @stopped = false
-          Thread.new do
-            until stopped?
-              tick
-              sleep 0.1
-            end
-          end
-          self
-        end
-
-        # Perform diagnoses.
-        #
-        # @return [void]
-        def tick
-          return if queue.empty? || host.synchronizing?
-          if !host.options['diagnostics']
-            mutex.synchronize { queue.clear }
-            return
-          end
-          current = mutex.synchronize { queue.shift }
-          return if queue.include?(current)
-          begin
-            host.diagnose current
-          rescue InvalidOffsetError
-            # @todo This error can occur when the Source is out of sync with
-            #   with the ApiMap. It's probably not the best way to handle it,
-            #   but it's quick and easy.
-            Logging.logger.warn "Deferring diagnosis due to invalid offset: #{current}"
-            mutex.synchronize { queue.push current }
-          end
-        end
-
-        private
-
-        # @return [Host]
-        attr_reader :host
-
-        # @return [Mutex]
-        attr_reader :mutex
-
-        # @return [Array]
-        attr_reader :queue
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # An asynchronous diagnosis reporter.
+      #
+      class Diagnoser
+        # @param host [Host]
+        def initialize host
+          @host = host
+          @mutex = Mutex.new
+          @queue = []
+          @stopped = true
+        end
+
+        # Schedule a file to be diagnosed.
+        #
+        # @param uri [String]
+        # @return [void]
+        def schedule uri
+          mutex.synchronize { queue.push uri }
+        end
+
+        # Stop the diagnosis thread.
+        #
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # True is the diagnoser is stopped.
+        #
+        # @return [Boolean]
+        def stopped?
+          @stopped
+        end
+
+        # Start the diagnosis thread.
+        #
+        # @return [self, nil]
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            until stopped?
+              tick
+              sleep 0.1
+            end
+          end
+          self
+        end
+
+        # Perform diagnoses.
+        #
+        # @return [void]
+        def tick
+          return if queue.empty? || host.synchronizing?
+          if !host.options['diagnostics']
+            mutex.synchronize { queue.clear }
+            return
+          end
+          current = mutex.synchronize { queue.shift }
+          return if queue.include?(current)
+          begin
+            host.diagnose current
+          rescue InvalidOffsetError
+            # @todo This error can occur when the Source is out of sync with
+            #   with the ApiMap. It's probably not the best way to handle it,
+            #   but it's quick and easy.
+            Logging.logger.warn "Deferring diagnosis due to invalid offset: #{current}"
+            mutex.synchronize { queue.push current }
+          end
+        end
+
+        private
+
+        # @return [Host]
+        attr_reader :host
+
+        # @return [Mutex]
+        attr_reader :mutex
+
+        # @return [::Array]
+        attr_reader :queue
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/dispatch.rb

@@ -1,111 +1,128 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    class Host
-      # Methods for associating sources with libraries via URIs.
-      #
-      module Dispatch
-        # @return [Sources]
-        def sources
-          @sources ||= begin
-            src = Sources.new
-            src.add_observer self, :update_libraries
-            src
-          end
-        end
-
-        # @return [Array<Library>]
-        def libraries
-          @libraries ||= []
-        end
-
-        # The Sources observer callback that merges a source into the host's
-        # libraries when it gets updated.
-        #
-        # @param uri [String]
-        # @return [void]
-        def update_libraries uri
-          src = sources.find(uri)
-          libraries.each do |lib|
-            lib.merge src if lib.contain?(src.filename)
-          end
-          diagnoser.schedule uri
-        end
-
-        # Find the best libary match for the given URI.
-        #
-        # @param uri [String]
-        # @return [Library]
-        def library_for uri
-          result = explicit_library_for(uri) ||
-            implicit_library_for(uri) ||
-            generic_library_for(uri)
-          # previous library for already call attach. avoid call twice
-          # result.attach sources.find(uri) if sources.include?(uri)
-          result
-        end
-
-        # Find an explicit library match for the given URI. An explicit match
-        # means the libary's workspace includes the file.
-        #
-        # If a matching library is found, the source corresponding to the URI
-        # gets attached to it.
-        #
-        # @raise [FileNotFoundError] if the source could not be attached.
-        #
-        # @param uri [String]
-        # @return [Library, nil]
-        def explicit_library_for uri
-          filename = UriHelpers.uri_to_file(uri)
-          libraries.each do |lib|
-            if lib.contain?(filename)
-              lib.attach sources.find(uri) if sources.include?(uri)
-              return lib
-            end
-          end
-          nil
-        end
-
-        # Find an implicit library match for the given URI. An implicit match
-        # means the file is located inside the library's workspace directory,
-        # regardless of whether the workspace is configured to include it.
-        #
-        # If a matching library is found, the source corresponding to the URI
-        # gets attached to it.
-        #
-        # @raise [FileNotFoundError] if the source could not be attached.
-        #
-        # @param uri [String]
-        # @return [Library, nil]
-        def implicit_library_for uri
-          filename = UriHelpers.uri_to_file(uri)
-          libraries.each do |lib|
-            if filename.start_with?(lib.workspace.directory)
-              lib.attach sources.find(uri)
-              return lib
-            end
-          end
-          nil
-        end
-
-        # Get a generic library for the given URI and attach the corresponding
-        # source.
-        #
-        # @raise [FileNotFoundError] if the source could not be attached.
-        #
-        # @param uri [String]
-        # @return [Library]
-        def generic_library_for uri
-          generic_library.attach sources.find(uri)
-          generic_library
-        end
-
-        # @return [Library]
-        def generic_library
-          @generic_library ||= Solargraph::Library.new
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # Methods for associating sources with libraries via URIs.
+      #
+      module Dispatch
+        # @abstract
+        # @return [Host::Diagnoser]
+        def diagnoser
+          raise NotImplementedError, 'Host::Dispatch requires a diagnoser method'
+        end
+
+        # @return [Sources]
+        def sources
+          @sources ||= begin
+            src = Sources.new
+            src.add_observer self, :update_libraries
+            src
+          end
+        end
+
+        # @return [::Array<Library>]
+        def libraries
+          @libraries ||= []
+        end
+
+        # The Sources observer callback that merges a source into the host's
+        # libraries when it gets updated.
+        #
+        # @param uri [String]
+        # @return [void]
+        def update_libraries uri
+          src = sources.find(uri)
+          using = libraries.select { |lib| lib.contain?(src.filename) }
+          using.push library_for(uri) if using.empty?
+          using.each { |lib| lib.merge src }
+          diagnoser.schedule uri
+        end
+
+        # Find the best libary match for the given URI.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def library_for uri
+          result = explicit_library_for(uri) ||
+            implicit_library_for(uri) ||
+            generic_library_for(uri)
+          # previous library for already call attach. avoid call twice
+          # result.attach sources.find(uri) if sources.include?(uri)
+          result
+        end
+
+        # Find an explicit library match for the given URI. An explicit match
+        # means the libary's workspace includes the file.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def explicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            if lib.contain?(filename)
+              lib.attach sources.find(uri) if sources.include?(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        # Find an implicit library match for the given URI. An implicit match
+        # means the file is located inside the library's workspace directory,
+        # regardless of whether the workspace is configured to include it.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def implicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            if filename.start_with?(lib.workspace.directory)
+              lib.attach sources.find(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        def options
+          @options ||= {}.freeze
+        end
+
+        # Get a generic library for the given URI and attach the corresponding
+        # source.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def generic_library_for uri
+          generic_library.attach sources.find(uri)
+          generic_library
+        end
+
+        # @return [Library]
+        def generic_library
+          @generic_library ||= Solargraph::Library.new(Solargraph::Workspace.new('', nil, options), nil)
+                                                  .tap { |lib| lib.add_observer self }
+        end
+
+        # @param library [Solargraph::Library]
+        # @return [void]
+        def update progress
+          progress&.send(self)
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/message_worker.rb

@@ -1,59 +1,106 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    class Host
-      # A serial worker Thread to handle message.
-      #
-      # this make check pending message possible, and maybe cancelled to speedup process
-      class MessageWorker
-        # @param host [Host]
-        def initialize(host)
-          @host = host
-          @mutex = Mutex.new
-          @resource = ConditionVariable.new
-          @stopped = true
-        end
-
-        # pending handle messages
-        def messages
-          @messages ||= []
-        end
-
-        def stopped?
-          @stopped
-        end
-
-        def stop
-          @stopped = true
-        end
-
-        # @param message [Hash] The message should be handle. will pass back to Host#receive
-        # @return [void]
-        def queue(message)
-          @mutex.synchronize do
-            messages.push(message)
-            @resource.signal
-          end
-        end
-
-        def start
-          return unless @stopped
-          @stopped = false
-          Thread.new do
-            tick until stopped?
-          end
-        end
-
-        def tick
-          message = @mutex.synchronize do
-            @resource.wait(@mutex) if messages.empty?
-            messages.shift
-          end
-          handler = @host.receive(message)
-          handler && handler.send_response
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # A serial worker Thread to handle incoming messages.
+      #
+      class MessageWorker
+        UPDATE_METHODS = [
+          'textDocument/didOpen',
+          'textDocument/didChange',
+          'workspace/didChangeWatchedFiles'
+        ].freeze
+
+        # @param host [Host]
+        def initialize(host)
+          @host = host
+          @mutex = Mutex.new
+          @resource = ConditionVariable.new
+          @stopped = true
+        end
+
+        # pending handle messages
+        # @return [Array<Hash>]
+        def messages
+          @messages ||= []
+        end
+
+        def stopped?
+          @stopped
+        end
+
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # @param message [Hash] The message to handle. Will be forwarded to Host#receive
+        # @return [void]
+        def queue(message)
+          @mutex.synchronize do
+            messages.push(message)
+            @resource.signal
+          end
+        end
+
+        # @return [void]
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            tick until stopped?
+          end
+        end
+
+        # @return [void]
+        def tick
+          message = @mutex.synchronize do
+            @resource.wait(@mutex) if messages.empty?
+            next_message
+          end
+          handler = @host.receive(message)
+          handler&.send_response
+        end
+
+        private
+
+        def next_message
+          cancel_message || next_priority
+        end
+
+        def cancel_message
+          # Handle cancellations first
+          idx = messages.find_index { |msg| msg['method'] == '$/cancelRequest' }
+          return unless idx
+
+          msg = messages[idx]
+          messages.delete_at idx
+          msg
+        end
+
+        def next_priority
+          # Prioritize updates and version-dependent messages for performance
+          idx = messages.find_index do |msg|
+            UPDATE_METHODS.include?(msg['method']) || version_dependent?(msg)
+          end
+          return messages.shift unless idx
+
+          msg = messages[idx]
+          messages.delete_at idx
+          msg
+        end
+
+        # True if the message requires a previous update to have executed in
+        # order to work correctly.
+        #
+        # @param msg [Hash{String => Object}]
+        # @todo need boolish type from RBS
+        # @return [Object]
+        def version_dependent? msg
+          msg['textDocument'] && msg['position']
+        end
+      end
+    end
+  end
+end