Caliban: Functional GraphQL Library for Scala

CALIBAN
FUNCTIONAL GRAPHQL LIBRARY FOR SCALA
Scala Matsuri - October 2020
Scalaの GraphQLライブラリ

WHO AM I?
> Pierre Ricadat aka @ghostdogpr
>
!
exiled to
"
> Developer at devsisters
> Contributor to ZIO
> Creator of Caliban
自己紹介
フランス出身韓
Caliban作者

GRAPHQL IN A NUTSHELL
> query language for APIs
> server exposes a typed schema
> client requests and receives only what they want
> client and server can use any programming language
> good tooling
GraphQLの
API のためのクエリ言語、スキーマは型付き

GRAPHQL SCHEMA
type Query {
user(id: ID): User
users: [User!]!
}
type User {
id: ID!
name: String!
age: Int
}
GraphQLスキーマ

GRAPHQL QUERY
query {
user(id: "xxx") {
name
age
}
}
GraphQLクエリ

GRAPHQL IN SCALA
> Sangria
> Caliban
> server
> client (including Scala.js support)
ScalaのGraphQLライブラリ

MOTIVATIONS
> minimize boilerplate
> purely functional
> strongly typed
> explicit errors
> user friendly
動機
ボイラープレートの最小化 / 純

DEFINING A SCHEMA
case class User(
id: UUID,
name: String,
age: Option[Int]
)
type User {
id: ID!
name: String!
age: Int
}
スキーマ定義

DEFINING A SCHEMA
case class UserArgs(id: UUID)
case class Query (
user: UserArgs => Option[User]
users: List[User]
)
type Query {
user(id: ID): User
users: [User!]!
}
スキーマ定義

SUPPORTED SCHEMAS
> Int, String, Boolean, List, Option, Tuple...
> Java Time, Java UUID
> Future, ZIO, ZStream
> case classes, sealed traits (derived by Magnolia)
> Monix, Cats Effect, Circe, Refined (via interop)
サポートしているスキーマ
各種基本の型、ライブラリに加え、自分でも

DEFINING A RESOLVER
val query = Query(
args => userService.getUser(args.id),
userService.getAllUsers
)
val api = graphQL(RootResolver(query))
リゾルバーの定義

CHECK YOUR SCHEMA
println(api.render)
/**
type Query {
user(id: ID): User
users: [User!]!
}
type User {
id: ID!
name: String!
age: Int
}
**/
スキーマを表示確認

TEST YOUR API
val query = "query { user(id: "xxx") { name age } }"
for {
interpreter <- api.interpreter
result <- interpreter.execute(query)
} yield result
APIをテストする

SERVE YOUR API
> http4s
> Akka HTTP
> Play Framework
> Finch
val route: HttpRoutes[Task] = Http4sAdapter.makeHttpService(interpreter)
APIをサーバーで動かす

N + 1 PROBLEM
query {
order(id: 12345) {
name
products {
name
}
}
}

NAIVE
for {
order <- getOrder(id)
products <- ZIO.foreachPar(order.pIds)(getProduct)
} yield Order(order.name, products)
n + 1 requests
そのままだと・・・
N+1回のリクエスト

OPTIMIZED
for {
order <- getOrder(id)
products <- ZQuery.foreachPar(order.pIds)(getProduct)
} yield Order(order.name, products)
2 requests
最適化すると
2回のリクエスト

ZQUERY
case class GetProduct(id: Int) extends Request[Throwable, Product]
val ProductDataSource =
DataSource.fromFunctionBatchedM("ProductDataSource")(
requests => dbService.getProducts(requests.map(_.id))
)
def getProduct(id: Int): ZQuery[Any, Throwable, Product] =
ZQuery.fromRequest(GetProduct(id))(ProductDataSource)
> See zio-query
ZQueryを使うと

WRAPPERS
> parsing
> validation
> execution
> field execution
> whole execution
ラッパー
パース、

BUILTIN WRAPPERS
val api = graphQL(...) @@
maxDepth(30) @@
maxFields(200) @@
timeout(10 seconds) @@
printSlowQueries(1 second)
> Apollo Tracing, Apollo Caching, Apollo Persisted
Queries, etc.
組み
Apolloのトレース、キャシュ、永

MORE FEATURES
> combine APIs
> annotations
> code generation tool
> schema diff
> Apollo Federation
他の機能
APIの結合、アノテーション、コード生成ツール等

CALIBAN CLIENT
> no boilerplate
> no more string copy-pasting
> no need for aliases, fragments, etc
Calibanクライアント
無ボイラープレート、alias や fragment もいらない

STEP 1: CODEGEN TOOL
calibanGenClient <schemaPath> <outputPath>
type Location {
latitude: Float!
longitude: Float!
}
⬇
type Location
object Location {
def latitude: SelectionBuilder[Location, Double] = (...)
def longitude: SelectionBuilder[Location, Double] = (...)
}
コード生成ツール

STEP 2: WRITING QUERIES
val location =
Location.latitude ~ Location.longitude
val query =
Query.search(Some("Berlin Ostbahnhof")) {
Searchable.stations {
Station.name ~ Station.location {
location
}
}
}
クエリを書く

STEP 3: RUNNING QUERIES
val request = query.toRequest(uri)
SttpClient.send(request)
> Response is already parsed into Scala types
> Use the sttp backend of your choice (including Scala.js)
クエリの
レスポンスはScalaの型としてパース /Scala.jsを含み、
好きなsttpバックエンドを使用可能

CURRENT STATE
> Recently celebrated 1st birthday
> Already 520 stars on github
> Built by 45 contributors
#
現在の
開 1年 /520スター/45コントリビューター/パフォーマ
ンス改善

THANKS!
> Website: https://ghostdogpr.github.io/caliban/
> Resources, FAQ, Examples
> ZIO Discord: #caliban
> Twitter: @ghostdogpr
ご

QUESTIONS?
質問はありますか？

Caliban: Functional GraphQL Library for Scala

More Related Content

What's hot (20)

Similar to Caliban: Functional GraphQL Library for Scala (20)

Caliban: Functional GraphQL Library for Scala