Skip to content

[Updater] Break out handler methods for Dependabot::Error classes into a small utility class #6865

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.

Sign up for GitHub

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

Merged
brrygrdn merged 1 commit into from
Mar 20, 2023
Merged

[Updater] Break out handler methods for Dependabot::Error classes into a small utility class #6865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
235 changes: 11 additions & 224 deletions updater/lib/dependabot/updater.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
require "dependabot/bundler"
require "dependabot/pub"

require "dependabot/updater/error_handler"
require "dependabot/security_advisory"
require "dependabot/update_checkers"
require "wildcard_matcher"
Expand All @@ -42,17 +43,6 @@ def initialize(message, raven_context:)
end
end

# These are errors that halt the update run and are handled in the main
# backend. They do *not* raise a sentry.
RUN_HALTING_ERRORS = {
Dependabot::OutOfDisk => "out_of_disk",
Dependabot::OutOfMemory => "out_of_memory",
Dependabot::AllVersionsIgnored => "all_versions_ignored",
Dependabot::UnexpectedExternalCode => "unexpected_external_code",
Errno::ENOSPC => "out_of_disk",
Octokit::Unauthorized => "octokit_unauthorized"
}.freeze

# To do work, this class needs three arguments:
# - The Dependabot::Service to send events and outcomes to
# - The Dependabot::Job that describes the work to be done
Expand All @@ -61,6 +51,7 @@ def initialize(service:, job:, dependency_snapshot:)
@service = service
@job = job
@dependency_snapshot = dependency_snapshot
@error_handler = ErrorHandler.new(service: service, job: job)
# TODO: Collect @created_pull_requests on the Job object?
@created_pull_requests = []
end
Expand All @@ -75,7 +66,7 @@ def run
Dependabot.logger.info("Starting update job for #{job.source.repo}")
dependencies.each { |dep| check_and_create_pr_with_error_handling(dep) }
end
rescue *RUN_HALTING_ERRORS.keys => e
rescue *ErrorHandler::RUN_HALTING_ERRORS.keys => e
if e.is_a?(Dependabot::AllVersionsIgnored) && !job.security_updates_only?
error = StandardError.new(
"Dependabot::AllVersionsIgnored was unexpectedly raised for a non-security update job"
Expand All @@ -87,38 +78,34 @@ def run

# OOM errors are special cased so that we stop the update run early
service.record_update_job_error(
error_type: RUN_HALTING_ERRORS.fetch(e.class),
error_type: ErrorHandler::RUN_HALTING_ERRORS.fetch(e.class),
error_details: nil
)
end

private

attr_accessor :created_pull_requests
attr_reader :service, :job, :dependency_snapshot
attr_reader :service, :job, :dependency_snapshot, :error_handler

def check_and_create_pr_with_error_handling(dependency)
check_and_create_pull_request(dependency)
rescue Dependabot::InconsistentRegistryResponse => e
log_error(
error_handler.log_error(
dependency: dependency,
error: e,
error_type: "inconsistent_registry_response",
error_detail: e.message
)
rescue StandardError => e
raise if RUN_HALTING_ERRORS.keys.any? { |err| e.is_a?(err) }

handle_dependabot_error(error: e, dependency: dependency)
error_handler.handle_dependabot_error(error: e, dependency: dependency)
end

def check_and_update_existing_pr_with_error_handling(dependencies)
dependency = dependencies.last
check_and_update_pull_request(dependencies)
rescue StandardError => e
raise if RUN_HALTING_ERRORS.keys.any? { |err| e.is_a?(err) }

handle_dependabot_error(error: e, dependency: dependency)
error_handler.handle_dependabot_error(error: e, dependency: dependency)
end

# rubocop:disable Metrics/AbcSize
Expand Down Expand Up @@ -554,19 +541,6 @@ def log_up_to_date(dependency)
)
end

def log_error(dependency:, error:, error_type:, error_detail: nil)
if error_type == "unknown_error"
Dependabot.logger.error "Error processing #{dependency.name} (#{error.class.name})"
Dependabot.logger.error error.message
error.backtrace.each { |line| Dependabot.logger.error line }
else
Dependabot.logger.info(
"Handled error whilst updating #{dependency.name}: #{error_type} " \
"#{error_detail}"
)
end
end

def log_requirements_for_update(requirements_to_unlock, checker)
Dependabot.logger.info("Requirements to unlock #{requirements_to_unlock}")

Expand Down Expand Up @@ -603,6 +577,7 @@ def existing_pull_request(updated_dependencies)
created_pull_requests.find { |pr| Set.new(pr) == new_pr_set }
end

# rubocop:disable Metrics/AbcSize
# rubocop:disable Metrics/PerceivedComplexity
def dependencies
all_deps = dependency_snapshot.dependencies
Expand Down Expand Up @@ -644,10 +619,11 @@ def dependencies

deps
rescue StandardError => e
handle_parser_error(e)
error_handler.handle_parser_error(e)
[]
end
# rubocop:enable Metrics/PerceivedComplexity
# rubocop:enable Metrics/AbcSize

def update_checker_for(dependency, raise_on_ignored:)
Dependabot::UpdateCheckers.for_package_manager(job.package_manager).new(
Expand Down Expand Up @@ -775,195 +751,6 @@ def close_pull_request(reason:)
"#{job.dependencies.join(', ')} - #{reason_string}")
service.close_pull_request(job.dependencies, reason)
end

# rubocop:disable Metrics/AbcSize
# rubocop:disable Metrics/MethodLength
def handle_dependabot_error(error:, dependency:)
error_details =
case error
when Dependabot::DependencyFileNotResolvable
{
"error-type": "dependency_file_not_resolvable",
"error-detail": { message: error.message }
}
when Dependabot::DependencyFileNotEvaluatable
{
"error-type": "dependency_file_not_evaluatable",
"error-detail": { message: error.message }
}
when Dependabot::GitDependenciesNotReachable
{
"error-type": "git_dependencies_not_reachable",
"error-detail": { "dependency-urls": error.dependency_urls }
}
when Dependabot::GitDependencyReferenceNotFound
{
"error-type": "git_dependency_reference_not_found",
"error-detail": { dependency: error.dependency }
}
when Dependabot::PrivateSourceAuthenticationFailure
{
"error-type": "private_source_authentication_failure",
"error-detail": { source: error.source }
}
when Dependabot::PrivateSourceTimedOut
{
"error-type": "private_source_timed_out",
"error-detail": { source: error.source }
}
when Dependabot::PrivateSourceCertificateFailure
{
"error-type": "private_source_certificate_failure",
"error-detail": { source: error.source }
}
when Dependabot::MissingEnvironmentVariable
{
"error-type": "missing_environment_variable",
"error-detail": {
"environment-variable": error.environment_variable
}
}
when Dependabot::GoModulePathMismatch
{
"error-type": "go_module_path_mismatch",
"error-detail": {
"declared-path": error.declared_path,
"discovered-path": error.discovered_path,
"go-mod": error.go_mod
}
}
when Dependabot::NotImplemented
{
"error-type": "not_implemented",
"error-detail": {
message: error.message
}
}
when Dependabot::SharedHelpers::HelperSubprocessFailed
# If a helper subprocess has failed the error may include sensitive
# info such as file contents or paths. This information is already
# in the job logs, so we send a breadcrumb to Sentry to retrieve those
# instead.
msg = "Subprocess #{error.raven_context[:fingerprint]} failed to run. Check the job logs for error messages"
sanitized_error = SubprocessFailed.new(msg, raven_context: error.raven_context)
sanitized_error.set_backtrace(error.backtrace)
service.capture_exception(error: sanitized_error, job: job)

{ "error-type": "unknown_error" }
when *Octokit::RATE_LIMITED_ERRORS
# If we get a rate-limited error we let dependabot-api handle the
# retry by re-enqueing the update job after the reset
{
"error-type": "octokit_rate_limited",
"error-detail": {
"rate-limit-reset": error.response_headers["X-RateLimit-Reset"]
}
}
else
service.capture_exception(
error: error,
job: job,
dependency: dependency
)
{ "error-type": "unknown_error" }
end

service.record_update_job_error(
error_type: error_details.fetch(:"error-type"),
error_details: error_details[:"error-detail"],
dependency: dependency
)

log_error(
dependency: dependency,
error: error,
error_type: error_details.fetch(:"error-type"),
error_detail: error_details.fetch(:"error-detail", nil)
)
end
# rubocop:enable Metrics/MethodLength
# rubocop:enable Metrics/AbcSize

# rubocop:disable Metrics/MethodLength
def handle_parser_error(error)
# This happens if the repo gets removed after a job gets kicked off.
# The service will handle the removal without any prompt from the updater,
# so no need to add an error to the errors array
return if error.is_a? Dependabot::RepoNotFound

error_details =
case error
when Dependabot::DependencyFileNotEvaluatable
{
"error-type": "dependency_file_not_evaluatable",
"error-detail": { message: error.message }
}
when Dependabot::DependencyFileNotResolvable
{
"error-type": "dependency_file_not_resolvable",
"error-detail": { message: error.message }
}
when Dependabot::BranchNotFound
{
"error-type": "branch_not_found",
"error-detail": { "branch-name": error.branch_name }
}
when Dependabot::DependencyFileNotParseable
{
"error-type": "dependency_file_not_parseable",
"error-detail": {
message: error.message,
"file-path": error.file_path
}
}
when Dependabot::DependencyFileNotFound
{
"error-type": "dependency_file_not_found",
"error-detail": { "file-path": error.file_path }
}
when Dependabot::PathDependenciesNotReachable
{
"error-type": "path_dependencies_not_reachable",
"error-detail": { dependencies: error.dependencies }
}
when Dependabot::PrivateSourceAuthenticationFailure
{
"error-type": "private_source_authentication_failure",
"error-detail": { source: error.source }
}
when Dependabot::GitDependenciesNotReachable
{
"error-type": "git_dependencies_not_reachable",
"error-detail": { "dependency-urls": error.dependency_urls }
}
when Dependabot::NotImplemented
{
"error-type": "not_implemented",
"error-detail": {
message: error.message
}
}
when Octokit::ServerError
# If we get a 500 from GitHub there's very little we can do about it,
# and responsibility for fixing it is on them, not us. As a result we
# quietly log these as errors
{ "error-type": "unknown_error" }
else
raise if RUN_HALTING_ERRORS.keys.any? { |e| error.is_a?(e) }

Dependabot.logger.error error.message
error.backtrace.each { |line| Dependabot.logger.error line }

service.capture_exception(error: error, job: job)
{ "error-type": "unknown_error" }
end

service.record_update_job_error(
error_type: error_details.fetch(:"error-type"),
error_details: error_details[:"error-detail"]
)
end
# rubocop:enable Metrics/MethodLength
end
end
# rubocop:enable Metrics/ClassLength
Loading