(maint) Refactor server services to common namespace

In order to add a Debug Server, parts of the Language Server need to be extacted
into a common namespace so they can be shared between them; Mainly the logging,
TCP Server, and version detection. This commit:

- Moves the TCP Server, logging and version detection from PuppetLanguageServer
  to PuppetVSCode namespace.
- All relevant calls in the language server were modified for the new names
- Updated the spec tests for the new names

Author: glennsarti

server/lib/languageserver/puppet_version.rb

@@ -21,7 +21,7 @@ def self.create(options)
       result['functionsLoaded'] = options['functionsLoaded'] unless options['functionsLoaded'].nil?
       result['typesLoaded']     = options['typesLoaded'] unless options['typesLoaded'].nil?
 
-      result['languageServerVersion'] = PuppetLanguageServer.version
+      result['languageServerVersion'] = PuppetVSCode.version
 
       result
     end

server/lib/puppet-languageserver.rb

@@ -1,6 +1,7 @@
 require 'languageserver/languageserver'
+require 'puppet-vscode'
 
-%w[version simple_tcp_server json_rpc_handler message_router server_capabilities document_validator
+%w[json_rpc_handler message_router server_capabilities document_validator
    puppet_parser_helper puppet_helper facter_helper completion_provider hover_provider].each do |lib|
   begin
     require "puppet-languageserver/#{lib}"
@@ -80,34 +81,12 @@ def self.parse(options)
   end
 
   def self.log_message(severity, message)
-    return if @logger.nil?
-
-    case severity
-    when :debug
-      @logger.debug(message)
-    when :info
-      @logger.info(message)
-    when :warn
-      @logger.info(message)
-    when :error
-      @logger.error(message)
-    when :fatal
-      @logger.fatal(message)
-    else
-      @logger.unknown(message)
-    end
+    PuppetVSCode::log_message(severity, message)
   end
 
   def self.init_puppet(options)
-    if options[:debug].nil?
-      @logger = nil
-    elsif options[:debug].casecmp 'stdout'
-      @logger = Logger.new($stdout)
-    elsif !options[:debug].to_s.empty?
-      # Log to file
-      @logger = Logger.new(options[:debug])
-    end
-    log_message(:info, "Language Server is v#{PuppetLanguageServer.version}")
+    PuppetVSCode::init_logging(options)
+    log_message(:info, "Language Server is v#{PuppetVSCode.version}")
     log_message(:info, "Using Puppet v#{Puppet.version}")
 
     log_message(:info, 'Initializing settings...')
@@ -143,7 +122,9 @@ def self.init_puppet_worker(options)
   def self.rpc_server(options)
     log_message(:info, 'Starting RPC Server...')
 
-    server = PuppetLanguageServer::SimpleTCPServer.new
+    server = PuppetVSCode::SimpleTCPServer.new
+
+    options[:servicename] = 'LANGUAGE SERVER'
 
     server.add_service(options[:ipaddress], options[:port])
     trap('INT') { server.stop }

server/lib/puppet-languageserver/json_rpc_handler.rb

@@ -37,7 +37,7 @@ module PuppetLanguageServer
   KEY_CODE      = 'code'.freeze
   KEY_MESSAGE   = 'message'.freeze
 
-  class JSONRPCHandler < PuppetLanguageServer::SimpleTCPServerConnection
+  class JSONRPCHandler < PuppetVSCode::SimpleTCPServerConnection
     def initialize(*_options)
       @key_jsonrpc = KEY_JSONRPC
       @key_id = KEY_ID
@@ -110,14 +110,14 @@ def receive_data(data)
     end
 
     def send_response(response)
-      PuppetLanguageServer.log_message(:debug, "--- OUTBOUND\n#{response}\n---")
+      PuppetVSCode.log_message(:debug, "--- OUTBOUND\n#{response}\n---")
 
       size = response.bytesize if response.respond_to?(:bytesize)
       send_data "Content-Length: #{size}\r\n\r\n" + response
     end
 
     def parse_data(data)
-      PuppetLanguageServer.log_message(:debug, "--- INBOUND\n#{data}\n---")
+      PuppetVSCode.log_message(:debug, "--- INBOUND\n#{data}\n---")
 
       result = JSON.parse(data)
       received_parsed_object(result)
@@ -179,12 +179,12 @@ def process(obj)
 
     # This method must be overriden in the user's inherited class.
     def receive_request(request)
-      PuppetLanguageServer.log_message(:debug, "request received:\n#{request.inspect}")
+      PuppetVSCode.log_message(:debug, "request received:\n#{request.inspect}")
     end
 
     # This method must be overriden in the user's inherited class.
     def receive_notification(method, params)
-      PuppetLanguageServer.log_message(:debug, "notification received (method: #{method.inspect}, params: #{params.inspect})")
+      PuppetVSCode.log_message(:debug, "notification received (method: #{method.inspect}, params: #{params.inspect})")
     end
 
     def encode_json(data)
@@ -226,17 +226,17 @@ def send_show_message_notification(msg_type, message)
 
     # This method could be overriden in the user's inherited class.
     def parsing_error(_data, exception)
-      PuppetLanguageServer.log_message(:error, "parsing error:\n#{exception.message}")
+      PuppetVSCode.log_message(:error, "parsing error:\n#{exception.message}")
     end
 
     # This method could be overriden in the user's inherited class.
     def batch_not_supported_error(_obj)
-      PuppetLanguageServer.log_message(:error, 'batch request received but not implemented')
+      PuppetVSCode.log_message(:error, 'batch request received but not implemented')
     end
 
     # This method could be overriden in the user's inherited class.
     def invalid_request(_obj, code, message = nil)
-      PuppetLanguageServer.log_message(:error, "error #{code}: #{message}")
+      PuppetVSCode.log_message(:error, "error #{code}: #{message}")
     end
 
     class Request

server/lib/puppet-vscode.rb

@@ -0,0 +1,7 @@
+%w[logging version simple_tcp_server].each do |lib|
+  begin
+    require "puppet-vscode/#{lib}"
+  rescue LoadError
+    require File.expand_path(File.join(File.dirname(__FILE__), 'puppet-vscode', 'lib', lib))
+  end
+end

server/lib/puppet-vscode/logging.rb

@@ -0,0 +1,31 @@
+module PuppetVSCode
+  def self.log_message(severity, message)
+    return if @logger.nil?
+
+    case severity
+    when :debug
+      @logger.debug(message)
+    when :info
+      @logger.info(message)
+    when :warn
+      @logger.info(message)
+    when :error
+      @logger.error(message)
+    when :fatal
+      @logger.fatal(message)
+    else
+      @logger.unknown(message)
+    end
+  end
+
+  def self.init_logging(options)
+    if options[:debug].nil?
+      @logger = nil
+    elsif options[:debug].casecmp 'stdout'
+      @logger = Logger.new($stdout)
+    elsif !options[:debug].to_s.empty?
+      # Log to file
+      @logger = Logger.new(options[:debug])
+    end
+  end
+end

server/lib/puppet-languageserver/simple_tcp_server.rb renamed to server/lib/puppet-vscode/simple_tcp_server.rb

@@ -3,25 +3,25 @@
 # Based on code from
 # http://stackoverflow.com/questions/29858113/unable-to-make-socket-accept-non-blocking-ruby-2-2
 
-module PuppetLanguageServer
+module PuppetVSCode
   class SimpleTCPServerConnection
     attr_accessor :socket
     attr_accessor :simple_tcp_server
 
     # Methods to override
     def post_init
       # Override this to recieve events after a client is connected
-      PuppetLanguageServer.log_message(:debug, 'TCPSRV: Client has connected')
+      PuppetVSCode.log_message(:debug, 'TCPSRV: Client has connected')
     end
 
     def unbind
       # Override this to recieve events after a client is disconnected
-      PuppetLanguageServer.log_message(:debug, 'TCPSRV: Client has disconnected')
+      PuppetVSCode.log_message(:debug, 'TCPSRV: Client has disconnected')
     end
 
     def receive_data(data)
       # Override this to recieve data
-      PuppetLanguageServer.log_message(:debug, "TCPSRV: Received #{data.length} characters")
+      PuppetVSCode.log_message(:debug, "TCPSRV: Received #{data.length} characters")
     end
 
     # @api public
@@ -67,8 +67,7 @@ class << self
     @c_locker = Mutex.new
 
     def log(message)
-      # Override this to recieve log messages
-      PuppetLanguageServer.log_message(:debug, "TCPSRV: #{message}")
+      PuppetVSCode.log_message(:debug, "TCPSRV: #{message}")
     end
 
     ####
@@ -95,7 +94,9 @@ def get_data(io, connection_data)
     @handler_start_options = nil
     @server_options = nil
 
-    def start(handler = PuppetLanguageServer::SimpleTCPServerConnection, connection_options = {}, max_threads = 2)
+    def start(handler = PuppetVSCode::SimpleTCPServerConnection, connection_options = {}, max_threads = 2)
+      connection_options[:servicename] = 'LANGUAGE SERVER' if connection_options[:servicename].nil?
+
       # prepare threads
       exit_flag = false
       threads = []
@@ -121,10 +122,10 @@ def start(handler = PuppetLanguageServer::SimpleTCPServerConnection, connection_
       log("Will stop the server in #{connection_options[:connection_timeout]} seconds if no connection is made.") if kill_timer > 0
       log('Will stop the server when client disconnects') if !@server_options[:stop_on_client_exit].nil? && @server_options[:stop_on_client_exit]
 
-      # Output to STDOUT.  This is required by Langugage Client so it knows the server is now running
+      # Output to STDOUT.  This is required by clients so it knows the server is now running
       self.class.s_locker.synchronize do
-        self.class.services.each_value do |options|
-          $stdout.write("LANGUAGE SERVER RUNNING #{options[:hostname]}:#{options[:port]}\n")
+        self.class.services.each do |_service, options|
+          $stdout.write("#{@handler_start_options[:servicename]} RUNNING #{options[:hostname]}:#{options[:port]}\n")
         end
       end
       $stdout.flush

server/lib/puppet-languageserver/version.rb renamed to server/lib/puppet-vscode/version.rb

@@ -1,5 +1,5 @@
-module PuppetLanguageServer
-  PUPPETLANGUAGESERVERVERSION = '0.0.1'.freeze unless defined? PUPPETLANGUAGESERVERVERSION
+module PuppetVSCode
+  PUPPETVSCODEVERSION = '0.0.1'.freeze unless defined? PUPPETVSCODEVERSION
 
   # @api public
   #
@@ -10,7 +10,7 @@ def self.version
     version_file = File.join(File.dirname(__FILE__), 'VERSION')
     version = read_version_file(version_file)
 
-    @lang_server_version = version ? version : PUPPETLANGUAGESERVERVERSION
+    @lang_server_version = version ? version : PUPPETVSCODEVERSION
   end
 
   # Sets the langauge server version

server/spec/unit/puppet-languageserver/version_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'puppet-vscode'
+
+describe "version" do
+  before :each do
+    PuppetVSCode.instance_eval do
+      @lang_server_version = nil if @lang_server_version
+    end
+  end
+
+  context "without a VERSION file" do
+    before :each do
+      expect(PuppetVSCode).to receive(:read_version_file).and_return(nil)
+    end
+
+    it "is PuppetVSCode::PUPPETVSCODEVERSION" do
+      expect(PuppetVSCode.version).to eq(PuppetVSCode::PUPPETVSCODEVERSION)
+    end
+  end
+
+  context "with a VERSION file" do
+    let (:file_version) { '1.2.3' }
+
+    before :each do
+      expect(PuppetVSCode).to receive(:read_version_file).with(/VERSION$/).and_return(file_version)
+    end
+
+    it "is the content of the file" do
+      expect(PuppetVSCode.version).to eq(file_version)
+    end
+  end
+end