この記事はQiitaにも書いていますが、一応ブログにも同様のものを載せておきます。
qiita.com
graphql-rubyはリソースの参照元のデフォルトがActiveRecordなので、それをElasticsearchに変更したかったのですが、ライブラリがなかったので自分で実装しました。
環境について
- Ruby 2.7.3
- Rails 6.0.3.4
- Gem
- graphql 1.12.12
- elasticsearch-model 7.1.1
実装方法について
GraphQLのページネーションは Relay-Style Cursor Pagination が主流でしょう。その他、kaminariなどを使ったページネーションの実装もQiitaの記事で紹介されていました。
https://qiita.com/nobuo_hirai/items/f9e34d8572a82283538b
こちらの記事にあるように、社内で使うだけとかであれば、kaminariのページネーションを使うのもありだと思うのですが、最終的に公開を目指しているAPIなので、素直にRelay-Style Cursor Paginationを使えるようにしました。
カスタムコネクションを作る
graphql-rubyは、デフォルトで様々なリソース用のコネクションクラスを準備しています。ActiveRecordだけでなく、Sequel、MongoDB、配列などをサポートしています。しかし、Elasticsearchはありません。そのため、独自にカスタムコネクションを作らなければなりません。
カスタムコネクションの作り方のサンプルは、公式のカスタムコネクションのページにざっくりとした作り方が書いてあります。
https://graphql-ruby.org/pagination/custom_connections
当初は、これを見ながら実装しようかと思ったのですが、やはりざっくりとしか書いてないので、なかなかわかりませんでした。そこで、graphql-rubyのpaginationsディレクトリのソースコードを読みながら進めることにしました。
https://github.com/rmosolgo/graphql-ruby/tree/master/lib/graphql/pagination
ActiveRecordRelationConnectionというクラスがあるのですが、それはRelationConnectionクラスを継承していたので、当初はRelationConnectionを継承して進めようとしましたが、よくわからなかったので、Connectionクラスを継承元とし、RelationConnectionで定義されているメソッドを全て再実装していきました。
結果的には、RelationConnectionで実装されているメソッドのままでよいものが大多数だったので、継承元をRelationConnectionに変更しましたが、処理の流れは掴めました。
それで、作成したクラスがこちらです。
module Connections
class ElasticsearchRelationConnection < GraphQL::Pagination::RelationConnection
def nodes
@nodes ||= limited_nodes.records.to_a
end
alias_method :load_nodes, :nodes
private :load_nodes
def cursor_for(item)
load_nodes
offset = @nodes.index(item) + 1 + (@paged_nodes_offset || 0)
encode(offset.to_s)
end
private
def relation_larger_than(relation, size)
initial_offset = relation_offset(relation)
relation_count(relation) > initial_offset + size
end
def relation_offset(relation)
relation.search.definition.fetch(:from, 0)
end
def relation_limit(relation)
relation.search.definition[:size]
end
def relation_count(relation)
relation.results.total
end
def null_relation(relation)
relation.records.none
end
def limited_nodes
super()
rescue ArgumentError => _e
ApplicationRecord.none
end
end
end
これを使えるようにします。先ほど作ったコネクションを使えるように登録します。
class MySchema < GraphQL::Schema
connections.add(Elasticsearch::Model::Response::Response, Connections::ElasticsearchRelationConnection)
end
そして、これを使ったスキーマを定義します。UserモデルのElasticsearchのスキーマ定義は省略します…。
module Types
class QueryType < Types::BaseObject
field :users, Objects::User.connection_type, null: false do
argument :keyword, String, required: false
end
def users(keyword: nil, **args)
query = Elasticsearch::DSL::Search::Search.new
query.query do
bool do
if keyword.present?
must do
simple_query_string do
query keyword
fields ['keyword_search_field']
default_operator :and
end
end
end
end
end
es_response = User.__elasticsearch__.search(query.to_hash)
Connections::ElasticsearchRelationConnection.new(
es_response,
first: args[:first],
last: args[:last],
before: args[:before],
after: args[:after],
)
end
end
end
これで、Elasticsearchに対してGraphQLで検索させることができるようになりました。
実際にクエリを書いてみます。
query {
users(keyword: "山田", first: 3) {
edges {
cursor
node {
id
name
}
}
pageInfo {
startCursor
endCursor
hasNextPage
hasPreviousPage
}
}
}
先ほどのクエリを実行した結果です（公開用にデータは適当に修正しています）。
pageInfoにカーソルの値や、前後のページの有無が返っています。
{
"data": {
"users": {
"edges": [
{
"cursor": "MQ",
"node": {
"id": "34",
"name": "山田 孝夫"
}
},
{
"cursor": "Mg",
"node": {
"id": "76",
"name": "山田 孝之"
}
},
{
"cursor": "Mw",
"node": {
"id": "55",
"name": "山田 太郎"
}
}
],
"pageInfo": {
"startCursor": "MQ",
"endCursor": "Mw",
"hasNextPage": true,
"hasPreviousPage": false
}
}
}
}
まとめ
- graphql-rubyはデフォルトで様々なコネクションクラスを持っている
- その他のリソースで検索させたい場合などは
GraphQL::Pagination::Connectionクラスを継承して作ることができる
- graphql-rubyでElasticsearchを使いつつ、Relay-Style Cursor Paginationを実現したければ、カスタムコネクションを作る必要がある
- 上記に載せた
ElasticsearchRelationConnectionのコードが、それである。
id:tech-kazuhisa
id:Songmu
