There’s no doubt that GraphQL has been making waves in the web development community since it was announced, and for good reason! GraphQL helps decouple an application’s front-end from its back-end in amazingly flexible ways.
Unfortunately, React and Redux, the current go-to front-end frameworks for handling client-side state and interacting with a GraphQL server are cumbersome to use at best. Thankfully, the Apollo client, a new project from the Meteor Development Group, is trying to offer a more straight-forward, batteries included option for interfacing with GraphQL and managing your client-side state.
Let’s dig into how to set up a basic GraphQL server in Elixir using Absinthe, and how to interact with that server using the Apollo client.
Elixir’s Absinthe
Absinthe is a GraphQL implementation for Elixir. It lets you set up a GraphQL endpoint on your Elixir/Phoenix server.
Setting up Absinthe is a straight-forward process. To start, we’ll add dependencies on the absinthe
and absinthe_plug
Mix packages and fire up their corresponding applications:
defp deps do
[ ...
{:absinthe, "~> 1.2.0"},
{:absinthe_plug, "~> 1.2.0"}]
applications: [ … :absinthe, :absinthe_plug]
Just like in the Absinthe tutorial, our next step is to set up our GraphQL types. We’ll create simple schemas for an author and a post:
object :author do
field :id, :id
field :first_name, :string
field :last_name, :string
field :posts, list_of(:post) do
resolve fn author, _, _ ->
{:ok, HelloAbsinthe.Schema.find_posts(author.id)}
end
end
end
object :post do
field :id, :id
field :title, :string
field :author, :author do
resolve fn post, _, _ ->
{:ok, HelloAbsinthe.Schema.find_author(post.author.id)}
end
end
field :votes, :integer
end
Next, we’ll define the types of queries we support. To keep things simple, we’ll add two basic queries. The first, posts
, will return all posts in the system, and the second, author
, will return an author for a given id
:
query do
field :posts, list_of(:post) do
resolve &get_all_posts/2
end
field :author, type: :author do
arg :id, non_null(:id)
resolve &get_author/2
end
end
To cut down on the number of moving parts in this example, we’ll write our two resolver functions to return a set of hard-coded posts and authors, rather than pulling them from some external data source:
@posts [
%{id: 1, title: "GraphQL Rocks", votes: 3, author: %{id: 1}},
%{id: 2, title: "Introduction to GraphQL", votes: 2, author: %{id: 2}},
%{id: 3, title: "Advanced GraphQL", votes: 1, author: %{id: 1}}
]
@authors [
%{id: 1, first_name: "Sashko", last_name: "Stubailo"},
%{id: 2, first_name: "Tom", last_name: "Coleman"},
]
...
def get_all_posts(_args, _info) do
{:ok, @posts}
end
def get_author(%{id: id}, _info) do
{:ok, find_author(id)}
end
def find_author(id) do
Enum.find(@authors, fn author -> author.id == id end)
end
def find_posts(author_id) do
Enum.find(@posts, fn post -> post.author.id == author_id end)
end
Now all we need to do is tell Absinthe that we want our GraphQL endpoint to listen on the "/graphql"
route and that we want it to use our newly defined schemas and queries:
forward "/graphql", Absinthe.Plug, schema: HelloAbsinthe.Schema
And that’s it! Now we can send our server GraphQL queries and it will process them and send back the result.
Let’s move on to setting up Apollo on the front-end.
Apollo Client
If you haven’t noticed already, we’re basing this example off of the query example on the Apollo Developer page.
Before we continue with their example, we need to set up React in our application. Since we started with a fresh Phoenix project (mix phoenix.new
), we’ll need to install install some NPM dependencies to work with React, Apollo, etc…:
npm install --save react react-dom apollo-client react-apollo \
graphql-tag babel-preset-react
Next, we’ll need to tell Brunch how to we want our ES6 transpiled by tweaking our Babel options in brunch-config.js
:
plugins: {
babel: {
presets: ["es2015", "react"],
...
The last thing we need to do is replace the HTML our Phoenix application generates (in app.html.eex
) with an empty <div>
to hold our React application:
<div id="app"></div>
Now we can copy over the <PostList>
component from the Apollo example. We’ll throw it in a file called PostList.jsx
.
Lastly, we’ll create an instance of ApolloClient
and wire up the <PostList>
component to our container <div>
in our app.js
:
const client = new ApolloClient();
ReactDOM.render(
<ApolloProvider client={client}>
<PostList />
</ApolloProvider>,
document.getElementById("app")
);
And that’s it! When our application reloads, we’ll see all of the hard-coded author and post data from our server loaded up and rendered on the client.
How it Works
This is obviously a drastically over-simplified example of what GraphQL can do, but it’s a good jumping off point. Let’s see how all of it ties together, starting on the client.
The <PostList>
component we pulled from the Apollo example is a simple component that expects to be passed a loading
boolean and a list of posts
inside of a data
property.
If loading
is true, we’ll show a loading message. Otherwise, we’ll render the list of posts
:
function PostList({ data: { loading, posts } }) {
if (loading) {
return <div>Loading</div>;
} else {
return (<ul>{posts.map(post => … )} </ul>);
}
}
Where do loading
and posts
come from? The loading
field is controlled by the Apollo client. When we’re waiting on the response for a GraphQL query, loading
will be true
. The posts
field actually comes directly from the response to our GraphQL query.
When we export PostList
, we actually wrap it in a GraphQL query that describes the data this component needs to render:
export default graphql(gql`
query allPosts {
posts {
id
title
votes
author {
id
firstName
lastName
}
}
}
`)(PostList);
The shape of a GraphQL query’s response maps directly to the shape of the query itself. Notice how we’re asking for a set of posts
. We want each post to be returned with an id
, title
, votes
, and an author
object, complete with id
, firstName
, and lastName
.
Our response will look exactly like this:
{
posts: [
{
id: 1,
title: "GraphQL Rocks",
votes: 3,
author: {
id: 1,
firstName: "Sashko",
lastName: "Stubailo"
}
},
...
]
}
This is the power of GraphQL. It inverts the normal query/result relationship between the client and the server. The client tells the server exactly what it needs, and that exact data is returned from the query. No more, no less.
Apollo takes that client-first mentality even further. With Apollo, each component tells the server exactly what it needs and manages it’s data lifecycle entirely on its own, independent from other components in the application.
Final Thoughts
I’m really excited about the combination of an Elixir/Absinthe back-end driving an Apollo-powered client front-end.
I’ve only just started playing with this combination, but I hope to start building out more complex and realistic applications to see if it lived up to my hopes and expectations.
Be sure to check out the entire project on GitHub. Have you used Absinthe or any part of the Apollo stack? If so, shoot me an email and let me know your opinions!