👻

新しいRubyパーサーPrism利用時の開発体験の変化

2024/01/26に公開

Ruby

パーサー

Prism

tech

この記事で扱っていること

本記事ではRuby 3.3で導入されたPrismという新しいパーサーについて扱っています
Prismが持つ「パース時に問題が発生した場合でも可能な限り意味のある結果を返却する」という機能に着目して下記について話します
- Rubyを記述する際の開発者体験がどれくらい向上しているのか？
- 「可能な限り意味のある結果」をどうやって組み立てているのか？
最後に主テーマから外れますが、Prismの動かし方についても話しています

はじめに

こんにちはウォンテッドリーで推薦基盤の改善をやっているnasaです

去年の12/25にもRubyの最新バージョンがサンタさんから届きました。https://www.ruby-lang.org/ja/news/2023/12/25/ruby-3-3-0-released/

最新バージョンのRuby 3.3.0ではPrismという新しいパーサーが導入されています。

Prismは実験的導入という扱いでruby --parser-prismのようにオプションを指定することで利用できます。
また、デフォルトgemとしても導入されているので下記のようなRubyプログラムで試すことも出来ます。

require "prism"

source = <<~RUBY
def foo
  puts "foo"
end
RUBY

result = Prism.parse(source)

本記事ではPrismの持つ「パース時に問題が発生した場合でも可能な限り意味のある結果を返却する」という機能について話していきます。

Prismの特徴

と、その前にPrismを初めて聞いた、聞いたことあるけど特徴は知らないって人向けにPrismの概要を述べます。(本題に早く入りたい人は適当に読み飛ばして下さいー)

Prismは主にShopifyが開発している新しいRubyパーサーです。
現時点のRubyの構文は100%カバーされており、なおかつShopifyなど複数の大規模アプリケーションで動作確認が行われ問題なく動作することが確認できているステータスです。

では、なぜ新しいパーサーが必要だったのでしょうか？
Prismは下記の3つが開発のモチベーションとなっています。

エラートレラント
ポータビリティ
メンテナンス性

それぞれ少し詳しく書いていきますね。

エラートレラント

Prismにおいてのエラートレラントは「パーサーで何か問題が発生した場合でも可能な限り意味のある結果を返却すること」を意味します。
パーサーの責務と言えばASTを組み立てることですが、LSPのような実装途中のプログラムを扱うソフトウェアの事を考えるとただASTを組み立てるだけでは不十分です。
ソースコードが絶え間なく変化する状況で開発者にとって有益な情報を返すことが望まれます。
そのためPrismはエラートレラントを念頭に開発されています。

ポータビリティ

続いてポータビリティです。
現状のRubyのパーサーは様々な箇所で再実装されています。
CRuby, JRuby, TruffleRubyといったRuby処理系をはじめにsorbet, steep, ruby-lspといった開発ツールなどですね。
このカオスを打破することを目指しPrismはポータビリティに重きをおいて開発されています。

メンテナビリティ

最後にメンテナビリティです。
ポータビリティやエラートレラントの結果、多くのコミュニティーで長く使われてることが期待されます。
その結果としてメンテナンス性の重要度が上がっているって感じみたいです。
実際にドキュメントやテストの拡充には力が入っておりゴリゴリと追加されています。

これらがPrismが開発されたモチベーションになります。
Prism開発者が公開しているこちらのスライドを見るとより多くを学べると思います！

https://speakerdeck.com/kddnewton/prism

Rubyを記述する際の開発者体験がどれくらい向上しているのか？

では本題です。
PrismのエラートレラントによってRubyを使用した開発体験がどの程度向上するのか見ていきましょう。
Rubyでよくやってしまう構文エラーをいくつか挙げデフォルトパーサーとPrismとでエラーメッセージを見比べてみます。

end忘れ

ネストが深くなったときによくやってしまいます。endが一つ多いのもやる。。

def example_method
  puts "Hello"

これはPrismのほうが対応が必要な箇所が分かりやすいですね

Default parser	Prism

endが多い

ということで先程出たendが一つ多い問題

def example_method
  puts "Hello"
end
end

デフォルトパーサーのエラーメッセージunexpected endは分かりやすいですがエラー箇所把握がちょっとムズい。
Prismのエラー箇所は的を射ているがエラーメッセージcannot parse the expressionは不正確ですね。endキーワードではなく式としてパースされているのでしょうか

Default parser	Prism

閉じ括弧忘れ

def test(
  puts "hoge"
end

test(

どちらもputsを引数として解釈してputsの後に閉じ括弧が必要だと解釈しているようですね。
Prismに関しては２つ目の構文エラーに関しても扱えているのでこの点は良いなって思いました。

Default parser	Prism

区切り文字忘れ

array = [1, 2, 3, 4 5]

これはどちらも分かりやすいエラーを返してくれていますね。
デフォルトパーサーは閉じ括弧]を要求しているのに対してPrismはデリミタ,を要求していて正確ですね。

Default parser	Prism

変数名タイポ(存在しない変数名)

a = 1
puts aa

これはデフォルトパーサーがプログラマーが意図してそうな変数名をサジェストしてくれてていい感じですね。

Default parser	Prism

続いてメソッド名のタイポもやってみます。

def tes
end

test1

メソッドも同様デフォルトパーサーが良い感じですねー

Default parser	Prism

メソッド呼び出しのドットだけ書いた

あまり無いミスですが実装途中によく発生すると思うので試してみます。

test.

おっと。Prismはクラッシュしてしまいましたね。。。
PRチャンスかもしれません。

Default parser	Prism

インデントを考慮してくれるか

このようなコードではインデントを考慮するとifに対するendが無いと言えます。この辺考慮してくれるのでしょうか

def test
  if true
    puts "true"
end

まあ予想はしていましたが厳しいようですね。。。

Default parser	Prism

その他

ここでほんの一部しか扱えていません。
その他に対応しているエラーについてはPrismのテストコードを眺めてみて下さい！(僕も全てに目を通したわけじゃないのでいい感じのものがあれば教えてもらえると嬉しいです)

所感

RubyのデフォルトパーサーとPrismのエラーメッセージを見比べてみての所感です。

Prismで複数箇所のエラーを扱ってくれるのは嬉しい。デフォルトパーサーでは1つめのエラー時点で終了してしまう
Prismはクラッシュする問題があって現時点で使うのは苦戦しそう
エラーメッセージに関しても、エラー箇所に関してもPrismには期待できる
ただしデフォルトパーサーも親切なメッセージを出すケースがある
個人的にはPrism優勢に見えるがもうちょっと頑張って欲しい印象

現時点ではどちらにも良さがあるので置き換えるかと言われると悩ましいですね。
とはいっても今後ガンガン改善されていくと思うので楽しみですね。

「可能な限り意味のある結果」をどうやって組み立てているのか？

どうやって正しい構文を推論し意味のある結果を返しているのか気になったのでソースコードを読んで調べました。(それっぽいドキュメントがなかったため)
ここでは該当箇所を見つける過程と実装の解説を少し行います。

エラートレラントのエントリーポイントを探す

最初にエラートレラントを行っている関数があると仮説を立ててコードを読んでいきました。
結果としてエラートレラント関数のようなものは存在しておらず、トークン列を辿っていき都度正しい構文で埋めていることが分かりました。

つまり、仮説として「ASTの組み立てとエラートレラントが疎結合になっている」と思っていましたが実態は密結合になっていました。
仮説は外れていましたがparse_statementsを読めば仕組みを把握できそうなことが分かりました

ちなみに下記の流れでparse_statementsまでたどり着けます。

Prism.parse (ここまでRuby)
parse関数 (こっからC)
parse_input関数
pm_parse
parse_program
parse_statements

`defined?`キーワードのパースを読む

parse_statementsでエラーからの復帰を行っているのは分かりましたがすべてを読むのは厳しいですね。

なのでdefined?キーワードのパースのみをピックアップします。
defined?を選んだ理由は仕様が少なくパーサーの実装が簡素だったからです。興味があればdefやdoなどを読んでみると学びが多そうです。

実装はこちらです。

case PM_TOKEN_KEYWORD_DEFINED: {
    // 略...

    // 括弧が省略されていない時
    // ex. defined?(expression)
    if (accept1(parser, PM_TOKEN_PARENTHESIS_LEFT)) {
        lparen = parser->previous;

        // 式のパース。今回は本題じゃない
        expression = parse_expression(parser, PM_BINDING_POWER_COMPOSITION, true, PM_ERR_DEFINED_EXPRESSION);

        // `parser->recovering`はエラーから復帰中のときにtrueになる
        // どのトークンで埋めるか自明じゃないときにcontextにそれを残しておいてどっかでリカバリーするっぽい？
        if (parser->recovering) {
            rparen = not_provided(parser);
        } else {
            // 指定したトークンであれば読み飛ばす。ここでは改行であれば読み飛ばす
            // 下記の書き方に対応するため
            // ex.
            // ```ruby
            // defined?(
            //  expression
            //            ^ ここの改行に対応
            // )
            // ```
            accept1(parser, PM_TOKEN_NEWLINE);

            // ********************
            // **** ここが本題 ****
            // ********************
            // 閉じ括弧括弧が存在するか確認し存在しなければ第三引数`PM_ERR_EXPECT_RPAREN`エラーを`parser`構造体のerrorsに追加している。
            // その後`PM_TOKEN_MISSING`で埋めている
            // 重要なのは次の二点だと解釈している
            // 1. エラーをparser->errorsに蓄積すること
            // 2. TOKEN_MISSINGで埋めてパース処理を続行すること
            expect1(parser, PM_TOKEN_PARENTHESIS_RIGHT, PM_ERR_EXPECT_RPAREN);
            rparen = parser->previous;
        }
    // 括弧の省略時
    // ex. defined? expression
    } else {
        // not_providedは括弧が省略されていることを示すトークンを返す関数
        lparen = not_provided(parser);
        rparen = not_provided(parser);

        // 式のパース。今回は本題じゃない
        expression = parse_expression(parser, PM_BINDING_POWER_DEFINED, false, PM_ERR_DEFINED_EXPRESSION);
    }

    return (pm_node_t *) pm_defined_node_create(
        parser,
        &lparen,
        expression,
        &rparen,
        &PM_LOCATION_TOKEN_VALUE(&keyword)
    );
}

基本的な方針としては必要なトークンがないときはエラーを配列に詰め、足りないトークンをPM_TOKEN_MISSINGで埋め可能な限り処理を続行することです。

僕の持っていた仮説は「構文情報というものがありそこから論理的に近しいトークンを推論する」だったのですが、理論ベースではなく直感的に正しいもので埋めておくってことをしていました。
「このケースはエラーですよね。あなたがやりたいことはこれですよね」ってのを随所で行う実装のようです。

まとめ

本記事ではRuby 3.3で導入されたPrismという新しいパーサーについて、「パース時に問題が発生した場合でも可能な限り意味のある結果を返却する」という機能に着目しまとめました。

具体的には下記の３つについて扱いました。

Prismの紹介と特徴: エラートレラント、ポータビリティ、メンテナビリティの３つの指針について
開発体験の変化: Prismを利用することでどのようにRubyの開発体験が変化するのか。エラー検出の精度をデフォルトパーサーと比較する
エラートレラントの仕組み: 「可能な限り意味のある結果」をどうやって組み立てているのか実装を見て雰囲気を掴む

Prismはこれからガンガン使われ改善されるフェーズにあると思うので今後の改善が楽しみですね。

本編は以上でここからは余談的なところです。

Prismの動かし方

rubyインタプリタ経由で動かすのに一工夫必要だったのでそれを紹介します

ruby --parser=prismとオプションを指定することで利用はできるんですが、構文エラーが発生した際にはクラッシュしてしまう状態です。。。(このバグは3.3.1で修正予定みたい)

なのでmasterのrubyを利用する必要があります。
実際に動かしてみたい人はこちらのドキュメントを頼りに最新のRubyをビルドしてみて下さい！

それから実はもう一つハマりポイントがあります。ファイルの末尾の空行の有無によって挙動が変わるため注意が必要です。
空行が存在する場合はきちんと動いてくれるんですが、空行があるとハングしてしまいました。これもおそらく3.3.1で修正されると思います。

Prismが動作するプログラム(空行あり)

:) % bat main.rb
───────┬──────────────────────────────
       │ File: main.rb
───────┼──────────────────────────────
   1   │ class Foo
   2   │   def initialize(
   3   │     true
   4   │   end
   5   │
───────┴──────────────────────────────

:) % ruby --parser=prism main.rb
main.rb: syntax errors found (SyntaxError)
  1 | class Foo
> 2 |   def initialize(
    |                  ^ expected a `)` to close the parameters
  3 |     true
  4 |   end
> 5 |
    | ^ expected an `end` to close the `class` statement
    | ^ cannot parse the expression

Prismがクラッシュするプログラム(空行なし)

:) % bat main.rb
───────┬──────────────────────────────
       │ File: main.rb
───────┼──────────────────────────────
   1   │ class Foo
   2   │   def initialize(
   3   │     true
   4   │   end
───────┴──────────────────────────────

SEGV received in BUS handler

GitHubで編集を提案