Skip to content

fix calling npm.org when there's no npmrc with replaces-base #5928

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
jakecoffman merged 2 commits into from
Oct 21, 2022
Merged

fix calling npm.org when there's no npmrc with replaces-base #5928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74ee793
fix calling npm.org when there's no npmrc with replaces-base
jakecoffman Oct 19, 2022
9d53bfe
Merge branch 'main' into jakecoffman/npm-library-no-npmrc
jakecoffman Oct 21, 2022
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: 6 additions & 2 deletions npm_and_yarn/lib/dependabot/npm_and_yarn/file_updater/npmrc_builder.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ def build_npmrc_content_from_lockfile
return unless yarn_lock || package_lock
return unless global_registry

"registry = https://#{global_registry['registry']}\n" \
registry = global_registry["registry"]
registry = "https://#{registry}" unless registry.start_with?("http")
"registry = #{registry}\n" \
"#{global_registry_auth_line}" \
"always-auth = true"
end
Expand Down Expand Up @@ -113,8 +115,10 @@ def complete_npmrc_from_credentials
return initial_content unless yarn_lock || package_lock
return initial_content unless global_registry

registry = global_registry["registry"]
registry = "https://#{registry}" unless registry.start_with?("http")
initial_content +
"registry = https://#{global_registry['registry']}\n" \
"registry = #{registry}\n" \
"#{global_registry_auth_line}" \
"always-auth = true\n"
end
Expand Down
25 changes: 21 additions & 4 deletions npm_and_yarn/lib/dependabot/npm_and_yarn/update_checker/registry_finder.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,10 @@ def registry_from_rc(dependency_name)
def first_registry_with_dependency_details
@first_registry_with_dependency_details ||=
known_registries.find do |details|
url = "#{details['registry'].gsub(%r{/+$}, '')}/#{escaped_dependency_name}"
url = "https://#{url}" unless url.start_with?("http")
response = Dependabot::RegistryClient.get(
url: "https://#{details['registry'].gsub(%r{/+$}, '')}/#{escaped_dependency_name}",
url: url,
headers: auth_header_for(details["token"])
)
response.status < 400 && JSON.parse(response.body)
Expand All @@ -80,6 +82,8 @@ def first_registry_with_dependency_details
end

def registry_url
return registry if registry.start_with?("http")

protocol =
if registry_source_url
registry_source_url.split("://").first
Expand Down Expand Up @@ -202,23 +206,36 @@ def unique_registries(registries)
end
end

# rubocop:disable Metrics/PerceivedComplexity
def global_registry
return @global_registry if defined? @global_registry

npmrc_file&.content.to_s.scan(NPM_GLOBAL_REGISTRY_REGEX) do
next if Regexp.last_match[:registry].include?("${")

return Regexp.last_match[:registry].strip
return @global_registry = Regexp.last_match[:registry].strip
end

yarnrc_file&.content.to_s.scan(YARN_GLOBAL_REGISTRY_REGEX) do
next if Regexp.last_match[:registry].include?("${")

return Regexp.last_match[:registry].strip
return @global_registry = Regexp.last_match[:registry].strip
end

return parsed_yarnrc_yml["npmRegistryServer"] if parsed_yarnrc_yml&.key?("npmRegistryServer")
if parsed_yarnrc_yml&.key?("npmRegistryServer")
return @global_registry = parsed_yarnrc_yml["npmRegistryServer"]
end

replaces_base = credentials.find { |cred| cred["type"] == "npm_registry" && cred["replaces-base"] == true }
if replaces_base
registry = replaces_base["registry"]
registry = "https://#{registry}" unless registry.start_with?("http")
return @global_registry = registry
end

"https://registry.npmjs.org"
end
# rubocop:enable Metrics/PerceivedComplexity

def scoped_registry(scope)
npmrc_file&.content.to_s.scan(NPM_SCOPED_REGISTRY_REGEX) do
Expand Down
16 changes: 14 additions & 2 deletions npm_and_yarn/spec/dependabot/npm_and_yarn/update_checker/registry_finder_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,18 @@

it { is_expected.to eq("https://registry.npmjs.org") }

context "with no rc and with credentials" do
let(:credentials) do
[{
"type" => "npm_registry",
"registry" => "http://example.com",
"replaces-base" => true
}]
end

it { is_expected.to eq("http://example.com") }
Copy link
Copy Markdown
Contributor

@mctofu mctofu Oct 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense to preserve the protocol but it currently will have limited use. On dotcom/ghes:

  • the protocol is stripped on the backend
  • the proxy won't attach credentials to http requests

Copy link
Copy Markdown
Member Author

@jakecoffman jakecoffman Oct 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that's too bad. It will be there if we need it.

end

context "with a global npm registry" do
let(:npmrc_file) { Dependabot::DependencyFile.new(name: ".npmrc", content: "registry=http://example.com") }

Expand Down Expand Up @@ -122,7 +134,7 @@
"password" => "token"
}, {
"type" => "npm_registry",
"registry" => "npm.fury.io/dependabot",
"registry" => "https://npm.fury.io/dependabot",
"token" => "secret_token"
}]
end
Expand All @@ -145,7 +157,7 @@
to_return(status: 200, body: body)
end

it { is_expected.to eq("npm.fury.io/dependabot") }
it { is_expected.to eq("https://npm.fury.io/dependabot") }

context "but returns HTML" do
before do
Expand Down