@envelop/response-cache-redis

• Supports redis cache for @envelop/response-cache plugin
• Suitable for serverless deployments where the LRU In-Memory Cache is not possible

Check out the GraphQL Response Cache Guide for more information

Getting Started

1yarn add @envelop/response-cache
2yarn add @envelop/response-cache-redis

Usage Example

In order to use the Redis cache, you need to:

• Create a Redis database
• Collect the connection settings (or its connection string), e.g., host, port, username, password, tls, etc.
• Create and configure a Redis client with your connection settings and any additional options
• Create an instance of the Redis Cache and set to the useResponseCache plugin options

1import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
2import { envelop, useEngine } from '@envelop/core'
3import { useResponseCache } from '@envelop/response-cache'
4import { createRedisCache } from '@envelop/response-cache-redis'
5import Redis from 'ioredis'
6
7/**
8 * For additional Redis options to create the ioredis client
9 * @see: https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new
10 *
11 **/
12const redis = new Redis({
13  host: 'my-redis-db.example.com',
14  port: '30652',
15  password: '1234567890'
16})
17
18// or, you can also specify connection options as a redis:// URL or rediss:// URL when using TLS encryption
19const redis = new Redis('rediss://:1234567890@my-redis-db.example.com:30652')
20
21const cache = createRedisCache({ redis })
22
23const getEnveloped = envelop({
24  plugins: [
25    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
26    // ... other plugins ...
27    useResponseCache({ cache })
28  ]
29})

Invalidate Cache based on custom logic

1import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
2import { envelop, useEngine } from '@envelop/core'
3import { useResponseCache } from '@envelop/response-cache'
4import { createRedisCache } from '@envelop/response-cache-redis'
5import { emitter } from './eventEmitter'
6
7// we create our cache instance, which allows calling all methods on it
8const redis = new Redis('rediss://:1234567890@my-redis-db.example.com:30652')
9
10const cache = createRedisCache({ redis })
11
12const getEnveloped = envelop({
13  plugins: [
14    useEngine({ parse, validate, specifiedRules, execute, subscribe }),
15    // ... other plugins ...
16    useResponseCache({
17      ttl: 2000,
18      // we pass the cache instance to the request.
19      cache
20    })
21  ]
22})
23
24emitter.on('invalidate', resource => {
25  cache.invalidate([
26    {
27      typename: resource.type,
28      id: resource.id
29    }
30  ])
31})