Class: Dependabot::Gradle::Package::PackageDetailsFetcher

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Includes:
RepositoryDetailsHelpers
Defined in:
lib/dependabot/gradle/package/package_details_fetcher.rb

Constant Summary collapse

CENTRAL_REPO_URL = 
"https://repo.maven.apache.org/maven2"
KOTLIN_PLUGIN_REPO_PREFIX = 
"org.jetbrains.kotlin"
TYPE_SUFFICES = 
%w(jre android java native_mt agp).freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from RepositoryDetailsHelpers

#auth_headers_value, #string_key_value

Constructor Details

#initialize(dependency:, dependency_files:, credentials:, forbidden_urls:, cooldown_options: nil) ⇒ PackageDetailsFetcher

Returns a new instance of PackageDetailsFetcher.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 84

def initialize(dependency:, dependency_files:, credentials:, forbidden_urls:, cooldown_options: nil)
  @dependency = dependency
  @dependency_files = dependency_files
  @credentials = credentials
  @forbidden_urls = forbidden_urls
  @cooldown_options = T.let(cooldown_options, T.nilable(Dependabot::Package::ReleaseCooldownOptions))
  @repositories = T.let(nil, T.nilable(T::Array[T::Hash[String, Object]]))
  @google_version_details = T.let(nil, T.nilable(Nokogiri::XML::Document))
  @dependency_repository_details = T.let(nil, T.nilable(T::Array[T::Hash[String, Object]]))
  @release_details = T.let(nil, T.nilable(T::Hash[String, T::Hash[Symbol, Object]]))
  @version_release_date_fallback_fetcher = T.let(nil, T.nilable(VersionReleaseDateFallbackFetcher))
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



104
105
106
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 104

def credentials
  @credentials
end

#dependency ⇒ Object (readonly)

Returns the value of attribute dependency.



98
99
100
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 98

def dependency
  @dependency
end

#dependency_files ⇒ Object (readonly)

Returns the value of attribute dependency_files.



101
102
103
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 101

def dependency_files
  @dependency_files
end

#forbidden_urls ⇒ Object (readonly)

Returns the value of attribute forbidden_urls.



107
108
109
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 107

def forbidden_urls
  @forbidden_urls
end

Instance Method Details

#auth_headers(maven_repo_url) ⇒ Object 



474
475
476
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 474

def auth_headers(maven_repo_url)
  auth_headers_finder.auth_headers(maven_repo_url)
end

#auth_headers_finder ⇒ Object 



466
467
468
469
470
471
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 466

def auth_headers_finder
  @auth_headers_finder ||= T.let(
    Dependabot::Maven::Utils::AuthHeadersFinder.new(credentials),
    T.nilable(Dependabot::Maven::Utils::AuthHeadersFinder)
  )
end

#build_release_with_date(release, release_date) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 189

def build_release_with_date(release, release_date)
  Dependabot::Package::PackageRelease.new(
    version: release.version,
    released_at: release_date,
    latest: release.latest,
    yanked: release.yanked,
    yanked_reason: release.yanked_reason,
    downloads: release.downloads,
    url: release.url,
    package_type: release.package_type,
    language: release.language,
    tag: release.tag,
    details: release.details
  )
end

#central_repo_urls ⇒ Object 



452
453
454
455
456
457
458
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 452

def central_repo_urls
  central_url_without_protocol =
    Gradle::FileParser::RepositoriesFinder::CENTRAL_REPO_URL
    .gsub(%r{^.*://}, "")

  %w(http:// https://).map { |p| p + central_url_without_protocol }
end

#check_response(response, repository_url) ⇒ Object 



325
326
327
328
329
330
331
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 325

def check_response(response, repository_url)
  return unless response.status == 401 || response.status == 403
  return if T.must(@forbidden_urls).include?(repository_url)
  return if central_repo_urls.include?(repository_url)

  T.must(@forbidden_urls) << repository_url
end

#credentials_repository_details ⇒ Object 



334
335
336
337
338
339
340
341
342
343
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 334

def credentials_repository_details
  credentials
    .select { |cred| cred["type"] == "maven_repository" }
    .map do |cred|
    {
      "url" => cred.fetch("url").gsub(%r{/+$}, ""),
      "auth_headers" => auth_headers(cred.fetch("url").gsub(%r{/+$}, ""))
    }
  end
end

#dependency_metadata(repository_details) ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 274

def dependency_metadata(repository_details)
  @dependency_metadata ||= T.let({}, T.nilable(T::Hash[Integer, Nokogiri::XML::Document]))
  @dependency_metadata[repository_details.hash] ||=
    begin
      repository_url = string_key_value(repository_details, "url")
      response = EofRetry.get(
        url: dependency_metadata_url(repository_url),
        headers: auth_headers_value(repository_details)
      )

      check_response(response, repository_url)
      Nokogiri::XML(response.body)
    rescue URI::InvalidURIError
      Nokogiri::XML("")
    rescue Excon::Error::Socket, Excon::Error::Timeout,
           Excon::Error::TooManyRedirects
      raise if central_repo_urls.include?(repository_details["url"])

      Nokogiri::XML("")
    end
end

#dependency_metadata_url(repository_url) ⇒ Object 



404
405
406
407
408
409
410
411
412
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 404

def dependency_metadata_url(repository_url)
  group_id, artifact_id = group_and_artifact_ids
  group_id = "#{Dependabot::Gradle::MetadataFinder::KOTLIN_PLUGIN_REPO_PREFIX}.#{group_id}" if kotlin_plugin?

  "#{repository_url}/" \
    "#{T.must(group_id).tr('.', '/')}/" \
    "#{artifact_id}/" \
    "maven-metadata.xml"
end

#dependency_repository_details ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 346

def dependency_repository_details
  requirement_files =
    dependency.requirements
              .map { |r| r.fetch(:file) }
              .map { |nm| dependency_files.find { |f| f.name == nm } }

  @dependency_repository_details ||=
    requirement_files.flat_map do |target_file|
      Gradle::FileParser::RepositoriesFinder.new(
        dependency_files: dependency_files,
        target_dependency_file: target_file,
        credentials: credentials
      ).repository_urls
                                            .map do |url|
        { "url" => url, "auth_headers" => auth_headers(url) }
      end
    end.uniq
end

#distribution? ⇒ Boolean

Returns:

  • (Boolean) 


437
438
439
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 437

def distribution?
  Distributions.distribution_requirements?(dependency.requirements)
end

#distribution_repository_details ⇒ Object 



372
373
374
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 372

def distribution_repository_details
  [{ "url" => Gradle::Distributions::DISTRIBUTION_REPOSITORY_URL, "auth_headers" => {} }]
end

#distribution_version_details ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 226

def distribution_version_details
  DistributionsFetcher.available_versions.map do |info|
    build_time = info[:build_time]
    release_date = begin
      Time.parse(build_time) if build_time.is_a?(String)
    rescue StandardError
      nil
    end

    {
      version: info[:version],
      released_at: release_date,
      source_url: Distributions::DISTRIBUTION_REPOSITORY_URL
    }
  end
rescue StandardError
  nil
end

#fetch_available_versions ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 111

def fetch_available_versions
  package_releases = T.let([], T::Array[T::Hash[Symbol, Object]])
  version_details =
    repositories.map do |repository_details|
      url = repository_details.fetch("url")
      next distribution_version_details if url == Gradle::Distributions::DISTRIBUTION_REPOSITORY_URL
      next google_version_details if url == Gradle::FileParser::RepositoriesFinder::GOOGLE_MAVEN_REPO

      dependency_metadata(repository_details).css("versions > version")
                                             .select { |node| version_class.correct?(node.content) }
                                             .map { |node| version_class.new(node.content) }
                                             .map do |version|
        { version: version, source_url: url }
      end
    end.flatten.compact

  version_details = version_details.sort_by { |details| details.fetch(:version) }
  release_date_info = @cooldown_options ? release_details : {}
  version_details.each do |info|
    package_releases << {
      version: Gradle::Version.new(info[:version].to_s),
      released_at: info[:released_at] || release_date_info[info[:version].to_s]&.fetch(:release_date),
      source_url: info[:source_url]
    }
  end
  if version_details.none? && T.must(forbidden_urls).any?
    raise PrivateSourceAuthenticationFailure, T.must(forbidden_urls).first
  end

  package_releases
end

#fetch_release_metadata(release:) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 145

def fetch_release_metadata(release:)
  return release if release.released_at

  release_date = release_details[release.version.to_s]&.fetch(:release_date, nil)
  release_date = nil unless release_date.is_a?(Time)
  hydrated_release = build_release_with_date(release, release_date)

  return hydrated_release if hydrated_release.released_at || !plugin?

  build_release_with_date(hydrated_release, version_release_date_fallback(release.version.to_s))
end

#google_version_details ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 246

def google_version_details
  url = Gradle::FileParser::RepositoriesFinder::GOOGLE_MAVEN_REPO
  group_id, artifact_id = group_and_artifact_ids

  dependency_metadata_url = "#{Gradle::FileParser::RepositoriesFinder::GOOGLE_MAVEN_REPO}/" \
                            "#{T.must(group_id).tr('.', '/')}/" \
                            "group-index.xml"

  @google_version_details ||=
    begin
      response = Dependabot::RegistryClient.get(url: dependency_metadata_url)
      Nokogiri::XML(response.body)
    end

  xpath = "/#{group_id}/#{artifact_id}"
  return unless @google_version_details.at_xpath(xpath)

  @google_version_details.at_xpath(xpath)
                         .attributes.fetch("versions")
                         .value.split(",")
                         .select { |v| version_class.correct?(v) }
                         .map { |v| version_class.new(v) }
                         .map { |version| { version: version, source_url: url } }
rescue Nokogiri::XML::XPath::SyntaxError
  nil
end

#group_and_artifact_ids ⇒ Object 



415
416
417
418
419
420
421
422
423
424
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 415

def group_and_artifact_ids
  if kotlin_plugin?
    [dependency.name,
     "#{Dependabot::Gradle::MetadataFinder::KOTLIN_PLUGIN_REPO_PREFIX}.#{dependency.name}.gradle.plugin"]
  elsif plugin?
    [dependency.name, "#{dependency.name}.gradle.plugin"]
  else
    dependency.name.split(":")
  end
end

#kotlin_plugin? ⇒ Boolean

Returns:

  • (Boolean) 


432
433
434
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 432

def kotlin_plugin?
  plugin? && dependency.requirements.any? { |r| r.fetch(:groups).include? "kotlin" }
end

#matches_dependency_version_type?(comparison_version) ⇒ Boolean

Returns:

  • (Boolean) 


377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 377

def matches_dependency_version_type?(comparison_version)
  return true unless dependency.version

  current_type = T.must(dependency.version)
                  .gsub("native-mt", "native_mt")
                  .split(/[.\-]/)
                  .find do |type|
    Dependabot::Gradle::UpdateChecker::VersionFinder::TYPE_SUFFICES.find { |s| type.include?(s) }
  end

  version_type = comparison_version.to_s
                                   .gsub("native-mt", "native_mt")
                                   .split(/[.\-]/)
                                   .find do |type|
    Dependabot::Gradle::UpdateChecker::VersionFinder::TYPE_SUFFICES.find { |s| type.include?(s) }
  end

  current_type == version_type
end

#plugin? ⇒ Boolean

Returns:

  • (Boolean) 


427
428
429
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 427

def plugin?
  dependency.requirements.any? { |r| r.fetch(:groups).include? "plugins" }
end

#plugin_repository_details ⇒ Object 



366
367
368
369
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 366

def plugin_repository_details
  [{ "url" => Gradle::FileParser::RepositoriesFinder::GRADLE_PLUGINS_REPO, "auth_headers" => {} }] +
    dependency_repository_details
end

#plugin_version_pom_url(repository_url, version) ⇒ Object 



175
176
177
178
179
180
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 175

def plugin_version_pom_url(repository_url, version)
  group_id, artifact_id = group_and_artifact_ids
  group_id = "#{Dependabot::Gradle::MetadataFinder::KOTLIN_PLUGIN_REPO_PREFIX}.#{group_id}" if kotlin_plugin?
  pom_filename = "#{artifact_id}-#{version}.pom"
  File.join(repository_url, T.must(group_id).tr(".", "/"), artifact_id, version, pom_filename)
end

#pom ⇒ Object 



398
399
400
401
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 398

def pom
  filename = T.must(dependency.requirements.first).fetch(:file)
  dependency_files.find { |f| f.name == filename }
end

#release_details ⇒ Object 



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 158

def release_details
  @release_details ||= begin
    extractor = ReleaseDateExtractor.new(dependency_name: dependency.name, version_class: version_class)
    extractor.extract(
      repositories: repositories,
      dependency_metadata_fetcher: ->(repo) { dependency_metadata(repo) },
      release_info_metadata_fetcher: ->(repo) { release_info_metadata(repo) }
    )
  end
end

#release_info_metadata(repository_details) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 297

def release_info_metadata(repository_details)
  @release_info_metadata ||= T.let({}, T.nilable(T::Hash[Integer, Nokogiri::HTML::Document]))
  @release_info_metadata[repository_details.hash] ||=
    begin
      repository_url = string_key_value(repository_details, "url")
      response = EofRetry.get(
        url: dependency_metadata_url(repository_url).gsub("maven-metadata.xml", ""),
        headers: auth_headers_value(repository_details)
      )

      check_response(response, repository_url)
      Nokogiri::HTML(response.body)
    rescue URI::InvalidURIError
      Nokogiri::HTML("")
    rescue Excon::Error::Socket, Excon::Error::Timeout,
           Excon::Error::TooManyRedirects
      raise if central_repo_urls.include?(repository_details["url"])

      Nokogiri::HTML("")
    end
end

#repositories ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 206

def repositories
  return @repositories if @repositories

  details = if distribution?
              distribution_repository_details
            elsif plugin?
              plugin_repository_details + credentials_repository_details
            else
              dependency_repository_details + credentials_repository_details
            end

  @repositories =
    details.reject do |repo|
      next if repo["auth_headers"]

      details.any? { |r| r["url"] == repo["url"] && r["auth_headers"] != {} }
    end
end

#repository_urls ⇒ Object 



320
321
322
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 320

def repository_urls
  plugin? ? plugin_repository_details : dependency_repository_details
end

#version_class ⇒ Object 



461
462
463
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 461

def version_class
  dependency.version_class
end

#version_release_date_fallback(version) ⇒ Object 



170
171
172
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 170

def version_release_date_fallback(version)
  version_release_date_fallback_fetcher.fetch(version)
end

#version_release_date_fallback_fetcher ⇒ Object 



442
443
444
445
446
447
448
449
 
# File 'lib/dependabot/gradle/package/package_details_fetcher.rb', line 442

def version_release_date_fallback_fetcher
  @version_release_date_fallback_fetcher ||= VersionReleaseDateFallbackFetcher.new(
    dependency_name: dependency.name,
    repositories: repositories,
    forbidden_urls: T.must(forbidden_urls),
    pom_url_builder: ->(repository_url, version) { plugin_version_pom_url(repository_url, version) }
  )
end