Class: FastlaneCore::UpdateChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane_core/update_checker/update_checker.rb

Overview

Verifies, the user runs the latest version of this gem

Constant Summary collapse

UPDATE_URL =

This web service is fully open source: github.com/fastlane/refresher

"https://fastlane-refresher.herokuapp.com/"

Class Method Summary collapse

Class Method Details

.fetch_latest(url) ⇒ Object 



76
77
78
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 76

def self.fetch_latest(url)
  JSON.parse(Excon.post(url).body).fetch("version", nil)
end

.finished_running(gem_name) ⇒ Object 



80
81
82
83
84
85
86
87
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 80

def self.finished_running(gem_name)
  time = (Time.now - @start_time).to_i

  url = UPDATE_URL + "time/#{gem_name}"
  url += "?time=#{time}"
  url += "&ci=1" if Helper.is_ci?
  Excon.post(url)
end

.generate_fetch_url(gem_name) ⇒ Object

Generate the URL on the main thread (since we’re switching directory)



67
68
69
70
71
72
73
74
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 67

def self.generate_fetch_url(gem_name)
  url = UPDATE_URL + gem_name
  params = {}
  params["ci"] = "1" if Helper.is_ci?
  params["p_hash"] = p_hash if p_hash
  url += "?" + URI.encode_www_form(params) if params.count > 0
  return url
end

.p_hash ⇒ Object

To not count the same projects multiple time for the number of launches More information: github.com/fastlane/refresher Use the ‘FASTLANE_OPT_OUT_USAGE` variable to opt out The resulting value is e.g. ce12f8371df11ef6097a83bdf2303e4357d6f5040acc4f76019489fa5deeae0d



93
94
95
96
97
98
99
100
101
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 93

def self.p_hash
  return nil if ENV["FASTLANE_OPT_OUT_USAGE"]
  require 'credentials_manager'
  value = CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)
  return Digest::SHA256.hexdigest("p" + value + "fastlan3_SAlt") if value # hashed + salted the bundle identifier
  return nil
rescue
  return nil
end

.server_results ⇒ Object 



27
28
29
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 27

def self.server_results
  @@results ||= {}
end

.show_update_message(gem_name, current_version) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 50

def self.show_update_message(gem_name, current_version)
  available = server_results[gem_name]
  puts ""
  puts '#######################################################################'.green
  puts "# #{gem_name} #{available} is available. You are on #{current_version}.".green
  puts "# It is recommended to use the latest version.".green
  puts "# Update using 'sudo gem update #{gem_name.downcase}'.".green
  puts "# To see what's new, open https://github.com/fastlane/#{gem_name}/releases.".green if ENV["FASTLANE_HIDE_CHANGELOG"]
  if Random.rand(5) == 1
    puts '#######################################################################'.green
    puts "# Run `sudo gem cleanup` from time to time to speed up fastlane".green
  end
  puts '#######################################################################'.green
  Changelog.show_changes(gem_name, current_version) unless ENV["FASTLANE_HIDE_CHANGELOG"]
end

.show_update_status(gem_name, current_version) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 36

def self.show_update_status(gem_name, current_version)
  fork do
    begin
      finished_running(gem_name)
    rescue
      # we don't want to show a stack trace if something goes wrong
    end
  end

  if update_available?(gem_name, current_version)
    show_update_message(gem_name, current_version)
  end
end

.start_looking_for_update(gem_name) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 12

def self.start_looking_for_update(gem_name)
  return if Helper.is_test?
  return if ENV["FASTLANE_SKIP_UPDATE_CHECK"]

  @start_time = Time.now

  url = generate_fetch_url(gem_name)
  Thread.new do
    begin
      server_results[gem_name] = fetch_latest(url)
    rescue
    end
  end
end

.update_available?(gem_name, current_version) ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
34
 
# File 'lib/fastlane_core/update_checker/update_checker.rb', line 31

def self.update_available?(gem_name, current_version)
  latest = server_results[gem_name]
  return (latest and Gem::Version.new(latest) > Gem::Version.new(current_version))
end