lsp_router 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d57746f846403f9ca2c5a45bba0ecd01fdb6e907e05095431063b8bc4a0a5f80
+  data.tar.gz: a3aa45e975f6db6712acd14edd1f5fcfa3603578572890c87c29d0e8abb34da9
+SHA512:
+  metadata.gz: 101ee8a0b48df239a88ee5a4a684f3591ab544a7e76e35cbea4ab30e12ef4f0711fbde52dca246e0f5729d49589ada0d8327cf242ede5e6ef3f3ce7a5c2e0dea
+  data.tar.gz: dd2ec59d88c78cd1dd5111a0a6437ce87136b3ebc6fbdd1723b6a92e6d4a2e9ae5a6eff1c2c01ac61337e3e42dee342b8a4566b81e13367b03eb6154bcba149e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,189 @@
+AllCops:
+  NewCops: enable
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gems.rb
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/ExtraSpacing:
+  AllowBeforeTrailingComments: true
+
+Layout/LineLength:
+  Max: 130
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/SpaceAfterNot:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+
+Lint/SuppressedException:
+  AllowComments: true
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 100
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 100
+
+Style/AndOr:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ClassCheck:
+  Enabled: false
+
+Style/ClassMethods:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/InfiniteLoop:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/PreferredHashMethods:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/VariableInterpolation:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+

data/README.md

@@ -0,0 +1,39 @@
+# LspRouter
+
+複数のLSPサーバーに処理を振り分けるルーター
+
+## Installation
+
+```
+gem install lsp_router
+```
+
+## Usage
+
+次のような config ファイルを作成して、`lsp_router config-file` のように実行する。
+
+```ruby
+logfile '/tmp/lsp_router'
+loglevel :info
+
+server :rubocop do
+  command 'rubocop-lsp'
+  mode :stdio
+end
+
+server :solargraph do
+  command 'solargraph stdio'
+  mode :stdio
+end
+```
+
+この例では、`rubocop-lsp` と `solargraph stdio` を起動して、クライアントからの処理を振り分ける。
+最初に各サーバーの capabilities を確認して、各サーバーにどの機能があるかを確認し、クライアントからの REQUEST は対応しているサーバーに渡す。複数のサーバーが同じ機能を持っていれば上に書いたサーバーが優先される。NOTIFICATION は全サーバーに渡す。
+
+## Example
+
+Emacs の Eglot の場合はこんな感じに設定するといいっぽい。
+
+```
+(add-to-list 'eglot-server-programs '((ruby-mode ruby-ts-mode) . ("lsp_router" "--error=lsp_router.err" "lsp_router.conf")))
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config/example.conf

@@ -0,0 +1,12 @@
+logfile '/tmp/lsp_router'
+loglevel :info
+
+server :rubocop do
+  command 'rubocop-lsp'
+  mode :stdio
+end
+
+server :solargraph do
+  command 'solargraph stdio'
+  mode :stdio
+end

data/exe/lsp_router

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'lsp_router'
+require 'lsp_router/cli'
+
+LspRouter::CLI.start

data/lib/lsp_router/cli.rb

@@ -0,0 +1,31 @@
+require 'optparse'
+
+class LspRouter
+  # command line interface
+  class CLI
+    def self.start
+      port = nil
+      logfile = nil
+      error = nil
+
+      opts = OptionParser.new
+      opts.version = LspRouter::VERSION
+      opts.banner = "Usage: #{File.basename $0} [options] config_file"
+      opts.on('-p', '--port=port'){|v| port = v}
+      opts.on('--logfile=file'){|v| logfile = v}
+      opts.on('--error=file'){|v| error = v}
+      opts.parse!(ARGV)
+      if error
+        $stderr = File.open(error, 'a')
+        $stderr.sync = true
+      end
+      if ARGV.size != 1
+        puts opts.help
+        exit 1
+      end
+      config_file, = ARGV
+      load config_file, LspRouter::Config::M
+      LspRouter.new(LspRouter::Config.instance, port:, logfile:).run
+    end
+  end
+end

data/lib/lsp_router/client_side.rb

@@ -0,0 +1,50 @@
+class LspRouter
+  # client side
+  class ClientSide
+    # @param rio [IO]
+    # @param wio [IO]
+    # @param logger [Logger]
+    def initialize(rio, wio, logger:)
+      @logger = logger
+      @rio = rio
+      @wio = wio
+    end
+
+    # @return [Hash]
+    def read
+      header = @rio.gets("\r\n\r\n")
+      return unless header
+      fields = header.lines.map do |line|
+        n, v = line.chomp.split(/: */, 2)
+        [n.downcase, v] if n
+      end.compact.to_h
+      ret = @rio.read(fields['content-length'].to_i)
+      return unless ret
+      data = JSON.parse(ret)
+      log('client>', data)
+      data
+    end
+
+    # @param data [Hash]
+    def write(data)
+      log('client<', data)
+      json = data.to_json
+      @wio.puts "Content-Length: #{json.bytesize}\r\n\r\n"
+      @wio.write(json)
+      @wio.flush
+    end
+
+    # @param prefix [String]
+    # @param data [Hash]
+    def log(prefix, data)
+      if data['id'] && data['method']
+        @logger.debug "#{prefix}[REQUEST] id:#{data['id']} method:#{data['method']}"
+      elsif data['id']
+        @logger.debug "#{prefix}[RESPONSE] id:#{data['id']}"
+      else
+        @logger.debug "#{prefix}[NOTIFICATION] method:#{data['method']}"
+      end
+      @logger.debug data.inspect
+    end
+  end
+end

data/lib/lsp_router/config.rb

@@ -0,0 +1,69 @@
+require 'singleton'
+
+class LspRouter
+  # config
+  class Config
+    include Singleton
+
+    attr_reader :servers
+    attr_accessor :logfile, :loglevel
+
+    def initialize
+      @servers = []
+    end
+
+    # @param name [String]
+    def add_server(name, &block)
+      @servers.push Server.new(name, &block)
+    end
+
+    # module for configuration file
+    module M
+      # @param name [String]
+      def server(name, &block)
+        config.add_server(name, &block)
+      end
+
+      # @param filename [String]
+      def logfile(filename)
+        config.logfile = filename
+      end
+
+      # @param level [Symbol]
+      def loglevel(level)
+        config.loglevel = level
+      end
+
+      # @return [LspRouter::Config]
+      def config
+        Config.instance
+      end
+    end
+
+    # server
+    class Server
+      attr_reader :attr
+
+      # @param name [String]
+      def initialize(name, &block)
+        @attr = {name:}
+        self.instance_eval(&block)
+      end
+
+      # @param cmd [String]
+      def command(cmd)
+        @attr[:command] = cmd
+      end
+
+      # @param m [Symbol]
+      def mode(m)
+        @attr[:mode] = m
+      end
+
+      # @return [String]
+      def info
+        "[#{attr[:name]}] #{attr[:command]}"
+      end
+    end
+  end
+end

data/lib/lsp_router/server_side.rb

@@ -0,0 +1,66 @@
+require 'open3'
+
+class LspRouter
+  # server side
+  class ServerSide
+    # @return String
+    attr_reader :name
+    # @return [Hash]
+    attr_reader :capabilities
+
+    # @param server [LspRouter::Config::Server]
+    # @param logger [Logger]
+    def initialize(server, logger:)
+      @logger = logger
+      @name = server.attr[:name]
+      @command = server.attr[:command]
+      @stdin, @stdout, @stderr = Open3.popen3(@command)
+      @capabilities = {}
+    end
+
+    # @param req [Hash]
+    def init(req)
+      write(req)
+      data = read
+      capa = data.dig('result', 'capabilities')
+      capa.keys.grep(/Provider/).each do |key|
+        @capabilities[key.sub(/Provider\z/, '')] = true
+      end
+      data
+    end
+
+    # @param data [Hash]
+    def write(data)
+      log("#{name}<", data)
+      json = data.to_json
+      @stdin.puts "Content-Length: #{json.bytesize}\r\n\r\n"
+      @stdin.write(json)
+      @stdin.flush
+    end
+
+    # @return [Hash]
+    def read
+      header = @stdout.gets("\r\n\r\n")
+      fields = header.lines.map do |line|
+        n, v = line.chomp.split(/: */, 2)
+        [n.downcase, v] if n
+      end.compact.to_h
+      data = JSON.parse(@stdout.read(fields['content-length'].to_i))
+      log("#{name}>", data)
+      data
+    end
+
+    # @param prefix [String]
+    # @param data [Hash]
+    def log(prefix, data)
+      if data['id'] && data['method']
+        @logger.debug "#{prefix}[REQUEST] id:#{data['id']} method:#{data['method']}"
+      elsif data['id']
+        @logger.debug "#{prefix}[RESPONSE] id:#{data['id']}"
+      else
+        @logger.debug "#{prefix}[NOTIFICATION] method:#{data['method']}"
+      end
+      @logger.debug data.inspect
+    end
+  end
+end

data/lib/lsp_router/version.rb

@@ -0,0 +1,3 @@
+class LspRouter
+  VERSION = '0.1.0'
+end

data/lib/lsp_router.rb

@@ -0,0 +1,94 @@
+require_relative 'lsp_router/version'
+require_relative 'lsp_router/config'
+require_relative 'lsp_router/server_side'
+require_relative 'lsp_router/client_side'
+
+require 'socket'
+require 'json'
+require 'logger'
+
+# LspRouter
+class LspRouter
+  # @param config [LspRouter::Config] configuration filename
+  # @param port [Integer, String]
+  # @param logfile [String]
+  def initialize(config, port: nil, logfile: nil)
+    @config = config
+    @port = port
+    logfile ||= config.logfile || $stderr
+    @logger = Logger.new(logfile, level: Logger.const_get(config.loglevel.upcase))
+    @logger.info "LspRouter: start"
+    @config.servers.each do |server|
+      @logger.info "server: #{server.info}"
+    end
+  end
+
+  def run
+    if @port
+      @logger.info "mode: port:#{@port}"
+      Socket.tcp_server_loop(@port) do |sock, _|
+        @client = LspRouter::ClientSide.new(sock, sock, logger: @logger)
+        loop
+      end
+    else
+      @logger.info "mode: stdio"
+      @client = LspRouter::ClientSide.new($stdin, $stdout, logger: @logger)
+      loop
+    end
+  rescue => e
+    @logger.error e
+  ensure
+    @logger.info "LspRouter: stop"
+  end
+
+  def loop
+    req = @client.read
+    servers = @config.servers.map{LspRouter::ServerSide.new(_1, logger: @logger)}
+    primary = servers.first
+
+    res = nil
+    capa_server = {}
+    servers.each do |server|
+      data = server.init(req)
+      if res
+        res['result']['capabilities'].update(data.dig('result', 'capabilities')){|_, v, _| v}
+      else
+        res = data
+      end
+      server.capabilities.each_key do |key|
+        capa_server[key] ||= server
+      end
+    end
+    @client.write(res)
+
+    thr = Thread.new do
+      Thread.abort_on_exception = true
+      while true
+        data = @client.read
+        break unless data
+        if data['id']
+          # request
+          method = data['method']&.split('/')&.last
+          server = capa_server[method] || primary
+          server.write(data)
+        else
+          # notification
+          servers.each do |server|
+            server.write(data)
+          end
+        end
+      end
+    end
+
+    servers.each do |server|
+      Thread.new do
+        Thread.abort_on_exception = true
+        while true
+          data = server.read
+          @client.write(data)
+        end
+      end
+    end
+    thr.join
+  end
+end

data/sig/lsp_router.rbs

@@ -0,0 +1,4 @@
+module LspRouter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: lsp_router
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOMITA Masahiro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-20 00:00:00.000000000 Z
+dependencies: []
+description: routing multiple LSP server by capability
+email:
+- tommy@tmtm.org
+executables:
+- lsp_router
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- config/example.conf
+- exe/lsp_router
+- lib/lsp_router.rb
+- lib/lsp_router/cli.rb
+- lib/lsp_router/client_side.rb
+- lib/lsp_router/config.rb
+- lib/lsp_router/server_side.rb
+- lib/lsp_router/version.rb
+- sig/lsp_router.rbs
+homepage: https://gitlab.com/tmtms/lsp_router
+licenses:
+- GPLv3
+metadata:
+  homepage_uri: https://gitlab.com/tmtms/lsp_router
+  source_code_uri: https://gitlab.com/tmtms/lsp_router
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: LSP router
+test_files: []