bootsnap 1.4.8 → 1.16.0

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))
@@ -53,10 +56,22 @@ module Bootsnap
         end
       end
 
-      def self.register(observer, arr)
+      def self.register(arr, observer)
         return if arr.frozen? # can't register observer, but no need to.
+
         arr.instance_variable_set(:@lpc_observer, observer)
-        arr.extend(ArrayMixin)
+        ArrayMixin.instance_methods.each do |method_name|
+          arr.singleton_class.send(:define_method, method_name, ArrayMixin.instance_method(method_name))
+        end
+      end
+
+      def self.unregister(arr)
+        return unless arr.instance_variable_defined?(:@lpc_observer) && arr.instance_variable_get(:@lpc_observer)
+
+        ArrayMixin.instance_methods.each do |method_name|
+          arr.singleton_class.send(:remove_method, method_name)
+        end
+        arr.instance_variable_set(:@lpc_observer, nil)
       end
     end
   end

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

@@ -1,105 +1,37 @@
 # 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
-
-    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)
-    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
-      load_without_bootsnap(path, wrap)
-    end
-  end
-end
-
-class Module
-  alias_method(:autoload_without_bootsnap, :autoload)
-  def autoload(const, path)
-    # NOTE: This may defeat LoadedFeaturesIndex, but it's not immediately
-    # obvious how to make it work. This feels like a pretty niche case, unclear
-    # if it will ever burn anyone.
-    #
-    # 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
-      autoload_without_bootsnap(const, path)
+    return require_without_bootsnap(path) unless Bootsnap::LoadPathCache.enabled?
+
+    string_path = Bootsnap.rb_get_path(path)
+    return false if Bootsnap::LoadPathCache.loaded_features_index.key?(string_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
 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

@@ -26,20 +26,21 @@ module Bootsnap
     class LoadedFeaturesIndex
       def initialize
         @lfi = {}
-        @mutex = defined?(::Mutex) ? ::Mutex.new : ::Thread::Mutex.new # TODO: Remove once Ruby 2.2 support is dropped.
+        @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]
+            short = feat[(lpe.length + 1)..]
             stripped = strip_extension_if_elidable(short)
             @lfi[short] = hash
             @lfi[stripped] = hash
@@ -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..].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,14 +21,32 @@ 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
+          @real = true
+          self
+        else
+          Path.new(realpath, real: true)
+        end
       end
 
       # True if the path exists, but represents a non-directory object
       def non_directory?
         !File.stat(path).directory?
-      rescue Errno::ENOENT, Errno::ENOTDIR
+      rescue Errno::ENOENT, Errno::ENOTDIR, Errno::EINVAL
         false
       end
 
@@ -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
@@ -77,7 +101,7 @@ module Bootsnap
         ["", *dirs].each do |dir|
           curr = begin
             File.mtime("#{path}/#{dir}").to_i
-                 rescue Errno::ENOENT, Errno::ENOTDIR
+                 rescue Errno::ENOENT, Errno::ENOTDIR, Errno::EINVAL
                    -1
           end
           max = curr if curr > max
@@ -92,21 +116,19 @@ module Bootsnap
       VOLATILE = :volatile
 
       # 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']
+      # installed into sitedir, which generally lives under rubylibdir.
+      RUBY_LIBDIR  = RbConfig::CONFIG["rubylibdir"]
+      RUBY_SITEDIR = RbConfig::CONFIG["sitedir"]
 
       def stability
-        @stability ||= begin
-          if Gem.path.detect { |p| expanded_path.start_with?(p.to_s) }
-            STABLE
-          elsif Bootsnap.bundler? && expanded_path.start_with?(Bundler.bundle_path.to_s)
-            STABLE
-          elsif expanded_path.start_with?(RUBY_LIBDIR) && !expanded_path.start_with?(RUBY_SITEDIR)
-            STABLE
-          else
-            VOLATILE
-          end
+        @stability ||= if Gem.path.detect { |p| expanded_path.start_with?(p.to_s) }
+          STABLE
+        elsif Bootsnap.bundler? && expanded_path.start_with?(Bundler.bundle_path.to_s)
+          STABLE
+        elsif expanded_path.start_with?(RUBY_LIBDIR) && !expanded_path.start_with?(RUBY_SITEDIR)
+          STABLE
+        else
+          VOLATILE
         end
       end
     end

data/lib/bootsnap/load_path_cache/path_scanner.rb

@@ -1,21 +1,25 @@
 # 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
 
+      @ignored_directories = %w(node_modules)
+
       class << self
+        attr_accessor :ignored_directories
+
         def call(path)
           path = File.expand_path(path.to_s).freeze
           return [[], []] unless File.directory?(path)
@@ -33,10 +37,10 @@ module Bootsnap
           requirables = []
           walk(path, nil) do |relative_path, absolute_path, is_directory|
             if is_directory
-              dirs << relative_path
+              dirs << os_path(relative_path)
               !contains_bundle_path || !absolute_path.start_with?(BUNDLE_PATH)
             elsif relative_path.end_with?(*REQUIRABLE_EXTENSIONS)
-              requirables << relative_path
+              requirables << os_path(relative_path)
             end
           end
           [requirables, dirs]
@@ -44,11 +48,14 @@ module Bootsnap
 
         def walk(absolute_dir_path, relative_dir_path, &block)
           Dir.foreach(absolute_dir_path) do |name|
-            next if name.start_with?('.')
-            relative_path = relative_dir_path ? "#{relative_dir_path}/#{name}" : name.freeze
+            next if name.start_with?(".")
+
+            relative_path = relative_dir_path ? File.join(relative_dir_path, name) : name
 
             absolute_path = "#{absolute_dir_path}/#{name}"
             if File.directory?(absolute_path)
+              next if ignored_directories.include?(name)
+
               if yield relative_path, absolute_path, true
                 walk(absolute_path, relative_path, &block)
               end
@@ -57,6 +64,17 @@ module Bootsnap
             end
           end
         end
+
+        if RUBY_VERSION >= "3.1"
+          def os_path(path)
+            path.freeze
+          end
+        else
+          def os_path(path)
+            path.force_encoding(Encoding::US_ASCII) if path.ascii_only?
+            path.freeze
+          end
+        end
       end
     end
   end

data/lib/bootsnap/load_path_cache/store.rb

@@ -1,20 +1,23 @@
 # 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)
 
-      def initialize(store_path)
+      def initialize(store_path, readonly: false)
         @store_path = store_path
-        # TODO: Remove conditional once Ruby 2.2 support is dropped.
-        @txn_mutex =  defined?(::Mutex) ? ::Mutex.new : ::Thread::Mutex.new
+        @txn_mutex = Mutex.new
         @dirty = false
+        @readonly = readonly
         load_data
       end
 
@@ -24,10 +27,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
@@ -35,27 +39,32 @@ 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
-          ensure
-            commit_transaction
-          end
+          yield
+        ensure
+          commit_transaction
         end
       end
 
       private
 
+      def mark_for_mutation!
+        @dirty = true
+        @data = @data.dup if @data.frozen?
+      end
+
       def commit_transaction
-        if @dirty
+        if @dirty && !@readonly
           dump_data
           @dirty = false
         end
@@ -63,27 +72,58 @@ module Bootsnap
 
       def load_data
         @data = begin
-          MessagePack.load(File.binread(@store_path))
-                # handle malformed data due to upgrade incompatibility
-                rescue Errno::ENOENT, MessagePack::MalformedFormatError, MessagePack::UnknownExtTypeError, EOFError
-                  {}
-                rescue ArgumentError => e
-                  e.message =~ /negative array size/ ? {} : raise
+          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
         end
       end
 
       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.binwrite(tmp, MessagePack.dump(@data), mode: exclusive_write, encoding: Encoding::BINARY)
-        FileUtils.mv(tmp, @store_path)
+        File.open(tmp, mode: exclusive_write, encoding: Encoding::BINARY) do |io|
+          MessagePack.dump(@data, io)
+        end
+        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|
+          Dir.mkdir(dir)
+        rescue SystemCallError
+          raise unless File.directory?(dir)
+        end
       end
     end
   end