もちゅろぐ
ツール
RubyMine
RubyMineでUNIXドメインソケット通信なRailsアプリをデバッグする方法

RubyMineでUNIXドメインソケット通信なRailsアプリをデバッグする方法

2020-3-29

Table of Contents

環境
RubyMineから実行はUNIXドメインソケット通信による起動がない
UNIXドメインソケット通信はRubyMineでRailsアプリをアタッチする
RubyMineでUNIXドメインソケット通信でもデバッグできるようになる

RubyMine使ってますか？周りで使ってる人は少なく、ネットでも一部の人しか使われていない印象です。しかしIDE上がりの人間からするとやはりIDEの恩恵は授かりたいものですよね。私達は開発環境を整えるためにRubyを弄ってるのではなくアプリやツールなど体験を提供するサービスを作りたいのが本質のはずですし。

今回はRubyMineを使ってUNIXドメインソケット通信で起動してるRailsアプリにブレイクポイントを仕込んだり、ブレイクポイントで止めたコンテキストからRubyを実行したり、変数をウォッチしたりするいわゆるデバッグする方法についてまとめます。

環境

RubyMine
PumaにてUNIXドメインソケット通信中のRailsアプリ
Mac

RubyMineから実行はUNIXドメインソケット通信による起動がない

通常ならRubyMineからRailsアプリを実行するには、メニューバーの Run > Run... > Development: app_name の順で実行できます。もし設定を変更したい場合は、Run > Edit Configurations...を選ぶことで登録された設定情報を変更できる画面が表示されます。

▼RubyMineのEdit Configurations…を開いた画面

ここでIP addressとPortを指定して実行すればサーバが立ち上がります。しかしこの方法はTCP/IPによるポートが開かれるタイプとなり、UNIXドメインソケットによる立ち上げとは異なります。

Server項目を見てもそれらしき項目は見当たりません。

▼サーバーパラメータ一覧

私が調べた限りでは直接UNIXドメインソケット通信として起動する方法はありませんでした。これでは起動もデバッグもできずで、RubyMineが使い物にならなくなります。しかし、実は少し手間ですがちゃんと手段はあります。

UNIXドメインソケット通信はRubyMineでRailsアプリをアタッチする

それはメニューバーのRun > Attach to Process...による既存プロセスにアタッチする方法です。

▼メニューバーのRunにAttach to Process…はあります。

これを使うことで起動中のRailsアプリに対してアタッチを試み、成功したらRubyMineが介入できる環境を構築してくれます。

フローは次のようになります。

デバッグしたいRailsアプリをシェルで起動
RubyMineからAttach to Processを実行
Attachが成功するのを待つ

デバッグしたいRailsアプリをシェルで起動

ターミナルからRailsのServerコマンドを実行してRailsアプリを起動します。

Listening on unix:///usr/local/var/work/nginx-puma-rails/tmp/sockets/puma.sock

となっているのでUNIXドメインソケット通信として起動しています。

$ bin/rails s
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
=> Run `rails server --help` for more startup options
Puma starting in single mode...
* Version 4.3.3 (ruby 2.6.5-p114), codename: Mysterious Traveller
* Min threads: 5, max threads: 5
* Environment: development
* Listening on unix:///usr/local/var/work/nginx-puma-rails/tmp/sockets/puma.sock
Use Ctrl-C to stop

RubyMineからAttach to Process…を実行

Attach to Process...を選ぶとRubyMineがRubyで起動してるプロセスを見つけて一覧として出してくれます。

▼Rubyプロセス一覧

先程立ち上げたRailsアプリを見つけてくれます。賢いですね。

Attachが成功するのを待つ

次はこれを選ぶことでRubyMineがRailsアプリにアタッチをトライしてくれます。

RubyMineのDebug Toolbarにも次のようなログが流れます。

/bin/bash -c "env RBENV_VERSION=2.6.5 /usr/local/Cellar/rbenv/1.1.2/libexec/rbenv exec ruby /Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/ruby-debug-ide-0.8.0.beta21/bin/gdb_wrapper --pid 15009 --ruby-path /Users/mothule/.rbenv/versions/2.6.5/bin/ruby --include-gem /Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/ruby-debug-ide-0.8.0.beta21/lib --include-gem /Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/debase-0.3.0.beta23/lib -- --key-value --step-over-in-blocks --disable-int-handler --evaluation-timeout 20 --evaluation-control --time-limit 100 --memory-limit 0 --rubymine-protocol-extensions --port 61951 --host 0.0.0.0 --dispatcher-port 61952 --attach-mode"
Fast Debugger (ruby-debug-ide 0.8.0.beta21, debase 0.3.0.beta23, file filtering is supported, block breakpoints supported, smart steps supported, obtaining return values supported, partial obtaining of instance variables supported)
executed 'lldb /Users/mothule/.rbenv/versions/2.6.5/bin/ruby --no-lldbinit'
executed `attach 15009` command inside lldb.
executed `thread list` command inside lldb.
executed `thread list` command inside lldb.
executed `thread select 1` command inside lldb.
executed `bt` command inside lldb.
executed `thread select 2` command inside lldb.
executed `bt` command inside lldb.
...
executed `thread select 23` command inside lldb.
executed `bt` command inside lldb.
executed `thread select 1` command inside lldb.
executed `expr (void *) dlopen("/Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/debase-0.3.0.beta23/lib/attach.bundle", 2)` command inside lldb.
executed `expr (int) debase_start_attach()` command inside lldb.
executed `breakpoint set --shlib /Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/debase-0.3.0.beta23/lib/attach.bundle --name __func_to_set_breakpoint_at` command inside lldb.
continuing
executed `expr (void) debase_rb_eval("require '/Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/ruby-debug-ide-0.8.0.beta21/bin/../lib/ruby-debug-ide/attach/debugger_loader'; load_debugger(['/Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/ruby-debug-ide-0.8.0.beta21/lib', '/Users/mothule/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/debase-0.3.0.beta23/lib'], ['--key-value', '--step-over-in-blocks', '--disable-int-handler', '--evaluation-timeout', '20', '--evaluation-control', '--time-limit', '100', '--memory-limit', '0', '--rubymine-protocol-extensions', '--port', '61951', '--host', '0.0.0.0', '--dispatcher-port', '61952', '--attach-mode'])")` command inside lldb.

成功するとRailsアプリのログにも次のようなログが出力されます。

Fast Debugger (ruby-debug-ide 0.8.0.beta21, debase 0.3.0.beta23, file filtering is supported, block breakpoints supported, smart steps supported, obtaining return values supported, partial obtaining of instance variables supported) listens on 0.0.0.0:61951