class Bootsnap::LoadPathCache::Store

Constants

CURRENT_VERSION
NestedTransactionError
SetOutsideTransactionNotAllowed
VERSION_KEY

Public Class Methods

new(store_path) click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 15
def initialize(store_path)
  @store_path = store_path
  @txn_mutex = Mutex.new
  @dirty = false
  load_data
end

Public Instance Methods

fetch(key) { || ... } click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 26
def fetch(key)
  raise(SetOutsideTransactionNotAllowed) unless @txn_mutex.owned?

  v = get(key)
  unless v
    @dirty = true
    v = yield
    @data[key] = v
  end
  v
end
get(key) click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 22
def get(key)
  @data[key]
end
set(key, value) click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 38
def set(key, value)
  raise(SetOutsideTransactionNotAllowed) unless @txn_mutex.owned?

  if value != @data[key]
    @dirty = true
    @data[key] = value
  end
end
transaction() { || ... } click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 47
def transaction
  raise(NestedTransactionError) if @txn_mutex.owned?

  @txn_mutex.synchronize do
    begin
      yield
    ensure
      commit_transaction
    end
  end
end

Private Instance Methods

commit_transaction() click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 61
def commit_transaction
  if @dirty
    dump_data
    @dirty = false
  end
end
default_data() click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 109
def default_data
  {VERSION_KEY => CURRENT_VERSION}
end
dump_data() click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 90
def dump_data
  require "fileutils" unless defined? FileUtils

  # Change contents atomically so other processes can't get invalid
  # caches if they read at an inopportune time.
  tmp = "#{@store_path}.#{Process.pid}.#{(rand * 100_000).to_i}.tmp"
  FileUtils.mkpath(File.dirname(tmp))
  exclusive_write = File::Constants::CREAT | File::Constants::EXCL | File::Constants::WRONLY
  # `encoding:` looks redundant wrt `binwrite`, but necessary on windows
  # because binary is part of mode.
  File.open(tmp, mode: exclusive_write, encoding: Encoding::BINARY) do |io|
    MessagePack.dump(@data, io, freeze: true)
  end
  FileUtils.mv(tmp, @store_path)
rescue Errno::EEXIST
  retry
rescue SystemCallError
end
load_data() click to toggle source
# File lib/bootsnap/load_path_cache/store.rb, line 68
def load_data
  @data = begin
    data = File.open(@store_path, encoding: Encoding::BINARY) do |io|
      MessagePack.load(io)
    end
    if data.is_a?(Hash) && data[VERSION_KEY] == CURRENT_VERSION
      data
    else
      default_data
    end
  # handle malformed data due to upgrade incompatibility
  rescue Errno::ENOENT, MessagePack::MalformedFormatError, MessagePack::UnknownExtTypeError, EOFError
    default_data
  rescue ArgumentError => error
    if error.message =~ /negative array size/
      default_data
    else
      raise
    end
  end
end