bootsnap 1.6.0 → 1.18.3

data/ext/bootsnap/extconf.rb

@@ -1,19 +1,33 @@
 # frozen_string_literal: true
-require("mkmf")
-$CFLAGS << ' -O3 '
-$CFLAGS << ' -std=c99'
 
-# ruby.h has some -Wpedantic fails in some cases
-# (e.g. https://github.com/Shopify/bootsnap/issues/15)
-unless ['0', '', nil].include?(ENV['BOOTSNAP_PEDANTIC'])
-  $CFLAGS << ' -Wall'
-  $CFLAGS << ' -Werror'
-  $CFLAGS << ' -Wextra'
-  $CFLAGS << ' -Wpedantic'
+require "mkmf"
 
-  $CFLAGS << ' -Wno-unused-parameter' # VALUE self has to be there but we don't care what it is.
-  $CFLAGS << ' -Wno-keyword-macro' # hiding return
-  $CFLAGS << ' -Wno-gcc-compat' # ruby.h 2.6.0 on macos 10.14, dunno
-end
+if %w[ruby truffleruby].include?(RUBY_ENGINE)
+  have_func "fdatasync", "unistd.h"
+
+  unless RUBY_PLATFORM.match?(/mswin|mingw|cygwin/)
+    append_cppflags ["-D_GNU_SOURCE"] # Needed of O_NOATIME
+  end
+
+  append_cflags ["-O3", "-std=c99"]
 
-create_makefile("bootsnap/bootsnap")
+  # ruby.h has some -Wpedantic fails in some cases
+  # (e.g. https://github.com/Shopify/bootsnap/issues/15)
+  unless ["0", "", nil].include?(ENV["BOOTSNAP_PEDANTIC"])
+    append_cflags([
+      "-Wall",
+      "-Werror",
+      "-Wextra",
+      "-Wpedantic",
+
+      "-Wno-unused-parameter", # VALUE self has to be there but we don't care what it is.
+      "-Wno-keyword-macro", # hiding return
+      "-Wno-gcc-compat", # ruby.h 2.6.0 on macos 10.14, dunno
+      "-Wno-compound-token-split-by-macro",
+    ])
+  end
+
+  create_makefile("bootsnap/bootsnap")
+else
+  File.write("Makefile", dummy_makefile($srcdir).join)
+end

data/lib/bootsnap/bundler.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Bootsnap
-  extend(self)
+  extend self
 
   def bundler?
     return false unless defined?(::Bundler)

data/lib/bootsnap/cli/worker_pool.rb

@@ -37,7 +37,11 @@ module Bootsnap
 
         def initialize(jobs)
           @jobs = jobs
-          @pipe_out, @to_io = IO.pipe
+          @pipe_out, @to_io = IO.pipe(binmode: true)
+          # Set the writer encoding to binary since IO.pipe only sets it for the reader.
+          # https://github.com/rails/rails/issues/16514#issuecomment-52313290
+          @to_io.set_encoding(Encoding::BINARY)
+
           @pid = nil
         end
 
@@ -59,6 +63,7 @@ module Bootsnap
           loop do
             job, *args = Marshal.load(@pipe_out)
             return if job == :exit
+
             @jobs.fetch(job).call(*args)
           end
         rescue IOError

data/lib/bootsnap/cli.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'bootsnap'
-require 'bootsnap/cli/worker_pool'
-require 'optparse'
-require 'fileutils'
-require 'etc'
+require "bootsnap"
+require "bootsnap/cli/worker_pool"
+require "optparse"
+require "fileutils"
+require "etc"
 
 module Bootsnap
   class CLI
@@ -21,51 +21,60 @@ module Bootsnap
 
     attr_reader :cache_dir, :argv
 
-    attr_accessor :compile_gemfile, :exclude, :verbose, :iseq, :yaml, :jobs
+    attr_accessor :compile_gemfile, :exclude, :verbose, :iseq, :yaml, :json, :jobs
 
     def initialize(argv)
       @argv = argv
-      self.cache_dir = ENV.fetch('BOOTSNAP_CACHE_DIR', 'tmp/cache')
+      self.cache_dir = ENV.fetch("BOOTSNAP_CACHE_DIR", "tmp/cache")
       self.compile_gemfile = false
       self.exclude = nil
       self.verbose = false
       self.jobs = Etc.nprocessors
       self.iseq = true
       self.yaml = true
+      self.json = true
     end
 
     def precompile_command(*sources)
-      require 'bootsnap/compile_cache/iseq'
-      require 'bootsnap/compile_cache/yaml'
+      require "bootsnap/compile_cache/iseq"
+      require "bootsnap/compile_cache/yaml"
+      require "bootsnap/compile_cache/json"
 
       fix_default_encoding do
-        Bootsnap::CompileCache::ISeq.cache_dir = self.cache_dir
+        Bootsnap::CompileCache::ISeq.cache_dir = cache_dir
         Bootsnap::CompileCache::YAML.init!
-        Bootsnap::CompileCache::YAML.cache_dir = self.cache_dir
+        Bootsnap::CompileCache::YAML.cache_dir = cache_dir
+        Bootsnap::CompileCache::JSON.init!
+        Bootsnap::CompileCache::JSON.cache_dir = cache_dir
 
         @work_pool = WorkerPool.create(size: jobs, jobs: {
           ruby: method(:precompile_ruby),
           yaml: method(:precompile_yaml),
+          json: method(:precompile_json),
         })
         @work_pool.spawn
 
         main_sources = sources.map { |d| File.expand_path(d) }
         precompile_ruby_files(main_sources)
         precompile_yaml_files(main_sources)
+        precompile_json_files(main_sources)
 
         if compile_gemfile
-          # Some gems embed their tests, they're very unlikely to be loaded, so not worth precompiling.
-          gem_exclude = Regexp.union([exclude, '/spec/', '/test/'].compact)
-          precompile_ruby_files($LOAD_PATH.map { |d| File.expand_path(d) }, exclude: gem_exclude)
-
-          # Gems that include YAML files usually don't put them in `lib/`.
+          # Gems that include JSON or YAML files usually don't put them in `lib/`.
           # So we look at the gem root.
-          gem_pattern = %r{^#{Regexp.escape(Bundler.bundle_path.to_s)}/?(?:bundler/)?gem\/[^/]+}
-          gem_paths = $LOAD_PATH.map { |p| p[gem_pattern] }.compact.uniq
+          # Similarly, gems that include Rails engines generally file Ruby files in `app/`.
+          # However some gems embed their tests, they're very unlikely to be loaded, so not worth precompiling.
+          gem_exclude = Regexp.union([exclude, "/spec/", "/test/", "/features/"].compact)
+
+          gem_pattern = %r{^#{Regexp.escape(Bundler.bundle_path.to_s)}/?(?:bundler/)?gems/[^/]+}
+          gem_paths = $LOAD_PATH.map { |p| p[gem_pattern] || p }.uniq
+
+          precompile_ruby_files(gem_paths, exclude: gem_exclude)
           precompile_yaml_files(gem_paths, exclude: gem_exclude)
+          precompile_json_files(gem_paths, exclude: gem_exclude)
         end
 
-        if exitstatus = @work_pool.shutdown
+        if (exitstatus = @work_pool.shutdown)
           exit(exitstatus)
         end
       end
@@ -82,7 +91,7 @@ module Bootsnap
     if dir_sort
       def list_files(path, pattern)
         if File.directory?(path)
-          Dir[File.join(path,  pattern), sort: false]
+          Dir[File.join(path, pattern), sort: false]
         elsif File.exist?(path)
           [path]
         else
@@ -92,7 +101,7 @@ module Bootsnap
     else
       def list_files(path, pattern)
         if File.directory?(path)
-          Dir[File.join(path,  pattern)]
+          Dir[File.join(path, pattern)]
         elsif File.exist?(path)
           [path]
         else
@@ -119,9 +128,9 @@ module Bootsnap
 
       load_paths.each do |path|
         if !exclude || !exclude.match?(path)
-          list_files(path, '**/*.{yml,yaml}').each do |yaml_file|
+          list_files(path, "**/*.{yml,yaml}").each do |yaml_file|
             # We ignore hidden files to not match the various .ci.yml files
-            if !yaml_file.include?('/.') && (!exclude || !exclude.match?(yaml_file))
+            if !File.basename(yaml_file).start_with?(".") && (!exclude || !exclude.match?(yaml_file))
               @work_pool.push(:yaml, yaml_file)
             end
           end
@@ -131,8 +140,31 @@ module Bootsnap
 
     def precompile_yaml(*yaml_files)
       Array(yaml_files).each do |yaml_file|
-        if CompileCache::YAML.precompile(yaml_file, cache_dir: cache_dir)
-          STDERR.puts(yaml_file) if verbose
+        if CompileCache::YAML.precompile(yaml_file) && verbose
+          $stderr.puts(yaml_file)
+        end
+      end
+    end
+
+    def precompile_json_files(load_paths, exclude: self.exclude)
+      return unless json
+
+      load_paths.each do |path|
+        if !exclude || !exclude.match?(path)
+          list_files(path, "**/*.json").each do |json_file|
+            # We ignore hidden files to not match the various .config.json files
+            if !File.basename(json_file).start_with?(".") && (!exclude || !exclude.match?(json_file))
+              @work_pool.push(:json, json_file)
+            end
+          end
+        end
+      end
+    end
+
+    def precompile_json(*json_files)
+      Array(json_files).each do |json_file|
+        if CompileCache::JSON.precompile(json_file) && verbose
+          $stderr.puts(json_file)
         end
       end
     end
@@ -142,7 +174,7 @@ module Bootsnap
 
       load_paths.each do |path|
         if !exclude || !exclude.match?(path)
-          list_files(path, '**/*.rb').each do |ruby_file|
+          list_files(path, "**/{*.rb,*.rake,Rakefile}").each do |ruby_file|
             if !exclude || !exclude.match?(ruby_file)
               @work_pool.push(:ruby, ruby_file)
             end
@@ -153,8 +185,8 @@ module Bootsnap
 
     def precompile_ruby(*ruby_files)
       Array(ruby_files).each do |ruby_file|
-        if CompileCache::ISeq.precompile(ruby_file, cache_dir: cache_dir)
-          STDERR.puts(ruby_file) if verbose
+        if CompileCache::ISeq.precompile(ruby_file) && verbose
+          $stderr.puts(ruby_file)
         end
       end
     end
@@ -173,14 +205,14 @@ module Bootsnap
     end
 
     def invalid_usage!(message)
-      STDERR.puts message
-      STDERR.puts
-      STDERR.puts parser
+      $stderr.puts message
+      $stderr.puts
+      $stderr.puts parser
       1
     end
 
     def cache_dir=(dir)
-      @cache_dir = File.expand_path(File.join(dir, 'bootsnap/compile-cache'))
+      @cache_dir = File.expand_path(File.join(dir, "bootsnap/compile-cache"))
     end
 
     def exclude_pattern(pattern)
@@ -195,24 +227,24 @@ module Bootsnap
         opts.separator "GLOBAL OPTIONS"
         opts.separator ""
 
-        help = <<~EOS
+        help = <<~HELP
           Path to the bootsnap cache directory. Defaults to tmp/cache
-        EOS
-        opts.on('--cache-dir DIR', help.strip) do |dir|
+        HELP
+        opts.on("--cache-dir DIR", help.strip) do |dir|
           self.cache_dir = dir
         end
 
-        help = <<~EOS
+        help = <<~HELP
           Print precompiled paths.
-        EOS
-        opts.on('--verbose', '-v', help.strip) do
+        HELP
+        opts.on("--verbose", "-v", help.strip) do
           self.verbose = true
         end
 
-        help = <<~EOS
+        help = <<~HELP
           Number of workers to use. Default to number of processors, set to 0 to disable multi-processing.
-        EOS
-        opts.on('--jobs JOBS', '-j', help.strip) do |jobs|
+        HELP
+        opts.on("--jobs JOBS", "-j", help.strip) do |jobs|
           self.jobs = Integer(jobs)
         end
 
@@ -221,25 +253,30 @@ module Bootsnap
         opts.separator ""
         opts.separator "    precompile [DIRECTORIES...]: Precompile all .rb files in the passed directories"
 
-        help = <<~EOS
+        help = <<~HELP
           Precompile the gems in Gemfile
-        EOS
-        opts.on('--gemfile', help) { self.compile_gemfile = true }
+        HELP
+        opts.on("--gemfile", help) { self.compile_gemfile = true }
 
-        help = <<~EOS
+        help = <<~HELP
           Path pattern to not precompile. e.g. --exclude 'aws-sdk|google-api'
-        EOS
-        opts.on('--exclude PATTERN', help) { |pattern| exclude_pattern(pattern) }
+        HELP
+        opts.on("--exclude PATTERN", help) { |pattern| exclude_pattern(pattern) }
 
-        help = <<~EOS
+        help = <<~HELP
           Disable ISeq (.rb) precompilation.
-        EOS
-        opts.on('--no-iseq', help) { self.iseq = false }
+        HELP
+        opts.on("--no-iseq", help) { self.iseq = false }
 
-        help = <<~EOS
+        help = <<~HELP
           Disable YAML precompilation.
-        EOS
-        opts.on('--no-yaml', help) { self.yaml = false }
+        HELP
+        opts.on("--no-yaml", help) { self.yaml = false }
+
+        help = <<~HELP
+          Disable JSON precompilation.
+        HELP
+        opts.on("--no-json", help) { self.json = false }
       end
     end
   end

data/lib/bootsnap/compile_cache/iseq.rb

@@ -1,25 +1,59 @@
 # frozen_string_literal: true
-require('bootsnap/bootsnap')
-require('zlib')
+
+require "bootsnap/bootsnap"
+require "zlib"
 
 module Bootsnap
   module CompileCache
     module ISeq
       class << self
-        attr_accessor(:cache_dir)
+        attr_reader(:cache_dir)
+
+        def cache_dir=(cache_dir)
+          @cache_dir = cache_dir.end_with?("/") ? "#{cache_dir}iseq" : "#{cache_dir}-iseq"
+        end
+
+        def supported?
+          CompileCache.supported? && defined?(RubyVM)
+        end
+      end
+
+      has_ruby_bug_18250 = begin # https://bugs.ruby-lang.org/issues/18250
+        if defined? RubyVM::InstructionSequence
+          RubyVM::InstructionSequence.compile("def foo(*); ->{ super }; end; def foo(**); ->{ super }; end").to_binary
+        end
+        false
+      rescue TypeError
+        true
       end
 
-      def self.input_to_storage(_, path)
-        RubyVM::InstructionSequence.compile_file(path).to_binary
-      rescue SyntaxError
-        raise(Uncompilable, 'syntax error')
+      if has_ruby_bug_18250
+        def self.input_to_storage(_, path)
+          iseq = begin
+            RubyVM::InstructionSequence.compile_file(path)
+          rescue SyntaxError
+            return UNCOMPILABLE # syntax error
+          end
+
+          begin
+            iseq.to_binary
+          rescue TypeError
+            UNCOMPILABLE # ruby bug #18250
+          end
+        end
+      else
+        def self.input_to_storage(_, path)
+          RubyVM::InstructionSequence.compile_file(path).to_binary
+        rescue SyntaxError
+          UNCOMPILABLE # syntax error
+        end
       end
 
       def self.storage_to_output(binary, _args)
         RubyVM::InstructionSequence.load_from_binary(binary)
-      rescue RuntimeError => e
-        if e.message == 'broken binary format'
-          STDERR.puts("[Bootsnap::CompileCache] warning: rejecting broken binary")
+      rescue RuntimeError => error
+        if error.message == "broken binary format"
+          $stderr.puts("[Bootsnap::CompileCache] warning: rejecting broken binary")
           nil
         else
           raise
@@ -35,7 +69,7 @@ module Bootsnap
         )
       end
 
-      def self.precompile(path, cache_dir: ISeq.cache_dir)
+      def self.precompile(path)
         Bootsnap::CompileCache::Native.precompile(
           cache_dir,
           path.to_s,
@@ -53,10 +87,8 @@ module Bootsnap
           return nil if defined?(Coverage) && Bootsnap::CompileCache::Native.coverage_running?
 
           Bootsnap::CompileCache::ISeq.fetch(path.to_s)
-        rescue Errno::EACCES
-          Bootsnap::CompileCache.permission_error(path)
-        rescue RuntimeError => e
-          if e.message =~ /unmatched platform/
+        rescue RuntimeError => error
+          if error.message =~ /unmatched platform/
             puts("unmatched platform for file #{path}")
           end
           raise
@@ -73,11 +105,15 @@ module Bootsnap
         crc = Zlib.crc32(option.inspect)
         Bootsnap::CompileCache::Native.compile_option_crc32 = crc
       end
-      compile_option_updated
+      compile_option_updated if supported?
 
       def self.install!(cache_dir)
         Bootsnap::CompileCache::ISeq.cache_dir = cache_dir
+
+        return unless supported?
+
         Bootsnap::CompileCache::ISeq.compile_option_updated
+
         class << RubyVM::InstructionSequence
           prepend(InstructionSequenceMixin)
         end

data/lib/bootsnap/compile_cache/json.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "bootsnap/bootsnap"
+
+module Bootsnap
+  module CompileCache
+    module JSON
+      class << self
+        attr_accessor(:msgpack_factory, :supported_options)
+        attr_reader(:cache_dir)
+
+        def cache_dir=(cache_dir)
+          @cache_dir = cache_dir.end_with?("/") ? "#{cache_dir}json" : "#{cache_dir}-json"
+        end
+
+        def input_to_storage(payload, _)
+          obj = ::JSON.parse(payload)
+          msgpack_factory.dump(obj)
+        end
+
+        def storage_to_output(data, kwargs)
+          if kwargs&.key?(:symbolize_names)
+            kwargs[:symbolize_keys] = kwargs.delete(:symbolize_names)
+          end
+          msgpack_factory.load(data, kwargs)
+        end
+
+        def input_to_output(data, kwargs)
+          ::JSON.parse(data, **(kwargs || {}))
+        end
+
+        def precompile(path)
+          Bootsnap::CompileCache::Native.precompile(
+            cache_dir,
+            path.to_s,
+            self,
+          )
+        end
+
+        def install!(cache_dir)
+          self.cache_dir = cache_dir
+          init!
+          if ::JSON.respond_to?(:load_file)
+            ::JSON.singleton_class.prepend(Patch)
+          end
+        end
+
+        def init!
+          require "json"
+          require "msgpack"
+
+          self.msgpack_factory = MessagePack::Factory.new
+          self.supported_options = [:symbolize_names]
+          if supports_freeze?
+            self.supported_options = [:freeze]
+          end
+          supported_options.freeze
+        end
+
+        private
+
+        def supports_freeze?
+          ::JSON.parse('["foo"]', freeze: true).first.frozen? &&
+            MessagePack.load(MessagePack.dump("foo"), freeze: true).frozen?
+        end
+      end
+
+      module Patch
+        def load_file(path, *args)
+          return super if args.size > 1
+
+          if (kwargs = args.first)
+            return super unless kwargs.is_a?(Hash)
+            return super unless (kwargs.keys - ::Bootsnap::CompileCache::JSON.supported_options).empty?
+          end
+
+          ::Bootsnap::CompileCache::Native.fetch(
+            Bootsnap::CompileCache::JSON.cache_dir,
+            File.realpath(path),
+            ::Bootsnap::CompileCache::JSON,
+            kwargs,
+          )
+        end
+
+        ruby2_keywords :load_file if respond_to?(:ruby2_keywords, true)
+      end
+    end
+  end
+end