bootsnap 1.4.0 → 1.9.1

data/lib/bootsnap/load_path_cache/path_scanner.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require_relative('../explicit_require')
 
 module Bootsnap
   module LoadPathCache
     module PathScanner
-      ALL_FILES = "/{,**/*/**/}*"
       REQUIRABLE_EXTENSIONS = [DOT_RB] + DL_EXTENSIONS
       NORMALIZE_NATIVE_EXTENSIONS = !DL_EXTENSIONS.include?(LoadPathCache::DOT_SO)
       ALTERNATIVE_NATIVE_EXTENSIONS_PATTERN = /\.(o|bundle|dylib)\z/
@@ -11,37 +12,62 @@ module Bootsnap
       BUNDLE_PATH = if Bootsnap.bundler?
         (Bundler.bundle_path.cleanpath.to_s << LoadPathCache::SLASH).freeze
       else
-        ''.freeze
+        ''
       end
 
-      def self.call(path)
-        path = path.to_s
-
-        relative_slice = (path.size + 1)..-1
-        # If the bundle path is a descendent of this path, we do additional
-        # checks to prevent recursing into the bundle path as we recurse
-        # through this path. We don't want to scan the bundle path because
-        # anything useful in it will be present on other load path items.
-        #
-        # This can happen if, for example, the user adds '.' to the load path,
-        # and the bundle path is '.bundle'.
-        contains_bundle_path = BUNDLE_PATH.start_with?(path)
-
-        dirs = []
-        requirables = []
-
-        Dir.glob(path + ALL_FILES).each do |absolute_path|
-          next if contains_bundle_path && absolute_path.start_with?(BUNDLE_PATH)
-          relative_path = absolute_path.slice(relative_slice)
-
-          if File.directory?(absolute_path)
-            dirs << relative_path
-          elsif REQUIRABLE_EXTENSIONS.include?(File.extname(relative_path))
-            requirables << relative_path
+      class << self
+        def call(path)
+          path = File.expand_path(path.to_s).freeze
+          return [[], []] unless File.directory?(path)
+
+          # If the bundle path is a descendent of this path, we do additional
+          # checks to prevent recursing into the bundle path as we recurse
+          # through this path. We don't want to scan the bundle path because
+          # anything useful in it will be present on other load path items.
+          #
+          # This can happen if, for example, the user adds '.' to the load path,
+          # and the bundle path is '.bundle'.
+          contains_bundle_path = BUNDLE_PATH.start_with?(path)
+
+          dirs = []
+          requirables = []
+          walk(path, nil) do |relative_path, absolute_path, is_directory|
+            if is_directory
+              dirs << os_path(relative_path)
+              !contains_bundle_path || !absolute_path.start_with?(BUNDLE_PATH)
+            elsif relative_path.end_with?(*REQUIRABLE_EXTENSIONS)
+              requirables << os_path(relative_path)
+            end
+          end
+          [requirables, dirs]
+        end
+
+        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 ? File.join(relative_dir_path, name) : name
+
+            absolute_path = "#{absolute_dir_path}/#{name}"
+            if File.directory?(absolute_path)
+              if yield relative_path, absolute_path, true
+                walk(absolute_path, relative_path, &block)
+              end
+            else
+              yield relative_path, absolute_path, false
+            end
           end
         end
 
-        [requirables, dirs]
+        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/realpath_cache.rb

@@ -15,15 +15,15 @@ module Bootsnap
 
       def realpath(caller_location, path)
         base = File.dirname(caller_location)
-        file = find_file(File.expand_path(path, base))
-        dir = File.dirname(file)
-        File.join(dir, File.basename(file))
+        abspath = File.expand_path(path, base).freeze
+        find_file(abspath)
       end
 
       def find_file(name)
-        ['', *CACHED_EXTENSIONS].each do |ext|
+        return File.realpath(name).freeze if File.exist?(name)
+        CACHED_EXTENSIONS.each do |ext|
           filename = "#{name}#{ext}"
-          return File.realpath(filename) if File.exist?(filename)
+          return File.realpath(filename).freeze if File.exist?(filename)
         end
         name
       end

data/lib/bootsnap/load_path_cache/store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative('../explicit_require')
 
 Bootsnap::ExplicitRequire.with_gems('msgpack') { require('msgpack') }
@@ -11,7 +12,7 @@ module Bootsnap
 
       def initialize(store_path)
         @store_path = store_path
-        @in_txn = false
+        @txn_mutex = Mutex.new
         @dirty = false
         load_data
       end
@@ -21,7 +22,7 @@ module Bootsnap
       end
 
       def fetch(key)
-        raise(SetOutsideTransactionNotAllowed) unless @in_txn
+        raise(SetOutsideTransactionNotAllowed) unless @txn_mutex.owned?
         v = get(key)
         unless v
           @dirty = true
@@ -32,7 +33,7 @@ module Bootsnap
       end
 
       def set(key, value)
-        raise(SetOutsideTransactionNotAllowed) unless @in_txn
+        raise(SetOutsideTransactionNotAllowed) unless @txn_mutex.owned?
         if value != @data[key]
           @dirty = true
           @data[key] = value
@@ -40,12 +41,14 @@ module Bootsnap
       end
 
       def transaction
-        raise(NestedTransactionError) if @in_txn
-        @in_txn = true
-        yield
-      ensure
-        commit_transaction
-        @in_txn = false
+        raise(NestedTransactionError) if @txn_mutex.owned?
+        @txn_mutex.synchronize do
+          begin
+            yield
+          ensure
+            commit_transaction
+          end
+        end
       end
 
       private
@@ -59,10 +62,18 @@ 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
-                  {}
+          File.open(@store_path, encoding: Encoding::BINARY) do |io|
+            MessagePack.load(io)
+          end
+        # handle malformed data due to upgrade incompatibility
+        rescue Errno::ENOENT, MessagePack::MalformedFormatError, MessagePack::UnknownExtTypeError, EOFError
+          {}
+        rescue ArgumentError => error
+          if error.message =~ /negative array size/
+            {}
+          else
+            raise
+          end
         end
       end
 
@@ -74,10 +85,13 @@ module Bootsnap
         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)
+        File.open(tmp, mode: exclusive_write, encoding: Encoding::BINARY) do |io|
+          MessagePack.dump(@data, io, freeze: true)
+        end
         FileUtils.mv(tmp, @store_path)
       rescue Errno::EEXIST
         retry
+      rescue SystemCallError
       end
     end
   end

data/lib/bootsnap/load_path_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bootsnap
   module LoadPathCache
     ReturnFalse = Class.new(StandardError)
@@ -7,6 +9,11 @@ module Bootsnap
     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
+
     DL_EXTENSIONS = ::RbConfig::CONFIG
       .values_at('DLEXT', 'DLEXT2')
       .reject { |ext| !ext || ext.empty? }
@@ -21,10 +28,9 @@ module Bootsnap
     CACHED_EXTENSIONS = DLEXT2 ? [DOT_RB, DLEXT, DLEXT2] : [DOT_RB, DLEXT]
 
     class << self
-      attr_reader(:load_path_cache, :autoload_paths_cache,
-        :loaded_features_index, :realpath_cache)
+      attr_reader(:load_path_cache, :loaded_features_index, :realpath_cache)
 
-      def setup(cache_path:, development_mode:, active_support: true)
+      def setup(cache_path:, development_mode:)
         unless supported?
           warn("[bootsnap/setup] Load path caching is not supported on this implementation of Ruby") if $VERBOSE
           return
@@ -38,23 +44,11 @@ module Bootsnap
         @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')
-
-        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
       end
 
       def supported?
         RUBY_ENGINE == 'ruby' &&
-        RUBY_PLATFORM =~ /darwin|linux|bsd/
+        RUBY_PLATFORM =~ /darwin|linux|bsd|mswin|mingw|cygwin/
       end
     end
   end

data/lib/bootsnap/setup.rb

@@ -1,35 +1,4 @@
+# frozen_string_literal: true
 require_relative('../bootsnap')
 
-env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['ENV']
-development_mode = ['', nil, 'development'].include?(env)
-
-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
-
-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:   true,
-  compile_cache_yaml:   true,
-)
+Bootsnap.default_setup

data/lib/bootsnap/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Bootsnap
-  VERSION = "1.4.0"
+  VERSION = "1.9.1"
 end

data/lib/bootsnap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative('bootsnap/version')
 require_relative('bootsnap/bundler')
 require_relative('bootsnap/load_path_cache')
@@ -6,42 +8,119 @@ require_relative('bootsnap/compile_cache')
 module Bootsnap
   InvalidConfiguration = Class.new(StandardError)
 
+  class << self
+    attr_reader :logger
+  end
+
+  def self.log!
+    self.logger = $stderr.method(:puts)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+    if logger.respond_to?(:debug)
+      self.instrumentation = ->(event, path) { @logger.debug("[Bootsnap] #{event} #{path}") }
+    else
+      self.instrumentation = ->(event, path) { @logger.call("[Bootsnap] #{event} #{path}") }
+    end
+  end
+
+  def self.instrumentation=(callback)
+    @instrumentation = callback
+    if respond_to?(:instrumentation_enabled=, true)
+      self.instrumentation_enabled = !!callback
+    end
+  end
+
+  def self._instrument(event, path)
+    @instrumentation.call(event, path)
+  end
+
   def self.setup(
     cache_dir:,
     development_mode: true,
     load_path_cache: true,
-    autoload_paths_cache: true,
-    disable_trace: false,
+    autoload_paths_cache: nil,
+    disable_trace: nil,
     compile_cache_iseq: true,
-    compile_cache_yaml: true
+    compile_cache_yaml: true,
+    compile_cache_json: true
   )
-    if autoload_paths_cache && !load_path_cache
-      raise(InvalidConfiguration, "feature 'autoload_paths_cache' depends on feature 'load_path_cache'")
+    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
 
-    setup_disable_trace if disable_trace
+    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
 
     Bootsnap::LoadPathCache.setup(
-      cache_path:       cache_dir + '/bootsnap-load-path-cache',
+      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',
+      cache_dir: cache_dir + '/bootsnap/compile-cache',
       iseq: compile_cache_iseq,
-      yaml: compile_cache_yaml
+      yaml: compile_cache_yaml,
+      json: compile_cache_json,
     )
   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",
+  def self.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')
+  end
+
+  def self.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
+
+
+      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'],
       )
-    else
-      RubyVM::InstructionSequence.compile_option = { trace_instruction: false }
+
+      if ENV['BOOTSNAP_LOG']
+        log!
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,28 +28,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        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
@@ -97,42 +97,31 @@ dependencies:
 description: Boot large ruby/rails apps faster
 email:
 - burke.libbey@shopify.com
-executables: []
+executables:
+- bootsnap
 extensions:
 - ext/bootsnap/extconf.rb
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
-- README.jp.md
 - README.md
-- Rakefile
-- bin/ci
-- bin/console
-- bin/setup
-- bin/test-minimal-support
-- bin/testunit
-- bootsnap.gemspec
-- dev.yml
+- 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
@@ -142,7 +131,6 @@ files:
 - lib/bootsnap/load_path_cache/store.rb
 - lib/bootsnap/setup.rb
 - lib/bootsnap/version.rb
-- shipit.rubygems.yml
 homepage: https://github.com/Shopify/bootsnap
 licenses:
 - MIT
@@ -150,6 +138,7 @@ metadata:
   bug_tracker_uri: https://github.com/Shopify/bootsnap/issues
   changelog_uri: https://github.com/Shopify/bootsnap/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/Shopify/bootsnap
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -158,14 +147,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Boot large ruby/rails apps faster

data/.gitignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-*.gem
-*.db
-mkmf.log
-.rubocop-*

data/.rubocop.yml

@@ -1,20 +0,0 @@
-inherit_from:
-  - http://shopify.github.io/ruby-style-guide/rubocop.yml
-
-AllCops:
-  Exclude:
-    - 'vendor/**/*'
-    - 'tmp/**/*'
-  TargetRubyVersion: '2.2'
-
-# This doesn't take into account retrying from an exception
-Lint/HandleExceptions:
-  Enabled: false
-
-# allow String.new to create mutable strings
-Style/EmptyLiteral:
-  Enabled: false
-
-# allow the use of globals which makes sense in a CLI app like this
-Style/GlobalVars:
-  Enabled: false

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-sudo: false
-
-os:
-  - linux
-  - osx
-
-rvm:
-  - ruby-2.4
-  - ruby-2.5
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  include:
-    - rvm: jruby
-      os: linux
-      env: MINIMAL_SUPPORT=1
-    - rvm: truffleruby
-      os: linux
-      env: MINIMAL_SUPPORT=1
-
-script: bin/ci