Skip to content

Revert "Add more helpful error messaging when a vulnerable dependency cannot be upgraded" #5613

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
Nishnha merged 1 commit into from
Sep 1, 2022
Merged

Revert "Add more helpful error messaging when a vulnerable dependency cannot be upgraded" #5613

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
8 changes: 1 addition & 7 deletions npm_and_yarn/lib/dependabot/npm_and_yarn/update_checker.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,19 +96,13 @@ def requirements_update_strategy
end

def conflicting_dependencies
conflicts = ConflictingDependencyResolver.new(
ConflictingDependencyResolver.new(
dependency_files: dependency_files,
credentials: credentials
).conflicting_dependencies(
dependency: dependency,
target_version: lowest_security_fix_version
)

vulnerable = vulnerability_audit.select do |v|
!v["fix_available"] && v["explanation"]
end

conflicts + vulnerable
end

private
Expand Down
23 changes: 3 additions & 20 deletions npm_and_yarn/lib/dependabot/npm_and_yarn/update_checker/vulnerability_auditor.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ def initialize(dependency_files:, credentials:, allow_removal: false)
@allow_removal = allow_removal
end

# rubocop:disable Metrics/MethodLength
# Finds any dependencies in the `package-lock.json` or `npm-shrinkwrap.json` that have
# a subdependency on the given dependency that is locked to a vuln version range.
#
Expand All @@ -42,7 +41,6 @@ def initialize(dependency_files:, credentials:, allow_removal: false)
# dependency on the blocking dependency
# * :top_level_ancestors [Array<String>] the names of all top-level dependencies with a transitive
# dependency on the dependency
# * :explanation [String] an explanation for why the project failed the vulnerability auditor run
def audit(dependency:, security_advisories:)
fix_unavailable = {
"dependency_name" => dependency.name,
Expand Down Expand Up @@ -76,36 +74,21 @@ def audit(dependency:, security_advisories:)
function: "npm:vulnerabilityAuditor",
args: [Dir.pwd, vuln_versions]
)

validation_result = validate_audit_result(audit_result, security_advisories)
unless viable_audit_result?(validation_result)
fix_unavailable["explanation"] = explain_fix_unavailable(validation_result, dependency)
return fix_unavailable
end
return fix_unavailable unless viable_audit_result?(audit_result, security_advisories)

audit_result
end
rescue SharedHelpers::HelperSubprocessFailed => e
log_helper_subprocess_failure(dependency, e)
fix_unavailable
end
# rubocop:enable Metrics/MethodLength

private

attr_reader :dependency_files, :credentials

def explain_fix_unavailable(validation_result, dependency)
case validation_result
when :fix_unavailable, :dependency_still_vulnerable, :downgrades_dependencies
"No patched version available for #{dependency.name}"
when :vulnerable_dependency_removed
"#{dependency.name} was removed in the update. Dependabot is not able to " \
"deal with this yet, but you can still upgrade manually."
end
end

def viable_audit_result?(validation_result)
def viable_audit_result?(audit_result, security_advisories)
validation_result = validate_audit_result(audit_result, security_advisories)
return true if validation_result == :viable

Dependabot.logger.info("VulnerabilityAuditor: audit result not viable: #{validation_result}")
Expand Down
16 changes: 3 additions & 13 deletions npm_and_yarn/spec/dependabot/npm_and_yarn/update_checker/vulnerability_auditor_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,7 @@

expect(Dependabot.logger).to receive(:info).with(/audit result not viable: vulnerable_dependency_removed/i)
expect(subject.audit(dependency: dependency, security_advisories: security_advisories)).
to include(
"fix_available" => false,
"explanation" => "#{dependency.name} was removed in the update. "\
"Dependabot is not able to deal with this yet, but you can still upgrade manually."
)
to include("fix_available" => false)
end
end
end
Expand All @@ -141,10 +137,7 @@

expect(Dependabot.logger).to receive(:info).with(/audit result not viable: dependency_still_vulnerable/i)
expect(subject.audit(dependency: dependency, security_advisories: security_advisories)).
to include(
"fix_available" => false,
"explanation" => "No patched version available for #{dependency.name}"
)
to include("fix_available" => false)
end
end

Expand Down Expand Up @@ -179,10 +172,7 @@

expect(Dependabot.logger).to receive(:info).with(/audit result not viable: downgrades_dependencies/i)
expect(subject.audit(dependency: dependency, security_advisories: security_advisories)).
to include(
"fix_available" => false,
"explanation" => "No patched version available for #{dependency.name}"
)
to include("fix_available" => false)
end
end

Expand Down