bootsnap 1.7.2 → 1.11.1

data/lib/bootsnap/load_path_cache/change_observer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bootsnap
   module LoadPathCache
     module ChangeObserver
@@ -15,11 +16,13 @@ module Bootsnap
           @lpc_observer.push_paths(self, *entries.map(&:to_s))
           super
         end
+        alias_method :append, :push
 
         def unshift(*entries)
           @lpc_observer.unshift_paths(self, *entries.map(&:to_s))
           super
         end
+        alias_method :prepend, :unshift
 
         def concat(entries)
           @lpc_observer.push_paths(self, *entries.map(&:to_s))
@@ -55,6 +58,7 @@ module Bootsnap
 
       def self.register(observer, arr)
         return if arr.frozen? # can't register observer, but no need to.
+
         arr.instance_variable_set(:@lpc_observer, observer)
         arr.extend(ArrayMixin)
       end

data/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb

@@ -1,79 +1,43 @@
 # frozen_string_literal: true
-module Bootsnap
-  module LoadPathCache
-    module CoreExt
-      def self.make_load_error(path)
-        err = LoadError.new(+"cannot load such file -- #{path}")
-        err.instance_variable_set(Bootsnap::LoadPathCache::ERROR_TAG_IVAR, true)
-        err.define_singleton_method(:path) { path }
-        err
-      end
-    end
-  end
-end
 
 module Kernel
-  module_function # rubocop:disable Style/ModuleFunction
+  module_function
 
   alias_method(:require_without_bootsnap, :require)
 
-  # Note that require registers to $LOADED_FEATURES while load does not.
-  def require_with_bootsnap_lfi(path, resolved = nil)
-    Bootsnap::LoadPathCache.loaded_features_index.register(path, resolved) do
-      require_without_bootsnap(resolved || path)
-    end
-  end
-
   def require(path)
-    return false if Bootsnap::LoadPathCache.loaded_features_index.key?(path)
-
-    if (resolved = Bootsnap::LoadPathCache.load_path_cache.find(path))
-      return require_with_bootsnap_lfi(path, resolved)
-    end
+    string_path = Bootsnap.rb_get_path(path)
+    return false if Bootsnap::LoadPathCache.loaded_features_index.key?(string_path)
 
-    raise(Bootsnap::LoadPathCache::CoreExt.make_load_error(path))
-  rescue LoadError => e
-    e.instance_variable_set(Bootsnap::LoadPathCache::ERROR_TAG_IVAR, true)
-    raise(e)
-  rescue Bootsnap::LoadPathCache::ReturnFalse
-    false
-  rescue Bootsnap::LoadPathCache::FallbackScan
-    fallback = true
-  ensure
-    if fallback
-      require_with_bootsnap_lfi(path)
+    resolved = Bootsnap::LoadPathCache.load_path_cache.find(string_path)
+    if Bootsnap::LoadPathCache::FALLBACK_SCAN.equal?(resolved)
+      if (cursor = Bootsnap::LoadPathCache.loaded_features_index.cursor(string_path))
+        ret = require_without_bootsnap(path)
+        resolved = Bootsnap::LoadPathCache.loaded_features_index.identify(string_path, cursor)
+        Bootsnap::LoadPathCache.loaded_features_index.register(string_path, resolved)
+        return ret
+      else
+        return require_without_bootsnap(path)
+      end
+    elsif false == resolved
+      return false
+    elsif resolved.nil?
+      error = LoadError.new(+"cannot load such file -- #{path}")
+      error.instance_variable_set(:@path, path)
+      raise error
+    else
+      # Note that require registers to $LOADED_FEATURES while load does not.
+      ret = require_without_bootsnap(resolved)
+      Bootsnap::LoadPathCache.loaded_features_index.register(string_path, resolved)
+      return ret
     end
   end
 
-  alias_method(:require_relative_without_bootsnap, :require_relative)
-  def require_relative(path)
-    realpath = Bootsnap::LoadPathCache.realpath_cache.call(
-      caller_locations(1..1).first.absolute_path, path
-    )
-    require(realpath)
-  end
-
   alias_method(:load_without_bootsnap, :load)
   def load(path, wrap = false)
-    if (resolved = Bootsnap::LoadPathCache.load_path_cache.find(path))
-      return load_without_bootsnap(resolved, wrap)
-    end
-
-    # load also allows relative paths from pwd even when not in $:
-    if File.exist?(relative = File.expand_path(path).freeze)
-      return load_without_bootsnap(relative, wrap)
-    end
-
-    raise(Bootsnap::LoadPathCache::CoreExt.make_load_error(path))
-  rescue LoadError => e
-    e.instance_variable_set(Bootsnap::LoadPathCache::ERROR_TAG_IVAR, true)
-    raise(e)
-  rescue Bootsnap::LoadPathCache::ReturnFalse
-    false
-  rescue Bootsnap::LoadPathCache::FallbackScan
-    fallback = true
-  ensure
-    if fallback
+    if (resolved = Bootsnap::LoadPathCache.load_path_cache.find(Bootsnap.rb_get_path(path), try_extensions: false))
+      load_without_bootsnap(resolved, wrap)
+    else
       load_without_bootsnap(path, wrap)
     end
   end
@@ -89,17 +53,13 @@ class Module
     # The challenge is that we don't control the point at which the entry gets
     # added to $LOADED_FEATURES and won't be able to hook that modification
     # since it's done in C-land.
-    autoload_without_bootsnap(const, Bootsnap::LoadPathCache.load_path_cache.find(path) || path)
-  rescue LoadError => e
-    e.instance_variable_set(Bootsnap::LoadPathCache::ERROR_TAG_IVAR, true)
-    raise(e)
-  rescue Bootsnap::LoadPathCache::ReturnFalse
-    false
-  rescue Bootsnap::LoadPathCache::FallbackScan
-    fallback = true
-  ensure
-    if fallback
+    resolved = Bootsnap::LoadPathCache.load_path_cache.find(Bootsnap.rb_get_path(path))
+    if Bootsnap::LoadPathCache::FALLBACK_SCAN.equal?(resolved)
       autoload_without_bootsnap(const, path)
+    elsif resolved == false
+      return false
+    else
+      autoload_without_bootsnap(const, resolved || path)
     end
   end
 end

data/lib/bootsnap/load_path_cache/core_ext/loaded_features.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class << $LOADED_FEATURES
   alias_method(:delete_without_bootsnap, :delete)
   def delete(key)

data/lib/bootsnap/load_path_cache/loaded_features_index.rb

@@ -29,14 +29,15 @@ module Bootsnap
         @mutex = Mutex.new
 
         # In theory the user could mutate $LOADED_FEATURES and invalidate our
-        # cache. If this ever comes up in practice — or if you, the
-        # enterprising reader, feels inclined to solve this problem — we could
+        # cache. If this ever comes up in practice - or if you, the
+        # enterprising reader, feels inclined to solve this problem - we could
         # parallel the work done with ChangeObserver on $LOAD_PATH to mirror
         # updates to our @lfi.
         $LOADED_FEATURES.each do |feat|
           hash = feat.hash
           $LOAD_PATH.each do |lpe|
             next unless feat.start_with?(lpe)
+
             # /a/b/lib/my/foo.rb
             #          ^^^^^^^^^
             short = feat[(lpe.length + 1)..-1]
@@ -58,9 +59,9 @@ module Bootsnap
       end
 
       def purge_multi(features)
-        rejected_hashes = features.map(&:hash).to_set
+        rejected_hashes = features.each_with_object({}) { |f, h| h[f.hash] = true }
         @mutex.synchronize do
-          @lfi.reject! { |_, hash| rejected_hashes.include?(hash) }
+          @lfi.reject! { |_, hash| rejected_hashes.key?(hash) }
         end
       end
 
@@ -68,11 +69,30 @@ module Bootsnap
         @mutex.synchronize { @lfi.key?(feature) }
       end
 
+      def cursor(short)
+        unless Bootsnap.absolute_path?(short.to_s)
+          $LOADED_FEATURES.size
+        end
+      end
+
+      def identify(short, cursor)
+        $LOADED_FEATURES[cursor..-1].detect do |feat|
+          offset = 0
+          while (offset = feat.index(short, offset))
+            if feat.index(".", offset + 1) && !feat.index("/", offset + 2)
+              break true
+            else
+              offset += 1
+            end
+          end
+        end
+      end
+
       # There is a relatively uncommon case where we could miss adding an
       # entry:
       #
       # If the user asked for e.g. `require 'bundler'`, and we went through the
-      # `FallbackScan` pathway in `kernel_require.rb` and therefore did not
+      # `FALLBACK_SCAN` pathway in `kernel_require.rb` and therefore did not
       # pass `long` (the full expanded absolute path), then we did are not able
       # to confidently add the `bundler.rb` form to @lfi.
       #
@@ -82,15 +102,8 @@ module Bootsnap
       #    not quite right; or
       # 2. Inspect $LOADED_FEATURES upon return from yield to find the matching
       #    entry.
-      def register(short, long = nil)
-        if long.nil?
-          pat = %r{/#{Regexp.escape(short)}(\.[^/]+)?$}
-          len = $LOADED_FEATURES.size
-          ret = yield
-          long = $LOADED_FEATURES[len..-1].detect { |feat| feat =~ pat }
-        else
-          ret = yield
-        end
+      def register(short, long)
+        return if Bootsnap.absolute_path?(short)
 
         hash = long.hash
 
@@ -109,13 +122,11 @@ module Bootsnap
           @lfi[short] = hash
           (@lfi[altname] = hash) if altname
         end
-
-        ret
       end
 
       private
 
-      STRIP_EXTENSION = /\.[^.]*?$/
+      STRIP_EXTENSION = /\.[^.]*?$/.freeze
       private_constant(:STRIP_EXTENSION)
 
       # Might Ruby automatically search for this extension if
@@ -132,15 +143,15 @@ module Bootsnap
       # with calling a Ruby file 'x.dylib.rb' and then requiring it as 'x.dylib'.)
       #
       # See <https://ruby-doc.org/core-2.6.4/Kernel.html#method-i-require>.
-      def extension_elidable?(f)
-        f.to_s.end_with?('.rb', '.so', '.o', '.dll', '.dylib')
+      def extension_elidable?(feature)
+        feature.to_s.end_with?(".rb", ".so", ".o", ".dll", ".dylib")
       end
 
-      def strip_extension_if_elidable(f)
-        if extension_elidable?(f)
-          f.sub(STRIP_EXTENSION, '')
+      def strip_extension_if_elidable(feature)
+        if extension_elidable?(feature)
+          feature.sub(STRIP_EXTENSION, "")
         else
-          f
+          feature
         end
       end
     end

data/lib/bootsnap/load_path_cache/path.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require_relative('path_scanner')
+
+require_relative("path_scanner")
 
 module Bootsnap
   module LoadPathCache
@@ -20,8 +21,26 @@ module Bootsnap
 
       attr_reader(:path)
 
-      def initialize(path)
+      def initialize(path, real: false)
         @path = path.to_s.freeze
+        @real = real
+      end
+
+      def to_realpath
+        return self if @real
+
+        realpath = begin
+          File.realpath(path)
+        rescue Errno::ENOENT
+          return self
+        end
+
+        if realpath != path
+          Path.new(realpath, real: true)
+        else
+          @real = true
+          self
+        end
       end
 
       # True if the path exists, but represents a non-directory object
@@ -43,6 +62,7 @@ module Bootsnap
           # set to zero anyway, just in case we change the stability heuristics.
           _, entries, dirs = store.get(expanded_path)
           return [entries, dirs] if entries # cache hit
+
           entries, dirs = scan!
           store.set(expanded_path, [0, entries, dirs])
           return [entries, dirs]
@@ -60,7 +80,11 @@ module Bootsnap
       end
 
       def expanded_path
-        File.expand_path(path).freeze
+        if @real
+          path
+        else
+          @expanded_path ||= File.expand_path(path).freeze
+        end
       end
 
       private
@@ -93,8 +117,8 @@ module Bootsnap
 
       # Built-in ruby lib stuff doesn't change, but things can occasionally be
       # installed into sitedir, which generally lives under libdir.
-      RUBY_LIBDIR  = RbConfig::CONFIG['libdir']
-      RUBY_SITEDIR = RbConfig::CONFIG['sitedir']
+      RUBY_LIBDIR  = RbConfig::CONFIG["libdir"]
+      RUBY_SITEDIR = RbConfig::CONFIG["sitedir"]
 
       def stability
         @stability ||= begin

data/lib/bootsnap/load_path_cache/path_scanner.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require_relative('../explicit_require')
+require_relative("../explicit_require")
 
 module Bootsnap
   module LoadPathCache
     module PathScanner
       REQUIRABLE_EXTENSIONS = [DOT_RB] + DL_EXTENSIONS
       NORMALIZE_NATIVE_EXTENSIONS = !DL_EXTENSIONS.include?(LoadPathCache::DOT_SO)
-      ALTERNATIVE_NATIVE_EXTENSIONS_PATTERN = /\.(o|bundle|dylib)\z/
+      ALTERNATIVE_NATIVE_EXTENSIONS_PATTERN = /\.(o|bundle|dylib)\z/.freeze
 
       BUNDLE_PATH = if Bootsnap.bundler?
         (Bundler.bundle_path.cleanpath.to_s << LoadPathCache::SLASH).freeze
       else
-        ''
+        ""
       end
 
       class << self
@@ -44,7 +44,8 @@ module Bootsnap
 
         def walk(absolute_dir_path, relative_dir_path, &block)
           Dir.foreach(absolute_dir_path) do |name|
-            next if name.start_with?('.')
+            next if name.start_with?(".")
+
             relative_path = relative_dir_path ? File.join(relative_dir_path, name) : name
 
             absolute_path = "#{absolute_dir_path}/#{name}"
@@ -58,7 +59,7 @@ module Bootsnap
           end
         end
 
-        if RUBY_VERSION >= '3.1'
+        if RUBY_VERSION >= "3.1"
           def os_path(path)
             path.freeze
           end

data/lib/bootsnap/load_path_cache/store.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
-require_relative('../explicit_require')
 
-Bootsnap::ExplicitRequire.with_gems('msgpack') { require('msgpack') }
-Bootsnap::ExplicitRequire.from_rubylibdir('fileutils')
+require_relative("../explicit_require")
+
+Bootsnap::ExplicitRequire.with_gems("msgpack") { require("msgpack") }
 
 module Bootsnap
   module LoadPathCache
     class Store
+      VERSION_KEY = "__bootsnap_ruby_version__"
+      CURRENT_VERSION = "#{RUBY_REVISION}-#{RUBY_PLATFORM}".freeze # rubocop:disable Style/RedundantFreeze
+
       NestedTransactionError = Class.new(StandardError)
       SetOutsideTransactionNotAllowed = Class.new(StandardError)
 
@@ -23,10 +26,11 @@ module Bootsnap
 
       def fetch(key)
         raise(SetOutsideTransactionNotAllowed) unless @txn_mutex.owned?
+
         v = get(key)
         unless v
-          @dirty = true
           v = yield
+          mark_for_mutation!
           @data[key] = v
         end
         v
@@ -34,14 +38,16 @@ module Bootsnap
 
       def set(key, value)
         raise(SetOutsideTransactionNotAllowed) unless @txn_mutex.owned?
+
         if value != @data[key]
-          @dirty = true
+          mark_for_mutation!
           @data[key] = value
         end
       end
 
       def transaction
         raise(NestedTransactionError) if @txn_mutex.owned?
+
         @txn_mutex.synchronize do
           begin
             yield
@@ -53,6 +59,11 @@ module Bootsnap
 
       private
 
+      def mark_for_mutation!
+        @dirty = true
+        @data = @data.dup if @data.frozen?
+      end
+
       def commit_transaction
         if @dirty
           dump_data
@@ -62,15 +73,20 @@ module Bootsnap
 
       def load_data
         @data = begin
-          File.open(@store_path, encoding: Encoding::BINARY) do |io|
-            MessagePack.load(io)
+          data = File.open(@store_path, encoding: Encoding::BINARY) do |io|
+            MessagePack.load(io, freeze: true)
+          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
@@ -80,17 +96,37 @@ module Bootsnap
       def dump_data
         # Change contents atomically so other processes can't get invalid
         # caches if they read at an inopportune time.
-        tmp = "#{@store_path}.#{Process.pid}.#{(rand * 100000).to_i}.tmp"
-        FileUtils.mkpath(File.dirname(tmp))
+        tmp = "#{@store_path}.#{Process.pid}.#{(rand * 100_000).to_i}.tmp"
+        mkdir_p(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)
+          MessagePack.dump(@data, io)
         end
-        FileUtils.mv(tmp, @store_path)
+        File.rename(tmp, @store_path)
       rescue Errno::EEXIST
         retry
+      rescue SystemCallError
+      end
+
+      def default_data
+        {VERSION_KEY => CURRENT_VERSION}
+      end
+
+      def mkdir_p(path)
+        stack = []
+        until File.directory?(path)
+          stack.push path
+          path = File.dirname(path)
+        end
+        stack.reverse_each do |dir|
+          begin
+            Dir.mkdir(dir)
+          rescue SystemCallError
+            raise unless File.directory?(dir)
+          end
+        end
       end
     end
   end

data/lib/bootsnap/load_path_cache.rb

@@ -2,20 +2,14 @@
 
 module Bootsnap
   module LoadPathCache
-    ReturnFalse = Class.new(StandardError)
-    FallbackScan = Class.new(StandardError)
+    FALLBACK_SCAN = BasicObject.new
 
-    DOT_RB = '.rb'
-    DOT_SO = '.so'
-    SLASH  = '/'
-
-    # If a NameError happens several levels deep, don't re-handle it
-    # all the way up the chain: mark it once and bubble it up without
-    # more retries.
-    ERROR_TAG_IVAR = :@__bootsnap_rescued
+    DOT_RB = ".rb"
+    DOT_SO = ".so"
+    SLASH  = "/"
 
     DL_EXTENSIONS = ::RbConfig::CONFIG
-      .values_at('DLEXT', 'DLEXT2')
+      .values_at("DLEXT", "DLEXT2")
       .reject { |ext| !ext || ext.empty? }
       .map    { |ext| ".#{ext}" }
       .freeze
@@ -28,7 +22,7 @@ module Bootsnap
     CACHED_EXTENSIONS = DLEXT2 ? [DOT_RB, DLEXT, DLEXT2] : [DOT_RB, DLEXT]
 
     class << self
-      attr_reader(:load_path_cache, :loaded_features_index, :realpath_cache)
+      attr_reader(:load_path_cache, :loaded_features_index)
 
       def setup(cache_path:, development_mode:)
         unless supported?
@@ -39,27 +33,25 @@ module Bootsnap
         store = Store.new(cache_path)
 
         @loaded_features_index = LoadedFeaturesIndex.new
-        @realpath_cache = RealpathCache.new
 
         @load_path_cache = Cache.new(store, $LOAD_PATH, development_mode: development_mode)
-        require_relative('load_path_cache/core_ext/kernel_require')
-        require_relative('load_path_cache/core_ext/loaded_features')
+        require_relative("load_path_cache/core_ext/kernel_require")
+        require_relative("load_path_cache/core_ext/loaded_features")
       end
 
       def supported?
-        RUBY_ENGINE == 'ruby' &&
-        RUBY_PLATFORM =~ /darwin|linux|bsd|mswin|mingw|cygwin/
+        RUBY_ENGINE == "ruby" &&
+          RUBY_PLATFORM =~ /darwin|linux|bsd|mswin|mingw|cygwin/
       end
     end
   end
 end
 
 if Bootsnap::LoadPathCache.supported?
-  require_relative('load_path_cache/path_scanner')
-  require_relative('load_path_cache/path')
-  require_relative('load_path_cache/cache')
-  require_relative('load_path_cache/store')
-  require_relative('load_path_cache/change_observer')
-  require_relative('load_path_cache/loaded_features_index')
-  require_relative('load_path_cache/realpath_cache')
+  require_relative("load_path_cache/path_scanner")
+  require_relative("load_path_cache/path")
+  require_relative("load_path_cache/cache")
+  require_relative("load_path_cache/store")
+  require_relative("load_path_cache/change_observer")
+  require_relative("load_path_cache/loaded_features_index")
 end

data/lib/bootsnap/setup.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
-require_relative('../bootsnap')
+
+require_relative("../bootsnap")
 
 Bootsnap.default_setup

data/lib/bootsnap/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Bootsnap
-  VERSION = "1.7.2"
+  VERSION = "1.11.1"
 end