--- id: persisted-queries title: Persisted Queries slug: /guides/persisted-queries/ description: Relay guide to persisted queries keywords: - persisted --- import DocsRating from '@site/src/core/DocsRating'; import {FbInternalOnly, OssOnly} from 'docusaurus-plugin-internaldocs-fb/internal'; :::tip At Meta, persistence is handled by the `relay` command for you. You likely do not need to worry about the contents of this guide. ::: The Relay compiler supports persisted queries. This is useful because: - The client operation text becomes just an md5 hash which is usually shorter than the real query string. This saves upload bytes from the client to the server. - The server can now allowlist queries which improves security by restricting the operations that can be executed by a client. ## Usage on the client ### The `persistConfig` option In the `relay` configuration section of your `package.json` you'll need specify "persistConfig". ``` "scripts": { "relay": "relay-compiler", "relay-persisting": "node relayLocalPersisting.js" }, "relay": { "src": "./src", "schema": "./schema.graphql", "persistConfig": { "url": "http://localhost:2999", "params": {} } } ``` Specifying `persistConfig` in the config will do the following: 1. It converts all query and mutation operation texts to md5 hashes. For example without `persistConfig`, a generated `ConcreteRequest` might look like below: ```javascript const node/*: ConcreteRequest*/ = (function(){ //... excluded for brevity return { "kind": "Request", "operationKind": "query", "name": "TodoItemRefetchQuery", "id": null, // NOTE: id is null "text": "query TodoItemRefetchQuery(\n $itemID: ID!\n) {\n node(id: $itemID) {\n ...TodoItem_item_2FOrhs\n }\n}\n\nfragment TodoItem_item_2FOrhs on Todo {\n text\n isComplete\n}\n", //... excluded for brevity }; })(); ``` With `persistConfig` this becomes: ```javascript const node/*: ConcreteRequest*/ = (function(){ //... excluded for brevity return { "kind": "Request", "operationKind": "query", "name": "TodoItemRefetchQuery", "id": "3be4abb81fa595e25eb725b2c6a87508", // NOTE: id is now an md5 hash // of the query text "text": null, // NOTE: text is null now //... excluded for brevity }; })(); ``` 2. It will send an HTTP POST request with a `text` parameter to the specified `url`. You can also add additional request body parameters via the `params` option. ``` "scripts": { "relay": "relay-compiler" }, "relay": { "src": "./src", "schema": "./schema.graphql", "persistConfig": { "url": "http://localhost:2999", "params": {} } } ``` ### Local Persisted Queries With the following config, you can generate a local JSON file which contains a map of `operation_id => full operation text`. ``` "scripts": { "relay": "relay-compiler" }, "relay": { "src": "./src", "schema": "./schema.graphql", "persistConfig": { "file": "./persisted_queries.json", "algorithm": "MD5" // this can be one of MD5, SHA256, SHA1 } } ``` Ideally, you'll take this file and ship it to your server at deploy time so your server knows about all the queries it could possibly receive. If you don't want to do that, you'll have to implement the [Automatic Persisted Queries handshake](https://www.apollographql.com/docs/apollo-server/performance/apq/). #### Tradeoffs - ✅ If your server's persisted query datastore gets wiped, you can recover automatically through your client's requests. - ❌ When there's a cache miss, it'll cost you an extra round trip to the server. - ❌ You'll have to ship your `persisted_queries.json` file to the browser which will increase your bundle size. ### Example implementation of `relayLocalPersisting.js` Here's an example of a simple persist server that will save query text to the `queryMap.json` file. ```javascript const http = require('http'); const crypto = require('crypto'); const fs = require('fs'); function md5(input) { return crypto.createHash('md5').update(input).digest('hex'); } class QueryMap { constructor(fileMapName) { this._fileMapName = fileMapName; this._queryMap = new Map(JSON.parse(fs.readFileSync(this._fileMapName))); } _flush() { const data = JSON.stringify(Array.from(this._queryMap.entries())); fs.writeFileSync(this._fileMapName, data); } saveQuery(text) { const id = md5(text); this._queryMap.set(id, text); this._flush(); return id; } } const queryMap = new QueryMap('./queryMap.json'); async function requestListener(req, res) { if (req.method === 'POST') { const buffers = []; for await (const chunk of req) { buffers.push(chunk); } const data = Buffer.concat(buffers).toString(); res.writeHead(200, { 'Content-Type': 'application/json' }); try { if (req.headers['content-type'] !== 'application/x-www-form-urlencoded') { throw new Error( 'Only "application/x-www-form-urlencoded" requests are supported.' ); } const text = new URLSearchParams(data).get('text'); if (text == null) { throw new Error('Expected to have `text` parameter in the POST.'); } const id = queryMap.saveQuery(text); res.end(JSON.stringify({"id": id})); } catch (e) { console.error(e); res.writeHead(400); res.end(`Unable to save query: ${e}.`); } } else { res.writeHead(400); res.end("Request is not supported.") } } const PORT = 2999; const server = http.createServer(requestListener); server.listen(PORT); console.log(`Relay persisting server listening on ${PORT} port.`); ``` The example above writes the complete query map file to `./queryMap.json`. To use this, you'll need to update `package.json`: ``` "scripts": { "persist-server": "node ./relayLocalPersisting.js", "relay": "relay-compiler" } ``` ### Network layer changes You'll need to modify your network layer fetch implementation to pass an ID parameter in the POST body (e.g., `doc_id`) instead of a query parameter: ```javascript function fetchQuery(operation, variables) { return fetch('/graphql', { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify({ doc_id: operation.id, // NOTE: pass md5 hash to the server // query: operation.text, // this is now obsolete because text is null variables, }), }).then(response => { return response.json(); }); } ``` ## Executing Persisted Queries on the Server Your server should then look up the query referenced by `doc_id` when responding to this request. To execute client requests that send persisted queries instead of query text, your server will need to be able to lookup the query text corresponding to each ID. Typically this will involve saving the output of the `queryMap.json` JSON file to a database or some other storage mechanism, and retrieving the corresponding text for the ID specified by a client. Additionally, your implementation of `relayLocalPersisting.js` could directly save queries to the database or other storage. For universal applications where the client and server code are in one project, this is not an issue since you can place the query map file in a common location accessible to both the client and the server. ### Compile time push For applications where the client and server projects are separate, one option is to have an additional npm run script to push the query map at compile time to a location accessible by your server: ```javascript "scripts": { "push-queries": "node ./pushQueries.js", "persist-server": "node ./relayLocalPersisting.js", "relay": "relay-compiler && npm run push-queries" } ``` Some possibilities of what you can do in `./pushQueries.js`: - `git push` to your server repo. - Save the query maps to a database. ### Run time push A second more complex option is to push your query maps to the server at runtime, without the server knowing the query IDs at the start. The client optimistically sends a query ID to the server, which does not have the query map. The server then in turn requests for the full query text from the client so it can cache the query map for subsequent requests. This is a more complex approach requiring the client and server to interact to exchange the query maps. ### Simple server example Once your server has access to the query map, you can perform the mapping. The solution varies depending on the server and database technologies you use, so we'll just cover the most common and basic example here. If you use `express-graphql` and have access to the query map file, you can import it directly and perform the matching using the `persistedQueries` middleware from [express-graphql-persisted-queries](https://github.com/kyarik/express-graphql-persisted-queries). ```javascript import express from 'express'; import {graphqlHTTP} from 'express-graphql'; import {persistedQueries} from 'express-graphql-persisted-queries'; import queryMap from './path/to/queryMap.json'; const app = express(); app.use( '/graphql', persistedQueries({ queryMap, queryIdKey: 'doc_id', }), graphqlHTTP({schema}), ); ``` ## Using `persistConfig` and `--watch` It is possible to continuously generate the query map files by using the `persistConfig` and `--watch` options simultaneously. This only makes sense for universal applications i.e. if your client and server code are in a single project and you run them both together on localhost during development. Furthermore, in order for the server to pick up changes to the `queryMap.json`, you'll need to have server side hot-reloading set up. The details on how to set this up are out of the scope of this document.