bootsnap 0.2.15 → 1.1.0

data/ext/bootsnap/bootsnap.h

@@ -1,8 +1,6 @@
 #ifndef BOOTSNAP_H
 #define BOOTSNAP_H 1
 
-#include <stdint.h>
-#include <sys/types.h>
-#include "ruby.h"
+/* doesn't expose anything */
 
 #endif /* BOOTSNAP_H */

data/lib/bootsnap/compile_cache/iseq.rb

@@ -4,6 +4,10 @@ require 'zlib'
 module Bootsnap
   module CompileCache
     module ISeq
+      class << self
+        attr_accessor :cache_dir
+      end
+
       def self.input_to_storage(_, path)
         RubyVM::InstructionSequence.compile_file(path).to_binary
       rescue SyntaxError
@@ -27,7 +31,11 @@ module Bootsnap
 
       module InstructionSequenceMixin
         def load_iseq(path)
+          # Having coverage enabled prevents iseq dumping/loading.
+          return nil if defined?(Coverage) && Bootsnap::CompileCache::Native.coverage_running?
+
           Bootsnap::CompileCache::Native.fetch(
+            Bootsnap::CompileCache::ISeq.cache_dir,
             path.to_s,
             Bootsnap::CompileCache::ISeq
           )
@@ -36,18 +44,6 @@ module Bootsnap
             puts "unmatched platform for file #{path}"
           end
           raise
-        rescue Errno::ERANGE
-          STDERR.puts <<~EOF
-            \x1b[31mError loading ISeq from cache for \x1b[1;34m#{path}\x1b[0;31m!
-            You can likely fix this by running:
-              \x1b[1;32mxattr -c #{path}
-            \x1b[0;31m...but, first, please make sure \x1b[1;34m@burke\x1b[0;31m knows you ran into this bug!
-            He will want to see the results of:
-              \x1b[1;32m/bin/ls -l@ #{path}
-            \x1b[0;31mand:
-              \x1b[1;32mxattr -p user.aotcc.key #{path}\x1b[0m
-          EOF
-          raise
         end
 
         def compile_option=(hash)
@@ -62,7 +58,8 @@ module Bootsnap
         Bootsnap::CompileCache::Native.compile_option_crc32 = crc
       end
 
-      def self.install!
+      def self.install!(cache_dir)
+        Bootsnap::CompileCache::ISeq.cache_dir = cache_dir
         Bootsnap::CompileCache::ISeq.compile_option_updated
         class << RubyVM::InstructionSequence
           prepend InstructionSequenceMixin

data/lib/bootsnap/compile_cache/yaml.rb

@@ -1,3 +1,5 @@
+require 'bootsnap/bootsnap'
+
 module Bootsnap
   module CompileCache
     module YAML
@@ -30,7 +32,7 @@ module Bootsnap
         ::YAML.load(data)
       end
 
-      def self.install!
+      def self.install!(cache_dir)
         require 'yaml'
         require 'msgpack'
 
@@ -44,6 +46,7 @@ module Bootsnap
         klass = class << ::YAML; self; end
         klass.send(:define_method, :load_file) do |path|
           Bootsnap::CompileCache::Native.fetch(
+            cache_dir,
             path.to_s,
             Bootsnap::CompileCache::YAML
           )

data/lib/bootsnap/compile_cache.rb

@@ -1,15 +1,14 @@
-require_relative 'compile_cache/iseq'
-require_relative 'compile_cache/yaml'
-
 module Bootsnap
   module CompileCache
-    def self.setup(iseq:, yaml:)
+    def self.setup(cache_dir:, iseq:, yaml:)
       if iseq
-        Bootsnap::CompileCache::ISeq.install!
+        require_relative 'compile_cache/iseq'
+        Bootsnap::CompileCache::ISeq.install!(cache_dir)
       end
 
       if yaml
-        Bootsnap::CompileCache::YAML.install!
+        require_relative 'compile_cache/yaml'
+        Bootsnap::CompileCache::YAML.install!(cache_dir)
       end
     end
   end

data/lib/bootsnap/load_path_cache/cache.rb

@@ -46,9 +46,9 @@ module Bootsnap
       # Try to resolve this feature to an absolute path without traversing the
       # loadpath.
       def find(feature)
-        reinitialize if stale?
+        reinitialize if (@has_relative_paths && dir_changed?) || stale?
         feature = feature.to_s
-        return feature if feature.start_with?(SLASH)
+        return feature if absolute_path?(feature)
         return File.expand_path(feature) if feature.start_with?('./')
         @mutex.synchronize do
           x = search_index(feature)
@@ -85,6 +85,16 @@ module Bootsnap
         end
       end
 
+      if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+        def absolute_path?(path)
+          path[1] == ':'
+        end
+      else
+        def absolute_path?(path)
+          path.start_with?(SLASH)
+        end
+      end
+
       def unshift_paths(sender, *paths)
         return unless sender == @path_obj
         @mutex.synchronize { unshift_paths_locked(*paths) }
@@ -116,15 +126,26 @@ module Bootsnap
 
       private
 
+      def dir_changed?
+        @prev_dir ||= Dir.pwd
+        if @prev_dir == Dir.pwd
+          false
+        else
+          @prev_dir = Dir.pwd
+          true
+        end
+      end
+
       def push_paths_locked(*paths)
         @store.transaction do
           paths.map(&:to_s).each do |path|
             p = Path.new(path)
+            @has_relative_paths = true if p.relative?
             next if p.non_directory?
             entries, dirs = p.entries_and_dirs(@store)
             # push -> low precedence -> set only if unset
             dirs.each    { |dir| @dirs[dir]  ||= true }
-            entries.each { |rel| @index[rel] ||= path }
+            entries.each { |rel| @index[rel] ||= p.expanded_path }
           end
         end
       end
@@ -137,7 +158,7 @@ module Bootsnap
             entries, dirs = p.entries_and_dirs(@store)
             # unshift -> high precedence -> unconditional set
             dirs.each    { |dir| @dirs[dir]  = true }
-            entries.each { |rel| @index[rel] = path }
+            entries.each { |rel| @index[rel] = p.expanded_path }
           end
         end
       end

data/lib/bootsnap/load_path_cache/path.rb

@@ -30,34 +30,42 @@ module Bootsnap
         false
       end
 
+      def relative?
+        !path.start_with?(SLASH)
+      end
+
       # Return a list of all the requirable files and all of the subdirectories
       # of this +Path+.
       def entries_and_dirs(store)
         if stable?
           # the cached_mtime field is unused for 'stable' paths, but is
           # set to zero anyway, just in case we change the stability heuristics.
-          _, entries, dirs = store.get(path)
+          _, entries, dirs = store.get(expanded_path)
           return [entries, dirs] if entries # cache hit
           entries, dirs = scan!
-          store.set(path, [0, entries, dirs])
+          store.set(expanded_path, [0, entries, dirs])
           return [entries, dirs]
         end
 
-        cached_mtime, entries, dirs = store.get(path)
+        cached_mtime, entries, dirs = store.get(expanded_path)
 
-        current_mtime = latest_mtime(path, dirs || [])
+        current_mtime = latest_mtime(expanded_path, dirs || [])
         return [[], []]        if current_mtime == -1 # path does not exist
         return [entries, dirs] if cached_mtime == current_mtime
 
         entries, dirs = scan!
-        store.set(path, [current_mtime, entries, dirs])
+        store.set(expanded_path, [current_mtime, entries, dirs])
         [entries, dirs]
       end
 
+      def expanded_path
+        File.expand_path(path)
+      end
+
       private
 
       def scan! # (expensive) returns [entries, dirs]
-        PathScanner.call(path)
+        PathScanner.call(expanded_path)
       end
 
       # last time a directory was modified in this subtree. +dirs+ should be a
@@ -83,15 +91,17 @@ module Bootsnap
       VOLATILE = :volatile
 
       # Built-in ruby lib stuff doesn't change, but things can occasionally be
-      # installed into sitedir, which often lives under prefix.
-      RUBY_PREFIX = RbConfig::CONFIG['prefix']
-      SITE_DIR    = RbConfig::CONFIG['sitedir']
+      # installed into sitedir, which generally lives under libdir.
+      RUBY_LIBDIR  = RbConfig::CONFIG['libdir']
+      RUBY_SITEDIR = RbConfig::CONFIG['sitedir']
 
       def stability
         @stability ||= begin
-          if Gem.path.detect { |p| path.start_with?(p.to_s) }
+          if Gem.path.detect { |p| expanded_path.start_with?(p.to_s) }
+            STABLE
+          elsif expanded_path.start_with?(Bundler.bundle_path.to_s)
             STABLE
-          elsif path.start_with?(RUBY_PREFIX) && !path.start_with?(SITE_DIR)
+          elsif expanded_path.start_with?(RUBY_LIBDIR) && !expanded_path.start_with?(RUBY_SITEDIR)
             STABLE
           else
             VOLATILE

data/lib/bootsnap/load_path_cache/path_scanner.rb

@@ -3,8 +3,6 @@ require_relative '../load_path_cache'
 module Bootsnap
   module LoadPathCache
     module PathScanner
-      RelativePathNotSupported = Class.new(StandardError)
-
       REQUIRABLES_AND_DIRS = "/**/*{#{DOT_RB},#{DL_EXTENSIONS.join(',')},/}"
       IS_DIR = %r{(.*)/\z}
       NORMALIZE_NATIVE_EXTENSIONS = !DL_EXTENSIONS.include?(LoadPathCache::DOT_SO)
@@ -13,7 +11,6 @@ module Bootsnap
 
       def self.call(path)
         path = path.to_s
-        raise RelativePathNotSupported unless path.start_with?(SLASH)
 
         relative_slice = (path.size + 1)..-1
         # If the bundle path is a descendent of this path, we do additional

data/lib/bootsnap/load_path_cache/store.rb

@@ -59,7 +59,7 @@ module Bootsnap
         @data = begin
           MessagePack.load(File.binread(@store_path))
         # handle malformed data due to upgrade incompatability
-        rescue Errno::ENOENT, MessagePack::MalformedFormatError, MessagePack::UnknownExtTypeError
+        rescue Errno::ENOENT, MessagePack::MalformedFormatError, MessagePack::UnknownExtTypeError, EOFError
           {}
         end
       end

data/lib/bootsnap/setup.rb

@@ -0,0 +1,47 @@
+require_relative '../bootsnap'
+
+env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['ENV']
+development_mode = ['', nil, 'development'].include?(env)
+
+# only enable on 'ruby' (MRI), POSIX (darin, linux, *bsd), and >= 2.3.0
+enable_cc = \
+  RUBY_ENGINE == 'ruby' && \
+  RUBY_PLATFORM =~ /darwin|linux|bsd/ && \
+  RUBY_VERSION                    # "1.9.3"
+    .split('.')                   # ["1", "9", "3"]
+    .map(&:to_i)                  # [1, 9, 3]
+    .zip([2, 3, -1])              # [[1, 2], [9, 3], [3, -1]]
+    .map { |a, b| a <=> b }       # [-1, 1, 1]
+    .detect { |e| !e.zero? }      # -1
+    .==(1)                        # false
+
+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:   enable_cc,
+  compile_cache_yaml:   enable_cc
+)

data/lib/bootsnap/version.rb

@@ -1,3 +1,3 @@
 module Bootsnap
-  VERSION = "0.2.15"
+  VERSION = "1.1.0"
 end

data/lib/bootsnap.rb

@@ -27,6 +27,7 @@ module Bootsnap
     ) if load_path_cache
 
     Bootsnap::CompileCache.setup(
+      cache_dir: cache_dir + '/bootsnap-compile-cache',
       iseq: compile_cache_iseq,
       yaml: compile_cache_yaml
     )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 1.1.0
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: ffi-xattr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +132,7 @@ files:
 - lib/bootsnap/load_path_cache/path.rb
 - lib/bootsnap/load_path_cache/path_scanner.rb
 - lib/bootsnap/load_path_cache/store.rb
+- lib/bootsnap/setup.rb
 - lib/bootsnap/version.rb
 homepage: https://github.com/Shopify/bootsnap
 licenses:
@@ -159,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="