入社数ヶ月のnewbieが稼働7年超のプロジェクトに型を導入して見えた世界

by Fu-ga

Slide 1

Slide 1 text

Kaigi on Rails 2022 - 10.22(Sat) 入社数ヶ月のnewbieが稼働7年超のプロジェクトに型を導入して見えた世界ふーが@fugakkbn / ESM, Inc

Slide 2

Slide 2 text

Profile ふーが @fugakkbn 　 2022年3月からエンジニアに(at ESM, Inc) 　 Railsを使用したアプリケーション開発　 gem_rbs_collectionのコントリビューター　プロジェクトへの型導入を進めている　 Kaigi on Rails Organizer

Slide 3

Slide 3 text

動機なぜ型に興味を持ったのか？初めての型 TypeScriptで静的型に初めて触れ、型があることのメリットを知った。 Rubyでも型の恩恵を 3.0からRubyでも静的型を扱えるようになったが、プロジェクトには導入されていなかった。後押し 1on1でEMに「型に興味がある」話をしたら「プロジェクトに導入してみたら？」

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

Slide 6

Slide 6 text

コミュニティとの ”共生” このワードにピンと来た方は… @fugakkbn or agile.esm.co.jp まで!!

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

Kaigi on Rails 2022 - 10.22(Sat) 入社数ヶ月のnewbieが稼働7年超のプロジェクトに型を導入して見えた世界ふーが@fugakkbn / ESM, Inc

Slide 9

Slide 9 text

アジェンダ newbieこそ型定義をするべきどのように導入を提案したか導入する上での障壁

Slide 10

Slide 10 text

今日伝えたいこと newbie の皆さん型情報から得られるフィードバック以外にもたくさんのメリットがあることを知って欲しいもし型に興味を持ってもらえたなら、ぜひプロジェクトへの導入を！先輩の皆さん同僚から型導入の打診があった時は今日紹介するようなメリットを思い出して、ぜひ導入の支援をお願いします！

Slide 11

Slide 11 text

RBSの文法、書き方導入の具体的な手順

Slide 12

Slide 12 text

用語の紹介基本的なものだけ紹介 RBS Rubyの型を書くための言語の名称。Ruby Likeな書き方ができるため理解やすい。 Steep Rubyの静的型解析機。 steep checkコマンドで Rubyファイルとrbsファイルの型検査ができる。ジェネレーターこの発表では「プロダクトコードをもとにRBSのコードを自動生成するもの」として話します。

Slide 13

Slide 13 text

newbieこそ型定義をするべき https://unsplash.com/ja/%E5%86%99%E7%9C%9F/ak4hw4r6xio

Slide 14

Slide 14 text

なぜ？理由はいくつかあります　コードを読み解きやすくなる　プロジェクトの全容把握の近道になる　実装を読むことへの抵抗がなくなる　無限にコントリビュートチャンスがある

Slide 15

Slide 15 text

Slide 16

Slide 16 text

皆さんに質問プロジェクトに全部でいくつのメソッドが定義されていますか？また、それらの引数にはどんな値が入りますか？

Slide 17

Slide 17 text

とあるアプリのメソッド数

Slide 18

Slide 18 text

とあるアプリのメソッド数

Slide 19

Slide 19 text

すべてを覚えておくのはムリ！一度読んで理解してもしばらくしたら忘れてしまう先輩のコードをレビューしているとき、テストコードを読み解くとき、障害発生時に調査するとき…などなど、折に触れてメソッドの構造を理解するべきタイミングがあると思います。

Slide 20

Slide 20 text

そこで型ですよ型があれば覚えておく必要がないなぜなら型を見ればどんな引数を渡してどんな返り値なのかが一目でわかるから「これってどういうメソッドなんだっけ？」から始まる調査の手間は決して軽いものではないはず。

Slide 21

Slide 21 text

rbsファイルアプリケーションコード

Slide 22

Slide 22 text

rbsファイルアプリケーションコード

Slide 23

Slide 23 text

rbsファイル違う型を引数に渡そうとすると…

Slide 24

Slide 24 text

rbsファイル型が違うことを教えてくれる！

Slide 25

Slide 25 text

型をつけたことでたくさんあるメソッドを読み解きやすくなった

Slide 26

Slide 26 text

型をつけたことでたくさんあるメソッドを読み解きやすくなった型

Slide 27

Slide 27 text

Slide 28

Slide 28 text

プロジェクトの全容把握 newbieな僕の最初の壁その１

Slide 29

Slide 29 text

newbie 心の叫びどこに何が定義されているのかわからない。モデル同士の関連どうなってるの？「簡単な修正」って issue 振ってもらったけど…どこから手をつければいいの？メソッドの処理が複雑すぎて最終的にどうなるのかわからん！！！コードジャンプ候補に同名メソッドがたくさん出てきてどれが正しいのかわからない。。。

Slide 30

Slide 30 text

Slide 31

Slide 31 text

そこで型ですよ型を書くことで理解が深まる型を書くにはメソッドの使い方や使用時の挙動を調査する必要がある。それを繰り返す中でどんどんわかることが増えていき、プロジェクトへの理解が深まっていく。

Slide 32

Slide 32 text

型定義を進めるために嫌でもプロジェクト内のファイルを横断的に見ることになるモデル同士の関連がどうなっているか理解が進んだり、このモデルにこんなメソッドがあるのか！などの発見があるそれらに型付けする過程でユースケースやどこで使われているのかなどが自然とわかる

Slide 33

Slide 33 text

別のメリット今後の自分の助けにもなる型付けが進むとIDEの補完の正確度が上がる。正確度が上がると調査も実装も速度が上がるため、相対的に同じ時間内で得られる情報量が増える。

Slide 34

Slide 34 text

補完候補（型がない場合）

Slide 35

Slide 35 text

補完候補（型がない場合）

Slide 36

Slide 36 text

補完候補（型がある場合）

Slide 37

Slide 37 text

補完候補（型がある場合）

Slide 38

Slide 38 text

nextメソッドの定義を見たい！

Slide 39

Slide 39 text

ここでコードジャンプしようとすると…

Slide 40

Slide 40 text

候補がたくさん表示されてしまう

Slide 41

Slide 41 text

型をStringだと定義しておくと…

Slide 42

Slide 42 text

一発で String#next の定義元に飛べる！

Slide 43

Slide 43 text

型をつけたことでプロジェクトへの理解が進み調査や実装もしやすくなった

Slide 44

Slide 44 text

型をつけたことでプロジェクトへの理解が進み調査や実装もしやすくなった型

Slide 45

Slide 45 text

Slide 46

Slide 46 text

gemの実装を見るのが苦手 newbieな僕の最初の壁その２

Slide 47

Slide 47 text

苦手な理由思い返してみると… 難しいコードがたくさん出てくる印象どこから見ればいいのかわからない「まだ自分には読めない」という先入観

Slide 48

Slide 48 text

型生成プロセス良いサイクルが生まれます調査メソッドの構造（引数の型、返り値の型）や使われ方を調査する。型定義調査結果をもとに型を定義していく。このとき gem の型定義の不足や誤りが判明することも実装の確認起こっているエラーが型定義の誤りなのかそうでないのかは、 gem の実装を見る必要がある反復型定義はこれらの繰り返し。繰り返しやっているうちに実装を見るのが日常になる。成果物プロジェクトの型定義はもちろん、場合によっては OSS にコントリビュートできることも。

Slide 49

Slide 49 text

steep checkで出たエラーに疑義がある場合 gemの型定義がなくて追加しようとするとき

Slide 50

Slide 50 text

steep check 実行時に見つかる

Slide 51

Slide 51 text

steep check 実行時に見つかる

Slide 52

Slide 52 text

steep check 実行時に見つかる

Slide 53

Slide 53 text

steep check 実行時に見つかる

Slide 54

Slide 54 text

実装元を確認する

Slide 55

Slide 55 text

Receive block!

Slide 56

Slide 56 text

gemの実装を見ることが "日常"になった。あの頃の苦手意識はもうない

Slide 57

Slide 57 text

gemの実装を見ることが "日常"になった。あの頃の苦手意識はもうない型

Slide 58

Slide 58 text

gemの実装を見ることが "日常"になった。あの頃の苦手意識はもうない型 ※ただし読めるとは言っていない

Slide 59

Slide 59 text

Slide 60

Slide 60 text

OSSってなにから始めればいいの？ newbieな僕の最初の壁その3

Slide 61

Slide 61 text

OSS

Slide 62

Slide 62 text

OSS 選ばれし人がやること初心者の自分にできるわけがない。技術に秀でたすごい人たちがやること。

Slide 63

Slide 63 text

OSS 選ばれし人がやること初心者の自分にできるわけがない。技術に秀でたすごい人たちがやること。自分にできることがあるはずないすごい技術を持った人たちが作ったものに自分が修正できるところがあるわけない。

Slide 64

Slide 64 text

OSS 選ばれし人がやること初心者の自分にできるわけがない。技術に秀でたすごい人たちがやること。自分にできることがあるはずないすごい技術を持った人たちが作ったものに自分が修正できるところがあるわけない。やってみたい気持ちはあるけれど… どこから手をつけたらいいのか、どこが修正すべきところなのか、どうやってパッチを送ればいいのかナニモワカラナイ。

Slide 65

Slide 65 text

型定義を始めるまでは…

Slide 66

Slide 66 text

型定義の誤り

Slide 67

Slide 67 text

gemの型定義の不足

Slide 68

Slide 68 text

試行錯誤の中での気づきプロジェクトの型導入をしている中で gemの型定義が足りなかったり間違ってることがあるなぁ

Slide 69

Slide 69 text

試行錯誤の中での気づきプロジェクトの型導入をしている中で gemの型定義が足りなかったり間違ってることがあるなぁこれってもしや…コントリビュートチャンスってやつ！？

Slide 70

Slide 70 text

OSSへの初めてのコントリビュート

Slide 71

Slide 71 text

No content

Slide 72

Slide 72 text

コントリビュートはすごい人だからするものではない。「使ってる人が気付いた時にするもの」

Slide 73

Slide 73 text

コントリビュートはすごい人だからするものではない。「使ってる人が気付いた時にするもの」型

Slide 74

Slide 74 text

Slide 75

Slide 75 text

興味を持ってもらえたらプロジェクトに型を導入してみてください！ newbieの多くの悩みを解決してくれます

Slide 76

Slide 76 text

とはいえ…

Slide 77

Slide 77 text

newbieに型を導入する裁量なんてないんですが！？

Slide 78

Slide 78 text

どのように型導入を提案したか https://unsplash.com/ja/%E5%86%99%E7%9C%9F/5Q07sS54D0Q

Slide 79

Slide 79 text

小さく少しずつ

Slide 80

Slide 80 text

第1ステップとして、rbs, rbs-rails, gem_rbs_collection などで大枠の型定義をそろえる

Slide 81

Slide 81 text

第1ステップとして、rbs, rbs-rails, gem_rbs_collection などで大枠の型定義をそろえる第2ステップとして、生成された rbs ファイルの untyped を正しい型に書き換えていく

Slide 82

Slide 82 text

第1ステップとして、rbs, rbs-rails, gem_rbs_collection などで大枠の型定義をそろえる第2ステップとして、生成された rbs ファイルの untyped を正しい型に書き換えていく並行して、steep check でのエラーから gem の型定義不足や誤りを見つけて修正する

Slide 83

Slide 83 text

gemもrbsも独立しているので剥がすのは簡単主要なModelやAPIだけでもよい型があってもなくてもプロダクトコードに影響はない Linterで警告が出たりノイズが発生することもない

Slide 84

Slide 84 text

CIには入れない

Slide 85

Slide 85 text

エラーの解消が目的ではない目的はあくまで"開発者体験の向上" CIに組み込むと間違いなくエラーが出続ける CIがずっとredだと"オオカミ少年"状態になる… 型のエラーを検知したい訳ではないプロジェクト内の型を充実させることに集中する方が建設的

Slide 86

Slide 86 text

書きたい人だけ

Slide 87

Slide 87 text

型を書きたい人

Slide 88

Slide 88 text

型を書きたい人

Slide 89

Slide 89 text

型を書きたい

Slide 90

Slide 90 text

型を書きたい

Slide 91

Slide 91 text

型の恩恵を受けたい型を書きたい

Slide 92

Slide 92 text

"書かなきゃいけないもの"にすると開発速度の低下ややらされてる感からの生産性低下 "書く気力のある人"が少しずつ進めていくしかない。"型のある開発環境"を水面化で進める機能追加のPull Requestに混ぜない。ノイズになる。型は個別のPull Requestで余裕のある人が見る(見なくてもいい)

Slide 93

Slide 93 text

チームへの説明

Slide 94

Slide 94 text

newbieの独断では入れられないメンバーの理解と協力が不可欠受け入れてくれたメンバーに感謝ここまで説明したようなスタンス、メリットを伝える「やっぱりダメだね」となった場合もすぐに剥がせる一人でもメンテナンスしていく覚悟

Slide 95

Slide 95 text

導入の障壁 https://unsplash.com/ja/%E5%86%99%E7%9C%9F/sQ5yREHU_fI

Slide 96

Slide 96 text

gemの型不足

Slide 97

Slide 97 text

gemの型定義はまだまだ足りていない（2022年10月現在、 57個がgem_rbs_collectionにある） gemの型定義が増えるとプロジェクトに導入しやすくなるはずだと考えています興味がある方はぜひgemの型定義をやってみましょう！gem の型定義が増えて導入するプロジェクトが増えれば、型エコシステムの発展も早くなるかも？

Slide 98

Slide 98 text

RubyKaigi 2022 でそういう発表をしました https://speakerdeck.com/fugakkbn/types-teaches-success-what-will-we-do

Slide 99

Slide 99 text

変更への追従

Slide 100

Slide 100 text

コードの変更への追従検知するソリューションがないメソッド追加、構造の変更など自動で検知することができないため人力になる別ファイルであることのデメリット「気づいたときにやればいい」というスタンス

Slide 101

Slide 101 text

大量のエラー

Slide 102

Slide 102 text

プロジェクトに型を導入して全体で steep check を実行すると、大量にエラーが出るはず今のプロジェクトでは1万以上のエラーが出る繰り返しになるが、エラーを解消することに心血を注ぐ必要はないと考えている

Slide 103

Slide 103 text

https://speakerdeck.com/soutaro/ruby-programming-with-types-in-action?slide=13

Slide 104

Slide 104 text

まとめ

Slide 105

Slide 105 text

newbieが型を書くメリットはたくさんあります！興味の裾野を広げる一歩目にいかがですか？プロジェクトに型を導入することで得られる恩恵は限定的。でも新しいメンバーがいち早くプロジェクトに馴染む助けにもなりそう。小さく始められてランタイムに影響を与えないので導入しやすい。メンバーから打診があったらぜひ前向きな検討を！

Slide 106

Slide 106 text

型を通じてできることが増えた取り組む意識が変わった興味の幅が拡がった Rubyがもっと楽しくなった

Slide 107

Slide 107 text

波紋波紋 https://unsplash.com/ja/%E5%86%99%E7%9C%9F/Tf18kgGiop4

Slide 108

Slide 108 text

No content

Slide 109

Slide 109 text

型

Slide 110

Slide 110 text

誰がメンテしてる？型

Slide 111

Slide 111 text

誰がメンテしてる？ Steepのコマンドは内部的にどう呼ばれてる？型

Slide 112

Slide 112 text

誰がメンテしてる？どうやってコントリビュートする？ Steepのコマンドは内部的にどう呼ばれてる？型

Slide 113

Slide 113 text

誰がメンテしてる？どうやってコントリビュートする？ Steepのコマンドは内部的にどう呼ばれてる？型 ASTってなに？ ASTってなに？

Slide 114

Slide 114 text

見える景色が変わった見える景色が変わった知覚できる世界が広がった知覚できる世界が広がった https://unsplash.com/ja/%E5%86%99%E7%9C%9F/1lfI7wkGWZ4