Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maartenvanvliet/apq
Support for Automatic Persisted Queries in Absinthe
https://github.com/maartenvanvliet/apq
Last synced: 3 months ago
JSON representation
Support for Automatic Persisted Queries in Absinthe
- Host: GitHub
- URL: https://github.com/maartenvanvliet/apq
- Owner: maartenvanvliet
- License: mit
- Created: 2018-09-15T12:46:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-30T05:00:01.000Z (over 1 year ago)
- Last Synced: 2024-07-11T22:09:37.504Z (4 months ago)
- Language: Elixir
- Size: 200 KB
- Stars: 51
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Apq
 [][hex-page] [][apq-hexdocs] [][mit-license]
Support for [Automatic Persisted Queries][apq] in Absinthe. Query documents in GraphQL can be be of a significant size. Especially on mobile it may be beneficial to limit the size of the queries so fewer bytes go across the network. APQ uses a deterministic hash of the input query in a request. If the server does not know the hash the client can retry the request with the expanded query. The server can use this request to store the query in its cache.
You'll need a GraphQL client that can use APQ, such as Apollo Client.
Complete example project is available [here][example-project]
## Installation
Since APQ is [available in Hex][hex-page], the package can be installed
by adding `apq` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:apq, "~> 2.0"}
]
end
```
## Examples
Define a new module and `use Apq.DocumentProvider`:
```elixir
defmodule ApqExample.Apq do
use Apq.DocumentProvider,
cache_provider: ApqExample.Cache,
max_query_size: 16384 #default
end
```
If you're going to [use `GET` requests for APQ's hashed queries][apq-with-get], you'll need to specify a `json_codec` that responds to `decode!/1` such as [Jason][jason] or [Poison][poison]:
```elixir
defmodule ApqExample.Apq do
use Apq.DocumentProvider,
json_codec: Jason
end
```
In a Phoenix project, this should be set with `Phoenix.json_library()`.
You'll need to implement a cache provider. This is up to you, the provider should implement `Apq.CacheProvidr`
### Cachex cache provider
In this example I use [Cachex][cachex].
Define a module for the cache, e.g when using Cachex:
```elixir
defmodule ApqExample.Cachex.Cache do
@behaviour Apq.CacheProvider
def get(hash) do
Cachex.get(:apq_cache, hash)
end
def put(hash, query) do
Cachex.put(:apq_cache, hash, query)
end
end
```
You'll need to start it in your supervision tree:
```elixir
children = [
worker(Cachex, [ :apq_cache, [ limit: 100 ] ]),
#...
]
```
### Redis cache provider
When using Redis as a cache provider you can use the [Redix][redix] library.
You'll need to start a connection to Redis.
```elixir
children = [
{Redix, name: :redix}
#...
]
```
```elixir
defmodule ApqExample.Redix do
@behaviour Apq.CacheProvider
def get(hash) do
Redix.command(:redix, ["GET", hash])
end
def put(hash, query) do
Redix.command(:redix, ["SET", hash, query])
end
end
```
Now we need to add the `ApqExample.Apq` module to the list of document providers. This goes in your router file.
```elixir
match("/api",
to: Absinthe.Plug,
init_opts: [
schema: ApqExample.Schema,
json_codec: Jason,
interface: :playground,
document_providers: [ApqExample.Apq, Absinthe.Plug.DocumentProvider.Default]
]
)
```
This is it, if you query with a client that has support for Apq it should work with Absinthe.
## Documentation
Documentation can be generated with [ExDoc][exdoc]
and published on [HexDocs][hexdocs]. Once published, the docs can
be found at [https://hexdocs.pm/apq][hex-page].
[apq-hexdocs]: https://hexdocs.pm/apq/readme.html
[apq-with-get]: https://www.apollographql.com/docs/apollo-server/performance/apq/#using-get-requests-with-apq-on-a-cdn
[apq]: https://www.apollographql.com/docs/guides/performance.html#automatic-persisted-queries
[build-status]: https://travis-ci.com/maartenvanvliet/apq
[cachex]: https://github.com/whitfin/cachex
[example-project]: https://github.com/maartenvanvliet/apq_example
[exdoc]: https://github.com/elixir-lang/ex_doc
[hex-page]: https://hex.pm/packages/apq
[hexdocs]: https://hexdocs.pm
[jason]: https://github.com/michalmuskala/jason
[mit-license]: https://opensource.org/licenses/MIT
[poison]: https://github.com/devinus/poison
[redix]: https://github.com/whatyouhide/redix