solargraph 0.53.4 → 0.54.1

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

@@ -34,7 +34,7 @@ module Solargraph
         def update_libraries uri
           src = sources.find(uri)
           using = libraries.select { |lib| lib.contain?(src.filename) }
-          using.push generic_library_for(uri) if using.empty?
+          using.push library_for(uri) if using.empty?
           using.each { |lib| lib.merge src }
           diagnoser.schedule uri
         end
@@ -114,6 +114,13 @@ module Solargraph
         # @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

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

@@ -6,7 +6,10 @@ module Solargraph
       # A serial worker Thread to handle message.
       #
       # this make check pending message possible, and maybe cancelled to speedup process
+      #
       class MessageWorker
+        UPDATE_METHODS = ['textDocument/didOpen', 'textDocument/didChange', 'workspace/didChangeWatchedFiles'].freeze
+
         # @param host [Host]
         def initialize(host)
           @host = host
@@ -30,7 +33,7 @@ module Solargraph
           @stopped = true
         end
 
-        # @param message [Hash] The message should be handle. will pass back to Host#receive
+        # @param message [Hash] The message to handle. Will be forwarded to Host#receive
         # @return [void]
         def queue(message)
           @mutex.synchronize do
@@ -52,10 +55,33 @@ module Solargraph
         def tick
           message = @mutex.synchronize do
             @resource.wait(@mutex) if messages.empty?
-            messages.shift
+            next_message
           end
           handler = @host.receive(message)
-          handler && handler.send_response
+          handler&.send_response
+        end
+
+        private
+
+        def next_message
+          # Prioritize updates and version-dependent messages for performance
+          idx = messages.find_index do |msg|
+            UPDATE_METHODS.include?(msg['method']) || version_dependent?(msg)
+          end
+          # @todo We might want to clear duplicate instances of this message
+          #   that occur before the next update
+          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.
+        #
+        def version_dependent? msg
+          msg['textDocument'] && msg['position']
         end
       end
     end

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

@@ -11,54 +11,10 @@ module Solargraph
         include Observable
         include UriHelpers
 
-        def initialize
-          @mutex = Mutex.new
-          @stopped = true
-          @has_uri = ConditionVariable.new
-        end
-
-        def stopped?
-          @stopped
-        end
-
-        # @return [void]
-        def start
-          return unless @stopped
-          @stopped = false
-          Thread.new do
-            tick until stopped?
-          end
-        end
-
-        # @return [void]
-        def tick
-          uri = mutex.synchronize { next_uri }
-
-          return if queue.include?(uri)
-          mutex.synchronize do
-            nxt = open_source_hash[uri].finish_synchronize
-            open_source_hash[uri] = nxt
-            changed
-            notify_observers uri
-          end
-        end
-
         # @param uri [String]
         # @return [void]
         def add_uri(uri)
           queue.push(uri)
-          @has_uri.signal
-        end
-
-        # @return [String]
-        def next_uri
-          @has_uri.wait(mutex) if queue.empty?
-          queue.shift
-        end
-
-        # @return [void]
-        def stop
-          @stopped = true
         end
 
         # Open a source.
@@ -89,20 +45,7 @@ module Solargraph
         # @return [void]
         def update uri, updater
           src = find(uri)
-          mutex.synchronize { open_source_hash[uri] = src.synchronize(updater) }
-          changed
-          notify_observers uri
-        end
-
-        # @param uri [String]
-        # @param updater [Source::Updater]
-        # @return [void]
-        def async_update uri, updater
-          src = find(uri)
-          mutex.synchronize do
-            open_source_hash[uri] = src.start_synchronize(updater)
-            add_uri(uri)
-          end
+          open_source_hash[uri] = src.synchronize(updater)
           changed
           notify_observers uri
         end
@@ -144,9 +87,6 @@ module Solargraph
           @open_source_hash ||= {}
         end
 
-        # @return [Mutex]
-        attr_reader :mutex
-
         # An array of source URIs that are waiting to finish synchronizing.
         #
         # @return [::Array<String>]

data/lib/solargraph/language_server/host.rb

@@ -12,7 +12,6 @@ module Solargraph
     #
     class Host
       autoload :Diagnoser,     'solargraph/language_server/host/diagnoser'
-      autoload :Cataloger,     'solargraph/language_server/host/cataloger'
       autoload :Sources,       'solargraph/language_server/host/sources'
       autoload :Dispatch,      'solargraph/language_server/host/dispatch'
       autoload :MessageWorker, 'solargraph/language_server/host/message_worker'
@@ -43,8 +42,6 @@ module Solargraph
         return unless stopped?
         @stopped = false
         diagnoser.start
-        cataloger.start
-        sources.start
         message_worker.start
       end
 
@@ -155,6 +152,7 @@ module Solargraph
       def delete *uris
         filenames = uris.map { |uri| uri_to_file(uri) }
         libraries.each do |lib|
+          lib.delete_observer self
           lib.delete(*filenames)
         end
         uris.each do |uri|
@@ -253,7 +251,7 @@ module Solargraph
       # @return [void]
       def change params
         updater = generate_updater(params)
-        sources.async_update params['textDocument']['uri'], updater
+        sources.update params['textDocument']['uri'], updater
         diagnoser.schedule params['textDocument']['uri']
       end
 
@@ -294,8 +292,9 @@ module Solargraph
         begin
           workspace = Solargraph::Workspace.new(path, nil, options)
           lib = Solargraph::Library.new(workspace, name)
+          lib.add_observer self
           libraries.push lib
-          async_library_map lib
+          library_map lib
         rescue WorkspaceTooLargeError => e
           send_notification 'window/showMessage', {
             'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
@@ -324,6 +323,7 @@ module Solargraph
         # @param lib [Library]
         libraries.delete_if do |lib|
           next false if lib.workspace.directory != directory
+          lib.delete_observer self
           true
         end
       end
@@ -458,9 +458,7 @@ module Solargraph
         return if @stopped
         @stopped = true
         message_worker.stop
-        cataloger.stop
         diagnoser.stop
-        sources.stop
         changed
         notify_observers
       end
@@ -684,11 +682,15 @@ module Solargraph
         libraries.each(&:catalog)
       end
 
-      # @return [Hash{String => BasicObject}]
+      # @return [Hash{String => Hash{String => Boolean}}]
       def client_capabilities
         @client_capabilities ||= {}
       end
 
+      def client_supports_progress?
+        client_capabilities['window'] && client_capabilities['window']['workDoneProgress']
+      end
+
       private
 
       # @return [MessageWorker]
@@ -701,11 +703,6 @@ module Solargraph
         @diagnoser ||= Diagnoser.new(self)
       end
 
-      # @return [Cataloger]
-      def cataloger
-        @cataloger ||= Cataloger.new(self)
-      end
-
       # A hash of client requests by ID. The host uses this to keep track of
       # pending responses.
       #
@@ -835,72 +832,28 @@ module Solargraph
         client_capabilities['rename'] && client_capabilities['rename']['prepareSupport']
       end
 
-      def client_supports_progress?
-        client_capabilities['window'] && client_capabilities['window']['workDoneProgress']
-      end
-
       # @param library [Library]
       # @return [void]
-      def async_library_map library
+      def library_map library
         return if library.mapped?
-        Thread.new do
-          if client_supports_progress?
-            uuid = SecureRandom.uuid
-            send_request 'window/workDoneProgress/create', {
-              token: uuid
-            } do |response|
-              do_async_library_map library, response.nil? ? uuid : nil
-            end
-          else
-            do_async_library_map library
-          end
-        end
+        Thread.new { sync_library_map library }
       end
 
       # @param library [Library]
       # @param uuid [String, nil]
       # @return [void]
-      def do_async_library_map library, uuid = nil
+      def sync_library_map library
         total = library.workspace.sources.length
-        if uuid
-          send_notification '$/progress', {
-            token: uuid,
-            value: {
-              kind: 'begin',
-              title: "Mapping workspace",
-              message: "0/#{total} files",
-              cancellable: false,
-              percentage: 0
-            }
-          }
-        end
-        pct = 0
-        mod = 10
+        progress = Progress.new('Mapping workspace')
+        progress.begin "0/#{total} files", 0
+        progress.send self
         while library.next_map
-          next unless uuid
-          cur = ((library.source_map_hash.keys.length.to_f / total.to_f) * 100).to_i
-          if cur > pct && cur % mod == 0
-            pct = cur
-            send_notification '$/progress', {
-              token: uuid,
-              value: {
-                kind: 'report',
-                cancellable: false,
-                message: "#{library.source_map_hash.keys.length}/#{total} files",
-                percentage: pct
-              }
-            }
-          end
-        end
-        if uuid
-          send_notification '$/progress', {
-            token: uuid,
-            value: {
-              kind: 'end',
-              message: 'Mapping complete'
-            }
-          }
+          pct = ((library.source_map_hash.keys.length.to_f / total) * 100).to_i
+          progress.report "#{library.source_map_hash.keys.length}/#{total} files", pct
+          progress.send self
         end
+        progress.finish 'done'
+        progress.send self
       end
     end
   end

data/lib/solargraph/language_server/message/base.rb

@@ -16,7 +16,7 @@ module Solargraph
         # @return [String]
         attr_reader :method
 
-        # @return [Hash]
+        # @return [Hash{String => Array, Hash, String, Integer}]
         attr_reader :params
 
         # @return [Hash, Array, nil]

data/lib/solargraph/language_server/message/initialize.rb

@@ -47,6 +47,8 @@ module Solargraph
 
         private
 
+        # @todo '?' methods should type like RBS 'boolish' rather than a strict true or false
+        # @sg-ignore
         def support_workspace_folders?
           params['capabilities'] &&
             params['capabilities']['workspace'] &&
@@ -82,6 +84,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
         def static_on_type_formatting
           {
             documentOnTypeFormattingProvider: {
@@ -91,6 +94,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_hover
           return {} unless host.options['hover']
           {
@@ -98,6 +102,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_formatting
           return {} unless host.options['formatting']
           {
@@ -105,6 +110,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_symbols
           return {} unless host.options['symbols']
           {
@@ -112,12 +118,14 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_workspace_symbols
           {
             workspaceSymbolProvider: true
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_definitions
           return {} unless host.options['definitions']
           {
@@ -125,6 +133,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_type_definitions
           return {} unless host.options['typeDefinitions']
           {
@@ -132,12 +141,15 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
         def static_rename
           {
             renameProvider: {prepareProvider: true}
           }
         end
 
+
+        # @return [Hash{Symbol => Boolean}]
         def static_references
           return {} unless host.options['references']
           {
@@ -145,6 +157,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_folding_range
           return {} unless host.options['folding']
           {
@@ -152,6 +165,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_highlights
           {
             documentHighlightProvider: true

data/lib/solargraph/language_server/message/text_document/definition.rb

@@ -13,10 +13,10 @@ module Solargraph::LanguageServer::Message::TextDocument
     def code_location
       suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?
-      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
+      suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
         {
-          uri: file_to_uri(pin.location.filename),
-          range: pin.location.range.to_hash
+          uri: file_to_uri(pin.best_location.filename),
+          range: pin.best_location.range.to_hash
         }
       end
     end

data/lib/solargraph/language_server/message/text_document/document_symbol.rb

@@ -6,15 +6,15 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
   def process
     pins = host.document_symbols params['textDocument']['uri']
     info = pins.map do |pin|
-      next nil unless pin.location&.filename
+      next nil unless pin.best_location&.filename
 
       result = {
         name: pin.name,
         containerName: pin.namespace,
         kind: pin.symbol_kind,
         location: {
-          uri: file_to_uri(pin.location.filename),
-          range: pin.location.range.to_hash
+          uri: file_to_uri(pin.best_location.filename),
+          range: pin.best_location.range.to_hash
         },
         deprecated: pin.deprecated?
       }

data/lib/solargraph/language_server/message/text_document/formatting.rb

@@ -70,6 +70,7 @@ module Solargraph
 
           def formatter_class(config)
             if self.class.const_defined?('BlankRubocopFormatter')
+              # @sg-ignore
               BlankRubocopFormatter
             else
               require_rubocop(config['version'])

data/lib/solargraph/language_server/message/text_document/hover.rb

@@ -21,7 +21,7 @@ module Solargraph
               parts.push pin.documentation unless pin.documentation.nil? || pin.documentation.empty?
               unless parts.empty?
                 data = parts.join("\n\n")
-                next if contents.last && contents.last.end_with?(data)
+                next if contents.last&.end_with?(data)
                 contents.push data
               end
               last_link = this_link unless this_link.nil?

data/lib/solargraph/language_server/message/text_document/type_definition.rb

@@ -13,10 +13,10 @@ module Solargraph::LanguageServer::Message::TextDocument
     def code_location
       suggestions = host.type_definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?
-      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
+      suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
         {
-          uri: file_to_uri(pin.location.filename),
-          range: pin.location.range.to_hash
+          uri: file_to_uri(pin.best_location.filename),
+          range: pin.best_location.range.to_hash
         }
       end
     end

data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb

@@ -6,14 +6,14 @@ class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargra
   def process
     pins = host.query_symbols(params['query'])
     info = pins.map do |pin|
-      uri = file_to_uri(pin.location.filename)
+      uri = file_to_uri(pin.best_location.filename)
       {
         name: pin.path,
         containerName: pin.namespace,
         kind: pin.symbol_kind,
         location: {
           uri: uri,
-          range: pin.location.range.to_hash
+          range: pin.best_location.range.to_hash
         },
         deprecated: pin.deprecated?
       }

data/lib/solargraph/language_server/progress.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Solargraph
+  module LanguageServer
+    # Progress notification handling for language server hosts.
+    #
+    class Progress
+      WAITING = :waiting
+      CREATED = :created
+      FINISHED = :finished
+
+      # @return [String]
+      attr_reader :uuid
+
+      # @return [String]
+      attr_reader :title
+
+      # @return [String, nil]
+      attr_reader :kind
+
+      # @return [String, nil]
+      attr_reader :message
+
+      # @return [Integer]
+      attr_reader :percentage
+
+      # @return [Symbol]
+      attr_reader :status
+
+      # @param title [String]
+      def initialize title
+        @title = title
+        @uuid = SecureRandom.uuid
+        @percentage = 0
+        @status = WAITING
+      end
+
+      # @param message [String]
+      # @param percentage [Integer]
+      def begin message, percentage
+        @kind = 'begin'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      # @param percentage [Integer]
+      def report message, percentage
+        @kind = 'report'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      def finish message
+        @kind = 'end'
+        @message = message
+        @percentage = 100
+        true
+      end
+
+      # @param host [Solargraph::LanguageServer::Host]
+      def send host
+        return unless host.client_supports_progress? && !finished?
+
+        message = build
+        create(host)
+        host.send_notification '$/progress', message
+        @status = FINISHED if kind == 'end'
+        keep_alive host
+      end
+
+      def created?
+        [CREATED, FINISHED].include?(status)
+      end
+
+      def finished?
+        status == FINISHED
+      end
+
+      private
+
+      # @param host [Solargraph::LanguageServer::Host]
+      # @return [void]
+      def create host
+        return if created?
+
+        host.send_request 'window/workDoneProgress/create', { token: uuid }
+        @status = CREATED
+      end
+
+      def build
+        {
+          token: uuid,
+          value: {
+            kind: kind,
+            cancellable: false
+          }.merge(build_value)
+        }
+      end
+
+      def build_value
+        case kind
+        when 'begin'
+          { title: title, message: message, percentage: percentage }
+        when 'report'
+          { message: message, percentage: percentage }
+        when 'end'
+          { message: message }
+        else
+          raise "Invalid progress kind #{kind}"
+        end
+      end
+
+      # @param host [Host]
+      def keep_alive host
+        mutex.synchronize { @last = Time.now }
+        @keep_alive ||= Thread.new do
+          until finished?
+            sleep 10
+            break if finished?
+            next if mutex.synchronize { Time.now - @last < 10 }
+            send host
+          end
+        end
+      end
+
+      def mutex
+        @mutex ||= Mutex.new
+      end
+    end
+  end
+end

data/lib/solargraph/language_server.rb

@@ -15,5 +15,6 @@ module Solargraph
     autoload :MessageTypes, 'solargraph/language_server/message_types'
     autoload :Request,      'solargraph/language_server/request'
     autoload :Transport,    'solargraph/language_server/transport'
+    autoload :Progress,     'solargraph/language_server/progress'
   end
 end