bootsnap 1.4.6 → 1.18.3

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 incompatability
-                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

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
@@ -27,52 +21,60 @@ module Bootsnap
 
     CACHED_EXTENSIONS = DLEXT2 ? [DOT_RB, DLEXT, DLEXT2] : [DOT_RB, DLEXT]
 
+    @enabled = false
+
     class << self
-      attr_reader(:load_path_cache, :autoload_paths_cache,
-        :loaded_features_index, :realpath_cache)
+      attr_reader(:load_path_cache, :loaded_features_index, :enabled)
+      alias_method :enabled?, :enabled
+      remove_method(:enabled)
 
-      def setup(cache_path:, development_mode:, active_support: true)
+      def setup(cache_path:, development_mode:, ignore_directories:, readonly: false)
         unless supported?
           warn("[bootsnap/setup] Load path caching is not supported on this implementation of Ruby") if $VERBOSE
           return
         end
 
-        store = Store.new(cache_path)
+        store = Store.new(cache_path, readonly: readonly)
 
         @loaded_features_index = LoadedFeaturesIndex.new
-        @realpath_cache = RealpathCache.new
 
+        PathScanner.ignored_directories = ignore_directories if ignore_directories
         @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')
+        @enabled = true
+        require_relative "load_path_cache/core_ext/kernel_require"
+        require_relative "load_path_cache/core_ext/loaded_features"
+      end
 
-        if active_support
-          # this should happen after setting up the initial cache because it
-          # loads a lot of code. It's better to do after +require+ is optimized.
-          require('active_support/dependencies')
-          @autoload_paths_cache = Cache.new(
-            store,
-            ::ActiveSupport::Dependencies.autoload_paths,
-            development_mode: development_mode
-          )
-          require_relative('load_path_cache/core_ext/active_support')
-        end
+      def unload!
+        @enabled = false
+        @loaded_features_index = nil
+        @realpath_cache = nil
+        @load_path_cache = nil
+        ChangeObserver.unregister($LOAD_PATH) if supported?
       end
 
       def supported?
-        RUBY_ENGINE == 'ruby' &&
-        RUBY_PLATFORM =~ /darwin|linux|bsd/
+        if RUBY_PLATFORM.match?(/darwin|linux|bsd|mswin|mingw|cygwin/)
+          case RUBY_ENGINE
+          when "truffleruby"
+            # https://github.com/oracle/truffleruby/issues/3131
+            RUBY_ENGINE_VERSION >= "23.1.0"
+          when "ruby"
+            true
+          else
+            false
+          end
+        end
       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,39 +1,5 @@
 # frozen_string_literal: true
-require_relative('../bootsnap')
 
-env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['ENV']
-development_mode = ['', nil, 'development'].include?(env)
+require_relative "../bootsnap"
 
-cache_dir = ENV['BOOTSNAP_CACHE_DIR']
-unless cache_dir
-  config_dir_frame = caller.detect do |line|
-    line.include?('/config/')
-  end
-
-  unless config_dir_frame
-    $stderr.puts("[bootsnap/setup] couldn't infer cache directory! Either:")
-    $stderr.puts("[bootsnap/setup]   1. require bootsnap/setup from your application's config directory; or")
-    $stderr.puts("[bootsnap/setup]   2. Define the environment variable BOOTSNAP_CACHE_DIR")
-
-    raise("couldn't infer bootsnap cache directory")
-  end
-
-  path = config_dir_frame.split(/:\d+:/).first
-  path = File.dirname(path) until File.basename(path) == 'config'
-  app_root = File.dirname(path)
-
-  cache_dir = File.join(app_root, 'tmp', 'cache')
-end
-
-ruby_version = Gem::Version.new(RUBY_VERSION)
-iseq_cache_enabled = ruby_version < Gem::Version.new('2.5.0') || ruby_version >= Gem::Version.new('2.6.0')
-
-Bootsnap.setup(
-  cache_dir:            cache_dir,
-  development_mode:     development_mode,
-  load_path_cache:      true,
-  autoload_paths_cache: true, # assume rails. open to PRs to impl. detection
-  disable_trace:        false,
-  compile_cache_iseq:   iseq_cache_enabled,
-  compile_cache_yaml:   true,
-)
+Bootsnap.default_setup

data/lib/bootsnap/version.rb

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

data/lib/bootsnap.rb

@@ -1,48 +1,152 @@
 # frozen_string_literal: true
-require_relative('bootsnap/version')
-require_relative('bootsnap/bundler')
-require_relative('bootsnap/load_path_cache')
-require_relative('bootsnap/compile_cache')
+
+require_relative "bootsnap/version"
+require_relative "bootsnap/bundler"
+require_relative "bootsnap/load_path_cache"
+require_relative "bootsnap/compile_cache"
 
 module Bootsnap
   InvalidConfiguration = Class.new(StandardError)
 
-  def self.setup(
-    cache_dir:,
-    development_mode: true,
-    load_path_cache: true,
-    autoload_paths_cache: true,
-    disable_trace: false,
-    compile_cache_iseq: true,
-    compile_cache_yaml: true
-  )
-    if autoload_paths_cache && !load_path_cache
-      raise(InvalidConfiguration, "feature 'autoload_paths_cache' depends on feature 'load_path_cache'")
-    end
-
-    setup_disable_trace if disable_trace
-
-    Bootsnap::LoadPathCache.setup(
-      cache_path:       cache_dir + '/bootsnap-load-path-cache',
-      development_mode: development_mode,
-      active_support:   autoload_paths_cache
-    ) if load_path_cache
-
-    Bootsnap::CompileCache.setup(
-      cache_dir: cache_dir + '/bootsnap-compile-cache',
-      iseq: compile_cache_iseq,
-      yaml: compile_cache_yaml
+  class << self
+    attr_reader :logger
+
+    def log_stats!
+      stats = {hit: 0, revalidated: 0, miss: 0, stale: 0}
+      self.instrumentation = ->(event, _path) { stats[event] += 1 }
+      Kernel.at_exit do
+        stats.each do |event, count|
+          $stderr.puts "bootsnap #{event}: #{count}"
+        end
+      end
+    end
+
+    def log!
+      self.logger = $stderr.method(:puts)
+    end
+
+    def logger=(logger)
+      @logger = logger
+      self.instrumentation = if logger.respond_to?(:debug)
+        ->(event, path) { @logger.debug("[Bootsnap] #{event} #{path}") unless event == :hit }
+      else
+        ->(event, path) { @logger.call("[Bootsnap] #{event} #{path}") unless event == :hit }
+      end
+    end
+
+    def instrumentation=(callback)
+      @instrumentation = callback
+      if respond_to?(:instrumentation_enabled=, true)
+        self.instrumentation_enabled = !!callback
+      end
+    end
+
+    def _instrument(event, path)
+      @instrumentation.call(event, path)
+    end
+
+    def setup(
+      cache_dir:,
+      development_mode: true,
+      load_path_cache: true,
+      ignore_directories: nil,
+      readonly: false,
+      revalidation: false,
+      compile_cache_iseq: true,
+      compile_cache_yaml: true,
+      compile_cache_json: true
     )
-  end
+      if load_path_cache
+        Bootsnap::LoadPathCache.setup(
+          cache_path: "#{cache_dir}/bootsnap/load-path-cache",
+          development_mode: development_mode,
+          ignore_directories: ignore_directories,
+          readonly: readonly,
+        )
+      end
 
-  def self.setup_disable_trace
-    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
-      warn(
-        "from #{caller_locations(1, 1)[0]}: The 'disable_trace' method is not allowed with this Ruby version. " \
-        "current: #{RUBY_VERSION}, allowed version: < 2.5.0",
+      Bootsnap::CompileCache.setup(
+        cache_dir: "#{cache_dir}/bootsnap/compile-cache",
+        iseq: compile_cache_iseq,
+        yaml: compile_cache_yaml,
+        json: compile_cache_json,
+        readonly: readonly,
+        revalidation: revalidation,
       )
+    end
+
+    def unload_cache!
+      LoadPathCache.unload!
+    end
+
+    def default_setup
+      env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || ENV["ENV"]
+      development_mode = ["", nil, "development"].include?(env)
+
+      unless ENV["DISABLE_BOOTSNAP"]
+        cache_dir = ENV["BOOTSNAP_CACHE_DIR"]
+        unless cache_dir
+          config_dir_frame = caller.detect do |line|
+            line.include?("/config/")
+          end
+
+          unless config_dir_frame
+            $stderr.puts("[bootsnap/setup] couldn't infer cache directory! Either:")
+            $stderr.puts("[bootsnap/setup]   1. require bootsnap/setup from your application's config directory; or")
+            $stderr.puts("[bootsnap/setup]   2. Define the environment variable BOOTSNAP_CACHE_DIR")
+
+            raise("couldn't infer bootsnap cache directory")
+          end
+
+          path = config_dir_frame.split(/:\d+:/).first
+          path = File.dirname(path) until File.basename(path) == "config"
+          app_root = File.dirname(path)
+
+          cache_dir = File.join(app_root, "tmp", "cache")
+        end
+
+        ignore_directories = if ENV.key?("BOOTSNAP_IGNORE_DIRECTORIES")
+          ENV["BOOTSNAP_IGNORE_DIRECTORIES"].split(",")
+        end
+
+        setup(
+          cache_dir: cache_dir,
+          development_mode: development_mode,
+          load_path_cache: !ENV["DISABLE_BOOTSNAP_LOAD_PATH_CACHE"],
+          compile_cache_iseq: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
+          compile_cache_yaml: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
+          compile_cache_json: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
+          readonly: !!ENV["BOOTSNAP_READONLY"],
+          ignore_directories: ignore_directories,
+        )
+
+        if ENV["BOOTSNAP_LOG"]
+          log!
+        elsif ENV["BOOTSNAP_STATS"]
+          log_stats!
+        end
+      end
+    end
+
+    if RbConfig::CONFIG["host_os"] =~ /mswin|mingw|cygwin/
+      def absolute_path?(path)
+        path[1] == ":"
+      end
     else
-      RubyVM::InstructionSequence.compile_option = { trace_instruction: false }
+      def absolute_path?(path)
+        path.start_with?("/")
+      end
     end
+
+    # This is a semi-accurate ruby implementation of the native `rb_get_path(VALUE)` function.
+    # The native version is very intricate and may behave differently on windows etc.
+    # But we only use it for non-MRI platform.
+    def rb_get_path(fname)
+      path_path = fname.respond_to?(:to_path) ? fname.to_path : fname
+      String.try_convert(path_path) || raise(TypeError, "no implicit conversion of #{path_path.class} into String")
+    end
+
+    # Allow the C extension to redefine `rb_get_path` without warning.
+    alias_method :rb_get_path, :rb_get_path # rubocop:disable Lint/DuplicateMethods
   end
 end