コードリーディング

はじめに 先日、Railsガイドを読んでいたら、sandbox_by_defaultという設定がRails7.1から追加されたことを知りました。 本番環境での操作ミスを低減できるので良いなと感じ、早速業務で使っているアプリでもこの設定を有効にしました。 この設定ってどういうコードで実現しているんだろうというのを疑問に思ったので、sandbox_by_defaultのPRを見ながらざっくりRailsのコードリーディングしてみました。 github.com （まとめ）PRと関連のRailsコードを読んでわかったこと Railsでconfigを管理しているのはRails::Application::…

今回のとことんDevOps勉強会は「IaCコードリーディング ~Terraformのコードを一緒に読んで行こう~」と題して、Terraformのコードをステップ・バイ・ステップで読み解きながら、理解を深めていくコードリーディングを行いました。 IaCが徐々に普及し、IaCのメリットやツールに関する情報はこの勉強会でも扱ってきましたが、実際にどのようなコードを記述するのか、コードレベルでどのようなことができるのかという点に関してはまとまった形で触れる機会はあまりないかと思います。今回はAWSのEKSを設定し、そこにアプリケーションをデプロイするまでのシナリオをTerraformで実現するコードを…

Railsの初期化プロセスは複雑で、数多くのステップが絡み合っています。この記事では、その複雑さをステップバイステップで確認していくことで、Railsの初期化順序を理解できます。そして、Railsの初期化にまつわる改善やバグ解消を行いやすくなるでしょう。 Ruby on Railsのバージョンは、7.0.5で確認しています。また、Rails の初期化プロセス - Railsガイドも大いに参考にしています。 Railsの初期化プロセスの全体的な流れ Step 1. railsコマンドの実行 Step 2.config/application.rbの読み込み Step 2.1. config/ap…

ログはとても重要ですが、機微情報を出力してしまうとすると大きなリスクにつながります。Railsではconfig.filter_parametersとActiveSupport::ParameterFilterを用いてリクエストパラメータやカラムの値をフィルタリングしています。この記事では、具体的にどのようにフィルタをしているか紹介します。 Ruby on Railsのバージョンは、7.0.5で確認しています。 Railsのconfig.filter_parametersとは Railsのconfig.filter_parametersの挙動を確認する 特定のgemをいれるとRailsのconf…

この記事について 想定読者 この記事を書いたきっかけ 具体的なやりかた 〜プロジェクト全体のコードベースを把握する方法〜 プロジェクトのディレクトリ構成に着目する プロジェクトで使われている主要なデータ構造を把握する 木を見ず森を見るように､大きなモジュール単位で読む コードを読む際に､併せて心がけたいこと アウトプットしながら読む 感想を持ちながらコードを読む 筆者固有の経験則 仕様書を重視しない プルリクエストレビュー時は､関連コードも確認する まとめ この記事について この記事では､全てのエンジニアが必ず行う｢コード読む｣という行為について､その重要性とノウハウを説明します｡ 想定読者 …

コードは他の人が最短時間で理解できるように書かなくてはいけない。 『リーダブルコード』 p3 今週、機能開発をしているプロダクトのコードを読んでいて、理解が難しく時間がかかってしまい、頭を悩ませていました。 何かヒントになるものはないかと『リーダブルコード』を眺めていて、「コードは他の人が最短時間で理解できるように書かなくてはいけない」という一文を見つけました。 www.oreilly.co.jp コードが「読んで理解できるか」にとどまらず「最短時間で理解できるか」という、積極的な目標になっているのが気に入りました。 既存のコードベースに機能追加するとき、既存のコードで理解に時間がかかるコード…

こんにちは、サーバーサイドエンジニア の 橋本 です。 この記事は Enigmo Advent Calendar 2022 の 14 日目の記事です。 はじめに エンジニアとして仕事をしているとコードを読むことが多いと思います。例えば、仕様調査、CSからのお問合せ対応、レビュー対応などがあると思います。 今年を振り返るとコードを書く以上に読むことが多く、コードをより正確かつ速く読むにはどうすればいいかを考えることが多くありました。 ということで、この記事では私個人がコードを読む時に意識していることを紹介していこうと思います。 いきなりコードは読まない 1つ目はいきなりコードは読まないことです。…