Merge pull request #2037 from Shopify/ko/add-on-dsl-generation

[Tapioca add-on] Generate DSL RBIs in add-on mode

lib/ruby_lsp/tapioca/addon.rb

@@ -80,7 +80,7 @@ def workspace_did_change_watched_files(changes)
         @rails_runner_client.delegate_notification(
           server_addon_name: "Tapioca",
           request_name: "dsl",
-          params: { constants: constants },
+          constants: constants,
         )
       end
     end

lib/ruby_lsp/tapioca/server_addon.rb

@@ -20,7 +20,8 @@ def execute(request, params)
       private
 
       def dsl(params)
-        # TODO
+        load("tapioca/cli.rb") # Reload the CLI to reset thor defaults between requests
+        ::Tapioca::Cli.start(["dsl", "--lsp_addon", "--workers=1"] + params[:constants])
       end
     end
   end

lib/tapioca/cli.rb

@@ -144,6 +144,11 @@ def todo
       type: :hash,
       desc: "Options to pass to the DSL compilers",
       default: {}
+    option :lsp_addon,
+      type: :boolean,
+      desc: "Generate DSL RBIs from the LSP addon. Internal to tapioca and not intended for end-users",
+      default: false,
+      hide: true
     def dsl(*constant_or_paths)
       set_environment(options)
 
@@ -166,6 +171,7 @@ def dsl(*constant_or_paths)
         app_root: options[:app_root],
         halt_upon_load_error: options[:halt_upon_load_error],
         compiler_options: options[:compiler_options],
+        lsp_addon: options[:lsp_addon],
       }
 
       command = if options[:verify]

lib/tapioca/commands/abstract_dsl.rb

@@ -28,6 +28,7 @@ class AbstractDsl < CommandWithoutTracker
           app_root: String,
           halt_upon_load_error: T::Boolean,
           compiler_options: T::Hash[String, T.untyped],
+          lsp_addon: T::Boolean,
         ).void
       end
       def initialize(
@@ -47,7 +48,8 @@ def initialize(
         rbi_formatter: DEFAULT_RBI_FORMATTER,
         app_root: ".",
         halt_upon_load_error: true,
-        compiler_options: {}
+        compiler_options: {},
+        lsp_addon: false
       )
         @requested_constants = requested_constants
         @requested_paths = requested_paths
@@ -66,6 +68,7 @@ def initialize(
         @halt_upon_load_error = halt_upon_load_error
         @skip_constant = skip_constant
         @compiler_options = compiler_options
+        @lsp_addon = lsp_addon
 
         super()
       end
@@ -74,6 +77,10 @@ def initialize(
 
       sig { params(outpath: Pathname, quiet: T::Boolean).returns(T::Set[Pathname]) }
       def generate_dsl_rbi_files(outpath, quiet:)
+        if @lsp_addon
+          pipeline.active_compilers.each(&:reset_state)
+        end
+
         existing_rbi_files = existing_rbi_filenames(all_requested_constants)
 
         generated_files = pipeline.run do |constant, contents|
@@ -116,6 +123,7 @@ def load_application
           eager_load: @requested_constants.empty? && @requested_paths.empty?,
           app_root: @app_root,
           halt_upon_load_error: @halt_upon_load_error,
+          lsp_addon: @lsp_addon,
         )
       end
 
@@ -133,6 +141,7 @@ def create_pipeline
           skipped_constants: constantize(@skip_constant, ignore_missing: true),
           number_of_workers: @number_of_workers,
           compiler_options: @compiler_options,
+          lsp_addon: @lsp_addon,
         )
       end
 

lib/tapioca/dsl/compiler.rb

@@ -51,6 +51,13 @@ def requested_constants=(constants)
           @@requested_constants = constants # rubocop:disable Style/ClassVars
         end
 
+        sig { void }
+        def reset_state
+          @processable_constants = nil
+          @all_classes = nil
+          @all_modules = nil
+        end
+
         private
 
         sig do

lib/tapioca/dsl/pipeline.rb

@@ -34,6 +34,7 @@ class Pipeline
           skipped_constants: T::Array[Module],
           number_of_workers: T.nilable(Integer),
           compiler_options: T::Hash[String, T.untyped],
+          lsp_addon: T::Boolean,
         ).void
       end
       def initialize(
@@ -44,7 +45,8 @@ def initialize(
         error_handler: $stderr.method(:puts).to_proc,
         skipped_constants: [],
         number_of_workers: nil,
-        compiler_options: {}
+        compiler_options: {},
+        lsp_addon: false
       )
         @active_compilers = T.let(
           gather_active_compilers(requested_compilers, excluded_compilers),
@@ -57,6 +59,7 @@ def initialize(
         @number_of_workers = number_of_workers
         @compiler_options = compiler_options
         @errors = T.let([], T::Array[String])
+        @lsp_addon = lsp_addon
       end
 
       sig do
@@ -177,7 +180,7 @@ def filter_anonymous_and_reloaded_constants(constants)
         # Find the constants that have been reloaded
         reloaded_constants = constants_by_name.select { |_, constants| constants.size > 1 }.keys
 
-        unless reloaded_constants.empty?
+        unless reloaded_constants.empty? || @lsp_addon
           reloaded_constant_names = reloaded_constants.map { |name| "`#{name}`" }.join(", ")
 
           $stderr.puts("WARNING: Multiple constants with the same name: #{reloaded_constant_names}")

lib/tapioca/loaders/dsl.rb

@@ -10,16 +10,27 @@ class << self
         extend T::Sig
 
         sig do
-          params(tapioca_path: String, eager_load: T::Boolean, app_root: String, halt_upon_load_error: T::Boolean).void
+          params(
+            tapioca_path: String,
+            eager_load: T::Boolean,
+            app_root: String,
+            halt_upon_load_error: T::Boolean,
+            lsp_addon: T::Boolean,
+          ).void
         end
-        def load_application(tapioca_path:, eager_load: true, app_root: ".", halt_upon_load_error: true)
+        def load_application(tapioca_path:, eager_load: true, app_root: ".", halt_upon_load_error: true,
+          lsp_addon: false)
           loader = new(
             tapioca_path: tapioca_path,
             eager_load: eager_load,
             app_root: app_root,
             halt_upon_load_error: halt_upon_load_error,
           )
-          loader.load
+          if lsp_addon
+            loader.load_dsl_extensions_and_compilers
+          else
+            loader.load
+          end
         end
       end
 
@@ -30,6 +41,12 @@ def load
         load_dsl_compilers
       end
 
+      sig { void }
+      def load_dsl_extensions_and_compilers
+        load_dsl_extensions
+        load_dsl_compilers
+      end
+
       protected
 
       sig do

tasks/readme.rake

@@ -29,7 +29,7 @@ task :readme do
   end
 
   def skip_option?(option)
-    option.name == "auth"
+    option.name == "auth" || option.hide
   end
 
   def option_value(option)