[rubygems/rubygems] Use file in XDG_STATE_HOME directory to store last update check timestamp.

https://github.com/rubygems/rubygems/commit/0fbc4ace8a
This commit is contained in:
Josef Šimánek 2022-10-29 02:47:14 +02:00 committed by Hiroshi SHIBATA
parent c7d043065c
commit 7ce0f81fbb
Notes: git 2022-11-11 08:24:28 +00:00
5 changed files with 57 additions and 21 deletions

View File

@ -371,16 +371,18 @@ if you believe they were disclosed to a third party.
@backtrace || $DEBUG
end
# Check config file is writable. Creates empty file if not present to ensure we can write to it.
def config_file_writable?
if File.exist?(config_file_name)
File.writable?(config_file_name)
# Check state file is writable. Creates empty file if not present to ensure we can write to it.
def state_file_writable?
if File.exist?(state_file_name)
File.writable?(state_file_name)
else
require "fileutils"
FileUtils.mkdir_p File.dirname(config_file_name)
File.open(config_file_name, "w") {}
FileUtils.mkdir_p File.dirname(state_file_name)
File.open(state_file_name, "w") {}
true
end
rescue Errno::EACCES
false
end
# The name of the configuration file.
@ -388,6 +390,25 @@ if you believe they were disclosed to a third party.
@config_file_name || Gem.config_file
end
# The name of the state file.
def state_file_name
@state_file_name || Gem.state_file
end
# Reads time of last update check from state file
def last_update_check
if File.readable?(state_file_name)
File.read(state_file_name).to_i
else
0
end
end
# Writes time of last update check to state file
def last_update_check=(timestamp)
File.write(state_file_name, timestamp.to_s) if state_file_writable?
end
# Delegates to @hash
def each(&block)
hash = @hash.dup

View File

@ -133,6 +133,13 @@ module Gem
@config_file ||= find_config_file.tap(&Gem::UNTAINT)
end
##
# The path to standard location of the user's state file.
def self.state_file
@state_file ||= File.join(Gem.state_home, "gem", "last_update_check").tap(&Gem::UNTAINT)
end
##
# The path to standard location of the user's cache directory.
@ -147,6 +154,13 @@ module Gem
@data_home ||= (ENV["XDG_DATA_HOME"] || File.join(Gem.user_home, ".local", "share"))
end
##
# The path to standard location of the user's state directory.
def self.state_home
@data_home ||= (ENV["XDG_STATE_HOME"] || File.join(Gem.user_home, ".local", "state"))
end
##
# How String Gem paths should be split. Overridable for esoteric platforms.

View File

@ -41,24 +41,22 @@ Run `gem update --system #{Gem.latest_rubygems_version}` to update your installa
return false if Gem.disable_system_update_message
return false if ci?
# check makes sense only when we can store of last try
# otherwise we will not be able to prevent annoying update message
# check makes sense only when we can store timestamp of last try
# otherwise we will not be able to prevent "annoying" update message
# on each command call
return unless Gem.configuration.config_file_writable?
return unless Gem.configuration.state_file_writable?
# load time of last check, ensure the difference is enough to repeat the suggestion
check_time = Time.now.to_i
last_update_check = Gem.configuration[:last_update_check] || 0
last_update_check = Gem.configuration.last_update_check
return false if (check_time - last_update_check) < ONE_WEEK
# compare current and latest version, this is the part where
# latest rubygems spec is fetched from remote
(Gem.rubygems_version < Gem.latest_rubygems_version).tap do |eglible|
if eglible
# store the time of last successful check into config file
Gem.configuration[:last_update_check] = check_time
Gem.configuration.write
end
if (Gem.rubygems_version < Gem.latest_rubygems_version)
# store the time of last successful check into state file
Gem.configuration.last_update_check = check_time
return true
end
rescue # don't block install command on any problem
false

View File

@ -307,6 +307,7 @@ class Gem::TestCase < Test::Unit::TestCase
ENV["XDG_CACHE_HOME"] = nil
ENV["XDG_CONFIG_HOME"] = nil
ENV["XDG_DATA_HOME"] = nil
ENV["XDG_STATE_HOME"] = nil
ENV["SOURCE_DATE_EPOCH"] = nil
ENV["BUNDLER_VERSION"] = nil
ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = "true"
@ -327,6 +328,7 @@ class Gem::TestCase < Test::Unit::TestCase
@gemhome = File.join @tempdir, "gemhome"
@userhome = File.join @tempdir, "userhome"
@statehome = File.join @tempdir, "statehome"
ENV["GEM_SPEC_CACHE"] = File.join @tempdir, "spec_cache"
@orig_ruby = if ENV["RUBY"]
@ -361,6 +363,7 @@ class Gem::TestCase < Test::Unit::TestCase
Gem.instance_variable_set :@user_home, nil
Gem.instance_variable_set :@config_home, nil
Gem.instance_variable_set :@data_home, nil
Gem.instance_variable_set :@state_home, @statehome
Gem.instance_variable_set :@gemdeps, nil
Gem.instance_variable_set :@env_requirements_by_name, nil
Gem.send :remove_instance_variable, :@ruby_version if

View File

@ -27,7 +27,7 @@ class TestUpdateSuggestion < Gem::TestCase
original_config, Gem.configuration[:prevent_update_suggestion] = Gem.configuration[:prevent_update_suggestion], nil
original_env, ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"], nil
original_disable, Gem.disable_system_update_message = Gem.disable_system_update_message, nil
Gem.configuration[:last_update_check] = nil
Gem.configuration.last_update_check = 0
Gem.ui.stub :tty?, tty do
Gem.stub :rubygems_version, rubygems_version do
@ -61,10 +61,10 @@ class TestUpdateSuggestion < Gem::TestCase
with_eglible_environment(cmd: @cmd) do
Time.stub :now, 123456789 do
assert @cmd.eglible_for_update?
assert_equal Gem.configuration[:last_update_check], 123456789
assert_equal Gem.configuration.last_update_check, 123456789
# test last check is written to config file
assert File.read(Gem.configuration.config_file_name).match("last_update_check: 123456789")
assert File.read(Gem.configuration.state_file_name).match("123456789")
end
end
end
@ -122,7 +122,7 @@ class TestUpdateSuggestion < Gem::TestCase
def test_eglible_for_update_unwrittable_config
with_eglible_environment(ci: true, cmd: @cmd) do
Gem.configuration.stub :config_file_writable?, false do
Gem.configuration.stub :state_file_writable?, false do
refute @cmd.eglible_for_update?
end
end
@ -130,7 +130,7 @@ class TestUpdateSuggestion < Gem::TestCase
def test_eglible_for_update_notification_delay
with_eglible_environment(cmd: @cmd) do
Gem.configuration[:last_update_check] = Time.now.to_i
Gem.configuration.last_update_check = Time.now.to_i
refute @cmd.eglible_for_update?
end
end