bootsnap 1.10.3 → 1.18.6

data/lib/bootsnap.rb

@@ -1,9 +1,9 @@
 # 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)
@@ -11,6 +11,16 @@ module Bootsnap
   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
@@ -18,9 +28,9 @@ module Bootsnap
     def logger=(logger)
       @logger = logger
       self.instrumentation = if logger.respond_to?(:debug)
-        ->(event, path) { @logger.debug("[Bootsnap] #{event} #{path}") }
+        ->(event, path) { @logger.debug("[Bootsnap] #{event} #{path}") unless event == :hit }
       else
-        ->(event, path) { @logger.call("[Bootsnap] #{event} #{path}") }
+        ->(event, path) { @logger.call("[Bootsnap] #{event} #{path}") unless event == :hit }
       end
     end
 
@@ -39,55 +49,41 @@ module Bootsnap
       cache_dir:,
       development_mode: true,
       load_path_cache: true,
-      autoload_paths_cache: nil,
-      disable_trace: nil,
+      ignore_directories: nil,
+      readonly: false,
+      revalidation: false,
       compile_cache_iseq: true,
       compile_cache_yaml: true,
       compile_cache_json: true
     )
-      unless autoload_paths_cache.nil?
-        warn "[DEPRECATED] Bootsnap's `autoload_paths_cache:` option is deprecated and will be removed. " \
-          "If you use Zeitwerk this option is useless, and if you are still using the classic autoloader " \
-          "upgrading is recommended."
-      end
-
-      unless disable_trace.nil?
-        warn "[DEPRECATED] Bootsnap's `disable_trace:` option is deprecated and will be removed. " \
-          "If you use Ruby 2.5 or newer this option is useless, if not upgrading is recommended."
-      end
-
-      if compile_cache_iseq && !iseq_cache_supported?
-        warn "Ruby 2.5 has a bug that break code tracing when code is loaded from cache. It is recommened " \
-          "to turn `compile_cache_iseq` off on Ruby 2.5"
-      end
-
       if load_path_cache
         Bootsnap::LoadPathCache.setup(
-          cache_path: cache_dir + "/bootsnap/load-path-cache",
+          cache_path: "#{cache_dir}/bootsnap/load-path-cache",
           development_mode: development_mode,
+          ignore_directories: ignore_directories,
+          readonly: readonly,
         )
       end
 
       Bootsnap::CompileCache.setup(
-        cache_dir: cache_dir + "/bootsnap/compile-cache",
+        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 iseq_cache_supported?
-      return @iseq_cache_supported if defined? @iseq_cache_supported
-
-      ruby_version = Gem::Version.new(RUBY_VERSION)
-      @iseq_cache_supported = ruby_version < Gem::Version.new("2.5.0") || ruby_version >= Gem::Version.new("2.6.0")
+    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"]
+      if enabled?("BOOTSNAP")
         cache_dir = ENV["BOOTSNAP_CACHE_DIR"]
         unless cache_dir
           config_dir_frame = caller.detect do |line|
@@ -109,17 +105,26 @@ module Bootsnap
           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"] && iseq_cache_supported?,
-          compile_cache_yaml: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
-          compile_cache_json: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
+          load_path_cache: enabled?("BOOTSNAP_LOAD_PATH_CACHE"),
+          compile_cache_iseq: enabled?("BOOTSNAP_COMPILE_CACHE"),
+          compile_cache_yaml: enabled?("BOOTSNAP_COMPILE_CACHE"),
+          compile_cache_json: enabled?("BOOTSNAP_COMPILE_CACHE"),
+          readonly: bool_env("BOOTSNAP_READONLY"),
+          revalidation: bool_env("BOOTSNAP_REVALIDATE"),
+          ignore_directories: ignore_directories,
         )
 
         if ENV["BOOTSNAP_LOG"]
           log!
+        elsif ENV["BOOTSNAP_STATS"]
+          log_stats!
         end
       end
     end
@@ -133,5 +138,27 @@ module Bootsnap
         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
+
+    private
+
+    def enabled?(key)
+      !ENV["DISABLE_#{key}"]
+    end
+
+    def bool_env(key, default: false)
+      value = ENV.fetch(key) { default }
+      !["0", "false", false].include?(value)
+    end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.10.3
+  version: 1.18.6
 platform: ruby
 authors:
 - Burke Libbey
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -57,7 +56,6 @@ files:
 - lib/bootsnap/load_path_cache/loaded_features_index.rb
 - lib/bootsnap/load_path_cache/path.rb
 - lib/bootsnap/load_path_cache/path_scanner.rb
-- lib/bootsnap/load_path_cache/realpath_cache.rb
 - lib/bootsnap/load_path_cache/store.rb
 - lib/bootsnap/setup.rb
 - lib/bootsnap/version.rb
@@ -69,7 +67,6 @@ metadata:
   changelog_uri: https://github.com/Shopify/bootsnap/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/Shopify/bootsnap
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -77,15 +74,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Boot large ruby/rails apps faster
 test_files: []

data/lib/bootsnap/load_path_cache/realpath_cache.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Bootsnap
-  module LoadPathCache
-    class RealpathCache
-      def initialize
-        @cache = Hash.new { |h, k| h[k] = realpath(*k) }
-      end
-
-      def call(*key)
-        @cache[key]
-      end
-
-      private
-
-      def realpath(caller_location, path)
-        base = File.dirname(caller_location)
-        abspath = File.expand_path(path, base).freeze
-        find_file(abspath)
-      end
-
-      def find_file(name)
-        return File.realpath(name).freeze if File.exist?(name)
-
-        CACHED_EXTENSIONS.each do |ext|
-          filename = "#{name}#{ext}"
-          return File.realpath(filename).freeze if File.exist?(filename)
-        end
-        name
-      end
-    end
-  end
-end