2024-01-31

aws-sdk-ruby配下すべてのgemにRBSが含まれた状態でリリースされました

みなさまに、RBSに関する重要なニュースを発表できることを嬉しく思います。

私の目標の一つにはRBSを当たり前の世界にするというものがあります。

この目標に対して大きなインパクトを残せたことに大変興奮しています。*1

aws-sdk-ruby配下すべてのgemにRBSが含まれた状態でリリースされました

こちらは公式blogからのアナウンスです。

aws.amazon.com

aws-sdk-rubyはrubygemsでの累計ダウンロードランキング2位に乗るほどの人気gemです。(aws-sdk-core)

aws-sdk-rubyは現状370以上のgemのあつまりです。このすべてのgemにRBSが含まれた状態でリリースされました。 そうです。すべてです。

rbs v3.4.0以上でご利用いただけます。

え、なにがどうなるの？

具体的には配信されるgemのディレクトリーにsigというディレクトリーが生えて、中にRBSファイルが配置されるだけです。ライブラリーの挙動は何も変わりません。productionでも安心してご利用いただけます。

RBSをプロダクトに導入していない場合

何も変わりません。RBSを導入しましょう！

RBSをプロダクトに導入している場合

まずrbsをv3.4.0以上にあげましょう。それ以前だとgem_rbs_collectionのaws-sdk-coreが優先して読み込まれてしまうので、最悪RBS読み込みに失敗してしまいます。

まさかとは思いますが、万が一rbs collectionを使用していない場合は全く問題ないです。

たくさんのaws-sdk-ruby gemを使用している場合、RBSの読み込みが遅くなるかもしれません。使わなそうなものはrbs_collection.yamlでignore: true指定すると良いかもしれません。

なんでそんなに詳しいの？

私が実装を担当しました。何かおかしかったら直すので教えてください。

https://github.com/aws/aws-sdk-ruby/pull/2961

なにがおこったの？

2年くらい前

RBS利用当初から、ネットワーク等のI/Oを使用するプログラムと型は相性がいいとにらんでいました。テストコードだと、外部通信だのモックだので複雑になったり、そもそもおろそかになりがちだったりするところですが、型ならコードを書いた瞬間からレスポンス形式の不一致が分かったりします。そんなわけでaws-sdk-rubyとは相性が良いだろうと考えていました。

そこで、私はgem_rbs_collectionというリポジトリーでaws-sdk-rubyに対するRBSを生成するという取り組みを行なっていました。

aws-sdk-rubyのRubyコードのほとんどはJSONから自動生成されており、その仕組みに乗っかってRBSも出力してみようというアイデアです。

初期実装に2ヶ月くらいかかりました。※毎日の寝る前の1時間とかでやってる趣味活動です

これ自体はaws-sdk-rubyの中の人は知らず、私が勝手にやっている活動でした。

https://github.com/ruby/gem_rbs_collection/pull/118

2ヶ月くらい前

RubyConf2023 in San DiegoでRBSの作者である id:soutaro さんの元にaws-sdk-rubyのメンテナが「aws-sdk-rubyにRBSを入れたいんだよね」と声をかけたそうです。

soutaroさんは私の活動を知っていたので、すでにやってる人がいるよとgem_rbs_collectionを紹介したそうです。

という話を私がsoutaroさんから聞き、「それなら、ようしひとつやってみるかな」とissueを立てました。

https://github.com/aws/aws-sdk-ruby/issues/2950

やるぞ宣言です。

2週間くらい前まで

既存の実装を乗せ替えるだけでしょ。と思っていたら既存の実装は先方の理想の基準に達しておらず、長い開発の日々が始まりました。※毎日の寝る前の1時間とかでやってる趣味活動です

2ヶ月の間コードを書く→レビューを受けるを繰り返しました。

95のコメントと57ファイルの変更、1,657行の追加と22行の削除が行われました。

RBSの整合性を確認し、実際のライブラリーの挙動とRBSの表現で乖離がないか確認するテストも追加して、CIとしてタスクも追加しました。

メンテナがメンテナンスしやすいようにコードの分離関係も気を使いました。

もちろん全世界で使われる重要なライブラリーなので相当なプレッシャーでした。

ドキュメントひとつとっても、先方と議論を交わしました。

タイムゾーンが違いすぎるので、議論も1コメントしては次の日まで返事を待つというサイクルでした。

rbs本体側の問題もあったのでいくつか修正しました。※そのためrbs v3.4.0以上でないと利用できません。

おかげさまで満足できる完成度に至りました。

伝わりますか？オプションの順番までドキュメントと一緒。インデントもあって読みやすい。狂気の完成度と言えるでしょう。(言えない)

ちょっと前

https://github.com/aws/aws-sdk-ruby/commit/5b831e8eaa27b453fe6c1ca2e38b69ec39c58326

かくして、4,276 changed files with 983,107 additions and 2,101 deletions.という豪快なcommitによって、全サービス370gemで同時リリースが行われました。

RBS界隈へ与えたインパクトは大きいと思っていて、RBSがgemに含まれるのが当たり前の世界に近づいたとさえ思っています。最近RBSを同梱しているgemが増えたと耳にします。そこに世界トップクラスのgem 370個にもRBSが入ったとなれば、さらにRBSをgemに同梱する流れは加速するんじゃないかと考えています。

RBSの工夫点

RBSで型をつける上でのTipsを記憶があるうちに残しておきます。型チェッカーはsteepを想定しています。RubyMineでは大きな問題はないですが、ちょっと違う挙動らしいです。

RBS::Testを使用

RBSの正しさを検証するためにRBS::Testを使用しました。

RBS::Testが何なのかは以前に記事を書いたのでこちらも合わせてどうぞ。 RBSのテスト方法4パターン

RBS::Testを使ってaws-sdk-coreとaws-sdk-s3のrspec上でメソッドの引数と返り値を監視して、定義通りの挙動かチェックしています。 RBS::Testはあんまり使用例がないらしく、大きな使用例を世界に示せたと思います。

実装は短いrake taskになっているので参考にどうぞ。

https://github.com/aws/aws-sdk-ruby/blob/5b831e8eaa27b453fe6c1ca2e38b69ec39c58326/tasks/rbs.rake

rspecのタグを使って、後述するレアケースはスキップするようにしていますが、レスポンス構造の正しさなど基本的な部分は十分保証できています。

ほとんどのgemは自動生成された少量のテストケースしかないのですが、aws-sdk-s3は特別にテストケースが多くユーザーも多いので、これさえ通れば他のサービスもカバレッジ的にほぼカバーできているはずです。

引数の型

aws-sdk-rubyの特にClient系メソッドは以下のように書けます。※名前は私が適当につけたものです

client = Aws::S3::Client.new

# keyword argument style
client.get_object(bucket: 'bucket', key: 'key')

# record argument style
client.get_object({ bucket: 'bucket', key: 'key' })

# hash argument style
args = { bucket: 'bucket', key: 'key' }
client.get_object(args)

そのため、次のようなRBSを書くと、record argument styleとhash argument styleでエラーになります。

def get_object: (bucket: String, key: String) -> Response

かといって、こう書いてもhash argument styleでエラーになります。 Hashオブジェクトは変数宣言時にrecord型からHash型になるっぽい？のです。※将来的にSteepの挙動が変わるかもしれません。

def get_object: ({ bucket: String, key: String }) -> Response

そして次のように書くと全パターン通りますが、引数の型情報がなくなってしまいます。

def get_object: (Hash[Symbol, untyped]) -> Response

最終的には次のように、keyword argument styleとhash argument styleをまぜました。

def get_object: (bucket: String, key: String) -> Response
              | (Hash[Symbol, untyped]) -> Response

最終的にはhash argument styleで受けるのでエラーは発生しません。しかしながらkeyword argument styleがコードを書いているときにサジェストされるのでコーディング時のサポートになります。しかもRubyMineではkeyword argument styleの方が採用されて引数の型チェックができるっぽいです。すごい。本当かどうか確かめていません。

返り値の型

Delegatorの表現

RBSでは、同じclassなのに使えるメソッドが変わるDelegator class系の表現は難しいです。 aws-sdkの各Clientレスポンスデータは#dataで取得でき、かつ#dataを省略すると#dataにdelegateされます。

resp = Aws::S3::Client.new.get_object(...)
resp.class #=> Seahorse::Client::Response
resp.data #=> Types::GetObjectOutput (レスポンスデータ)
resp.data.etag #=> String
resp.etag #=> String (dataへdelegateされている)
resp.successful? #=> bool (各レスポンス共通で使えるメソッドもある)

こういうclassのRBSはどう書けばいいのでしょうか？そのままSeahorse::Client::Responseを返しても、Seahorse::Client::Responseは#etagメソッドを持っていません。class GetObjectOutput < Seahorse::Client::ResponseのようにRBSを定義しても、現実とclassが異なるのでRBS::Testは落ちてしまいます。

今回はinterfaceを使って解決してみました。イメージとしてはこうです。

interface _ResponseSuccess[DATA]
  def data: () -> DATA # レスポンスデータ
  def successful?: () -> bool # 共通メソッド
end
interface _GetObjectResponseSuccess
  include ::Seahorse::Client::_ResponseSuccess[Types::GetObjectOutput] #=> 共通メソッドをとりこみつつ、dataでレスポンスデータを取得できるように
  def etag: () -> ::String #=> delegateするメソッドはinterfaceのメソッドとして生成しちゃう
end
def get_object: (...) -> _GetObjectResponseSuccess

RBS::Testでは、interfaceならメソッド名が存在しているかと、メソッドの引数の個数ぐらいしかみません。かつsteepなどの型チェッカーでも正しい型が扱えます。

SuccessとErrorでレスポンスの型をわけるという割り切り

Clientのレスポンスでは、問題があると普通は例外をraiseするのですが、raiseしないオプションを使用することもできます。こうなると#etagなどは呼び出せないので使えるメソッドが変わってしまいます。よってRBSとしては正しくなくなってしまいます。

この問題へは、raiseしない場合はレアケースと割り切って、レスポンスは全て成功する前提で型をつけています。もしレアケースを使いたい場合は、型アノテーションを使ってエラーパターンを指定してあげてください。

client = Client.new(raise_response_errors: false)
# @type var response: ::Seahorse::Client::_ResponseError
response = client.operation()
response.error.message

レアケースなのでちょっと難しい対応にはなりますが、多くの場合でメリットを享受できるので実践的な割り切りといえます。

Resourceの型

Resource系は型付けと相性が良いようで、画像のように複雑なメソッドチェインしても型情報を失いません。

aws-sdk-rubyの人たち

GitHub上では3名で管理しているっぽくて、少人数で大きなプロジェクトを管理するという責任あるお仕事をされていました。しかしながら、そもそもRBSを導入したいと思っていたことや、PRでも好意的にサポートしていただいてレビュー体験は非常に良いものでした。みんなプログラミングが好きなんだろうな。最初は1サービスに導入して様子を見るのかな？と思っていたら、いきなり全サービスに導入する話になっていて、豪快さも持っています。さすが世界トップクラスのライブラリーのメンテナという感じでした。感謝。

さいごに

aws-sdk-rubyの型は、利用頻度が高そうなものに絞って型をつけているので、結構主観が入っています。例えばAsyncClientはまだ対応していませんし、coreは全て手書きなので、まだまだ型が足りないでしょう。つまりはコントリビュートチャンスです。みんなでこのビッグウェーブに乗っていきましょう！正直一人は心細い！

*1:言ってみたかっただけですすみません

2023-11-11

RBS v3.3.0のリリースノートを読む

RBS v3.3.0がリリースされたのでリリースノートを読んでみたいと思います。

https://github.com/ruby/rbs/wiki/Release-Note-3.3

Add `rbs diff` command

新コマンド追加です。

https://github.com/ruby/rbs/issues/1448

にPR作者の意気込みが書かれていますね。

例えばgem_rbs_collectionへPRを出す時に、RBSの自動生成をしたものだと差分が大きくて何が変わったのか、なにか抜け落ちてないか見抜くのは困難になります。そこで、結局何が変わったのかメソッド単位で差分を突き合わせて、「増えたもの」「減ったもの」「変わったもの」を抜き出して表示する。しかもPRに貼り付けることを意識してのmarkdown table形式や、CLI出力を意識しての色付きdiff形式等、出力形態も選べるようです。しかもこういう調査は結果さえわかればいいので手軽に実行したい。なのでいちいちスクリプトを書いて実行するのはしんどい。よって新コマンド追加というわけですかね。

なるほど、現実的な課題に向かい合った結果の機能追加というわけですね。

Add `--todo` option to `rbs prototype runtime`

これもPR作者の意気込みが書かれた文章が見つかりました。

https://github.com/ruby/rbs/issues/1449

内容をエスパーすると、最初の動機は上記のrbs diffコマンドを実験していた時に実際に実行したときのinstance_methodsなりとRBS定義とをdiffで比較してみると、意外とRBSの定義漏れを発見できて便利なんじゃないか？と思ったようですね。そこからrbs diffコマンドとは分離して、rbs todoコマンドを想像したようですが、pockeさんから「rbs prototype runtime と絡めるといいんじゃないか」という助言をもらい、rbs prototype runtimeのオプションとする案に落ち着いたようです。あくまでエスパーです。

このオプションを使うと、実際には存在するんだけど、RBSはまだ無いものだけをプロトタイプとして生成してくれるもののようです。実際のデモでもIOのような組み込みクラスでも、まだ実装されていないメソッドが見つかっています。「RBSになにか貢献したいなあ」と思っている方も、これを使ってまだ無いメソッドを探してPRで追加することができそうですね。

Add `todo` type

これは名前から察するに、上記の--todoオプションと関連するかと思いきや、実は関係ない変更です。たまたま名前が被ったようですね。 __todo__は、ほぼuntypedと同じですが、"なんでもいいよ"という意味のuntypedと、"まだ決めれてないよ"という意味のuntypedを分けて管理できるようにしたんじゃないかと思います。

prototypeの出力こそまさに__todo__向きかも？

Additional syntactic validation with `rbs validate`

rbs validateでチェックする項目が増えました。引数にvoidを使ったり、定数にselfを使ったり等、型の使い方を間違えていると教えてくれるようになったようです。間違うとどう動くんだろ。新しく追加されたエラーはwarning的な扱いですが、将来的には文法エラーとして実装予定らしいのでこのエラーを見たらすぐに修正するとよさそうです。

Delete `sources:` section from `rbs_collection.lock.yaml`

rbs_collection.lock.yamlファイルのsources:セクションは実はもう使ってないので削除されたようです。

ついでのCHANGELOGも読む

Signature updates

coreの型が数多く修正されています。ほとんど同じ人がやっていて、数がすごい。

Library changes

バグ修正が多いですが、少しピックアップしてみましょう。

Show location of type by method command (#1537)

rbs methodコマンドの出力として、型情報が記述されているファイルの場所が出力されるようになったようです。型情報を直したい時にすぐに見つけれて便利かも。

Better support for inherited class of `Struct` or `Data` by prototype runtime #1571

StructやDataを継承したclassの場合にいい感じにプロトタイプが出力されるようになったようです。

This will be one of the most important improvements in RBS 3.3. 🎉

なんかすごそうですね。

StructやDataによって作られたclassの型をどう書くかという問題は度々議論に上がっていましたが、この変更によってある程度の回答とできそうですね。

[prototype runtime] Add `--autoload` option (#1561)

rbs prototype runtimeはautoloadの壁を越えれないという弱点があったのですが、--autoloadというオプションをつければ限界を超えれるようです。将来的にデフォルトで有効になりそうな感じで書かれています。

[prototype runtime] Optimize performance (#1495)

マイクロベンチマークによると、classが1万個ある場合だと、100sから1sと100倍早くなってます。Railsアプリケーションとかだとそれぐらいいくので嬉しそうです。

[Collection] Simple colorize collection text like Bundler (#1558)

rbs collectionコマンドでBundlerのように色がつくようになったみたいです。色がつくとなんかちゃんとしてる感があっていいですね。

2023-10-29

Kaigi on Rails 2023に登壇した。

kaigionrails.org

2日目の最初だったので、オープニング担当だなと勝手に解釈した。

多分100人ぐらいはいた？50人くらいかもしれない。分からないけど1人でもお客さんがいるならライブをやるとdir en greyの京も言ってたしがんばった。

客観的にどういう公演になったかは分からないけど、主観的には出し切れてスッキリした気持ち。いいライブができた。

もうちょっとネタを盛り込みたかったけど社名を背負っているので自重した。「LUUPで来た」ぐらいは言いっとけばよかった。

周りに与えた影響として一番大きいのはrakeのリリースを急かすことに成功したことだと思う。rakeは影響力が大きいgemなので大変だとは思います。リリースお疲れ様です。

これからはとりあえずプロダクト側の改善を続けて、RubyKaigi 2024に向けてのネタを探したい。

関係者の皆様お疲れ様でした。

2023-10-29

rakeのエラー表示がちょっとだけ便利になりました。

rake v13.1.0がリリースされました 🎉

https://rubygems.org/gems/rake/versions/13.1.0

このリリースには私が実装した改善が含まれているので紹介します。というか書かないと環境変数とか誰にも気づかれなさそう。

Support `#detailed_message` when task failed by ksss · Pull Request #486 · ruby/rake · GitHub

rake task実行時に何らかのエラーによって失敗したとき、error_highlightやdid_you_meanが効くようになりました。

before

$ bundle exec rake demo
rake aborted!
NoMethodError: undefined method `opject_id' for main:Object

after

$ bundle exec rake demo
rake aborted!
NoMethodError: undefined method `opject_id' for main:Object (NoMethodError)

  p self.opject_id
        ^^^^^^^^^^
Did you mean?  object_id

これまでは発生したエラークラスの#messageメソッドを表示していたのですが、#detailed_messageというメソッドが呼べるならこっちを呼び出すようになります。

ruby v3.2.0からException#detailed_messageが導入されており、これを利用しています。

エラークラスに#detailed_messageメソッドさえあればv3.1以前のrubyでも動くっちゃ動くのですが、稀なケースだと思われます。

rbsはv.3.1でも#detailed_messageを呼べるようにしたのでこの施策は有効です。

Debug at stop when task fail by ksss · Pull Request #489 · ruby/rake · GitHub

環境変数RAKE_DEBUGに何かしらの値が入っていると、rake taskが失敗したときにdebug gemによるデバッガーが起動します。

$ RAKE_DEBUG=1 bundle exec rake demo
undefined local variable or method `aaa' for main:Object
[30, 36] in ~/src/github.com/ksss/rake/Rakefile
    30| end
    31|
    32| task default: :test
    33|
    34| task :demo do
=>  35|   aaa
    36| end
=>#0 block in <top (required)> at ~/src/github.com/ksss/rake/Rakefile:35
  #1    [C] Kernel.load at ~/.rbenv/versions/3.2.1/lib/ruby/3.2.0/bundler/cli/exec.rb:58
  # and 14 frames (use `bt' command for all frames)
(rdbg:postmortem)

これまでrdbgコマンドでrakeタスクに対してブレイクポイントを仕込む事はできましたが、エラー発生時にデバッガーを起動するpostmortem機能を使っても最後に起きたexceptionに対してデバッガーが起動するので、本来調べたかったコンテキストが失われた状態になっていました。

そこで rspec-debug gemをヒントにRake::Task#execute実行中に発生したエラーに対してpostmortemを起動することで、本来得たかったコンテキストを得ることができるようになりました。

もちろんdebug gemが使える状況でなければ環境変数をつけても起動しないのでご注意ください。

なにか問題があれば直すので教えて下さい。

まとめ

rake便利。

2023-06-19

37歳Web系ソフトウェアエンジニアの転職活動ふりかえり

2023年4月中ごろから6月の今日までの2ヶ月と少しかけた転職活動が終了したので、記録ついでに振り返りたいと思う。

あくまで個人的な記録である。

応募手法

応募方法は、さまざまな方向から行った。

Twitterでの公開募集
エージェント経由
YOUTRUST経由
直接応募

Twitterでの公開募集

正直なところ、一回やってみたかったという部分が大きい。今回の転職活動における大きなチャレンジだった。ありがたいことに20社以上から声をかけていただいた。知り合いのフリーランスの方から「うちが関わってるところどうですか？」という声がけも3名からあった。その節はありがとうございました。

数は多いものの、話を聞く聞かないを考えなくてはならなくなり対応に追われた。公開募集とは、受動的な方法なのだと痛感した。また「会社名も書いてないから怪しいな？」と思ってDMの送信主を調べたら国際指名手配者だったという話はいつまでもしていこうと思う。

かなり終盤で見た記事だが、こちらが参考になった。

転職意思をオープンにした転職活動をする場合におすすめの公開レジュメの活用 - Tbpgr Blog

エージェント経由

エージェントは主にFindyさんにお世話になった。若干動線がわかりにくいが、顧客インタビューの文脈からはじまってエージェント業務をされているらしいので、Findyを通していない応募も気にして応援してくれる。Findyを使わなかったら、かなり応募数も減っていたと思う。悩み事の話し相手や、話すことで考えるタイプの人向けの壁打ちもやってくれるので非常に体験が良かった。

他のエージェントも使っていたが、面談は一度きりで提示される企業も微妙なのばかり。いざ一つ受けてみたら連絡がエージェント経由になっているのに一週間以上連絡がつかなかったり、申請から1ヶ月くらいかかってやっとカジュアル面談できたと思ったらエージェントと言ってることがまるで違っていたりと散々だった。合うエージェント探しも重要なように思う。

YOUTRUST経由

あまり繋がりがなく、1件カジュアル面談につながったのみだった。

直接応募

1社だけ社のホームページから直接応募した。

話を聞いた数

全面談数: 34回
カジュアル面談: 16回
面接: 9回
エージェント面談: 4回
その他の面談: 3回
オファー面談: 2回

全面談数: 34回

期間は約2ヶ月とちょっと。面談は一日0回〜3回とまちまちだった。GWやRubyKaigiを挟んだりもしているが、何も予定がない日も企業研究や面談の予定取り付け、コーディングテストなどをしていた。

初めの方は余裕ぶって映画館に行ったりしていたが、後半はかなり焦って希望条件を下げてでも種まきをしていた。

カジュアル面談: 16回

もう少し多くても良かったかもしれないが、カジュアルとはいえ人と話すとある程度疲れるのでこれぐらいがちょうどいいのかもしれない。1対1での会社説明は若干コスト高そうで遠慮していた部分もあるが、会社としては知ってもらうだけでもプラスなので遠慮しなくても良かったかも。

面接: 9回

数年以内に転職活動をしていたので、その時の経験を使いまわして話した。もちろん最近の話だったりかなり前の話だったりもするが、話せる話題を職務経歴書やブログエントリーに書いているのでその内容を話す感じ。

技術面接ということで、通話しつつどういうコードを書くか画面をシェアしながら話す面接もあったが、普段の仕事をしている感覚が確認もできるので、緊張はしたけど良い点も大いにあった。

エージェント面談: 4回

最初にお願いしたエージェントは最初に1度話した後、emailでのやりとりになり次第にフェードアウトした。多分、見込みがないから見捨てられたんだと思う。

早々に見捨てられたと割り切ってFindyさんに切り替えた。Findyさんでは定期的にメッセージやミーティングで進捗確認してくれたので、並走してくれている感があって心強かった。転職活動は結構孤独な戦いなので、特有の悩みを話せる存在は大変ありがたかった。

その他の面談: 3回

Twitterで公開募集した際、個人的に話を聞いてくれた某K氏に感謝します。ほとんどエージェント業では？相談料とった方がいいのでは？と思えるくらい様々な有用情報を提供してくださいました。

某N氏もランチがてら話を聞いてくれて自分にない視点をくれてありがたかったです。感謝。

オファー面談: 2回

現地に行ってオフィスを見学して年収いくらいくらでどうでしょうという話を2社続けて行った。これまでの面接は自分を売り込む営業活動という側面があったけど、オファー面談は毛色が違って、独特の空気感があった。

内定は多いに越したことはないだろうと思っていたが、多いと悩むものは悩む。幸せな悩みだった。

選考落ち

5社選考に落ちた。全て1次面接での選考落ちだった。

理由はいろいろ考えられるので少し深掘りしたい。

得意領域のアンマッチ

ソフトウェアエンジニアと言っても、さまざまな得意領域がある。 DDDなどの設計を得意とする人、組み込みなどの低レイヤーを得意とする人、人と技術全体をまとめるのが得意な人。

僧侶が欲しいパーティには、どんなにいい武闘家だったとしても採用はできない。洗濯乾燥機を買ったばかりのおうちは、しばらく洗濯乾燥機を買わない。

そんなどうでもいい例えばかり思い付いては自分を納得させるために言い聞かせて精神を保っていた。

レベルのアンマッチ

採用には予算があり、計画がある。どんなに素晴らしい人であっても、ジュニアの椅子にシニアは座れない。逆もまた然り。

文化のアンマッチ

10社以上話を聞いてみて、やはり文化の違いは感じた。これは言葉にするのは非常に難しいのでなんとも言えないが、大事にするものの優先順位だったり、話している時の雰囲気だったりはもちろん個人差はあるものの、会社のカラーみたいなものを感じることが多かった。ここが合わないとそもそも選考に進もうと思わないし、たとえ無理やり選考に進んでも即選考落ちとなっていた。

使用ツール

Hatena Blog

主にTwitterでの公開募集用に、大体自分はこういう人ですよという文章を書いて公開した。職務経歴書ほど細かくは知られたくないけど、ここまでぐらいならいいかなーという情報を載せておくのに便利だった。

7月から無職なので求職します - スペクトラム

Google Docs

職務経歴書は、以前の転職時に独自に作ったものがあったので、これに付け足す形で流用した。 URLさえ知っていれば誰でも見れる形にして公開している。もちろん見られてもいい情報しか載せていない。面接時に便利だったが、公開までしなくてもいいと思う。PDFを生成できるので、PDF化してから送るのでも全税良いと思う。おそらくだが履歴書は意外と厳格に必要なようで、法律で決まっていたりするのかなと想像する。住所や電話番号などの個人情報となるので、これは公開設定はせずに毎回PDF化して送付していた。企業によって要求タイミングはまちまちだった。オーファ時には少なくとも必要っぽい。

Findy

エージェントがFindyだったので、自然とFindyを見ることが多くなり、ひたすらFindyからのいいねをみて受け会社を選んでいた。期間を切っていいねの検索などはできないっぽいが、「受け取ったいいね数 123」と表示されている。プレミアムスカウトなる機能があるっぽく、最初受け取った時は公式にドキュメントがないので「ナニコレ？」と混乱したが、エージェントさんによると文字通りプレミアムなスカウトらしい。多いのか少ないのかはわからないが、今回は全部で6件きた。

Spir

spirはスケジュール管理でお世話になった。複数社同時に面談の日程をつめる必要があるので重宝した。Googleカレンダーと連携しているので、Googleカレンダーを使っている人はいいが、私は毎日TimeTreeを見る習慣があったので、見逃し防止のためにはTimeTreeに転記する必要があるのが若干面倒ではあった。

まとめのポエム

たくさん話を聞いていると、「ここでもあそこでも困っている人がいる。手を貸してあげたいけど手は1つしかない……。」と思うことがよくあった。業界の人材不足ってやつでしょうかね。問題は無限にあるのに貸せる手は1つなので、何に手を貸すかが重要になってくる。これがまた難しい。。。

応募したにせよしなかったにせよ、求人の数だけ困り事があるということは痛感し、その中で自分がやることを決めることの重要性も実感した。「自分じゃなくてもいいな」と思ったら応募してないし「自分じゃなきゃ」と思える仕事をしたい。しかしながら自分じゃなくてもいいけどなんとかなってほしい問題も無数にあったのでみんな頑張ってほしい。みんながんばれ！

2023-04-05

7月から無職なので求職します

(6/19現在)内定承諾したので現在は募集していません。

過去のアーカイブとしてこの記事は残していますが、募集はしていません。

プロフィール

やってきたお仕事

ソシャゲ開発
ECサイト開発
マーケティングツール開発
新サービスの開発リード

等など、Web系のサーバーサイド開発を中心に10年以上の経験があります。全て自社開発サービスです。

得意分野

短期的に素早くマルチタスクに動くことより、長期的に深くシングルタスクで考えるほうが得意です。

技術的な先行調査や、開発環境改善、技術的に高度な課題解決、サービス共通基盤の開発等を担当することが多いです。

技術特化タイプです。

特にOSSへのアプローチ経験が豊富です。

プログラミング言語

Rubyが好きで、8年以上の経験があります。

プログラミング自体が好きで、言語自体の仕組みやエコシステムに強く興味があります。

RubyKaigi登壇など、外部発信も行っています。

OSS活動

ほとんど趣味としてOSS活動を続けています。

最近だとRBS関係が多いです。

これまでに400以上のPRを自分が管理していないリポジトリでmergeされています。merged PR一覧

詳細はhttps://github.com/ksssにまとめています。

希望する企業

得意分野から、企業のステージとしてはアーリーステージよりもある程度成熟したステージの企業の方が合うのかなと考えています。

また、社会基盤的な業界(医療・教育・福祉等)に特に興味があります。

しかし年収次第ではげふんげふん……。

働き方

フルリモート希望です。

働く時間は9時〜18時ぐらいです。

仕事より家族優先です。子供関係で有休以上に休むこともあります。

ブログ

連絡方法

@_ksss_へDMください。

返信を約束するものではありません。

知り合いを優先します。

2023-04-01

テストを実行してRubyの型情報を集めるやつを作った

イントロダクション

「テストを走らせて型情報を収集すればいいんじゃない？」そのアイデア自体は話題に上がることが多かったかと思われますが、観測範囲では前例がないように見えます。そこで、実際に作ってこそ見える世界があると思い動くものを実装してみました。

`Orthoses::Trace`

github.com

orthosesはRBSを生成するための機能を作るフレームワークで、この機能の一つとしてOrthoses::Traceというミドルウェアを実装しました。

例

例題として、rack-testというgemのRBSを生成したいとします。その場合の生成コードをOrthoses::Traceを使って以下のように準備します。

https://github.com/ksss/orthoses/blob/db80d506c5fb02dadaa0ae303e0761ba0a543f6f/examples/rack-test/generate.rb

require 'pathname'
require 'orthoses'
require 'fileutils'

include FileUtils

out = Pathname('out')
out.rmtree rescue nil
Orthoses.logger.level = :warn
Orthoses::Builder.new do
  use Orthoses::CreateFileByName,
    base_dir: out.to_s
  use Orthoses::Filter do |name, content|
    name.start_with?("Rack::Test")
  end
  use Orthoses::Trace,
    patterns: ['Rack::Test*']
  run ->(){
    cd "src" do
      load "spec/all.rb"
      Minitest.run
      # avoid to run on at_exit
      module ::Minitest
        def self.run args = []
          0
        end
      end
    end
  }
end.call

このコードを実行すると、rack-testのリポジトリ内のテストコードを走らせ、RBSを生成することができます。

Orthoses::CreateFileByNameミドルウェアの働きによってclass毎にファイルができます。

その一部を見てみましょう。Rack::Test::UploadedFileの場合は以下のような出力を得ることができます。

class Rack::Test::UploadedFile
  attr_reader tempfile: Tempfile?
  attr_reader original_filename: String
  attr_accessor content_type: String
  def self.finalize: (Tempfile file) -> Proc
  private def initialize_from_file_path: (String path) -> nil
  private def initialize: (String content, ?String content_type, ?bool binary, ?original_filename: nil) -> void
                        | (StringIO content, ?String content_type, ?bool binary, ?original_filename: String) -> void
                        | (String content, ?String content_type, ?bool binary, ?original_filename: String) -> void
                        | (StringIO content, ?String content_type, ?bool binary, ?original_filename: nil) -> void
  private def respond_to_missing?: (Symbol method_name, ?bool include_private) -> bool
  def method_missing: (Symbol method_name, *Array[untyped] args) ?{ (*untyped) -> untyped } -> (Integer | String)
                    | (Symbol method_name, *Array[Encoding] args) ?{ (*untyped) -> untyped } -> File
  def append_to: (String buffer) -> nil
  def self.actually_finalize: (Tempfile file) -> bool
  private def initialize_from_stringio: (StringIO stringio) -> StringIO
  def path: () -> String
end

テストコードを走らせて、わりとそれっぽいRBSを得ることができました。

実装方法

TracePointを使いました。基本的にはTracePointのcallイベントで引数の型を、returnイベントで返り値の型を、それぞれテスト実行時に集めておくという発想です。

コード例で説明します。

def foo(a)
  a.id
end

みたいなコードがあったときに、このままではa.idが何を返すのかわかりません。そこで、実際にコードを実行し、fooが呼ばれたときのaの値を見て引数の型を、返り値を見て返り値の型をfooの型として蓄積しておきます。

結果として

引数aはRecord型, 返り値はIntegerだった。
引数aはRecord型, 返り値はnilだった。

という情報を集めることができます。

これらの情報を統合して

def foo: (Record) -> Integer?

というRBSに落とし込む、というのが基本的な発想です。コードの実行が必要ではありますが、コードを実行する最高のサンプルとしてテストコードを使用すれば、既存の資産を流用しつつ0からよりも遥かに効率的にRBSを記述することが期待できます。

既存の手法

静的な型ファイルを自動生成する既存の手法としては以下の前例があります。これらの前例と今回の手法を比較し、どのようなメリットがあるのかを考えます。

rbs prototype

その名の通り、RBSのプロトタイプを作成するためのコマンドです。静的解析と動的解析の両方があり、コマンドひとつで生成できるので、RBSのプロトタイプ生成として最も有名な方法だと思われます。

typeprof

静的解析によってできるだけ型情報を収集する手法です。かなり精度も高く「そんなことまで分かるのか！」と驚きます。

rbs-dynamic

RubyKaigi2022で発表されたツールで、コードを実行して型情報を得るものです。今回実施した手法にかなり近いのですが、今回のように既存のテストコードをまるごと回す用途ではエラーが発生し動かせなかったので今回は使用していません。

比較

rbs prototype rb

ソースコードに対して実行します。簡略化のためコメントは除きます。

$ rbs --version
rbs 3.0.4

$ rbs prototype rb src/lib/rack/test/uploaded_file.rb | grep -v '#'
module Rack
  module Test
    class UploadedFile
      attr_reader original_filename: untyped

      attr_reader tempfile: untyped

      attr_accessor content_type: untyped

      def initialize: (untyped content, ?::String content_type, ?bool binary, ?original_filename: untyped?) -> void

      def path: () -> untyped

      alias local_path path

      def method_missing: (untyped method_name, *untyped args) { () -> untyped } -> untyped

      def append_to: (untyped buffer) -> nil

      def respond_to_missing?: (untyped method_name, ?bool include_private) -> untyped

      def self.finalize: (untyped file) -> untyped

      def self.actually_finalize: (untyped file) -> untyped

      private

      def initialize_from_stringio: (untyped stringio) -> untyped

      def initialize_from_file_path: (untyped path) -> untyped
    end
  end
end

rbs prototype runtime

$ rbs prototype runtime -r rack/test/uploaded_file 'Rack::Test::UploadedFile'

rbs prototype rbとほぼ変わらない結果となったので割愛

typeprof

$ typeprof --version
typeprof 0.21.7

$ typeprof src/lib/rack/test.rb src/spec/rack/test/uploaded_file_spec.rb
# ...snip...
class UploadedFile
  attr_reader original_filename: String?
  attr_reader tempfile: String | StringIO
  attr_accessor content_type: String
  def initialize: (String | StringIO content, ?String content_type, ?bool binary, ?original_filename: String?) -> void
  def path: -> untyped
  alias local_path path
  def method_missing: (:must_respond_to | :pos | :read method_name, *Symbol args) -> untyped
  def append_to: (untyped buffer) -> nil
  def respond_to_missing?: (untyped method_name, ?false include_private) -> true
  def self.finalize: (String | StringIO file) -> ^-> untyped
  def self.actually_finalize: (untyped file) -> untyped

  private
  def initialize_from_stringio: (String | StringIO stringio) -> (String | StringIO)
  def initialize_from_file_path: (String | StringIO path) -> void
end
# ...snip...

比較考察

出力は一部しか示していませんが、全体的な比較として以下のようになりました。

Tool	メリット	デメリット	備考
rbs prototype	実行が非常に手軽だった	ほとんどがuntypedだった	なし
typeprof	実行が手軽、かつある程度型がある。インスタンス変数も対応している。	untypedはある	rbs collectionで型情報を追加できる可能性がある
Orthoses::Trace	型情報が多い	実行のためにコードを書く必要がある	rbs collectionで型情報を追加できる可能性がある

手軽さと正確性にある程度のトレード・オフの関係があるように見えます。

もう少し細かく比較してみましょう。

実行の手軽さ

圧倒的にrbs prototypeやtypeprofが手軽です。Orthoses::Traceではちょっとしたスクリプトレベルのコードを書く必要があり手軽とは言えません。

型の正確性

方法によって考慮されている型情報に差はありますが、どの手法でも最終的な型情報はプログラマーの理想のものになるはずです。よっていずれの手法でもある程度の手直しは必要そうです。

対応範囲

typeprofは定数やインスタンス変数も対応しているのに対して、Orthoses::TraceではTracePoint軸なのでフックが設定でず対応できません。typeprofすごい。また、Orthoses::Traceでは、呼ばれていないメソッドは情報がないので型生成できません。typeprofは呼ばれてなくても類推できます。typeprofすごい。

テストツールごとの対応

Orthoses::Traceではコードを書くことでテストを走らせ、型情報を得ることができることがわかりました。テストツールは様々にあり、minitestやtest-unit、rspecなどが有名です。コードを書く以上、それぞれのツールに対応したコードを書く必要があります。ここではOrthoses::Traceを使った場合のテストツール毎のコードの書き方を示しておきます。

まずテストコードを含むソースコード全体が必要なので、ソースコードをgit clone等でダウンロードしておきます。以後説明のため、このソースコード置き場のディレクトリー名を仮にsrcとします。

minitest

最初に示したrack-testがminitestを使っています。 minitestを使っている場合、autorunを使っていなければload "test/run.rb"みたいな感じでテストコードを読み、Minitest.runでテストを走らせることができます。しかし、大抵はautorunを使っているので工夫が必要です。 autorunはat_exitで実行されるので、そのタイミングだとorthosesで解析するProcの外になってしまいます。なのでProc内でテストを実行しつつ、autorunを消すためにメソッドをまるごと上書きしています。Minitest.runはexit codeを返すインターフェースなので0を返すのがミソです。

test-unit

多分こんな感じだと思います。

Orthoses::Builder.new do
  use Orthoses::Trace, patterns: ['Foo*']
  run ->(){
    cd "src" do
      load "test/foo_test.rb"
      Test::Unit::AutoRunner.run

      class ::Test::Unit::AutoRunner
        def self.run(*, **)
          0
        end
      end
    end
  }
end

rspec

あんまりrspecを使ったライブラリーを見つけられなかったのですが、おそらく以下で動くと思います。ただし、テストが成功しないとexitで強制終了してしまうのですが、テストが失敗しているということは型は間違っている可能性が高いのでこれでいいのかも。

require "rspec/core"
Orthoses::Builder.new do
  use Orthoses::Trace, patterns: ['Foo*']
  run ->(){
    cd "src" do
      load "spec/foo.rb"
      RSpec::Core::Runner.invoke
    end
  }
end

めんどい

テストライブラリーに合わせて柔軟に対応できる分、自分でコードを書かなければいけないのがめんどいので、もう少しサポート方法を考えたいところですね。。。しかしながらリポジトリ毎にテストの走らせ方は千差万別で、gemの依存関係もそれぞれ異なってくるので統一された方法は難しいと考えています。

思うところ

TracePoint#enable(target: )問題

attr_accessor系のメソッドがRubyVM::InstructionSequence.ofに対応してくれるともう少しコードが簡単になるのですがレアケースそう……。

実装の詳細

実装面はかなり端折りましたが、実は面白い工夫が盛りだくさんです。TracePointに興味がある人は覗いてみてください。

typeprofすごい

ということでOrthoses内でtypeprofを呼ぶことができる拡張も作りました。

https://github.com/ksss/orthoses-typeprof

これまでにOrthoses内で蓄積した情報をtypeprofに渡して型の参考値にすることができます。

ちなみに今回の出力結果は以下にまとめたので比較してみてください。

Orthoses::Trace: https://github.com/ksss/orthoses/tree/main/examples/rack-test/out/rack typeprof: https://github.com/ksss/orthoses-typeprof/tree/main/examples/rack-test/out/rack

感想

これでライブラリーのRBS追加が少し楽になるかも……？どうだろう、typeprofで十分なのかもしれない……。

とりあえず作ってみる事はできたので、今後は使ってみて便利かどうか確かめる。ですかねえ……。

そもそも何かしらやりたいことがあって、そのときに思いついた手法なのですが、思いついて実装してブログを書くのに5ヶ月ぐらいかかってしまい本来の目的を見失いました。お後がよろしいようで。

思いついたとき。

おもしろそうなコード思いついて試してみたらいけそうで脳汁出てたらこんな時間
— ksss (@_ksss_) 2022年10月30日

aws-sdk-ruby配下すべてのgemにRBSが含まれた状態でリリースされました

え、なにがどうなるの？

RBSをプロダクトに導入していない場合

RBSをプロダクトに導入している場合

なんでそんなに詳しいの？

なにがおこったの？

2年くらい前

2ヶ月くらい前

2週間くらい前まで

ちょっと前

RBSの工夫点

RBS::Testを使用

引数の型

返り値の型

Delegatorの表現

SuccessとErrorでレスポンスの型をわけるという割り切り

Resourceの型

aws-sdk-rubyの人たち

さいごに

Add rbs diff command

Add --todo option to rbs prototype runtime

Add __todo__ type

Additional syntactic validation with rbs validate

Delete sources: section from rbs_collection.lock.yaml

ついでのCHANGELOGも読む

Signature updates

Library changes

Show location of type by method command (#1537)

Better support for inherited class of Struct or Data by prototype runtime #1571

[prototype runtime] Add --autoload option (#1561)

[prototype runtime] Optimize performance (#1495)

[Collection] Simple colorize collection text like Bundler (#1558)

まとめ

応募手法

Twitterでの公開募集

エージェント経由

YOUTRUST経由

直接応募

話を聞いた数

全面談数: 34回

カジュアル面談: 16回

面接: 9回

エージェント面談: 4回

その他の面談: 3回

オファー面談: 2回

選考落ち

得意領域のアンマッチ

レベルのアンマッチ

文化のアンマッチ

使用ツール

Hatena Blog

Findy

Spir

まとめのポエム

(6/19現在)内定承諾したので現在は募集していません。

プロフィール

やってきたお仕事

得意分野

OSS活動

希望する企業

働き方

ブログ

連絡方法

イントロダクション

Orthoses::Trace

例

実装方法

既存の手法

rbs prototype

比較

rbs prototype rb

rbs prototype runtime

typeprof

比較考察

実行の手軽さ

型の正確性

対応範囲

テストツールごとの対応

minitest

test-unit

Add `rbs diff` command

Add `--todo` option to `rbs prototype runtime`

Add `todo` type

Additional syntactic validation with `rbs validate`

Delete `sources:` section from `rbs_collection.lock.yaml`

Better support for inherited class of `Struct` or `Data` by prototype runtime #1571

[prototype runtime] Add `--autoload` option (#1561)

`Orthoses::Trace`