AR ホームベーカリー

オイラのアウトプット用ホームベーカリー!

homebrew 環境で bundle install しても mysql2 がインストールできない時

小さい結論

.bundle/config に以下を書く。

BUNDLE_BUILD__MYSQL2: "--with-mysql-lib=/opt/homebrew/opt/mysql/lib --with-mysql-dir=/opt/homebrew/opt/mysql --with-mysql-config=/opt/homebrew/opt/mysql/bin/mysql_config \ --with-mysql-include=/opt/homebrew/opt/mysql/include --with-ldflags=-L/opt/homebrew/opt/zlib/lib"

エラー

こんな感じのエラーが出た時が対象。

Gem::Ext::BuildError: ERROR: Failed to build gem native extension.

    current directory: /Users/donbulinux/Workspace/example/vendor/bundle/ruby/3.1.0/gems/mysql2-0.5.5/ext/mysql2
/Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/bin/ruby -I /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0 extconf.rb
checking for rb_absint_size()... yes
checking for rb_absint_singlebit_p()... yes
checking for rb_gc_mark_movable()... yes
checking for rb_wait_for_single_fd()... yes
checking for rb_enc_interned_str() in ruby.h... yes
-----
Using --with-openssl-dir=/opt/homebrew/opt/openssl@3
-----
-----
Using mysql_config at /opt/homebrew/bin/mysql_config
-----
checking for mysql.h... yes
checking for errmsg.h... yes
checking for SSL_MODE_DISABLED in mysql.h... yes
checking for SSL_MODE_PREFERRED in mysql.h... yes
checking for SSL_MODE_REQUIRED in mysql.h... yes
checking for SSL_MODE_VERIFY_CA in mysql.h... yes
checking for SSL_MODE_VERIFY_IDENTITY in mysql.h... yes
checking for MYSQL.net.vio in mysql.h... yes
checking for MYSQL.net.pvio in mysql.h... no
checking for MYSQL_DEFAULT_AUTH in mysql.h... yes
checking for MYSQL_ENABLE_CLEARTEXT_PLUGIN in mysql.h... yes
checking for SERVER_QUERY_NO_GOOD_INDEX_USED in mysql.h... yes
checking for SERVER_QUERY_NO_INDEX_USED in mysql.h... yes
checking for SERVER_QUERY_WAS_SLOW in mysql.h... yes
checking for MYSQL_OPTION_MULTI_STATEMENTS_ON in mysql.h... yes
checking for MYSQL_OPTION_MULTI_STATEMENTS_OFF in mysql.h... yes
checking for my_bool in mysql.h... no
-----
Don't know how to set rpath on your system, if MySQL libraries are not in path mysql2 may not load
-----
-----
Setting libpath to /opt/homebrew/Cellar/mysql/8.2.0_1/lib
-----
creating Makefile

current directory: /Users/donbulinux/Workspace/example/vendor/bundle/ruby/3.1.0/gems/mysql2-0.5.5/ext/mysql2
make DESTDIR\= sitearchdir\=./.gem.20240215-69106-y49t6l sitelibdir\=./.gem.20240215-69106-y49t6l clean

current directory: /Users/donbulinux/Workspace/example/vendor/bundle/ruby/3.1.0/gems/mysql2-0.5.5/ext/mysql2
make DESTDIR\= sitearchdir\=./.gem.20240215-69106-y49t6l sitelibdir\=./.gem.20240215-69106-y49t6l
compiling client.c
In file included from client.c:15:
./mysql_enc_name_to_ruby.h:43:1: warning: a function definition without a prototype is deprecated in all versions of C and is not supported in C2x
[-Wdeprecated-non-prototype]
mysql2_mysql_enc_name_to_rb_hash (str, len)
^
./mysql_enc_name_to_ruby.h:86:1: warning: a function definition without a prototype is deprecated in all versions of C and is not supported in C2x
[-Wdeprecated-non-prototype]
mysql2_mysql_enc_name_to_rb (str, len)
^
2 warnings generated.
compiling infile.c
compiling mysql2_ext.c
compiling result.c
result.c:304:35: warning: implicit conversion loses integer precision: 'unsigned long' to 'int' [-Wshorten-64-to-32]
        precision = field->length - (field->decimals > 0 ? 2 : 1);
                  ~ ~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.
compiling statement.c
linking shared-object mysql2/mysql2.bundle
ld: warning: ignoring duplicate libraries: '-lruby.3.1'
ld: library 'zstd' not found
clang: error: linker command failed with exit code 1 (use -v to see invocation)
make: *** [mysql2.bundle] Error 1

make failed, exit code 2

Gem files will remain installed in /Users/donbulinux/Workspace/example/vendor/bundle/ruby/3.1.0/gems/mysql2-0.5.5 for inspection.
Results logged to /Users/donbulinux/Workspace/example/vendor/bundle/ruby/3.1.0/extensions/arm64-darwin-22/3.1.0/mysql2-0.5.5/gem_make.out

  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:102:in `run'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:51:in `block in make'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:43:in `each'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:43:in `make'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/ext_conf_builder.rb:42:in `build'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:171:in `build_extension'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:205:in `block in build_extensions'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:202:in `each'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/ext/builder.rb:202:in `build_extensions'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/3.1.0/rubygems/installer.rb:843:in `build_extensions'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/rubygems_gem_installer.rb:71:in `build_extensions'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/rubygems_gem_installer.rb:28:in `install'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/source/rubygems.rb:204:in `install'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/installer/gem_installer.rb:54:in `install'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/installer/gem_installer.rb:16:in `install_from_spec'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/installer/parallel_installer.rb:186:in `do_install'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/installer/parallel_installer.rb:177:in `block in worker_pool'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/worker.rb:62:in `apply_func'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/worker.rb:57:in `block in process_queue'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/worker.rb:54:in `loop'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/worker.rb:54:in `process_queue'
  /Users/donbulinux/.anyenv/envs/rbenv/versions/3.1.4/lib/ruby/gems/3.1.0/gems/bundler-2.3.3/lib/bundler/worker.rb:91:in `block (2 levels) in create_threads'

An error occurred while installing mysql2 (0.5.5), and Bundler cannot continue.

In Gemfile:
  mysql2

まあ Don't know how to set rpath on your system, if MySQL libraries are not in path mysql2 may not load と答えが書いてあるんですよね。

けど正直母国語じゃないと認知不可高いし、エラーログってスタックトレース出すのが第一になってて、「こうしろ!」みたいな適切なサジェストが来るとは言えないので。

Ruby の再インストール

最近の Homebrew は brew install mysql などすると、容赦なく InnovationRelease をインストールしてくるのでライブラリの更新が激しい。

なので、以下の様に Ruby を再インストールすることで、ライブラリの再リンクを促すと案外うまくいくパターンがある。

donbulinux.hatenablog.jp

が、これでも解決しない場合がある。 前述の通り homebrew で MySQL のバージョンが変わって、ライブラリのパスが更新されたりする場合などだ。

bundle に値を追加する

そこで、bundle の動作を記述する .bundle/config に以下を記述しておくことで、 MySQL が不意にアップデートされて参照すべきライブラリのパスなどが変わっても追従できるようにする。

---
BUNDLE_PATH: "vendor/bundle"
BUNDLE_BUILD__MYSQL2: "--with-mysql-lib=/opt/homebrew/opt/mysql/lib --with-mysql-dir=/opt/homebrew/opt/mysql --with-mysql-config=/opt/homebrew/opt/mysql/bin/mysql_config \ --with-mysql-include=/opt/homebrew/opt/mysql/include --with-ldflags=-L/opt/homebrew/opt/zlib/lib"

BUNDLE_PATH は僕の環境でこう設定しているだけなので、各々の環境に合わせてほしい。 記述されていないなら追記しないほうが動作上の問題がおきなくて良い、必要なのは BUNDLE_BUILD__MYSQL2: なので。

この対応が必要なパターン

Docker などで x86 な環境を動かしていると、 /usr /usr/local を探すはずなのでこの対応はいらないはず。 なのでタイトルの通り homebrew 環境、と書いている。

なんで

Docker で構築されているのに、それらで docker exec bundle install 〜 を利用せずに macOS 上で直接 bundle install を実行する必要があるんですか……?(猫の顔

Docker の起動コストが高すぎて、 Gemfile.lock 更新したいだけのために起動するの面倒だからですかね……。

マジでそういうのヤメロ、って怒られたらそれはそう。