Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split ServerAddon into new file #469

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ Sorbet/StrictSigil:
- "**/*.rake"
- "test/**/*.rb"
- "lib/ruby_lsp/ruby_lsp_rails/server.rb" # we can't assume sorbet-runtime is available
- "lib/ruby_lsp/ruby_lsp_rails/server_addon.rb" # we can't assume sorbet-runtime is available
46 changes: 1 addition & 45 deletions lib/ruby_lsp/ruby_lsp_rails/server.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,13 @@
# frozen_string_literal: true

require "json"
require_relative "server_addon"

# NOTE: We should avoid printing to stderr since it causes problems. We never read the standard error pipe from the
# client, so it will become full and eventually hang or crash. Instead, return a response with an `error` key.

module RubyLsp
module Rails
class ServerAddon
@server_addon_classes = []
@server_addons = {}

class << self
# We keep track of runtime server add-ons the same way we track other add-ons, by storing classes that inherit
# from the base one
def inherited(child)
@server_addon_classes << child
super
end

# Delegate `request` with `params` to the server add-on with the given `name`
def delegate(name, request, params)
@server_addons[name]&.execute(request, params)
end

# Instantiate all server addons and store them in a hash for easy access after we have discovered the classes
def finalize_registrations!(stdout)
until @server_addon_classes.empty?
addon = @server_addon_classes.shift.new(stdout)
@server_addons[addon.name] = addon
end
end
end

def initialize(stdout)
@stdout = stdout
end

# Write a response back. Can be used for sending notifications to the editor
def write_response(response)
json_response = response.to_json
@stdout.write("Content-Length: #{json_response.length}\r\n\r\n#{json_response}")
end

def name
raise NotImplementedError, "Not implemented!"
end

def execute(request, params)
raise NotImplementedError, "Not implemented!"
end
end

class Server
def initialize(stdout: $stdout, override_default_output_device: true)
# Grab references to the original pipes so that we can change the default output device further down
Expand Down
54 changes: 54 additions & 0 deletions lib/ruby_lsp/ruby_lsp_rails/server_addon.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# typed: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since .rubocop.yml was updated I think this shouldn't be needed?

# frozen_string_literal: true

# requiring sorbet-runtime in the server can lead to some problems, so this is untyped
# https://github.com/Shopify/ruby-lsp-rails/pull/469#issuecomment-2391429546

module RubyLsp
module Rails
class ServerAddon
@server_addon_classes = []
@server_addons = {}

class << self
# We keep track of runtime server add-ons the same way we track other add-ons, by storing
# classes that inherit from the base one
def inherited(child)
@server_addon_classes << child
super
end

# Delegate `request` with `params` to the server add-on with the given `name`
def delegate(name, request, params)
@server_addons[name]&.execute(request, params)
end

# Instantiate all server addons and store them in a hash for easy access after we have discovered the classes
def finalize_registrations!(stdout)
until @server_addon_classes.empty?
addon = @server_addon_classes.shift.new(stdout)
@server_addons[addon.name] = addon
end
end
end

def initialize(stdout)
@stdout = stdout
end

# Write a response back. Can be used for sending notifications to the editor
def write_response(response)
json_response = response.to_json
@stdout.write("Content-Length: #{json_response.length}\r\n\r\n#{json_response}")
end

def name
raise NotImplementedError, "Not implemented!"
end

def execute(request, params)
raise NotImplementedError, "Not implemented!"
end
end
end
end
Loading