Gem install fails for Ruby 3.2 in MacOS 12.6

[emceeaich]

Summary

Gem install fails with include file not found

Steps to reproduce

git clone [email protected]:zk-ruby/zookeeper.git
cd zookeeper
cat .ruby-version
3.2.0
^d
gem make zookeeper.gemspec
gem install zookeeper-1.5.4
irb 
>> require('zookeeper')

What happened

irb
irb(main):001:0> RUBY_VERSION
=> "3.2.0"
irb(main):002:0> require 'zookeeper'
<internal:/Users/emmah/.rbenv/versions/3.2.0/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:85:in `require': cannot load such file -- /Users/emmah/.rbenv/versions/3.2.0/lib/ruby/gems/3.2.0/gems/zookeeper-1.5.4/ext/zookeeper_c (LoadError)
	from <internal:/Users/emmah/.rbenv/versions/3.2.0/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:85:in `require'
	from /Users/emmah/.rbenv/versions/3.2.0/lib/ruby/gems/3.2.0/gems/zookeeper-1.5.4/lib/zookeeper.rb:26:in `block in require_root'
	from /Users/emmah/.rbenv/versions/3.2.0/lib/ruby/gems/3.2.0/gems/zookeeper-1.5.4/lib/zookeeper.rb:25:in `each'
	from /Users/emmah/.rbenv/versions/3.2.0/lib/ruby/gems/3.2.0/gems/zookeeper-1.5.4/lib/zookeeper.rb:25:in `require_root'
	from /Users/emmah/.rbenv/versions/3.2.0/lib/ruby/gems/3.2.0/gems/zookeeper-1.5.4/ext/c_zookeeper.rb:8:in `<top (required)>'

Expected

Gem installs without error

[emceeaich]

Another member of the team observed this when reproducing the error:

also here’s some output from when i installed it locally in 3.2:

linking shared-object zookeeper_c.bundle
current directory: /Users/daniel/.rbenv/versions/3.2.0/lib/ruby/gems/3.2.0/gems/zookeeper-1.5.4/ext
["make", "DESTDIR=", "sitearchdir=./.gem.20230105-56605-j5n3n4", "sitelibdir=./.gem.20230105-56605-j5n3n4", "install"]
/usr/bin/install -c -m 0755 zookeeper_c.bundle ./.gem.20230105-56605-j5n3n4

and the same bits for 3.1:

linking shared-object zookeeper_c.bundle
current directory: /Users/daniel/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/zookeeper-1.5.4/ext
["make", "DESTDIR=", "install"]
/usr/bin/install -c -m 0755 zookeeper_c.bundle ./.gem.20230105-66585-rsvonm

[tsroten]

It looks like the issue stems from the upgrade to Rubygems 3.4 as part of the Ruby 3.2.0 release. Specifically, build artifacts in the ext/ directory are cleaned up during gem installation.

Here is a possible fix:

diff --git a/ext/c_zookeeper.rb b/ext/c_zookeeper.rb
index 1c6f091..54f7d3f 100644
--- a/ext/c_zookeeper.rb
+++ b/ext/c_zookeeper.rb
@@ -5,7 +5,11 @@ Zookeeper.require_lib(
   'zookeeper/exceptions' # zookeeper_c depends on exceptions defined in here
 )

-Zookeeper.require_root 'ext/zookeeper_c'
+begin
+    Zookeeper.require_root 'ext/zookeeper_c'
+rescue LoadError # Rubygems 3.4+ cleans up build artifacts in the ext/ directory.
+    Zookeeper.require_lib 'zookeeper_c'
+end

 # require File.expand_path('../zookeeper_c', __FILE__)

[malmckay]

@emceeaich & @tsroten Thanks for the report, and the suggested fix. I've release 1.5.5 that loads correctly on Ruby 3.2

[emceeaich]

Confirming this is working in my env. Thank you all!