Avoid loading incorrect add-on versions when bundle path is inside project (#3620)

Author: vinistock

lib/ruby_lsp/addon.rb

@@ -56,7 +56,13 @@ def load_addons(global_state, outgoing_queue, include_project_addons: true)
         addon_files = Gem.find_files("ruby_lsp/**/addon.rb")
 
         if include_project_addons
-          addon_files.concat(Dir.glob(File.join(global_state.workspace_path, "**", "ruby_lsp/**/addon.rb")))
+          project_addons = Dir.glob("#{global_state.workspace_path}/**/ruby_lsp/**/addon.rb")
+
+          # Ignore add-ons from dependencies if the bundle is stored inside the project. We already found those with
+          # `Gem.find_files`
+          bundle_path = Bundler.bundle_path.to_s
+          project_addons.reject! { |path| path.start_with?(bundle_path) }
+          addon_files.concat(project_addons)
         end
 
         errors = addon_files.filter_map do |addon_path|

test/addon_test.rb

@@ -190,5 +190,40 @@ def version
         assert_predicate(addon, :hello)
       end
     end
+
+    def test_loading_project_addons_ignores_bundle_path
+      Dir.mktmpdir do |dir|
+        addon_dir = File.join(dir, "vendor", "bundle", "ruby_lsp", "test_addon")
+        FileUtils.mkdir_p(addon_dir)
+        File.write(File.join(addon_dir, "addon.rb"), <<~RUBY)
+          class ProjectAddon < RubyLsp::Addon
+            attr_reader :hello
+
+            def activate(global_state, outgoing_queue)
+              @hello = true
+            end
+
+            def name
+              "Project Addon"
+            end
+
+            def version
+              "0.1.0"
+            end
+          end
+        RUBY
+
+        @global_state.apply_options({
+          workspaceFolders: [{ uri: URI::Generic.from_path(path: dir).to_s }],
+        })
+
+        Bundler.stubs(:bundle_path).returns(Pathname.new(File.join(dir, "vendor", "bundle")))
+        Addon.load_addons(@global_state, @outgoing_queue)
+
+        assert_raises(Addon::AddonNotFoundError) do
+          Addon.get("Project Addon", "0.1.0")
+        end
+      end
+    end
   end
 end