logstash/lib/pluginmanager/command.rb
Ry Biesemeyer 8c96913807
Pluginmanager clean after mutate (#17203)
* pluginmanager: always clean after mutate

* pluginmanager: don't skip updating plugins installed with --version

* pr feedback
2025-03-04 10:59:35 -08:00

83 lines
3.4 KiB
Ruby

# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
class LogStash::PluginManager::Command < Clamp::Command
def gemfile
@gemfile ||= LogStash::Gemfile.new(File.new(LogStash::Environment::GEMFILE_PATH, 'r+')).load
end
# If set in debug mode we will raise an exception and display the stacktrace
def report_exception(readable_message, exception)
if debug?
raise exception
else
signal_error("#{readable_message}, message: #{exception.message}")
end
end
def display_bundler_output(output)
if debug? && output
# Display what bundler did in the last run
$stderr.puts("Bundler output")
$stderr.puts(output)
end
end
# Each plugin install for a gemfile create a path with a unique id.
# we must clear what is not currently used in the
def remove_unused_locally_installed_gems!
used_path = gemfile.locally_installed_gems.collect { |gem| gem.options[:path] }
Dir.glob(File.join(LogStash::Environment::LOCAL_GEM_PATH, '*')) do |path|
FileUtils.rm_rf(relative_path(path)) if used_path.none? { |p| p.start_with?(relative_path(path)) }
end
end
def remove_orphan_dependencies!
locked_gem_names = ::Bundler::LockfileParser.new(File.read(LogStash::Environment::LOCKFILE)).specs.map(&:full_name).to_set
orphan_gem_specs = ::Gem::Specification.each
.reject(&:stubbed?) # skipped stubbed (uninstalled) gems
.reject(&:default_gem?) # don't touch jruby-included default gems
.reject{ |spec| locked_gem_names.include?(spec.full_name) }
.sort
inactive_plugins, orphaned_dependencies = orphan_gem_specs.partition { |spec| LogStash::PluginManager.logstash_plugin_gem_spec?(spec) }
# uninstall plugins first, to limit damage should one fail to uninstall
inactive_plugins.each { |plugin| uninstall_gem!("inactive plugin", plugin) }
orphaned_dependencies.each { |dep| uninstall_gem!("orphaned dependency", dep) }
end
def uninstall_gem!(desc, spec)
require "rubygems/uninstaller"
Gem::DefaultUserInteraction.use_ui(debug? ? Gem::DefaultUserInteraction.ui : Gem::SilentUI.new) do
Gem::Uninstaller.new(spec.name, version: spec.version, force: true, executables: true).uninstall
end
puts "cleaned #{desc} #{spec.name} (#{spec.version})"
rescue Gem::InstallError => e
report_exception("Failed to uninstall `#{spec.full_name}`", e)
end
def relative_path(path)
require "pathname"
::Pathname.new(path).relative_path_from(::Pathname.new(LogStash::Environment::LOGSTASH_HOME)).to_s
end
def debug?
ENV["DEBUG"]
end
end