Class: Pod::CDNSource

Inherits:
Source
  • Object
show all
Includes:
Concurrent
Defined in:
lib/cocoapods-core/cdn_source.rb

Overview

Subclass of Pod::Source to provide support for CDN-based Specs repositories

Direct Known Subclasses

TrunkSource

Constant Summary collapse

MAX_NUMBER_OF_RETRIES = 
(ENV['COCOAPODS_CDN_MAX_NUMBER_OF_RETRIES'] || 5).to_i
HYDRA_EXECUTOR =

Single thread executor for all network activity.

Concurrent::SingleThreadExecutor.new

Constants inherited from Source

Source::DEFAULT_SPECS_BRANCH

Instance Attribute Summary

Attributes inherited from Source

#metadata, #repo

Querying the source collapse

Searching the source collapse

Instance Method Summary collapse

Methods inherited from Source

#<=>, #diff_until_commit_hash, #fuzzy_search, #git_commit_hash, #git_tracking_branch, #inspect, #load_spec_gracefully, #metadata_path, #name, #pod_path, #pods_for_specification_paths, #repo_git, #set, #specification, #to_hash, #to_yaml, #unchanged_github_repo?, #update_git_repo, #verify_compatibility!

Constructor Details

#initialize(repo) ⇒ CDNSource

Returns a new instance of CDNSource.

Parameters:

  • repo (String) —

    The name of the repository



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/cocoapods-core/cdn_source.rb', line 21

def initialize(repo)
  @check_existing_files_for_update = false
  # Optimization: we initialize startup_time when the source is first initialized
  # and then test file modification dates against it. Any file that was touched
  # after the source was initialized, is considered fresh enough.
  @startup_time = Time.new

  @version_arrays_by_fragment_by_name = {}

  super(repo)
end

Instance Method Details

#algolia_search_index ⇒ Object (private) 



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cocoapods-core/cdn_source.rb', line 296

def algolia_search_index
  @index ||= begin
    require 'algoliasearch'

    raise Informative, "Cannot perform full-text search in repo #{name} because it's missing Algolia config" if download_file('AlgoliaSearch.yml').nil?
    algolia_config = YAMLHelper.load_string(local_file('AlgoliaSearch.yml', &:read))

    client = Algolia::Client.new(:application_id => algolia_config['application_id'], :api_key => algolia_config['api_key'])
    Algolia::Index.new(algolia_config['index'], client)
  end
end

#all_specs ⇒ Array<Specification>

Returns all the specifications contained by the source.

Returns:

  • (Array<Specification>) —

    all the specifications contained by the source.

Raises:



177
178
179
 
# File 'lib/cocoapods-core/cdn_source.rb', line 177

def all_specs
  raise Informative, "Can't retrieve all the specs for a CDN-backed source, it will take forever"
end

#backoff_time(retries) ⇒ Object (private) 



429
430
431
432
 
# File 'lib/cocoapods-core/cdn_source.rb', line 429

def backoff_time(retries)
  current_retry = MAX_NUMBER_OF_RETRIES - retries
  4 * 2**current_retry
end

#concurrent_requests_catching_errors ⇒ Object (private) 



478
479
480
481
482
483
484
 
# File 'lib/cocoapods-core/cdn_source.rb', line 478

def concurrent_requests_catching_errors
  yield
rescue MultipleErrors => e
  # aggregated error message from `Concurrent`
  errors = e.errors
  raise Informative, "CDN: #{name} Repo update failed - #{e.errors.size} error(s):\n#{errors.join("\n")}"
end

#debug(message) ⇒ Object (private) 



470
471
472
473
474
475
476
 
# File 'lib/cocoapods-core/cdn_source.rb', line 470

def debug(message)
  if defined?(Pod::UI)
    Pod::UI.message(message)
  else
    CoreUI.puts(message)
  end
end

#deprecated_local_podspecs ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/cocoapods-core/cdn_source.rb', line 77

def deprecated_local_podspecs
  download_file('deprecated_podspecs.txt')
  local_file('deprecated_podspecs.txt', &:to_a).
    map { |f| Pathname.new(f.chomp) }.
    select { |f| repo.join(f).exist? }
end

#download_and_save_with_retries_async(partial_url, file_remote_url, etag, retries = MAX_NUMBER_OF_RETRIES) ⇒ Object (private) 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/cocoapods-core/cdn_source.rb', line 368

def download_and_save_with_retries_async(partial_url, file_remote_url, etag, retries = MAX_NUMBER_OF_RETRIES)
  path = repo + partial_url
  etag_path = path.sub_ext(path.extname + '.etag')

  download_task = download_typhoeus_impl_async(file_remote_url, etag).then do |response|
    case response.response_code
    when 301, 302
      redirect_location = response.headers['location']
      debug "CDN: #{name} Redirecting from #{file_remote_url} to #{redirect_location}"
      download_and_save_with_retries_async(partial_url, redirect_location, etag)
    when 304
      debug "CDN: #{name} Relative path not modified: #{partial_url}"
      # We need to update the file modification date, as it is later used for freshness
      # optimization. See #initialize for more information.
      FileUtils.touch path
      partial_url
    when 200
      File.open(path, 'w') { |f| f.write(response.response_body.force_encoding('UTF-8')) }

      etag_new = response.headers['etag'] unless response.headers.nil?
      debug "CDN: #{name} Relative path downloaded: #{partial_url}, save ETag: #{etag_new}"
      File.open(etag_path, 'w') { |f| f.write(etag_new) } unless etag_new.nil?
      partial_url
    when 404
      debug "CDN: #{name} Relative path couldn't be downloaded: #{partial_url} Response: #{response.response_code}"
      nil
    when 502, 503, 504
      # Retryable HTTP errors, usually related to server overloading
      if retries <= 1
        raise Informative, "CDN: #{name} URL couldn't be downloaded: #{file_remote_url} Response: #{response.response_code} #{response.response_body}"
      else
        debug "CDN: #{name} URL couldn't be downloaded: #{file_remote_url} Response: #{response.response_code} #{response.response_body}, retries: #{retries - 1}"
        exponential_backoff_async(retries).then do
          download_and_save_with_retries_async(partial_url, file_remote_url, etag, retries - 1)
        end
      end
    when 0
      # Non-HTTP errors, usually network layer
      if retries <= 1
        raise Informative, "CDN: #{name} URL couldn't be downloaded: #{file_remote_url} Response: #{response.return_message}"
      else
        debug "CDN: #{name} URL couldn't be downloaded: #{file_remote_url} Response: #{response.return_message}, retries: #{retries - 1}"
        exponential_backoff_async(retries).then do
          download_and_save_with_retries_async(partial_url, file_remote_url, etag, retries - 1)
        end
      end
    else
      raise Informative, "CDN: #{name} URL couldn't be downloaded: #{file_remote_url} Response: #{response.response_code} #{response.response_body}"
    end
  end

  # Calling `Future#run` flattens the chained futures created by retries or redirects
  #
  # Does not, in fact, run the task - that is already happening in Hydra at this point
  download_task.run
end

#download_file(partial_url) ⇒ Object (private) 



334
335
336
337
338
339
 
# File 'lib/cocoapods-core/cdn_source.rb', line 334

def download_file(partial_url)
  # Block the main thread waiting for Hydra to finish
  #
  # Used for single-file downloads
  download_file_async(partial_url).wait!
end

#download_file_async(partial_url) ⇒ Object (private) 



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/cocoapods-core/cdn_source.rb', line 341

def download_file_async(partial_url)
  file_remote_url = Addressable::URI.encode(url + partial_url.to_s)
  path = repo + partial_url

  file_okay = local_file_okay?(partial_url)
  if file_okay
    if @startup_time < File.mtime(path)
      debug "CDN: #{name} Relative path: #{partial_url} modified during this run! Returning local"
      return Promises.fulfilled_future(partial_url, HYDRA_EXECUTOR)
    end

    unless @check_existing_files_for_update
      debug "CDN: #{name} Relative path: #{partial_url} exists! Returning local because checking is only performed in repo update"
      return Promises.fulfilled_future(partial_url, HYDRA_EXECUTOR)
    end
  end

  path.dirname.mkpath

  etag_path = path.sub_ext(path.extname + '.etag')

  etag = File.read(etag_path) if file_okay && File.exist?(etag_path)
  debug "CDN: #{name} Relative path: #{partial_url}, has ETag? #{etag}" unless etag.nil?

  download_and_save_with_retries_async(partial_url, file_remote_url, etag)
end

#download_typhoeus_impl_async(file_remote_url, etag) ⇒ Object (private) 



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/cocoapods-core/cdn_source.rb', line 439

def download_typhoeus_impl_async(file_remote_url, etag)
  require 'typhoeus'

  # Create a prefereably HTTP/2 request - the protocol is ultimately responsible for picking
  # the maximum supported protocol
  # When debugging with proxy, use the following extra options:
  # :proxy => 'http://localhost:8888',
  # :ssl_verifypeer => false,
  # :ssl_verifyhost => 0,
  request = Typhoeus::Request.new(
    file_remote_url,
    :method => :get,
    :http_version => :httpv2_0,
    :timeout => 10,
    :connecttimeout => 10,
    :accept_encoding => 'gzip',
    :netrc => :optional,
    :netrc_file => Netrc.default_path,
    :headers => etag.nil? ? {} : { 'If-None-Match' => etag },
  )

  future = Promises.resolvable_future_on(HYDRA_EXECUTOR)
  queue_request(request)
  request.on_complete do |response|
    future.fulfill(response)
  end

  # This `Future` should never reject, network errors are exposed on `Typhoeus::Response`
  future
end

#ensure_versions_file_loaded(fragment) ⇒ Object (private) 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/cocoapods-core/cdn_source.rb', line 278

def ensure_versions_file_loaded(fragment)
  return if !@version_arrays_by_fragment_by_name[fragment].nil? && !@check_existing_files_for_update

  # Index file that contains all the versions for all the pods in the shard.
  # We use those because you can't get a directory listing from a CDN.
  index_file_name = index_file_name_for_fragment(fragment)
  download_file(index_file_name)
  versions_raw = local_file(index_file_name, &:to_a).map(&:chomp)
  @version_arrays_by_fragment_by_name[fragment] = versions_raw.reduce({}) do |hash, row|
    row = row.split('/')
    pod = row.shift
    versions = row

    hash[pod] = versions
    hash
  end
end

#exponential_backoff_async(retries) ⇒ Object (private) 



425
426
427
 
# File 'lib/cocoapods-core/cdn_source.rb', line 425

def exponential_backoff_async(retries)
  sleep_async(backoff_time(retries))
end

#files_definitely_to_update ⇒ Object 



73
74
75
 
# File 'lib/cocoapods-core/cdn_source.rb', line 73

def files_definitely_to_update
  Pathname.glob(repo.join('**/*.{txt,yml}')).map { |f| f.relative_path_from(repo).to_s }
end

#git? ⇒ Boolean

Returns:

  • (Boolean) 


268
269
270
 
# File 'lib/cocoapods-core/cdn_source.rb', line 268

def git?
  false
end

#index_file_name_for_fragment(fragment) ⇒ Object (private) 



308
309
310
311
312
 
# File 'lib/cocoapods-core/cdn_source.rb', line 308

def index_file_name_for_fragment(fragment)
  fragment_joined = fragment.join('_')
  fragment_joined = '_' + fragment_joined unless fragment.empty?
  "all_pods_versions#{fragment_joined}.txt"
end

#indexable? ⇒ Boolean

Returns:

  • (Boolean) 


272
273
274
 
# File 'lib/cocoapods-core/cdn_source.rb', line 272

def indexable?
  false
end

#local_file(partial_url) ⇒ Object (private) 



323
324
325
326
327
328
 
# File 'lib/cocoapods-core/cdn_source.rb', line 323

def local_file(partial_url)
  file_path = repo.join(partial_url)
  File.open(file_path) do |file|
    yield file if block_given?
  end
end

#local_file_okay?(partial_url) ⇒ Boolean (private)

Returns:

  • (Boolean) 


318
319
320
321
 
# File 'lib/cocoapods-core/cdn_source.rb', line 318

def local_file_okay?(partial_url)
  file_path = repo.join(partial_url)
  File.exist?(file_path) && File.size(file_path) > 0
end

#pod_sets ⇒ Array<Sets>

Returns the sets of all the Pods.

Returns:

  • (Array<Sets>) —

    the sets of all the Pods.

Raises:



183
184
185
 
# File 'lib/cocoapods-core/cdn_source.rb', line 183

def pod_sets
  raise Informative, "Can't retrieve all the pod sets for a CDN-backed source, it will take forever"
end

#pod_shard_fragment(pod_name) ⇒ Object (private) 



314
315
316
 
# File 'lib/cocoapods-core/cdn_source.rb', line 314

def pod_shard_fragment(pod_name)
  metadata.path_fragment(pod_name)[0..-2]
end

#pods ⇒ Array<String>

Returns the list of the name of all the Pods.

Returns:

  • (Array<String>) —

    the list of the name of all the Pods.



95
96
97
98
 
# File 'lib/cocoapods-core/cdn_source.rb', line 95

def pods
  download_file('all_pods.txt')
  local_file('all_pods.txt', &:to_a).map(&:chomp)
end

#preheat_existing_files ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cocoapods-core/cdn_source.rb', line 59

def preheat_existing_files
  files_to_update = files_definitely_to_update + deprecated_local_podspecs - ['deprecated_podspecs.txt']
  debug "CDN: #{name} Going to update #{files_to_update.count} files"

  concurrent_requests_catching_errors do
    # Queue all tasks first
    loaders = files_to_update.map do |file|
      download_file_async(file)
    end
    # Block and wait for all to complete running on Hydra
    Promises.zip_futures_on(HYDRA_EXECUTOR, *loaders).wait!
  end
end

#queue_request(request) ⇒ Object (private) 



486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/cocoapods-core/cdn_source.rb', line 486

def queue_request(request)
  @hydra ||= Typhoeus::Hydra.new

  # Queue the request into the Hydra (libcurl reactor).
  @hydra.queue(request)

  # Cycle the reactor on a separate thread
  #
  # The way it works is that if more requests are queued while Hydra is in the `#run`
  # method, it will keep executing them
  #
  # The upcoming calls to `#run` will simply run empty.
  HYDRA_EXECUTOR.post(@hydra, &:run)
end

#refresh_metadata ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cocoapods-core/cdn_source.rb', line 45

def refresh_metadata
  if metadata.nil?
    unless repo.exist?
      debug "CDN: Repo #{name} does not exist!"
      return
    end

    specs_dir.mkpath
    download_file('CocoaPods-version.yml')
  end

  super
end

#relative_pod_path(pod_name) ⇒ Object (private) 



330
331
332
 
# File 'lib/cocoapods-core/cdn_source.rb', line 330

def relative_pod_path(pod_name)
  pod_path(pod_name).relative_path_from(repo)
end

#search(query) ⇒ Set

TODO:

Rename to #load_set

Note:

This method is optimized for fast lookups by name, i.e. it does not require iterating through #pod_sets

Returns a set for a given dependency. The set is identified by the name of the dependency and takes into account subspecs.

Returns:

  • (Set) —

    a set for a given dependency. The set is identified by the name of the dependency and takes into account subspecs.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/cocoapods-core/cdn_source.rb', line 198

def search(query)
  unless specs_dir
    raise Informative, "Unable to find a source named: `#{name}`"
  end
  if query.is_a?(Dependency)
    query = query.root_name
  end

  fragment = pod_shard_fragment(query)

  ensure_versions_file_loaded(fragment)

  version_arrays_by_name = @version_arrays_by_fragment_by_name[fragment] || {}

  found = version_arrays_by_name[query].nil? ? nil : query

  if found
    set = set(query)
    set if set.specification_name == query
  end
end

#search_by_name(query, full_text_search = false) ⇒ Array<Set>

Note:

full text search requires to load the specification for each pod, and therefore not supported.

Returns The list of the sets that contain the search term.

Parameters:

  • query (String) —

    the search term. Can be a regular expression.

  • full_text_search (Boolean) (defaults to: false) —

    performed using Algolia

Returns:

  • (Array<Set>) —

    The list of the sets that contain the search term.



231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cocoapods-core/cdn_source.rb', line 231

def search_by_name(query, full_text_search = false)
  if full_text_search
    require 'algoliasearch'
    begin
      algolia_result = algolia_search_index.search(query, :attributesToRetrieve => 'name')
      names = algolia_result['hits'].map { |r| r['name'] }
      names.map { |n| set(n) }.reject { |s| s.versions.compact.empty? }
    rescue Algolia::AlgoliaError => e
      raise Informative, "CDN: #{name} - Cannot perform full-text search because Algolia returned an error: #{e}"
    end
  else
    super(query)
  end
end

#sleep_async(seconds) ⇒ Object (private) 



434
435
436
437
 
# File 'lib/cocoapods-core/cdn_source.rb', line 434

def sleep_async(seconds)
  # Async sleep to avoid blocking either the main or the Hydra thread
  Promises.schedule_on(HYDRA_EXECUTOR, seconds)
end

#specification_path(name, version) ⇒ Pathname

Returns the path of the specification with the given name and version.

Parameters:

  • name (String) —

    the name of the Pod.

  • version (Version, String) —

    the version for the specification.

Returns:

  • (Pathname) —

    The path of the specification.

Raises:

  • (ArgumentError) 


160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/cocoapods-core/cdn_source.rb', line 160

def specification_path(name, version)
  raise ArgumentError, 'No name' unless name
  raise ArgumentError, 'No version' unless version
  unless versions(name).include?(Version.new(version))
    raise StandardError, "Unable to find the specification #{name} " \
      "(#{version}) in the #{self.name} source."
  end

  podspec_version_path_relative = Pathname.new(version.to_s).join("#{name}.podspec.json")
  relative_podspec = relative_pod_path(name).join(podspec_version_path_relative).to_s
  download_file(relative_podspec)
  pod_path(name).join(podspec_version_path_relative)
end

#specs_dir ⇒ Pathname

Returns The directory where the specs are stored.

Returns:

  • (Pathname) —

    The directory where the specs are stored.



86
87
88
 
# File 'lib/cocoapods-core/cdn_source.rb', line 86

def specs_dir
  @specs_dir ||= repo + 'Specs'
end

#type ⇒ String

Returns The type of the source.

Returns:

  • (String) —

    The type of the source.



41
42
43
 
# File 'lib/cocoapods-core/cdn_source.rb', line 41

def type
  'CDN'
end

#update(_show_output) ⇒ Array<String>

Check update dates for all existing files. Does not download non-existing specs, since CDN-backed repo is updated live.

Parameters:

  • show_output (Boolean)

Returns:

  • (Array<String>) —

    Always returns empty array, as it cannot know everything that actually changed.



254
255
256
257
258
259
260
261
262
 
# File 'lib/cocoapods-core/cdn_source.rb', line 254

def update(_show_output)
  @check_existing_files_for_update = true
  begin
    preheat_existing_files
  ensure
    @check_existing_files_for_update = false
  end
  []
end

#updateable? ⇒ Boolean

Returns:

  • (Boolean) 


264
265
266
 
# File 'lib/cocoapods-core/cdn_source.rb', line 264

def updateable?
  true
end

#url ⇒ String

Returns The URL of the source.

Returns:

  • (String) —

    The URL of the source.



35
36
37
 
# File 'lib/cocoapods-core/cdn_source.rb', line 35

def url
  @url ||= File.read(repo.join('.url')).chomp.chomp('/') + '/'
end

#versions(name) ⇒ Array<Version>

Returns all the available versions for the Pod, sorted from highest to lowest.

Parameters:

  • name (String) —

    the name of the Pod.

Returns:

  • (Array<Version>) —

    all the available versions for the Pod, sorted from highest to lowest.

Raises:

  • (ArgumentError) 


106
107
108
109
110
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
142
143
144
145
146
147
148
 
# File 'lib/cocoapods-core/cdn_source.rb', line 106

def versions(name)
  return nil unless specs_dir
  raise ArgumentError, 'No name' unless name

  fragment = pod_shard_fragment(name)

  ensure_versions_file_loaded(fragment)

  return @versions_by_name[name] unless @versions_by_name[name].nil?

  pod_path_actual = pod_path(name)
  pod_path_relative = relative_pod_path(name)

  return nil if @version_arrays_by_fragment_by_name[fragment][name].nil?

  concurrent_requests_catching_errors do
    loaders = []

    @versions_by_name[name] ||= @version_arrays_by_fragment_by_name[fragment][name].map do |version|
      # Optimization: ensure all the podspec files at least exist. The correct one will get refreshed
      # in #specification_path regardless.
      podspec_version_path_relative = Pathname.new(version).join("#{name}.podspec.json")

      unless pod_path_actual.join(podspec_version_path_relative).exist?
        # Queue all podspec download tasks first
        loaders << download_file_async(pod_path_relative.join(podspec_version_path_relative).to_s)
      end

      begin
        Version.new(version) if version[0, 1] != '.'
      rescue ArgumentError
        raise Informative, 'An unexpected version directory ' \
        "`#{version}` was encountered for the " \
        "`#{pod_path_actual}` Pod in the `#{name}` repository."
      end
    end.compact.sort.reverse

    # Block and wait for all to complete running on Hydra
    Promises.zip_futures_on(HYDRA_EXECUTOR, *loaders).wait!
  end

  @versions_by_name[name]
end