GraphQL でネストしたクエリを書いたら Apollo Client が無限に計算し続けるようになった話

Hasura User Group Tokyo Meetup #3 で登壇した際のスライドです

こちらの記事に同じ内容が動く動画つきで載っています https://zenn.dev/whatasoda/articles/c79e71b74db9e2

Transcript

1. GraphQL でネストしたクエリを書いたら Apollo Client が無限に計算し続けるようになった話 @whatasoda
2. 自己紹介 Shota Hatada (whatasoda) Digital Hollywood University (日本の大学) mercari (2020/04 - 2022/09) フロントエンドチーム dinii (2022/10 -) Platform Team フロントエンドの基盤部分の実装を触ったりたまにインフラを触ったり色々 趣味：スキー お酒 アニソン
3. Hasura の Relationship テーブルやビューを接続しておけばネストしたクエリを書くだけで複数のテーブル・ビューにまたがるデータを関 連に基づいた状態で取得できる機能 例えば… todos とそれに紐づく user を一度に取得することができる (リレーションシップ - Hasura GraphQLチュートリアル) 😆 設定もクエリも簡単でとても便利！ 😮 ネストの深いクエリが増えがちに …
4. そのクエリ、実はフリーズの危険性があるかも …🥶
5. 先に結論から… Apollo Client でキャッシュを利用しているとクエリの形状に基づいたキャッシュの書き込みを行うために レスポンスデータの検証を行う 検証はデータ取得の度に同期的に行われ、データの量やクエリの複雑度などによっては膨大な時間を要 する 一度に取得するデータの量を調整するかクエリの複雑度を調整することで改善は見込める どちらも難しい場合は Apollo Client にパッチを当てるなどして検証の処理を飛ばすようにするしかない
6. なにが起こるの…？ https://apollo-client-heavy-validation-demo.whatasoda.me/ 内容が同じクエリが３つ クエリごとに返すデータの量を変える
7. なにが起こるの…？ ボタンを押すとクエリを実行する ↓ 数字や色の更新が止まる ↓ React の状態更新の処理や要素の描画の処 理がブロックされている Sample01 → 普通 Sample02 → 数秒フリーズ Sample03 → 無限…
8. なにが起こるの…？ キャッシュを無効にしていると特別フリーズはしない
9. なにが起こるの…？ パフォーマンス計測をして何が起きているのか見てみよう！（Sample02 がおすすめ） かなりのループ処理！ →詳しく見て調べてみると Apollo Client 内部での処理っぽい
10. なぜ起きるの…？ • 受け取ったデータを クエリの形状通りにキャッシュに書き込む ために検証っぽいことをしている ◦ キャッシュを使わなければ特に計算しない • クエリのフィールドの端の端までの丁寧な検証を 一つの同期処理上でやっている ◦ 他のあらゆる処理をブロックしてしまってフリーズしていた • 計算コストはざっくり『受け取るデータの数』 ×『クエリの複雑度』と言えそう ◦ 今回 paragraph の中身には id と text があるので paragraph の数 × 2 回検証するイメージ 『GraphQL クエリの形状が複雑』 AND 『受け取るデータの数が多い』 THEN フリーズの危険性がある
11. 対策は…？ • データを分割して取得する（ページネーションとか） • クエリの複雑度を抑える（一部を JSON Text として返す…？） マスターデータを全部取っておきたいので全件取得のほうが楽 … Hasura の Relationship を使っているのでクエリの複雑度はなかなか抑えられない … というか、そもそもキャッシュの検証って必要？ 実は必要ないのでは …？
12. 👊飛ばしちゃおう！💥
13. 🩹パッチを貼りました🩹
14. 対策（ゴリ押し） https://github.com/whatasoda/apollo-client-heavy-validation-demo/blob/36f7f04cca40b4ce5f67c86edde3e0aa006dd 12e/patches/@apollo+client+3.8.6.patch キャッシュ書き込みの検証時に末端の フィールドと同じように扱う
15. まとめ Apollo Client でキャッシュを利用しているとクエリの形状に基づいたキャッシュの書き込みを行うために レスポンスデータの検証を行う 検証はデータ取得の度に同期的に行われ、データの量やクエリの複雑度などによっては膨大な時間を要 する 一度に取得するデータの量を調整するかクエリの複雑度を調整することで改善は見込める どちらも難しい場合は Apollo Client にパッチを当てるなどして検証の処理を飛ばすようにするしかない
16. ご清聴ありがとうございました