samuraikun/graphql-ruby-hands-on

using GraphQL on Ruby3/Rails7

devcontainer for Ruby 3.1 and Rails 7.0

Ruby3.1, Ruby on Rails 7.0 の開発環境用の devcontainer

• language server: solargraph
• debugging: debug
• formatter: rubocop
• type checking: rbs, rbs_rails, steep

devcontainerを利用する

remote container のインストール

※ devcontainer に必要なツールのインストールはこちら

devcontainerの起動

1. VSCodeを開き、 Reopen in Container を実行する

操作

サーバーの立ち上げ

devcontainer上でTerminalを開き、コマンドを実行する

$ bin/rails s

Type Checking

# gem collection の install
$ bundle exec rbs collection install

# rbs_rails
$ bin/rake rbs_rails:all

# Steep check
$ bundle exec steep check

Solargraph

# Generate documentation for bundled gems
$ bundle exec solargraph bundle

# Download Ruby core documentation
$ bundle exec solargraph download-core

Debugging

devcontainer上で、 デバッグを実行 を実行する(ショートカットキー: F5)

デバッグを実行 を利用するとVSCode Debuggingが利用可能

VSCode extensions

• rebornix.Ruby
• castwide.solargraph
• KoichiSasada.vscode-rdbg
• soutaro.steep-vscode
• soutaro.rbs-syntax
• redhat.vscode-yaml
• VisualStudioExptTeam.vscodeintellicode
• esbenp.prettier-vscode
• EditorConfig.EditorConfig

構成

docker compose で構成

• app: ruby:3.1-bullseye
• postgres: postgres:14

リファレンス

• Visual Studio Code Doc - Developing inside a Container
• VS Code Solargraph Extension
• VSCode rdbg Ruby Debugger

graphql-ruby-hands-on's Issues

GraphQL APIのエラーハンドリング

参考

graphql-rubyでは、raiseする方法を提案している

• https://graphql-ruby.org/errors/error_handling.html

GraphQLを使用する側の開発体験を考慮して、Queryではエラーは最小限にするというアプローチ

https://qiita.com/QWYNG/items/370eefcf0e15b8b3d6ab#%E3%82%A8%E3%83%A9%E3%83%BC%E9%80%9A%E7%9F%A5

ZOZOの方針

https://techblog.zozo.com/entry/graphql_error_handling

GraphQLエンドポイントのAPIテストを作成する

Description

RSpec を使用して、Request Specを追加してAPIのテストをする

graphql-rubyを使用してGraphQLエンドポイントを追加する

graphql-ruby を利用する

Dataloaderを利用してN+1を回避するクエリを実装する

Description

info

• https://graphql-ruby.org/dataloader/overview.html
• https://qiita.com/QWYNG/items/370eefcf0e15b8b3d6ab#n1%E5%95%8F%E9%A1%8C%E3%81%B8%E3%81%AE%E5%85%B7%E4%BD%93%E7%9A%84%E3%81%AA%E5%AF%BE%E7%AD%96%E6%96%B9%E6%B3%95
• https://engineering.mercari.com/blog/entry/20220303-concerns-with-using-graphql/

Ruby(Rails)でのdatalaoderによるリクエスト処理をする場合の選択肢

graphql-batch

• ShopifyがOSSで開発しているGem
  • dataloader自体が非同期処理前提のためRubyでの非同期処理を実現させるため内部でpromise.rbを利用している
  • promise.rb自体はほぼメンテされていないのであまり筋がよいとは言えなさそう。。
• 採用事例は豊富

graphql-rubyに同梱されている GraphQL::Dataloader

• 非同期処理をFiberで実現している
  • graphql-batchとの比較記事
    • https://graphql-ruby.org/dataloader/adopting.html
• graphql-ruby自体にdataloaderが同梱されたのが比較的最近で、採用事例が現状少ない

batch-loader

• https://github.com/exAspArk/batch-loader
• Gemの実装がシンプル
• graphql-batchと違い、promise.rbに依存せず、Rubyのlazy objectを使用している

リソルバー部分のリファクタリング

参考

https://qiita.com/QWYNG/items/370eefcf0e15b8b3d6ab

サンプル用のRailsアプリケーション基盤を作成する

方法

https://github.com/saboyutaka/ruby31-rails70-devcontainer を利用してGithubの Use this template から作成する