bootsnap 1.21.0 → 1.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adb5e1d46d7560b403e6ef7051f9ad2ef21feca194c41f0af77f2e73d6e06508
-  data.tar.gz: cebcb8c52f1da65f13c531d05f5150fbe2b54d3fa51e0122b2cf4f2998cb63b9
+  metadata.gz: 4ca69038da7071534a7279f36d694ec5bcf5687272d091b314372b1f3195831b
+  data.tar.gz: c5dc747c2c66a71881d99af980085c06bfc378134d25712c51221b7fb6a6c03a
 SHA512:
-  metadata.gz: 6ff78c410b363a8e2fbc9e370b684865a3aaa45e6de961d9d8dd6b1207fa2002a4d0115751ad5b259e21d69d215a4859587da79386e3b6d0cdde7e54205620d2
-  data.tar.gz: bac1b52dfad5b0e0e1e03e6feeeb2c9d3555608410b7a73fc005e044bf31641aa8bdd72bf4f595eee69b7c58e4701579c5e6961a4937246567ef097bb9956aaf
+  metadata.gz: 9da2aa5050b26d377f46d1de5e8424168e0a60b00160d43ebdaf9f93c4a9006931bf6463a24afa6dd76559ccedc4ce3798d48733d5000a7a5eac08d7c7a03510
+  data.tar.gz: 17a8da7a372189c22f400f5c059947f98c6aa7836390965c92e6e173970a61e2e6aa57d77d3dd11a9ecea0afd729512a115fd38a21c7a30850d1e9bd662b7d26

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+# 1.21.1
+
+* Prevent a Ruby crash while scanning load path if `opendir` fails without setting `errno`.
+  According to the C spec this should not happen, but according to user reports, it did.
+
 # 1.21.0
 
 * Fix the `require` decorator to handle `Bootsnap.unload_cache!` being called.

data/ext/bootsnap/bootsnap.c

@@ -21,6 +21,10 @@
 #include <sys/stat.h>
 #include <dirent.h>
 
+#ifndef RBIMPL_ATTR_NORETURN
+#define RBIMPL_ATTR_NORETURN()
+#endif
+
 #ifdef __APPLE__
   // The symbol is present, however not in the headers
   // See: https://github.com/rails/bootsnap/issues/470
@@ -152,6 +156,21 @@ bs_rb_get_path(VALUE self, VALUE fname)
 }
 
 #ifdef HAVE_FSTATAT
+
+RBIMPL_ATTR_NORETURN()
+static void
+bs_syserr_fail_path(const char *func_name, int n, VALUE path)
+{
+    rb_syserr_fail_str(n, rb_sprintf("%s @ %s", func_name, RSTRING_PTR(path)));
+}
+
+RBIMPL_ATTR_NORETURN()
+static void
+bs_syserr_fail_dir_entry(const char *func_name, int n, VALUE dir, const char *d_name)
+{
+    rb_syserr_fail_str(n, rb_sprintf("%s @ %s/%s", func_name, RSTRING_PTR(dir), d_name));
+}
+
 static VALUE
 bs_rb_scan_dir(VALUE self, VALUE abspath)
 {
@@ -167,7 +186,17 @@ bs_rb_scan_dir(VALUE self, VALUE abspath)
         if (errno == ENOTDIR || errno == ENOENT) {
             return result;
         }
-        rb_sys_fail("opendir");
+
+        // BUG: Some users reported a crash here because Ruby's syserr trigger
+        // a crash if called with `errno == 0`.
+        // The opendir spec is quite clear that if it returns NULL, then `errno` must
+        // be set, and yet here we are.
+        // So turning no errno into EINVAL, and from there I hope to get to the bottom of things.
+        if (errno == 0) {
+            errno = EINVAL;
+        }
+
+        bs_syserr_fail_path("opendir", errno, abspath);
         return Qundef;
     }
 
@@ -185,7 +214,9 @@ bs_rb_scan_dir(VALUE self, VALUE abspath)
             if (dfd < 0) {
                 dfd = dirfd(dirp);
                 if (dfd < 0) {
-                    rb_sys_fail("dirfd");
+                    int err = errno;
+                    closedir(dirp);
+                    bs_syserr_fail_path("dirfd", err, abspath);
                     return Qundef;
                 }
             }
@@ -193,9 +224,12 @@ bs_rb_scan_dir(VALUE self, VALUE abspath)
             if (fstatat(dfd, entry->d_name, &st, 0)) {
                 if (errno == ENOENT) {
                     // Broken symlinK
+                    errno = 0;
                     continue;
                 }
-                rb_sys_fail("fstatat");
+                int err = errno;
+                closedir(dirp);
+                bs_syserr_fail_dir_entry("fstatat", err, abspath, entry->d_name);
                 return Qundef;
             }
 
@@ -226,7 +260,7 @@ bs_rb_scan_dir(VALUE self, VALUE abspath)
     }
 
     if (closedir(dirp)) {
-        rb_sys_fail("closedir");
+        bs_syserr_fail_path("closedir", errno, abspath);
         return Qundef;
     }
     return result;

data/lib/bootsnap/load_path_cache/path_scanner.rb

@@ -102,6 +102,13 @@ module Bootsnap
             end
 
             all_requirables
+          rescue SystemCallError => error
+            if ENV["BOOTSNAP_DEBUG"]
+              raise
+            else
+              Bootsnap.logger&.call("Unexpected error: #{error.class}: #{error.message}")
+              ruby_call(root_path)
+            end
           end
           alias_method :call, :native_call
         else

data/lib/bootsnap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bootsnap
-  VERSION = "1.21.0"
+  VERSION = "1.21.1"
 end

data/lib/bootsnap.rb

@@ -2,8 +2,6 @@
 
 require_relative "bootsnap/version"
 require_relative "bootsnap/bundler"
-require_relative "bootsnap/compile_cache"
-require_relative "bootsnap/load_path_cache"
 
 module Bootsnap
   InvalidConfiguration = Class.new(StandardError)
@@ -164,3 +162,6 @@ module Bootsnap
     end
   end
 end
+
+require_relative "bootsnap/compile_cache"
+require_relative "bootsnap/load_path_cache"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.21.1
 platform: ruby
 authors:
 - Burke Libbey