bootsnap 1.4.1 → 1.4.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ecf22c8b6dc4b98a6f7ac7fe451d3bc7e2d29893c2bc8e9428b0143997e739a
-  data.tar.gz: a57576a6e84953b44bf245e4e43e18a8a2a457a18fe5eb3688e066e9fe893c2c
+  metadata.gz: 1b7e391a76fc9fe8cc2c712d7623f26e6138f24c62acd3cd16a470f50812e554
+  data.tar.gz: 23d068050fd8c1962915608e73418c01dc568cc5371a5d27f77a269ef2926aeb
 SHA512:
-  metadata.gz: '005135654997ebaea3f0975bbc7be897b5d40eaaebec11573709ce83574f2131987441f103e795d45d7c83a4517ede8764e0a43c5e00cb53e84c8e498d9475e7'
-  data.tar.gz: 85cc529d70ec6318d30f1edba6cbed627276ee3c7fb200096960a3cd08a953ad0f018601bf223d0a5216b981edd07c3fa9b54b3192daa8881e0625c2d4f7fa11
+  metadata.gz: 815c87a26099673845b530d5a0bb2000ceda89f15a17eeca178b087d3ae4af6230ce8dcaa15a4360a2fdb0fc8d923d0659dc47ac6a7d2b072d43eebadeaebc79
+  data.tar.gz: 46584a5b22e3a64a02302a3ea87dfbe6e99676935838560ec93f938a0c3b86e854aacd48364e4f7161c021d5472497844b3d81074e1a3cc1be82a2aac3bee158

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# mvm:maintainer
+* @burke

data/.github/probots.yml

@@ -0,0 +1,2 @@
+enabled:
+  - cla

data/.travis.yml

@@ -17,8 +17,5 @@ matrix:
     - rvm: jruby
       os: linux
       env: MINIMAL_SUPPORT=1
-    - rvm: truffleruby
-      os: linux
-      env: MINIMAL_SUPPORT=1
 
 script: bin/ci

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.4.2
+
+* Fix bug when removing features loaded by relative path from `$LOADED_FEATURES`
+* Fix bug with propagation of `NameError` up from nested calls to `require`
+
 # 1.4.1
 
 * Don't register change observers to frozen objects.

data/README.md

@@ -4,9 +4,14 @@ Bootsnap is a library that plugs into Ruby, with optional support for `ActiveSup
 to optimize and cache expensive computations. See [How Does This Work](#how-does-this-work).
 
 #### Performance
-- [Discourse](https://github.com/discourse/discourse) reports a boot time reduction of approximately 50%, from roughly 6 to 3 seconds on one machine;
+
+- [Discourse](https://github.com/discourse/discourse) reports a boot time reduction of approximately
+  50%, from roughly 6 to 3 seconds on one machine;
 - One of our smaller internal apps also sees a reduction of 50%, from 3.6 to 1.8 seconds;
-- The core Shopify platform -- a rather large monolithic application -- boots about 75% faster, dropping from around 25s to 6.5s.
+- The core Shopify platform -- a rather large monolithic application -- boots about 75% faster,
+  dropping from around 25s to 6.5s.
+* In Shopify core (a large app), about 25% of this gain can be attributed to `compile_cache_*`
+  features; 75% to path caching, and ~1% to `disable_trace`. This is fairly representative.
 
 ## Usage
 
@@ -284,3 +289,12 @@ open    /c/nope.bundle -> -1
 ```
 # (nothing!)
 ```
+
+## When not to use Bootsnap
+
+*Alternative engines*: Bootsnap is pretty reliant on MRI features, and parts are disabled entirely on alternative ruby
+engines.
+
+*Non-local filesystems*: Bootsnap depends on `tmp/cache` (or whatever you set its cache directory
+to) being on a relatively fast filesystem. If you put it on a network mount, bootsnap is very likely
+to slow your application down quite a lot.

data/ext/bootsnap/bootsnap.c

@@ -468,21 +468,21 @@ static int
 atomic_write_cache_file(char * path, struct bs_cache_key * key, VALUE data, char ** errno_provenance)
 {
   char template[MAX_CACHEPATH_SIZE + 20];
-  char * dest;
   char * tmp_path;
   int fd, ret;
   ssize_t nwrite;
 
-  dest = strncpy(template, path, MAX_CACHEPATH_SIZE);
-  strcat(dest, ".tmp.XXXXXX");
+  tmp_path = strncpy(template, path, MAX_CACHEPATH_SIZE);
+  strcat(tmp_path, ".tmp.XXXXXX");
 
-  tmp_path = mktemp(template);
-  fd = open(tmp_path, O_WRONLY | O_CREAT, 0664);
+  // mkstemp modifies the template to be the actual created path
+  fd = mkstemp(tmp_path);
   if (fd < 0) {
-    if (mkpath(path, 0775) < 0) {
+    if (mkpath(tmp_path, 0775) < 0) {
       *errno_provenance = (char *)"bs_fetch:atomic_write_cache_file:mkpath";
       return -1;
     }
+    close(fd);
     fd = open(tmp_path, O_WRONLY | O_CREAT, 0664);
     if (fd < 0) {
       *errno_provenance = (char *)"bs_fetch:atomic_write_cache_file:open";

data/lib/bootsnap/compile_cache/iseq.rb

@@ -39,6 +39,8 @@ module Bootsnap
             path.to_s,
             Bootsnap::CompileCache::ISeq
           )
+        rescue Errno::EACCES
+          Bootsnap::CompileCache.permission_error(path)
         rescue RuntimeError => e
           if e.message =~ /unmatched platform/
             puts("unmatched platform for file #{path}")

data/lib/bootsnap/compile_cache/yaml.rb

@@ -46,11 +46,15 @@ module Bootsnap
 
         klass = class << ::YAML; self; end
         klass.send(:define_method, :load_file) do |path|
-          Bootsnap::CompileCache::Native.fetch(
-            cache_dir,
-            path,
-            Bootsnap::CompileCache::YAML
-          )
+          begin
+            Bootsnap::CompileCache::Native.fetch(
+              cache_dir,
+              path,
+              Bootsnap::CompileCache::YAML
+            )
+          rescue Errno::EACCES
+            Bootsnap::CompileCache.permission_error(path)
+          end
         end
       end
     end

data/lib/bootsnap/compile_cache.rb

@@ -1,5 +1,8 @@
 module Bootsnap
   module CompileCache
+    Error           = Class.new(StandardError)
+    PermissionError = Class.new(Error)
+
     def self.setup(cache_dir:, iseq:, yaml:)
       if iseq
         if supported?
@@ -20,6 +23,15 @@ module Bootsnap
       end
     end
 
+    def self.permission_error(path)
+      cpath = Bootsnap::CompileCache::ISeq.cache_dir
+      raise(
+        PermissionError,
+        "bootsnap doesn't have permission to write cache entries in '#{cpath}' " \
+        "(or, less likely, doesn't have permisison to read '#{path}')",
+      )
+    end
+
     def self.supported?
       # only enable on 'ruby' (MRI), POSIX (darwin, linux, *bsd), and >= 2.3.0
       RUBY_ENGINE == 'ruby' &&

data/lib/bootsnap/load_path_cache/cache.rb

@@ -46,7 +46,7 @@ module Bootsnap
         reinitialize if (@has_relative_paths && dir_changed?) || stale?
         feature = feature.to_s
         return feature if absolute_path?(feature)
-        return File.expand_path(feature) if feature.start_with?('./')
+        return expand_path(feature) if feature.start_with?('./')
         @mutex.synchronize do
           x = search_index(feature)
           return x if x
@@ -162,6 +162,10 @@ module Bootsnap
         end
       end
 
+      def expand_path(feature)
+        maybe_append_extension(File.expand_path(feature))
+      end
+
       def stale?
         @development_mode && @generated_at + AGE_THRESHOLD < now
       end
@@ -174,10 +178,18 @@ module Bootsnap
         def search_index(f)
           try_index(f + DOT_RB) || try_index(f + DLEXT) || try_index(f + DLEXT2) || try_index(f)
         end
+
+        def maybe_append_extension(f)
+          try_ext(f + DOT_RB) || try_ext(f + DLEXT) || try_ext(f + DLEXT2) || f
+        end
       else
         def search_index(f)
           try_index(f + DOT_RB) || try_index(f + DLEXT) || try_index(f)
         end
+
+        def maybe_append_extension(f)
+          try_ext(f + DOT_RB) || try_ext(f + DLEXT) || f
+        end
       end
 
       def try_index(f)
@@ -185,6 +197,10 @@ module Bootsnap
           p + '/' + f
         end
       end
+
+      def try_ext(f)
+        f if File.exist?(f)
+      end
     end
   end
 end

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

@@ -18,6 +18,11 @@ module Bootsnap
           Thread.current[:without_bootsnap_retry] = prev
         end
 
+        # 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
+
         module ClassMethods
           def autoload_paths=(o)
             super
@@ -60,19 +65,22 @@ module Bootsnap
               super
             end
           rescue NameError => e
+            raise(e) if e.instance_variable_defined?(ERROR_TAG_IVAR)
+            e.instance_variable_set(ERROR_TAG_IVAR, true)
+
             # This function can end up called recursively, we only want to
             # retry at the top-level.
-            raise if Thread.current[:without_bootsnap_retry]
+            raise(e) if Thread.current[:without_bootsnap_retry]
             # If we already had cache disabled, there's no use retrying
-            raise if Thread.current[:without_bootsnap_cache]
+            raise(e) if Thread.current[:without_bootsnap_cache]
             # NoMethodError is a NameError, but we only want to handle actual
             # NameError instances.
-            raise unless e.class == NameError
+            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 unless e.name == const_name
+            raise(e) unless e.name == const_name
             # If the constant was actually loaded, something else went wrong?
-            raise if from_mod.const_defined?(const_name)
+            raise(e) if from_mod.const_defined?(const_name)
             CoreExt::ActiveSupport.without_bootsnap_cache { super }
           end
 
@@ -80,9 +88,12 @@ module Bootsnap
           # reiterate it with version polymorphism here...
           def depend_on(*)
             super
-          rescue LoadError
+          rescue LoadError => e
+            raise(e) if e.instance_variable_defined?(ERROR_TAG_IVAR)
+            e.instance_variable_set(ERROR_TAG_IVAR, true)
+
             # If we already had cache disabled, there's no use retrying
-            raise if Thread.current[:without_bootsnap_cache]
+            raise(e) if Thread.current[:without_bootsnap_cache]
             CoreExt::ActiveSupport.without_bootsnap_cache { super }
           end
         end

data/lib/bootsnap/load_path_cache/store.rb

@@ -60,9 +60,11 @@ 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
-                  {}
+          # handle malformed data due to upgrade incompatability
+        rescue Errno::ENOENT, MessagePack::MalformedFormatError, MessagePack::UnknownExtTypeError, EOFError
+          {}
+        rescue ArgumentError => e
+          e.message =~ /negative array size/ ? {} : raise
         end
       end
 

data/lib/bootsnap/version.rb

@@ -1,3 +1,3 @@
 module Bootsnap
-  VERSION = "1.4.1"
+  VERSION = "1.4.2.rc1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2.rc1
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,8 @@ extensions:
 - ext/bootsnap/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/probots.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -161,12 +163,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Boot large ruby/rails apps faster