Class: Solargraph::LanguageServer::Host

Inherits:
Object
  • Object
show all
Includes:
Observable, Dispatch, UriHelpers, Solargraph::Logging
Defined in:
lib/solargraph/language_server/host.rb,
lib/solargraph/language_server/host/sources.rb,
lib/solargraph/language_server/host/dispatch.rb,
lib/solargraph/language_server/host/cataloger.rb,
lib/solargraph/language_server/host/diagnoser.rb

Overview

The language server protocol’s data provider. Hosts are responsible for querying the library and processing messages. They also provide thread safety for multi-threaded transports.

Defined Under Namespace

Modules: Dispatch Classes: Cataloger, Diagnoser, Sources

Constant Summary

Constants included from Solargraph::Logging

Solargraph::Logging::DEFAULT_LOG_LEVEL, Solargraph::Logging::LOG_LEVELS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Dispatch

#explicit_library_for, #generic_library, #generic_library_for, #implicit_library_for, #libraries, #library_for, #sources, #update_libraries

Methods included from Solargraph::Logging

logger

Methods included from UriHelpers

decode, encode, file_to_uri, uri_to_file

Constructor Details

#initialize ⇒ Host

Returns a new instance of Host.



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/solargraph/language_server/host.rb', line 25

def initialize
  @cancel_semaphore = Mutex.new
  @buffer_semaphore = Mutex.new
  @register_semaphore = Mutex.new
  @cancel = []
  @buffer = String.new
  @stopped = true
  @next_request_id = 0
  @dynamic_capabilities = Set.new
  @registered_capabilities = Set.new
end

Instance Attribute Details

#client_capabilities ⇒ Object 



632
633
634
 
# File 'lib/solargraph/language_server/host.rb', line 632

def client_capabilities
  @client_capabilities ||= {}
end

Instance Method Details

#allow_registration(method) ⇒ void

This method returns an undefined value.

Flag a method as available for dynamic registration.

Parameters:

  • method (String) —

    The method name, e.g., ‘textDocument/completion’



419
420
421
422
423
 
# File 'lib/solargraph/language_server/host.rb', line 419

def allow_registration method
  @register_semaphore.synchronize do
    @dynamic_capabilities.add method
  end
end

#can_register?(method) ⇒ Boolean

True if the specified LSP method can be dynamically registered.

Parameters:

  • method (String)

Returns:

  • (Boolean) 


429
430
431
 
# File 'lib/solargraph/language_server/host.rb', line 429

def can_register? method
  @dynamic_capabilities.include?(method)
end

#cancel(id) ⇒ void

This method returns an undefined value.

Cancel the method with the specified ID.

Parameters:

  • id (Integer) 


67
68
69
 
# File 'lib/solargraph/language_server/host.rb', line 67

def cancel id
  @cancel_semaphore.synchronize { @cancel.push id }
end

#cancel?(id) ⇒ Boolean

True if the host received a request to cancel the method with the specified ID.

Parameters:

  • id (Integer)

Returns:

  • (Boolean) 


76
77
78
79
80
 
# File 'lib/solargraph/language_server/host.rb', line 76

def cancel? id
  result = false
  @cancel_semaphore.synchronize { result = @cancel.include? id }
  result
end

#catalog ⇒ void

This method returns an undefined value.



628
629
630
 
# File 'lib/solargraph/language_server/host.rb', line 628

def catalog
  libraries.each(&:catalog)
end

#change(params) ⇒ void

This method returns an undefined value.

Update a document from the parameters of a textDocument/didChange method.

Parameters:



237
238
239
240
241
 
# File 'lib/solargraph/language_server/host.rb', line 237

def change params
  updater = generate_updater(params)
  sources.async_update params['textDocument']['uri'], updater
  diagnoser.schedule params['textDocument']['uri']
end

#clear(id) ⇒ void

This method returns an undefined value.

Delete the specified ID from the list of cancelled IDs if it exists.

Parameters:

  • id (Integer) 


86
87
88
 
# File 'lib/solargraph/language_server/host.rb', line 86

def clear id
  @cancel_semaphore.synchronize { @cancel.delete id }
end

#close(uri) ⇒ void

This method returns an undefined value.

Close the file specified by the URI.

Parameters:

  • uri (String) 


184
185
186
187
188
 
# File 'lib/solargraph/language_server/host.rb', line 184

def close uri
  logger.info "Closing #{uri}"
  sources.close uri
  diagnoser.schedule uri
end

#completions_at(uri, line, column) ⇒ Solargraph::SourceMap::Completion

Parameters:

  • uri (String)
  • line (Integer)
  • column (Integer)

Returns:



501
502
503
504
 
# File 'lib/solargraph/language_server/host.rb', line 501

def completions_at uri, line, column
  library = library_for(uri)
  library.completions_at uri_to_file(uri), line, column
end

#configure(update) ⇒ void

This method returns an undefined value.

Update the configuration options with the provided hash.

Parameters:



52
53
54
55
56
 
# File 'lib/solargraph/language_server/host.rb', line 52

def configure update
  return if update.nil?
  options.merge! update
  logger.level = LOG_LEVELS[options['logLevel']] || DEFAULT_LOG_LEVEL
end

#create(uri) ⇒ Boolean

Respond to a notification that a file was created in the workspace. The libraries will determine whether the file should be merged; see Solargraph::Library#create_from_disk.

Parameters:

  • uri (String) —

    The file uri.

Returns:

  • (Boolean) —

    True if a library accepted the file.



124
125
126
127
128
129
130
131
132
 
# File 'lib/solargraph/language_server/host.rb', line 124

def create uri
  filename = uri_to_file(uri)
  result = false
  libraries.each do |lib|
    result = true if lib.create_from_disk(filename)
  end
  diagnoser.schedule uri if open?(uri)
  result
end

#default_configuration ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/solargraph/language_server/host.rb', line 605

def default_configuration
  {
    'completion' => true,
    'hover' => true,
    'symbols' => true,
    'definitions' => true,
    'rename' => true,
    'references' => true,
    'autoformat' => false,
    'diagnostics' => false,
    'formatting' => false,
    'folding' => true,
    'logLevel' => 'warn'
  }
end

#definitions_at(uri, line, column) ⇒ Array<Solargraph::Pin::Base>

Parameters:

  • uri (String)
  • line (Integer)
  • column (Integer)

Returns:



510
511
512
513
 
# File 'lib/solargraph/language_server/host.rb', line 510

def definitions_at uri, line, column
  library = library_for(uri)
  library.definitions_at(uri_to_file(uri), line, column)
end

#delete(uri) ⇒ void

This method returns an undefined value.

Delete the specified file from the library.

Parameters:

  • uri (String) —

    The file uri.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/solargraph/language_server/host.rb', line 138

def delete uri
  filename = uri_to_file(uri)
  libraries.each do |lib|
    lib.delete(filename)
  end
  send_notification "textDocument/publishDiagnostics", {
    uri: uri,
    diagnostics: []
  }
end

#diagnose(uri) ⇒ void

This method returns an undefined value.

Parameters:

  • uri (String) 


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/solargraph/language_server/host.rb', line 192

def diagnose uri
  if sources.include?(uri)
    library = library_for(uri)
    if library.synchronized?
      logger.info "Diagnosing #{uri}"
      begin
        results = library.diagnose uri_to_file(uri)
        send_notification "textDocument/publishDiagnostics", {
          uri: uri,
          diagnostics: results
        }
      rescue DiagnosticsError => e
        logger.warn "Error in diagnostics: #{e.message}"
        options['diagnostics'] = false
        send_notification 'window/showMessage', {
          type: LanguageServer::MessageTypes::ERROR,
          message: "Error in diagnostics: #{e.message}"
        }
      rescue FileNotFoundError => e
        # @todo This appears to happen when an external file is open and
        #   scheduled for diagnosis, but the file was closed (i.e., the
        #   editor moved to a different file) before diagnosis started
        logger.warn "Unable to diagnose #{uri} : #{e.message}"
        send_notification 'textDocument/publishDiagnostics', {
          uri: uri,
          diagnostics: []
        }
      end
    else
      logger.info "Deferring diagnosis of #{uri}"
      diagnoser.schedule uri
    end
  else
    send_notification 'textDocument/publishDiagnostics', {
      uri: uri,
      diagnostics: []
    }
  end
end

#document(query) ⇒ Array

Parameters:

  • query (String)

Returns:

  • (Array) 


552
553
554
555
556
 
# File 'lib/solargraph/language_server/host.rb', line 552

def document query
  result = []
  libraries.each { |lib| result.concat lib.document(query) }
  result
end

#document_symbols(uri) ⇒ Array<Solargraph::Pin::Base>

Parameters:

  • uri (String)

Returns:



560
561
562
563
564
565
566
 
# File 'lib/solargraph/language_server/host.rb', line 560

def document_symbols uri
  library = library_for(uri)
  # At this level, document symbols should be unique; e.g., a
  # module_function method should return the location for Module.method
  # or Module#method, but not both.
  library.document_symbols(uri_to_file(uri)).uniq(&:location)
end

#flush ⇒ String

Clear the message buffer and return the most recent data.

Returns:

  • (String) —

    The most recent data or an empty string.



256
257
258
259
260
261
262
263
 
# File 'lib/solargraph/language_server/host.rb', line 256

def flush
  tmp = ''
  @buffer_semaphore.synchronize do
    tmp = @buffer.clone
    @buffer.clear
  end
  tmp
end

#folders ⇒ Array<String>

Returns:

  • (Array<String>) 


321
322
323
 
# File 'lib/solargraph/language_server/host.rb', line 321

def folders
  libraries.map { |lib| lib.workspace.directory }
end

#folding_ranges(uri) ⇒ Array<Range>

Parameters:

  • uri (String)

Returns:



623
624
625
 
# File 'lib/solargraph/language_server/host.rb', line 623

def folding_ranges uri
  sources.find(uri).folding_ranges
end

#locate_pins(params) ⇒ Array<Pin::Base>

Locate multiple pins that match a completion item. The first match is based on the corresponding location in a library source if available. Subsequent matches are based on path.

Parameters:

  • params (Hash) —

    A hash representation of a completion item

Returns:



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/solargraph/language_server/host.rb', line 466

def locate_pins params
  return [] unless params['data'] && params['data']['uri']
  library = library_for(params['data']['uri'])
  result = []
  if params['data']['location']
    location = Location.new(
      params['data']['location']['filename'],
      Range.from_to(
        params['data']['location']['range']['start']['line'],
        params['data']['location']['range']['start']['character'],
        params['data']['location']['range']['end']['line'],
        params['data']['location']['range']['end']['character']
      )
    )
    result.concat library.locate_pins(location).select{ |pin| pin.name == params['label'] }
  end
  if params['data']['path']
    result.concat library.path_pins(params['data']['path'])
  end
  # Selecting by both location and path can result in duplicate pins
  result.uniq { |p| [p.path, p.location] }
end

#open(uri, text, version) ⇒ void

This method returns an undefined value.

Open the specified file in the library.

Parameters:

  • uri (String) —

    The file uri.

  • text (String) —

    The contents of the file.

  • version (Integer) —

    A version number.



155
156
157
158
159
160
161
 
# File 'lib/solargraph/language_server/host.rb', line 155

def open uri, text, version
  src = sources.open(uri, text, version)
  libraries.each do |lib|
    lib.merge src
  end
  diagnoser.schedule uri
end

#open?(uri) ⇒ Boolean

True if the specified file is currently open in the library.

Parameters:

  • uri (String)

Returns:

  • (Boolean) 


176
177
178
 
# File 'lib/solargraph/language_server/host.rb', line 176

def open? uri
  sources.include? uri
end

#open_from_disk(uri) ⇒ void

This method returns an undefined value.

Parameters:

  • uri (String) 


165
166
167
168
169
170
 
# File 'lib/solargraph/language_server/host.rb', line 165

def open_from_disk uri
  sources.open_from_disk(uri)
  library = library_for(uri)
  # library.open_from_disk uri_to_file(uri)
  diagnoser.schedule uri
end

#options ⇒ Hash

Returns:



59
60
61
 
# File 'lib/solargraph/language_server/host.rb', line 59

def options
  @options ||= default_configuration
end

#pending_requests ⇒ Array<Integer>

Get a list of IDs for server requests that are waiting for responses from the client.

Returns:

  • (Array<Integer>) 


600
601
602
 
# File 'lib/solargraph/language_server/host.rb', line 600

def pending_requests
  requests.keys
end

#prepare(directory, name = nil) ⇒ void

This method returns an undefined value.

Prepare a library for the specified directory.

Parameters:

  • directory (String)
  • name (String, nil) (defaults to: nil) 


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/solargraph/language_server/host.rb', line 270

def prepare directory, name = nil
  # No need to create a library without a directory. The generic library
  # will handle it.
  return if directory.nil?
  logger.info "Preparing library for #{directory}"
  path = ''
  path = normalize_separators(directory) unless directory.nil?
  begin
    lib = Solargraph::Library.load(path, name)
    libraries.push lib
  rescue WorkspaceTooLargeError => e
    send_notification 'window/showMessage', {
      'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
      'message' => e.message
    }
  end
end

#prepare_folders(array) ⇒ void

This method returns an undefined value.

Prepare multiple folders.

Parameters:

  • array (Array<Hash{String => String}>) 


292
293
294
295
296
297
 
# File 'lib/solargraph/language_server/host.rb', line 292

def prepare_folders array
  return if array.nil?
  array.each do |folder|
    prepare uri_to_file(folder['uri']), folder['name']
  end
end

#query_symbols(query) ⇒ Array<Solargraph::Pin::Base>

Parameters:

  • query (String)

Returns:



536
537
538
539
540
 
# File 'lib/solargraph/language_server/host.rb', line 536

def query_symbols query
  result = []
  (libraries + [generic_library]).each { |lib| result.concat lib.query_symbols(query) }
  result.uniq
end

#queue(message) ⇒ void

This method returns an undefined value.

Queue a message to be sent to the client.

Parameters:

  • message (String) —

    The message to send.



247
248
249
250
251
 
# File 'lib/solargraph/language_server/host.rb', line 247

def queue message
  @buffer_semaphore.synchronize { @buffer += message }
  changed
  notify_observers
end

#read_text(uri) ⇒ String

Parameters:

  • uri (String)

Returns:

  • (String) 


491
492
493
494
495
 
# File 'lib/solargraph/language_server/host.rb', line 491

def read_text uri
  library = library_for(uri)
  filename = uri_to_file(uri)
  library.read_text(filename)
end

#receive(request) ⇒ Solargraph::LanguageServer::Message::Base

Start processing a request from the client. After the message is processed, the transport is responsible for sending the response.

Parameters:

  • request (Hash) —

    The contents of the message.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/solargraph/language_server/host.rb', line 95

def receive request
  if request['method']
    logger.info "Server received #{request['method']}"
    logger.debug request
    message = Message.select(request['method']).new(self, request)
    begin
      message.process
    rescue StandardError => e
      logger.warn "Error processing request: [#{e.class}] #{e.message}"
      logger.warn e.backtrace.join("\n")
      message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}"
    end
    message
  elsif request['id']
    # @todo What if the id is invalid?
    requests[request['id']].process(request['result'])
    requests.delete request['id']
  else
    logger.warn "Invalid message received."
    logger.debug request
  end
end

#references_from(uri, line, column, strip: true) ⇒ Array<Solargraph::Range>

Parameters:

  • uri (String)
  • line (Integer)
  • column (Integer)
  • strip (Boolean) (defaults to: true) —

    Strip special characters from variable names

Returns:



529
530
531
532
 
# File 'lib/solargraph/language_server/host.rb', line 529

def references_from uri, line, column, strip: true
  library = library_for(uri)
  library.references_from(uri_to_file(uri), line, column, strip: strip)
end

#register_capabilities(methods) ⇒ void

This method returns an undefined value.

Register the methods as capabilities with the client. This method will avoid duplicating registrations and ignore methods that were not flagged for dynamic registration by the client.

Parameters:

  • methods (Array<String>) —

    The methods to register



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/solargraph/language_server/host.rb', line 374

def register_capabilities methods
  logger.debug "Registering capabilities: #{methods}"
  registrations = methods.select{|m| can_register?(m) and !registered?(m)}.map { |m|
    @registered_capabilities.add m
    {
      id: m,
      method: m,
      registerOptions: dynamic_capability_options[m]
    }
  }
  return if registrations.empty?
  @register_semaphore.synchronize do
    send_request 'client/registerCapability', {
      registrations: registrations
    }
  end
end

#registered?(method) ⇒ Boolean

True if the specified method has been registered.

Parameters:

  • method (String) —

    The method name, e.g., ‘textDocument/completion’

Returns:

  • (Boolean) 


437
438
439
 
# File 'lib/solargraph/language_server/host.rb', line 437

def registered? method
  @registered_capabilities.include?(method)
end

#remove(directory) ⇒ void

This method returns an undefined value.

Remove a directory.

Parameters:

  • directory (String) 


303
304
305
306
307
308
309
310
 
# File 'lib/solargraph/language_server/host.rb', line 303

def remove directory
  logger.info "Removing library for #{directory}"
  # @param lib [Library]
  libraries.delete_if do |lib|
    next false if lib.workspace.directory != directory
    true
  end
end

#remove_folders(array) ⇒ void

This method returns an undefined value.

Parameters:

  • array (Array<Hash>) 


314
315
316
317
318
 
# File 'lib/solargraph/language_server/host.rb', line 314

def remove_folders array
  array.each do |folder|
    remove uri_to_file(folder['uri'])
  end
end

#search(query) ⇒ Array<String>

Parameters:

  • query (String)

Returns:

  • (Array<String>) 


544
545
546
547
548
 
# File 'lib/solargraph/language_server/host.rb', line 544

def search query
  result = []
  libraries.each { |lib| result.concat lib.search(query) }
  result
end

#send_notification(method, params) ⇒ void

This method returns an undefined value.

Send a notification to the client.

Parameters:

  • method (String) —

    The message method

  • params (Hash) —

    The method parameters



330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/solargraph/language_server/host.rb', line 330

def send_notification method, params
  response = {
    jsonrpc: "2.0",
    method: method,
    params: params
  }
  json = response.to_json
  envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
  queue envelope
  logger.info "Server sent #{method}"
  logger.debug params
end

#send_request(method, params, &block) {|The| ... } ⇒ void

This method returns an undefined value.

Send a request to the client and execute the provided block to process the response. If an ID is not provided, the host will use an auto- incrementing integer.

Parameters:

  • method (String) —

    The message method

  • params (Hash) —

    The method parameters

  • block (Proc) —

    The block that processes the response

Yield Parameters:

  • The (Hash) —

    result sent by the client



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/solargraph/language_server/host.rb', line 352

def send_request method, params, &block
  message = {
    jsonrpc: "2.0",
    method: method,
    params: params,
    id: @next_request_id
  }
  json = message.to_json
  requests[@next_request_id] = Request.new(@next_request_id, &block)
  envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
  queue envelope
  @next_request_id += 1
  logger.info "Server sent #{method}"
  logger.debug params
end

#show_message(text, type = LanguageServer::MessageTypes::INFO) ⇒ void

This method returns an undefined value.

Send a notification to the client.

Parameters:

  • text (String)
  • type (Integer) (defaults to: LanguageServer::MessageTypes::INFO) —

    A MessageType constant



573
574
575
576
577
578
 
# File 'lib/solargraph/language_server/host.rb', line 573

def show_message text, type = LanguageServer::MessageTypes::INFO
  send_notification 'window/showMessage', {
    type: type,
    message: text
  }
end

#show_message_request(text, type, actions, &block) {|The| ... } ⇒ void

This method returns an undefined value.

Send a notification with optional responses.

Parameters:

  • text (String)
  • type (Integer) —

    A MessageType constant

  • actions (Array<String>) —

    Response options for the client

  • block —

    The block that processes the response

Yield Parameters:

  • The (String) —

    action received from the client



588
589
590
591
592
593
594
 
# File 'lib/solargraph/language_server/host.rb', line 588

def show_message_request text, type, actions, &block
  send_request 'window/showMessageRequest', {
    type: type,
    message: text,
    actions: actions
  }, &block
end

#signatures_at(uri, line, column) ⇒ Array<Solargraph::Pin::Base>

Parameters:

  • uri (String)
  • line (Integer)
  • column (Integer)

Returns:



519
520
521
522
 
# File 'lib/solargraph/language_server/host.rb', line 519

def signatures_at uri, line, column
  library = library_for(uri)
  library.signatures_at(uri_to_file(uri), line, column)
end

#start ⇒ void

This method returns an undefined value.

Start asynchronous process handling.



40
41
42
43
44
45
46
 
# File 'lib/solargraph/language_server/host.rb', line 40

def start
  return unless stopped?
  @stopped = false
  diagnoser.start
  cataloger.start
  sources.start
end

#stop ⇒ void

This method returns an undefined value.



446
447
448
449
450
451
452
453
454
 
# File 'lib/solargraph/language_server/host.rb', line 446

def stop
  return if @stopped
  @stopped = true
  cataloger.stop
  diagnoser.stop
  sources.stop
  changed
  notify_observers
end

#stopped? ⇒ Boolean

Returns:

  • (Boolean) 


456
457
458
 
# File 'lib/solargraph/language_server/host.rb', line 456

def stopped?
  @stopped
end

#synchronizing? ⇒ Boolean

Returns:

  • (Boolean) 


441
442
443
 
# File 'lib/solargraph/language_server/host.rb', line 441

def synchronizing?
  !libraries.all?(&:synchronized?)
end

#unregister_capabilities(methods) ⇒ void

This method returns an undefined value.

Unregister the methods with the client. This method will avoid duplicating unregistrations and ignore methods that were not flagged for dynamic registration by the client.

Parameters:

  • methods (Array<String>) —

    The methods to unregister



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/solargraph/language_server/host.rb', line 398

def unregister_capabilities methods
  logger.debug "Unregistering capabilities: #{methods}"
  unregisterations = methods.select{|m| registered?(m)}.map{ |m|
    @registered_capabilities.delete m
    {
      id: m,
      method: m
    }
  }
  return if unregisterations.empty?
  @register_semaphore.synchronize do
    send_request 'client/unregisterCapability', {
      unregisterations: unregisterations
    }
  end
end