bootsnap 1.4.8 → 1.16.0

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,51 @@ 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
 
         @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')
+        PathScanner.ignored_directories = ignore_directories if ignore_directories
+        @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)
       end
 
       def supported?
-        RUBY_ENGINE == 'ruby' &&
-        RUBY_PLATFORM =~ /darwin|linux|bsd/
+        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,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.8"
+  VERSION = "1.16.0"
 end

data/lib/bootsnap.rb

@@ -1,49 +1,138 @@
 # 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!
+      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}") }
+      else
+        ->(event, path) { @logger.call("[Bootsnap] #{event} #{path}") }
+      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,
+      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,
       )
+    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!
+        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

metadata

@@ -1,103 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.4.8
+  version: 1.16.0
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 description: Boot large ruby/rails apps faster
 email:
 - burke.libbey@shopify.com
-executables: []
+executables:
+- bootsnap
 extensions:
 - ext/bootsnap/extconf.rb
 extra_rdoc_files: []
@@ -105,25 +36,27 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- exe/bootsnap
 - ext/bootsnap/bootsnap.c
 - ext/bootsnap/bootsnap.h
 - ext/bootsnap/extconf.rb
 - lib/bootsnap.rb
 - lib/bootsnap/bundler.rb
+- lib/bootsnap/cli.rb
+- lib/bootsnap/cli/worker_pool.rb
 - lib/bootsnap/compile_cache.rb
 - lib/bootsnap/compile_cache/iseq.rb
+- lib/bootsnap/compile_cache/json.rb
 - lib/bootsnap/compile_cache/yaml.rb
 - lib/bootsnap/explicit_require.rb
 - lib/bootsnap/load_path_cache.rb
 - lib/bootsnap/load_path_cache/cache.rb
 - lib/bootsnap/load_path_cache/change_observer.rb
-- lib/bootsnap/load_path_cache/core_ext/active_support.rb
 - lib/bootsnap/load_path_cache/core_ext/kernel_require.rb
 - lib/bootsnap/load_path_cache/core_ext/loaded_features.rb
 - 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
@@ -132,8 +65,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/Shopify/bootsnap/issues
-  changelog_uri: https://github.com/Shopify/bootsnap/blob/master/CHANGELOG.md
+  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:
@@ -142,14 +76,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.0.2
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Boot large ruby/rails apps faster

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

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-module Bootsnap
-  module LoadPathCache
-    module CoreExt
-      module ActiveSupport
-        def self.without_bootsnap_cache
-          prev = Thread.current[:without_bootsnap_cache] || false
-          Thread.current[:without_bootsnap_cache] = true
-          yield
-        ensure
-          Thread.current[:without_bootsnap_cache] = prev
-        end
-
-        def self.allow_bootsnap_retry(allowed)
-          prev = Thread.current[:without_bootsnap_retry] || false
-          Thread.current[:without_bootsnap_retry] = !allowed
-          yield
-        ensure
-          Thread.current[:without_bootsnap_retry] = prev
-        end
-
-        module ClassMethods
-          def autoload_paths=(o)
-            super
-            Bootsnap::LoadPathCache.autoload_paths_cache.reinitialize(o)
-          end
-
-          def search_for_file(path)
-            return super if Thread.current[:without_bootsnap_cache]
-            begin
-              Bootsnap::LoadPathCache.autoload_paths_cache.find(path)
-            rescue Bootsnap::LoadPathCache::ReturnFalse
-              nil # doesn't really apply here
-            rescue Bootsnap::LoadPathCache::FallbackScan
-              nil # doesn't really apply here
-            end
-          end
-
-          def autoloadable_module?(path_suffix)
-            Bootsnap::LoadPathCache.autoload_paths_cache.load_dir(path_suffix)
-          end
-
-          def remove_constant(const)
-            CoreExt::ActiveSupport.without_bootsnap_cache { super }
-          end
-
-          def require_or_load(*)
-            CoreExt::ActiveSupport.allow_bootsnap_retry(true) do
-              super
-            end
-          end
-
-          # If we can't find a constant using the patched implementation of
-          # search_for_file, try again with the default implementation.
-          #
-          # These methods call search_for_file, and we want to modify its
-          # behaviour.  The gymnastics here are a bit awkward, but it prevents
-          # 200+ lines of monkeypatches.
-          def load_missing_constant(from_mod, const_name)
-            CoreExt::ActiveSupport.allow_bootsnap_retry(false) do
-              super
-            end
-          rescue NameError => e
-            raise(e) if e.instance_variable_defined?(Bootsnap::LoadPathCache::ERROR_TAG_IVAR)
-            e.instance_variable_set(Bootsnap::LoadPathCache::ERROR_TAG_IVAR, true)
-
-            # This function can end up called recursively, we only want to
-            # retry at the top-level.
-            raise(e) if Thread.current[:without_bootsnap_retry]
-            # If we already had cache disabled, there's no use retrying
-            raise(e) if Thread.current[:without_bootsnap_cache]
-            # NoMethodError is a NameError, but we only want to handle actual
-            # NameError instances.
-            raise(e) unless e.class == NameError
-            # We can only confidently handle cases when *this* constant fails
-            # to load, not other constants referred to by it.
-            raise(e) unless e.name == const_name
-            # If the constant was actually loaded, something else went wrong?
-            raise(e) if from_mod.const_defined?(const_name)
-            CoreExt::ActiveSupport.without_bootsnap_cache { super }
-          end
-
-          # Signature has changed a few times over the years; easiest to not
-          # reiterate it with version polymorphism here...
-          def depend_on(*)
-            super
-          rescue LoadError => e
-            raise(e) if e.instance_variable_defined?(Bootsnap::LoadPathCache::ERROR_TAG_IVAR)
-            e.instance_variable_set(Bootsnap::LoadPathCache::ERROR_TAG_IVAR, true)
-
-            # If we already had cache disabled, there's no use retrying
-            raise(e) if Thread.current[:without_bootsnap_cache]
-            CoreExt::ActiveSupport.without_bootsnap_cache { super }
-          end
-        end
-      end
-    end
-  end
-end
-
-module ActiveSupport
-  module Dependencies
-    class << self
-      prepend(Bootsnap::LoadPathCache::CoreExt::ActiveSupport::ClassMethods)
-    end
-  end
-end

data/lib/bootsnap/load_path_cache/realpath_cache.rb

@@ -1,32 +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