OSSコントリビュート初体験： Rubocopのバグを修正した話

初めてPSSコントリビュートした話です。
といっても、構文解析についての踏み込んだ話は触れていません。

初心者の方でも理解できるように作ったつもりなので、感想などいただけたら嬉しいです。

Transcript

1. OSSコントリビュート初体験： Rubocopのバグを修正した話 Omotesando.rb #111
2. 自己紹介 5hun @5hun_s アラームボックスという会社でRuby on Railsを書いています。 Ruby歴は1年と半年くらい。 趣味は音楽です。
3. 会社紹介 アラームボックス株式会社は 与信管理という分野の会社です。 BtoBサービスを提供するSaaSの 会社です。
4. お客様へ、危ない企業の情報提供 反社、倒産、悪評など幅広くカバー あの会社の経営状況 はやばいわよ 代表者が 反社疑惑あり よし、あの会社と取引する のはやめとこう
5. 取引先が倒産など、いざという時の保証 よし、安心！ お金が支払われなかった 場合は 立て替えます！ いわゆる、立替え払い
6. エンジニアの役割 ・多くの企業情報を蓄積、管理し、運用するためのシステムつくり ・企業情報を効率よく収集するためのAI活用 ・３つのメインサービス（パワーサーチ、モニタリング、ギャランティ）を利用 できる会員サイトの運用
7. ここから本題
8. お品書き ・初めてOSSコントリビュートしました ・修正したcop ・修正内容の解説
9. 初めてOSSコントリビュートしました
10. 初めてのissueとプルリクの提出 https://github.com/rubocop/rubocop/pull/14315
11. 修正したcop
12. Style/SoleNestedConditional ネストしたif/unlessを一番外側のif文と繋げてくれます。 見ての通り、複数のネストを一発で修正してくれます。
13. ある日、自社プロダクトで突然のエラーが！ rubocop –a コマンドを実行したら、下記のエラーが発生しました
14. 気になったので原因と修正方法を考えてみました
15. 修正内容の解説
16. その前に、今日話さないこと ・詳細なRubocopの内部構造 ・詳細な構文解析に関する専門用語の解説（パーサーとか) →それらを知らなくてもなんとなくできた！という話だと思ってください。
17. 現状の把握（エラーの発生したコード） 2段目のネストでunlessを使っているのが ポイントです（ネタバレ）
18. まず、発生したエラーは何か見てみます https://github.com/whitequark/parser/blob/master/lib/parser/source/rewriter.rb ClobberingErrorが発生 しています！
19. エラーでググってみて、GitHubのコメントを読んでみます 上書きするような書き換え操作が行われると、Error が発生します
20. 何か書き換える処理が重複して エラーになっていると予測。
21. 次に、rubocopの、sole_nested_conditional.rb の実装を見てみます
22. スタックトレースから呼ばれている箇所を確認します 名前からして自動修 正するメソッドが呼ば れている https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cop/style/sole_nested_conditional.rb
23. メソッドをたどり、自動修正をしている箇所を見つけました。 unlessなら!ifに 書き換える 条件ブロックを 繋げる
24. 怪しいところは二つあると予測 ・複数のネストを一文に繋げるところでエラーになるのか ・unlessをifにする時にエラーになるのか どちらなのか検証してみます。
25. if/if/if はOK
26. つまり、 複数のネストを一文に繋げる→問題ない unlessをifにする→問題あり ということがわかりました。
27. ここからエラーの解説です
28. if/unless/if はNG 一番外側と2段目のネストが最初に修正対象として検知されます ①ここでunlessを 検知しifへ修正が 確定します
29. if/unless/if はNG 次に、2段目と3段目のネストが修正対象として検知されます ②ここでもunless を検知しifへ修正 が確定します
30. if/unless/if はNG 修正が重なり、 エラーとなる
31. なので、一度修正を検知した場所は 修正しないように記録しておけば良さそう
32. 私の書いた実際の修正後のコード 他の箇所でも使われている既存の仕組みを利用して修正できました。
33. 引数で指定されているノードとは 構文木における用語で、構文木を構成する個々の要素であり、文法の非終端記号 （例: 式、文、関数定義）や終端記号（例: 演算子、識別子、リテラル）に対応し ます。 ここでは、unless〜endのブロックを指すと思ってください。
34. 修正後のコードが何をしているか ここでignore_nodesという 配列にセットします
35. 修正後のコードが何をしているか ここでignore_nodesという 配列にセットします 現在修正対象のnodeが ignore_nodesに含まれているか 判定します
36. 修正後のコードが何をしているか ノードが、unlessブロックかつ無視対象のノードでない場合のみ、 unlessをifに書き換えるようにすることで、 書き換え操作の重複を回避し、エラーも回避できるようになりました。
37. テストコードを作成、実行し、エラーが発生 しないことを確認し、プルリクを提出 →マージされました！
38. 一点問題があり、マージ後にアカウント名 を変えました（Xと合ってなかった）
39. 無慈悲な現状
40. 今後の展望 ・仮説→検証の繰り返しをすれば、初見のコードも理解できるようになる！ ・OSS活動楽しい！ ・自社のRubocopを自分のコミットが含まれるv1.77まで上げる ・今の名前でなんとしてもまたコントリビュートしたい