spring rails console で PAGER=lv だと /dev/tty: Device not configured

spring rails console で pry を使っていて pager を起動するような出力をしたときに /dev/tty: Device not configured になることがあったので原因を調べてみました。 結論としてはタイトルに書いてありますが、 spring と lv の組み合わせが原因でした。

確認バージョン

関係する gem のバージョンは以下の通りです。

• rails 3.2.14, 4.0.0
• spring 0.0.10, 0.0.11

関係するプログラムのバージョンは以下の通りです。

• ruby 2.0.0-p247
• lv 4.51

確認した環境は Mac OS X です。

原因の切り分け

まず rails console だと問題は発生しないので、 spring が原因のひとつなのは確実だったので、 当面の回避策として、 spring rails console の代わりに rails console を使っていました。

次にふと他の pager を使ってみるとどうだろうと思って、 spring rails console の中で ENV['PAGER']="less" として lv から less に変えて試してみたところ、 問題なく使えました。 これがきっかけで lv も原因のひとつだということに気づきました。

原因調査

ここまでわかれば原因は調べやすくなったので、 まずエラーメッセージを出しているところを探しました。 これはすぐに見つかって、 lv の src/stream.c の perror( "/dev/tty" ) でした。

lv451/src/stream.c:

  close( 0 );
  if( IsAtty( 1 ) && 0 != open( "/dev/tty", O_RDONLY ) )
    perror( "/dev/tty" ), exit( -1 );

STDIN を開き直している処理があって、 ここで "/dev/tty" を開けないのが原因でした。

元々の STDIN は spring の中で UNIXSocket#send_io と UNIXSocket#recv_io で受け渡していました。 この STDIN をそのまま使ってくれれば問題は起きないのに、 わざわざ close( 0 ) で閉じてしまって、 開き直そうとしているのが問題だとわかりました。

spring rails console の中で直接 open("/dev/tty","r") を試しても同様に Errno::ENXIO: Device not configured - /dev/tty になってしまうので、 lv の方を変えない限りどうしようもなさそうです。

というわけで、 これはもう lv の処理が spring と相性が悪いということで、 spring の中では lv を避けるしかなさそうです。

結論

~/.spring.rb で ENV["PAGER"] を書き換えることにしました。

ENV["PAGER"] = "less" if ENV["PAGER"] == "lv"

余談

原因を調べているときに spring の標準入出力の処理周りをみていたのですが、 UNIXSocket#send_io と UNIXSocket#recv_io で受け渡していました。

recv_io で mode を指定していないので、 spring rails console では STDIN.write が使えたり STDOUT.gets が使えたりしてしまうようです。

これは recv_io(IO, "r") などに直せば良さそうに見えますが、 特に実害もなさそうなので、このままでもあまり問題はなさそうです。

パッチとしては以下のように直せば良さそうです。

diff --git a/lib/spring/application.rb b/lib/spring/application.rb
index b7df9bb..4e34f6c 100644
--- a/lib/spring/application.rb
+++ b/lib/spring/application.rb
@@ -93,7 +93,7 @@ module Spring
       log "got client"
       manager.puts
 
-      streams = 3.times.map { client.recv_io }
+      streams = %w[w w r].map { |mode| client.recv_io(IO, mode) }
       [STDOUT, STDERR].zip(streams).each { |a, b| a.reopen(b) }
 
       preload unless preloaded?

テストも以下のように書いてみたのですが、 Mac OS X の環境だとそもそも既存のテストも通らないものがあったり、 Linux だと上の変更をしなくてもテストが通ってしまったりしたので pull request を出すのは諦めました。 これらのパッチの著作権は主張しないので、 代わりに pull request を出してもらうのは歓迎します。

diff --git a/test/acceptance/app_test.rb b/test/acceptance/app_test.rb
index a21b556..ee04e5a 100644
--- a/test/acceptance/app_test.rb
+++ b/test/acceptance/app_test.rb
@@ -440,4 +440,16 @@ class AppTest < ActiveSupport::TestCase
       assert_success "bundle check"
     end
   end
+
+  test "STDIN mode" do
+    assert_success "#{spring} rails runner 'STDIN.write(%(test)) rescue $!.display'", stdout: "not opened for writing"
+  end
+
+  test "STDOUT mode" do
+    assert_success "#{spring} rails runner 'STDOUT.gets rescue $!.display'", stdout: "not opened for reading"
+  end
+
+  test "STDERR mode" do
+    assert_success "#{spring} rails runner 'STDERR.gets rescue $!.display'", stdout: "not opened for reading"
+  end
 end