LIVESENSE made*

リブセンスのエンジニアやデザイナーの活動や注目していることをまとめたブログです。

MENU

Gitのコミットの裏側で起こっていること

はじめまして。1ヶ月でエンジニアになろうとした山浦です。

先日Gitのことを突っ込んで調べる機会があり、Gitの仕組みって面白いねということを同僚に話していたら「面白いね。ところでGitって実装できる?実装できないと分かったとは言えないよね?」となぜか煽られるということがありました。

そうか、実装できないと分かったとは言えないのか、それも一理あるかもしれない。そう思い、Gitの仕組みを実装できるレベルまで掘り下げて調べてみました。

今回は実装はしないものの(過度に記事が複雑になるので)、Gitの根幹である git add コマンドと git commit コマンドの裏側で起こっていることを紹介します。

差分かスナップショットか?

ここで早速クイズです。

コミットで保存されているのはソースコードの差分でしょうか?スナップショットでしょうか?

今回の記事の中で解説していきますので、少し考えながら読み進めてみてください。 ちなみにこのデータの持ち方がGitと他のバージョン管理システム (Subversion等) との大きな違いだったりします。

git add コマンドの裏側で起こっていること

それでは、git add コマンドでインデックスに登録する裏側で何が起こっているのかをまず見ていきます。

$ git init sample
$ cd sample
$ echo 'Hello, world!' > sample.txt
$ git add sample.txt

git add コマンドを実行すると裏側では、①圧縮ファイルが作成され②インデックスに追記されます。これらを順に見ていきます。

f:id:livesense-made:20170813134138p:plain

①圧縮ファイルが作成される

git add コマンドを実行すると、addしたファイルを圧縮したファイルが .git/objects 以下に保存されます。

$ find .git/objects -type f
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b

これが先ほどの git add コマンドで追加されたファイルです。 このファイルはblob (カタマリ) オブジェクトと呼ばれていて、ファイルの内容を圧縮したものになります。

どのようにblobオブジェクトを作成しているかというと、まず、ファイルの内容にヘッダーを付け加えたものをSHA1でハッシュ化します (それがblobオブジェクトのID)。IDの先頭2文字をサブディレクトリの名前に、残り38文字をそのディレクトリ内のblobオブジェクトのファイル名にします。そして、ファイルの内容にヘッダーを付け加えたものをzlibライブラリを用いて圧縮し、blobオブジェクトのファイルに書き込みます。こうやってblobオブジェクトは作成され、ファイルが圧縮保存されます。

f:id:livesense-made:20170820100304p:plain

なお、blobオブジェクトの圧縮前の内容を確認したい時は、blobオブジェクトのIDに対して git cat-file -p コマンドを使うことで確認できます。

$ git cat-file -p af5626b4a114abcb82d63db7c8082c3c4756e51b
Hello, world!

さて、ここでファイルに追記して git add コマンドを実行するとどうなるでしょう。

$ echo 'Good morning.' >> sample.txt
$ git add sample.txt
$ find .git/objects -type f
.git/objects/67/dcebe5e80cb4513b614624763ce08cf3346d8f # 新規追加されたファイル
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b # 1回目のgit addで生成されたblobオブジェクト

すると、元々のblobオブジェクトは残ったまま、もう一つのファイルが追加されています。このファイルの中身はいったい何でしょう?

$ git cat-file -p 67dcebe5e80cb4513b614624763ce08cf3346d8f
Hello, world!
Good morning.

現状のsample.txtの内容が圧縮されていました。このように、git add コマンドを実行すると、その時点でのファイルの内容全部がblobオブジェクトという形で圧縮され記録されます。

ここでblobオブジェクトに関する重要な点をまとめます。

  • blobオブジェクトのIDはSHA1ハッシュで作成されているため、blobオブジェクトはファイル名に関係なく内容が同じなら同じIDになります。
  • blobオブジェクトのデータベースは追記のみで更新されません。イミュータブルなオブジェクトです。(ファイルを変更・削除してもblobオブジェクトは変更・削除されません)

②インデックスに追記される

ファイルはblobオブジェクトの形式で圧縮保存されるわけですが、blobオブジェクトはファイルの内容を圧縮しただけで、ファイル名の情報をどこにも保持していません。

そこで、ファイルの構造と名前を保持するために登場するのがインデックスです。

git add コマンドを実行すると、blobオブジェクトが作成された後、インデックスに追記されます。インデックスは、.git/index というバイナリファイルで管理されています。プロジェクトのある時点でのディレクトリツリー全体を表すデータを持ちます。

インデックスの中身を確認してみましょう。git ls-files –stage コマンドで .git/indexの内容を見ることができます。

$ git ls-files --stage
100644 67dcebe5e80cb4513b614624763ce08cf3346d8f 0       sample.txt

左からファイルモード (パーミッション)、(blob) オブジェクトのID、ステージ、ファイルパスが表示されています。ステージはマージコンフリクトのためにある数値です。通常0ですが、マージコンフリクトが起きた場合、ベースバージョン、一方のブランチのバージョン、他方のブランチのバージョンの3つをそれぞれステージ1、2、3としてインデックスに保持します。

このように、git add した時点でのblobオブジェクトのIDとファイルパスを紐付けて管理することで、ディレクトリーツリーの情報を保存します。

インデックスには次の特徴があります。

  • 次のコミットの準備をする場所。git commit すると、インデックスの情報を元にコミットされます。
  • バイナリファイルにパーミッション、オブジェクトのID、ファイルパスを持ちます。
  • treeオブジェクトの鋳型となります。treeオブジェクトに関してはこの後紹介します。

以上の2つが、git add コマンドでインデックスに追加する際に裏側で起こっていることです。

git commit コマンドの裏側で起こっていること

さて、ここからはコミットについて見ていきます。

$ git commit -m "first commit"
[master (root-commit) ef56b89] first commit
 1 file changed, 2 insertions(+)
 create mode 100644 sample.txt

git commit コマンドを実行すると裏側では、③treeオブジェクトが作成され④commitオブジェクトが作成され⑤ブランチの先頭を指すリファレンスが書き換えられます。

f:id:livesense-made:20170813153434p:plain ※ 図は①〜④まで

③treeオブジェクトが作成される

git commit コマンドを実行するとまず、treeオブジェクトが .git/objects 以下に保存されます。

$ find .git/objects -type f
.git/objects/2f/b1bd43dc899bcb3d8c1245e359716459ad992a # 今回追加されたファイル
.git/objects/67/dcebe5e80cb4513b614624763ce08cf3346d8f # 2回目のgit addで生成されたblobオブジェクト
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b # 1回目のgit addで生成されたblobオブジェクト
.git/objects/ef/56b8952e72e3be4b06f61ecef53a9d282a4568 # 今回追加されたファイル

今回追加されたファイルのうち、.git/objects/2f/b1bd43dc899bcb3d8c1245e359716459ad992a を先に見ていきましょう。このファイルは、treeオブジェクトと呼ばれているものになります。

# -t オプションを付けるとオブジェクトのタイプを表示します
$ git cat-file -t 2fb1bd43dc899bcb3d8c1245e359716459ad992a
tree

# -p オプションを付けるとオブジェクトの中身を表示します
$ git cat-file -p 2fb1bd43dc899bcb3d8c1245e359716459ad992a
100644 blob 67dcebe5e80cb4513b614624763ce08cf3346d8f    sample.txt

treeオブジェクトは、左からファイルモード(パーミッション)、オブジェクトのタイプ、オブジェクトのID、ファイルパスが表示されています。中身がインデックスに似ていますね。 treeオブジェクトもインデックスと同じように、オブジェクトのIDとファイルパスを紐付けることで、ディレクトリーツリーを保持するためのものになります。

インデックスとの違いは、新たにコミットするたびにtreeオブジェクトも追加で作成されるという点です。コミットすると、そのたびにtreeオブジェクトとcommitオブジェクトが作成され、その時点でのディレクトリーツリーが毎回保存されます。そうすることでGitは変更履歴を保存しているのです。それに対してインデックスは、インデックスした時点で .git/index を毎回上書します。あくまでインデックスは、変更をまとめてコミットするための準備をする場所です。インデックスすると .git/index にディレクトリーツリーが上書きされ、コミットするとその時点での .git/index の情報を元にtreeオブジェクトが作成されるわけです。

次に、ディレクトリを追加するとtreeオブジェクトがどのようにディレクトリーツリーを保存するのかを見ていきましょう。

$ mkdir src
$ echo 'main file.' > src/main.txt
$ git add src
$ git commit -m "add directory"
[master ebf5ca0] add directory
 1 file changed, 1 insertion(+)
 create mode 100644 src/main.txt

# masterブランチ上での最後のコミットが指しているツリーオブジェクトの中身を表示します
# git cat-file -p 9a49569a4956b912f7ea59f0efbdb4a5c4d18a19aee9bb でも同じです
$ git cat-file -p master^{tree}
100644 blob 67dcebe5e80cb4513b614624763ce08cf3346d8f    sample.txt
040000 tree 94d5c7eab249212c58445ace5acadf10ed991e0c    src

# srcのtreeオブジェクトの中身を表示します
$ git cat-file -p 94d5c7eab249212c58445ace5acadf10ed991e0c
100644 blob 258dda95ffff5919f3ea5894c3bfaafdf225bf57    main.txt

上記のtreeオブジェクトの構造を図で表すと、以下のようになります。

f:id:livesense-made:20170813162224p:plain

このようにtreeオブジェクトは、1つ以上のblobオブジェクトかtreeオブジェクトを保持する階層構造になっています。そして、treeオブジェクトからblobオブジェクトをたどることで、その時点のスナップショットを確認することができます。

ここでtreeオブジェクトの特徴をまとめます。

  • コミット時に作成されます。
  • 構造や名前をもたないblobオブジェクトにファイルシステムとしての構造を与えます。
  • blobオブジェクトかtreeオブジェクトを保持しています。

④commitオブジェクトが作成される

さて、treeオブジェクトにより、コミット時のディレクトリーツリーが分かるようになりました。

しかしまだ、そのコミットを誰が、いつ、何のために変更したのかという情報がありません。それを保持するのがcommitオブジェクトです。

コミットすると、treeオブジェクトが作成された後に、.git/objects 以下にcommitオブジェクトが作成されます。

$ find .git/objects -type f
.git/objects/25/8dda95ffff5919f3ea5894c3bfaafdf225bf57 # 3回目のgit addで生成されたblobオブジェクト
.git/objects/2f/b1bd43dc899bcb3d8c1245e359716459ad992a # 1回目のgit commitで生成されたtreeオブジェクト
.git/objects/67/dcebe5e80cb4513b614624763ce08cf3346d8f # 2回目のgit addで生成されたblobオブジェクト
.git/objects/94/d5c7eab249212c58445ace5acadf10ed991e0c # 最新のコミットで追加されたtreeオブジェクト
.git/objects/9a/4956b912f7ea59f0efbdb4a5c4d18a19aee9bb # 最新のコミットで追加されたtreeオブジェクト
.git/objects/af/5626b4a114abcb82d63db7c8082c3c4756e51b # 1回目のgit addで生成されたblobオブジェクト
.git/objects/eb/f5ca03e94fe2244bb784fc4fddabf80e27a2e7 # 最新のコミットで追加されたcommitオブジェクト
.git/objects/ef/56b8952e72e3be4b06f61ecef53a9d282a4568 # 1回目のgit commitで生成されたcommitオブジェクト

# git cat-file -p HEAD でも同じ。最新コミットのcommitオブジェクトの内容を表示します
$ git cat-file -p ebf5caebf5ca03e94fe2244bb784fc4fddabf80e27a2e7
tree 9a4956b912f7ea59f0efbdb4a5c4d18a19aee9bb
parent ef56b8952e72e3be4b06f61ecef53a9d282a4568
author Harry <harry@author.co.jp> 1502608263 +0900
committer Harry <harry@author.co.jp> 1502608263 +0900

add directory

commitオブジェクトの中身は、コミットが作成された時点のトップレベルのツリー、親コミット、作者とコミッターの情報、空行、コミットメッセージです。このように、ツリーを保存することでコミットした時点のスナップショットが、作者とコミッターの情報からいつ誰が、コミットメッセージからなぜ変更したのかということが分かるようになっています。

なお、親コミットとは直前のコミットになります。親コミットの内容も確認してみましょう。

# parentに記載されているcommitオブジェクトの内容を表示します
$ git cat-file -p ef56b8952e72e3be4b06f61ecef53a9d282a4568
tree 2fb1bd43dc899bcb3d8c1245e359716459ad992a
author Harry <harry@author.co.jp> 1502606667 +0900
committer Harry <harry@author.co.jp> 1502606667 +0900

first commit

今回の親コミットは、最初のコミットになります。そのコミット内容が表示されています。

ここまでのGitリポジトリ内のオブジェクトの様子を図でまとめます。

f:id:livesense-made:20170813170631p:plain

Gitはcommitオブジェクトにtreeオブジェクトを保持することで、その時点でのスナップショットが分かるようにしています。 加えて、直前のコミットを親コミットとして保持しておくことで、コミットの履歴を辿れるようにしているわけです。これがGitのバージョン管理の根幹をなしている仕組みです。

ここでcommitオブジェクトの特徴をまとめます。

  • コミット時点でのスナップショットを示すオブジェクトです。treeオブジェクトのIDを持っていて、それがスナップショットの情報になります。
  • parentを持っていて、履歴をたどることができます。
  • なお、マージコミットの場合はparentを2つ持つことになります。

⑤ブランチの先頭を指すリファレンスが書き換えられる

git commit コマンドを実行すると、commitオブジェクト作成後に、現在のブランチの先頭を指すリファレンスが書き換えられます。

そもそも現在のブランチの情報はどこで保持されているかというと、HEADになります。HEADとは、現在使用しているブランチの先頭を表していて、.git/HEAD に保存されています。早速確認してみましょう。

$ cat .git/HEAD
ref: refs/heads/master

これを見ると、HEADは refs/heads/master へのリファレンスになっていることが分かります。HEADというのは、現在のブランチへのリファレンスで、ブランチをチェックアウトしたタイミングで書き換えられます。

では次に、refs/heads/master を確認してみます。

$ cat .git/refs/heads/master
ebf5ca03e94fe2244bb784fc4fddabf80e27a2e7

$ git cat-file -p ebf5caebf5ca03e94fe2244bb784fc4fddabf80e27a2e7
tree 9a4956b912f7ea59f0efbdb4a5c4d18a19aee9bb
parent ef56b8952e72e3be4b06f61ecef53a9d282a4568
author Harry <harry@author.co.jp> 1502608263 +0900
committer Harry <harry@author.co.jp> 1502608263 +0900

add directory

refs/heads/master は、masterブランチの先頭のcommitオブジェクトへのリファレンスになっていました。

Gitはコミットすると、refs/heads/master に最新コミットのIDを記載することで、現在のブランチの先頭コミットがどれなのかを記録しているのです(ブランチが変わると、refs/heads/ 以下が該当ブランチ名に変わります)。

まとめ

さて、はじめにコミットで保存されているのはソースコードの差分かスナップショットか、というクイズを出したのを覚えていらっしゃるでしょうか?

コミットで保存されているのは「スナップショット」でした。

git add コマンドを実行すると①圧縮ファイルが作成され②インデックスに追記されます。
git commit コマンドを実行すると③treeオブジェクトが作成され④commitオブジェクトが作成され⑤ブランチの先頭を指すリファレンスが書き換えられます。
commmitオブジェクトがtreeオブジェクトのIDを保持することで、コミット時点のスナップショットが分かるようになっているのでしたね。

ちなみに、他のバージョン管理システム (Subversion等) の多くは、基点とするバージョンへの差分としてデータを保持しています。Gitが差分ではなくスナップショットとしてデータを持っていることは、ブランチを運用する際に特に大きなメリットとなります。多くのバージョン管理システムの場合だと、データを差分として保持しているため、ブランチの作成時に全ファイルを新たなディレクトリにコピーする必要があり、ブランチ作成に長い時間がかかります。それに対してGitの場合だと、データをスナップショットとして保持ているため、ブランチの作成時はブランチのリファレンスを追加するだけですみ (ref/heads/ブランチ名 のファイルにcommitオブジェクトへのリファレンスを指定するだけ)、非常に高速です。

Gitの実態は、今回見てきた3つのオブジェクト(blobオブジェクト、treeオブジェクト、commitオブジェクト。これらをGitオブジェクトと呼びます)を中心に構成されています。もちろん他にもリファレンスやタグ等もありますが、これがGitの一番コアな部分です。 Gitのコマンドや操作の多くは、これら3つのオブジェクトに対して何らかの操作をしているだけです。

今回Gitを詳しく調べてみて、Gitは大変シンプルな構成だと思いました。本内容が皆様のGitライフの一助になれば幸いです。

参考文献

9つのWebサイトモニタリングサービスの使用感まとめ

  • はじめに
  • モニタリングサービスまとめ
    • No.1 Site24x7
    • No.2 StatusCake
    • No.3 Pingdom
    • No.4 UPTRENDS
    • No.5 GTMetrix
    • No.6 DareBoost
    • No.7 NodePing
    • No.8 Monitoring Plus
    • No.9 UptimeRobot
  • まとめ
  • おわりに

はじめに

今年4月に中途で入社したインフラストラクチャーグループ所属の内河です。 最近、ジョブセンスのインフラ担当になりました。 オンプレのサーバを触りつつAnsibleのPlaybookを書いたり、AWSのリソース設定をTerraform化しています。

現在、リブセンスではサーバの監視・外形監視にはMackerelを、WebサイトのモニタリングにはNewRelicやDatadogを利用していることが多いです。 しかし、こういったサービスの移り変わりは早く、新しいサービスが出ていたり、既存のサービスも使い勝手が変わっているかもしれません。 今回の記事は、9つのモニタリングサービスについて以下の要件を満たしているか、実際に触ってみた感想や費用について纏めてみました。

  • UIはグラフィカルで直感的か
  • 以下の点をモニタリング出来るか
     1. レスポンスタイムが分かるか
     2. アップタイムが分かるか
     3. DOMContentLoadedやLoad時間が分かるとベター

※ 有名なMackerelやNewRelicなどは除いております。ご了承ください。
※ 記載した費用は2017/08/10日現在の割引を適用していない費用に基いています。

それでは実際に見てみましょう。

続きを読む

Livesense式 開発合宿マニュアル part2

f:id:taise:20170708180350j:plain

就活会議ユニットのエンジニアをしている大政です。
最近、データ分析基盤を開発する部署から異動になりました。

開発合宿、やっていますか?
半年前に、Livesense式 開発合宿マニュアル part1という記事を書きましたが、今回はその続きです。

開発合宿を有意義なものとするために、いろいろな試行錯誤がありました。
3年間やってきた中で得られたノウハウを共有できればと思います。

開発合宿アンチパターン

  • 会場に到着してから何を作るか考え始める
  • 持ち物の準備不足
  • 旅行として満喫してしまう

会場に到着してから何を作るか考え始める

各自でもくもく取り組むタイプの開発合宿で発生しやすいです。
いいものが考えつかないまま、あれこれ探している間に何時間も過ぎてしまい、気づいたときにはタイムアップ、という流れです。

開発合宿は、会場への移動や食事などで、自由に開発できる時間は意外と限られています。
その貴重な時間は、全て開発につぎ込まなければ、作りたいものを完成させられずに終わってしまいます。

持ち物の準備不足

宿泊施設によっては、電源タップがないため交代で充電しないといけなかったり、Wi-Fiありとなっていても、回線が弱くてみんなでつなぐとまともに使えないケースもあります。
開発に集中するためにも、環境を整えるための準備が大事です。

旅行として満喫してしまう

開発合宿は、温泉地や海辺などで行うことが多く、誘惑が多いです。
ともすると、1日中遊んでしまって開発が疎かになってしまう、ということもありがちです。

気分転換は必要ですが、開発合宿で遊びすぎてしまうと後ろめたさはあるし、開発時間がもったいないです。
開発時間と遊ぶ時間は、ある程度参加者全員で揃えておいたほうが無難です。

有意義な合宿にするために

合宿のしおりをつくる

リブセンスの開発合宿では、集合場所や開催場所、移動ルートや費用などをざっくりまとめた合宿のしおりを作っています。
参加者で事前に集まってしおりの読み合わせをすると、合宿に行く機運が高まります。しおりを作るタイミングで、開発時間と遊ぶ時間をある程度決めておくと、気持ちよく過ごせるでしょう。

また、後述するさまざまな点で、しおりの読み合わせは役に立ちます。

f:id:taise:20170802143330p:plain

持ち物リストを作る

前回ご紹介した開発合宿施設は、至れりつくせりで困ることはほとんど無いと思います。とはいえ、事前に持ち物リストを作ってちゃんとチェックしておくことに越したことはありません。

例えば見過ごしがちな持ち物として、ヘッドホンがあります。
会議室を借り切って開発をする場合、他の参加者の会話やBGMが気になる方もいるでしょう。 その際にヘッドホンがとても役立ちます。

MacのACアダプタは、比較的短いため、あまり自由に動けなかったり、延長コードの形状によっては、Macのアダプタがあまりつなげられない場合もあります。
その際に、Macを購入するとついてくる延長コードがあると大変便利です。

リブセンスでは以下のような持ち物リストを使っています。

  • PC*
  • ACアダプタ*
  • お泊りセット*
  • 携帯の充電ケーブル*
  • 電源アダプタ 延長コード (Mac)
  • ヘッドホン
  • お酒 🍶

*required

この他、ボードゲームを持っていったりするメンバーもいます。 合宿のしおりに、個人の持ち物と、全体で分担する持ち物を書いておくとスムーズです。

お酒の持ち込みは、宿泊施設によっては禁止されていたり、持ち込み料が必要なケースがあります。 事前にご確認ください。

出発前に何をやるか決める

会場に到着する前に、何をやるか決めてもらうことが大事です。
しおりの読み合わせをした時に、参加者に一人ひとりやることを聞いていき、 決まっていない人はその場で一緒に考えつつ、必ず決めてもらうようにしています。

当日までに作るものが変わっていても構わなくて、考える切っ掛けを事前に作ることが大事だと思っています。

中間発表/成果発表

合宿中に発表の場を作るのはとても重要です。
多くの人は締切がないと頑張れません。

初めてやった開発合宿は、各自がそれぞれだらだら開発してなんとなく終わってしまいました。 日々の進捗は中間発表で、最後は成果発表で自分のやったことを他の参加者に説明すると決まっていると、 何らかの形で動くもの・成果が見えるものを作りたくなります。

継続するために

これまでのノウハウを活かして開発合宿がうまく行ったら、ぜひ2回、3回と続けたいものです。 最後は継続のための工夫をお伝えしたいと思います。

  • 定期開催の流れを作る
  • 運営を複数人で分担する
  • 個別に勧誘する

定期開催の流れを作る

「毎年何月に開発合宿をやる」と決めておくと、それに合わせて開催の準備をすることができて、自然と定期開催することが来ます。
リブセンスでは大体6月と11月に開催しています。宿の繁忙期を避けるためです。

運営を複数人で分担する

最初期は1人で運営するのもやむを得ないかもしれませんが、日程調整から宿の予約など、やることは結構多いため大変です。 自分1人でやりきろうとすると、自分の気持ちが切れたときに、開発合宿も開催されなくなってしまいます。

参加メンバーに相談して一緒に準備してもらうと良いでしょう。
運営メンバーが複数になると、負担も軽くなり、他のメンバーからの開催のプレッシャーもかかるため、継続しやすくなります。

勧誘する

毎回参加してくれるメンバーも、子供が生まれるなどのライフステージや環境の変化で参加できなくなるということがあります。初期メンバーだけでは、どんどん参加者は減ってしまいます。 新しいメンバーに参加してもらい、刺激が得られたり、マンネリ化を防ぎましょう。

ただし、新しく参加するのはなかなかハードルが高いのも事実です。 開催の告知をするだけでは、「参加してもいいけどどうしようかな」と悩む方も多いようです。

直接声をかけたり、仲の良い同期同士で誘い合ってもらうことで、参加のハードルが下がります。勧誘をして、合宿仲間を増やしましょう。
開発合宿を楽しんでくださった方は、繰り返し参加して頂けます。

おわりに

part2は以上です。
ぜひこれらのノウハウを活用して、楽しい開発合宿を開催して頂けたら幸いです。

就活会議トップページをリニューアルしたときのCSS設計のお話

16卒で入社したエンジニアの田口です。 就活会議というメディアで、主にフロントエンド開発を担当しています。5月にトップページをフルリニューアルしましたので、その時のCSS設計についてお話しいたします。

就活会議のフロントエンド開発では、FLOCSSを採用しています。
1カラムのレイアウトの場合、2,3カラムの場合と比較して

  • どのパーツをLayoutにすべきか
  • どこまで細かくProjectとしてきり出すべきか

が曖昧になりやすく、開発者同士の議論が増え、コードの修正も多くなりました。

そこでパーツ単位の実例を、「ファーストビュー」と「企業口コミ」の2つを用いて、トップページのCSS設計について解説していきます。

トップページのファーストビュー

f:id:livesense-made:20170629122439p:plain

こちらのトップページのファーストビューでは、背景に動画を流し、その上にヘッダーパーツ、真ん中にメッセージパーツ、その下にテキストパーツがある構成になっています。このような場合、どのような設計をするのが適切でしょうか?

Layoutのクラスを作るべきか、Projectの単位はどうするのか、など悩みどころは多いかもしれません。 今回は以下のクラス設計で実装しました。Firebug等で実際に確認していただければと思います。

f:id:livesense-made:20170725151127p:plain

ポイントとしては、Layoutの責務とProjectの責務を明確に分離したことです。 l-top-visualというファイルにファーストビューのLayoutに関するクラスをまとめています。

_top-visual.scss
//------------------------------
//トップページのビジュアルのスタイル
//------------------------------

.l-top-visual {}
.l-top-visual__video {} 
.l-top-visual__filter {}
.l-top-visual__header {}
.l-top-visual__message {}
.l-top-visual__appeal {}

今回はabsoluteで、ヘッダーや中心のメッセージパーツなどの位置を指定しているため、場所を指定する要素はLayoutに書き、その中にProjectファイルでパーツのクラスを入れました。 他にもposition指定は1つのファイルにまとめておきたかったいう理由もあります。

一般的にLayoutのクラスはl-header, l-sidebarのように汎用的に使うことを想定されています。 しかし、今回はProjectファイルにLayoutの要素を持たせるのをやめて、Layoutの責務とパーツ単位の責務を明確に分離する方針をとりました。

企業口コミのパーツ

f:id:livesense-made:20170629123311p:plain

続いてこちらの企業口コミのパーツです。1つのProjectファイルで設計した場合、以下のようになるかと思います。

_top-word-mouths.scss

//-----------------------------------
//トップページの口コミ、口コミパネルのスタイル
//-----------------------------------

.p-top-word-mouths {}
.p-top-word-mouths__title {}
.p-top-word-mouths__desc {}
.p-top-word-mouths__content {}
.p-top-word-mouths__content-inner {}
.p-top-word-mouths__panel {}
.p-top-word-mouths__panel__img {}
.p-top-word-mouths__panel__img-mask {}
.p-top-word-mouths__panel__img-text {}
.p-top-word-mouths__panel__content {}
.p-top-word-mouths__panel__content-company {}
.p-top-word-mouths__panel__content-star {}
.p-top-word-mouths__panel__content-star-text {}
.p-top-word-mouths__panel__content-category {}
.p-top-word-mouths__panel__content-text {}
.p-top-word-mouths__panel__btn-area {}
.p-top-word-mouths__panel__btn {}
.p-top-word-mouths__panel__img {}

各クラスの要素を書いていないためわかりにくいですが、1ファイルでコードが200行を超えてしまい、かつElementのElementが存在してしまいます。 最初はこのように設計していたのですが、最終的には

  • .p-top-word-mouths
  • .p-top-word-mouth-panel

の2つのプロジェクトファイルに分けて作成しました。

f:id:livesense-made:20170706180343p:plain

各ファイルのクラスは以下のようになっています。

_top-word-mouths.scss
//------------------------------
//トップページの口コミのスタイル
//------------------------------

.p-top-word-mouths {}
.p-top-word-mouths__title {}
.p-top-word-mouths__desc {}
.p-top-word-mouths__content {}
.p-top-word-mouths__content-inner {}
_top-word-mouth-panel.scss
//-----------------------------------
//トップページの口コミのパネルのスタイル
//-----------------------------------

.p-top-word-mouth-panel {}
.p-top-word-mouth-panel__img {}
.p-top-word-mouth-panel__img-mask {}
.p-top-word-mouth-panel__img-text {}
.p-top-word-mouth-panel__content {}
.p-top-word-mouth-panel__content-company {}
.p-top-word-mouth-panel__content-star {}
.p-top-word-mouth-panel__content-star-text {}
.p-top-word-mouth-panel__content-category {}
.p-top-word-mouth-panel__content-text {}
.p-top-word-mouth-panel__btn-area {}
.p-top-word-mouth-panel__btn {}

この粒度であれば、1つのProjectファイルにまとめても良いかもしれませんが、 就活会議では以下をHTML・CSSのコーディング規約としてルール化しています。

  • ElementのElementは作らない
  • ファイル数が増えるのを許容して細かくProjectファイルを切り出す

この2点により

  • クラス名が長くなることを避けられる
  • 各ファイルの行数を少なくすることにより、ファイルの見通しが良くなる
  • ProjectをComponentにする際の変更が容易になる
  • HTML構造が変わった際に、クラス名を変更することを避けられる
  • Viewを見た際に、開発者がどのファイルを見ればいいかすぐにわかる

というメリットが得られます。 そのため、就活会議ではElementのElementを許可せず、Projectファイルを小さく切リ出す方針をとりました。

簡単ではありますが、トップページの実例を用いて就活会議のCSS設計についてご紹介しました。CSS設計の参考になれば幸いです。

Railsでの秘匿情報の取り扱いを運用しやすくするgemを作った話

f:id:livesense-made:20170720182249j:plainみなさんこんにちは。ジョブセンスでエンジニアをしている小沼です。初めまして。 16新卒で入社して現在2年目になります。 去年はSQLで円グラフを書いたりしていました。

さて、本題に入ります。先日新規でRailsリポジトリを立ち上げたのですが、その時に秘匿情報の取り扱いについて考えたことがあったので紹介いたします。

Rails5.1から導入されたEncrypted Secretsについて

Rails5.1から標準でEncryptedSecretsという機能を使うことができるようになりました。

参考: Rails 5.1: Loving JavaScript, System Tests, Encrypted Secrets, and more | Riding Rails

使い方はざっくりと以下の通りです。

# 鍵とsecretsを準備
# 鍵ファイルは自動で.gitignoreに追記される
$ bundle exec rails secrets:setup

# 編集
$ bundle exec rails secrets:edit

上記の操作で秘匿情報をセキュアにgit管理することができます。 暗号化された情報はconfig/secrets.yml.encに保存されていて、アプリケーションの初期化に際してconfig/secrets.ymlの内容とmergeされます。

実際にアプリケーション上で取り扱う際は、
config/application.rbまたはconfig/environments/*.rbconfig.read_encrypted_secrets = trueとした上、Rails.application.secrets.hogehogeで参照することができます。

正直なところ、かゆいところに手が届かない

新規で作成したリポジトリではRails5.1を使っていたので、EncryptedSecretsを使うことができる環境でした。 しかしながら実際の運用を始めてみると、EncryptedSecretsは少々使いにくいなと思うことがでてきました。

そのように感じた主な理由は以下3点です。

  • 暗号化された情報は一行で記述されるため、コンフリクトが起きやすい
    • 当然、変更のたびにファイル全体が変更されるため、どの情報がいつ変更されたのか確認できない
  • ファイル全体が暗号化されるため、そもそもなんの情報が暗号化されているのかすらわからない
  • せめてansible-vault showみたいな閲覧するだけのコマンドが欲しい

なのでぼくの欲求を満たしてくれるGemを作った

実現したいことは以下の通りです。

  • 暗号化するのはYAMLの末端(葉)で、かつkey: valuevalueのみ
    • (それによってセキュアさが落ちることは許容する)
  • 暗号化したあともYAMLの構造は守る
  • 複合化した情報を手軽に参照できるコマンドを提供する

そしてできたのがleml(Leaf Encrypt YAML)です。

lemlの概要

インストールと使い方

lemlはRailsのプラグインとして実装されていて、秘匿情報はrakeタスクによって閲覧、編集を可能にしています。 実際のRailsプロジェクトはGemfile/Gemfile.lockによってgemを管理することが多いと思います。通常のgemをインストール手順と同じく、

# Gemfile
gem 'leml'

とした上で、$ bundle install

初期化

その後、初期化を行います。

$ bundle exec rake leml:init
Complete!
create  config/leml.key
create  config/leml.yml

Caution Don't forget add key file in gitignore

※ 自動的に鍵ファイルは.gitignoreに追加されません(今後機能として追加していく予定です)
※ デフォルトでYAMLのシンタックスハイライトが効いて欲しかったので本家のファイル名にある.encサフィックスは削除させてもらいました

編集/閲覧

暗号化されたファイルの編集、閲覧は以下のように行います。

$ EDITOR=vim bundle exec rake leml:edit

これでvimが立ち上がり秘匿情報の編集ができるようになります。環境変数'EDITOR'を利用するのでお好きなエディタをセットしてください。 保存して終了すると、内容を暗号化した上でconfig/leml.ymlが更新されます。編集する必要はなく、内容を確認できればいい場合は以下のコマンドで標準出力に出力することも可能です。

$ bundle exec rake leml:show

実際に使ってみると以下のようになります。
元のYAML

---
development:
  gem:
    leml:
      author: onunu
      github: https://github.com/onunu
  favorite_precure: twinkle

上記の内容を暗号化すると、

$ cat config/leml.yml
---
development:
  gem:
    leml:
      author: aFR1RWUyT0RoVTJzSlgrZ0ptVmlqdz09LS0vL2hzZXVLMzZtTFJ5dk1ZSzdqQ2lRPT0=--bced3fd4f521287b819edb677460e2518bcefb8b
      github: ZW9PcTBYMy8xakZQUXhqVmhWNlNxNXBKMmM3Z3FLTDZKVEdoRmFzUnB4Z2JScTNKMlo1VktiK0NZS01JVlpLWC0tc2hHTTlrTytOYXpJckxIMmhhNWV5QT09--5340c65706b5619afcc81318dca47c033aecf65f
  favorite_precure: T21uN2R0NjhsNjdHOHgzY1d6WHp5RDRibnNYVHBOY2l4TC9rcmc1UGZ5OD0tLXllQnQrTXk0Q3lVdmtTdzAzQVprVXc9PQ==--e2568a8cfa84055f367dce531f5e287ac5182033

階層構造があっても問題ありません。何が暗号化されているのか一目瞭然! 実際のアプリケーションから参照する時は、通常のsecretsと同様に扱うことができます。

$ bundle exec rails c
Running via Spring preloader in process 68212
Loading development environment (Rails 5.1.2)
irb(main):001:0> Rails.application.secrets.favorite_precure
=> "twinkle"

なにをしているのか

Railtieについて

lemlはRailsの初期化プロセスに相乗りする形でsecretsをmergeしていますが、これはrailtieを使うことで比較的簡単に実装することができます。 lemlでは以下のようにしてRailsの初期化プロセスを拡張しました。

# leml/lib/leml/railtie.rb
module Leml
  class Railtie < Rails::Engine
    initializer 'Decrypt Leml file' do
      require 'leml/core'
      Leml::Core.new.merge_secrets
    end
  end
end

RailtieはRails公式のプラグイン機構です。Railtieに基づいて各コンポーネントを組み合わせることで、Railsの様々な処理を手軽に拡張することができます。自作のgem(今回でいうところのLemlモジュール内)でRails::Engineクラスを継承したRailtieクラスを定義することで、Railsが処理を行う際に相乗りさせてもらえます。

参考: Rails::Railtie

今回は初期化プロセスを拡張したいので、内部でinitializerメソッドを定義しました。これにより、Railsが実行する初期化と同時に、initializerメソッド内で記述した処理をRailsが行ってくれます。

各タスクについて

lemlでは各操作をrakeタスクで提供しています。 Rails pluginではleml(gem名)/lib/tasks配下にrakeファイルを設置することで、Railsプロジェクトのタスクとして読み取ってもらえるだけでなく、タスクの実行時にはRailsの初期化プロセスが行われた後でタスクを実行してくれます。

lemlのrakeファイルは以下のようになっています。

# leml/lib/tasks/leml_tasks.rake
require 'leml/core'

namespace :leml do
  desc 'initialize secrets yaml'
  task :init => :environment do
    Leml::Core.setup
  end

  desc 'edit encrypted yaml'
  task :edit => :environment do
    Leml::Core.new.edit
  end

  desc 'show encrypted yaml'
  task :show => :environment do
    Leml::Core.new.show
  end
end

終わりに

いかがでしたか? 自分で書いたファイル数は4つくらいでしたし、それぞれ基本的なことしかしていません。 それでも自分のやりたかったことはある程度実現できました。Railsの懐の深さに驚きです。

また本家のEncryptedSecretsの実装、Railtieの仕組みなどを理解するのにソースコードを読みましたが大変勉強になりました。やはり一次資料はソースコードですね。

lemlはオープンソースで提供しているので、みなさん使ってみてくださいね! まだまだ至らぬ所はありますが、メンテ頑張っていきたいと思います。ご要望やバグ報告、その他ご指摘などはissueを立ち上げていただけると幸いです。

ご注意

lemlはYAMLファイル中のkey: valueのうちvalueだけを暗号化します。当然、keyは平文のまま残るため、keyからvalueの値を推測されてしまう危険性をもっています。 そのリスクを許容できない場合はRails標準のEncryptedSecretsを利用するか、あるいは併用するのがよいでしょう。 ご利用の際にはご注意ください。