84547e54c7
* Use [node-]redis as a direct dependency * Extract Redis client creation to its own module * Attach extensive logging in the Redis client creation module * Allow the rate limiter to pass requests when Redis is disconnected * Update rate-limit-redis * Default error input to empty object for formatRedisError method * Provide a name for the rate limiter's Redis client * Include redis-mock, exclude ioredis/ioredis-mock * Remove unused RedisAccessor#exists method * Switch RedisAccessor to use redis/redis-mock * Provide a name for logging on the Redis page cache * Remove extraneous trailing space from Redis logging prefix Our updated use of console.* will already be adding a space after the prefix * Replace ioredis-mock with redis-mock in tests * Revert removal of ioredis dependency * Bind Redis client to async promisified methods * Extract former RedisAccessor constructor tests to new create-client tests * Update RedisAccessor tests to work with the callback-based redis client * Handle formatting Redis errors (or not) with more resiliency
114 lines
3.1 KiB
JavaScript
114 lines
3.1 KiB
JavaScript
const createRedisClient = require('./redis/create-client')
|
|
const InMemoryRedis = require('redis-mock')
|
|
const { promisify } = require('util')
|
|
|
|
const { CI, NODE_ENV, REDIS_URL } = process.env
|
|
|
|
// Do not use real a Redis client for CI, tests, or if the REDIS_URL is not provided
|
|
const useRealRedis = !CI && NODE_ENV !== 'test' && !!REDIS_URL
|
|
|
|
class RedisAccessor {
|
|
constructor ({ databaseNumber = 0, prefix = null, allowSetFailures = false, name = null } = {}) {
|
|
const redisClient = useRealRedis
|
|
? createRedisClient({
|
|
url: REDIS_URL,
|
|
db: databaseNumber,
|
|
name: name || 'redis-accessor'
|
|
})
|
|
: InMemoryRedis.createClient()
|
|
|
|
this._client = redisClient
|
|
|
|
this._prefix = prefix ? prefix.replace(/:+$/, '') + ':' : ''
|
|
|
|
// Allow for graceful failures if a Redis SET operation fails?
|
|
this._allowSetFailures = allowSetFailures === true
|
|
}
|
|
|
|
/** @private */
|
|
prefix (key) {
|
|
if (typeof key !== 'string' || !key) {
|
|
throw new TypeError(`Key must be a non-empty string but was: ${JSON.stringify(key)}`)
|
|
}
|
|
|
|
return this._prefix + key
|
|
}
|
|
|
|
static translateSetArguments (options = {}) {
|
|
const setArgs = []
|
|
|
|
const defaults = {
|
|
newOnly: false,
|
|
existingOnly: false,
|
|
expireIn: null, // No expiration
|
|
rollingExpiration: true
|
|
}
|
|
const opts = { ...defaults, ...options }
|
|
|
|
if (opts.newOnly === true) {
|
|
if (opts.existingOnly === true) {
|
|
throw new TypeError('Misconfiguration: entry cannot be both new and existing')
|
|
}
|
|
setArgs.push('NX')
|
|
} else if (opts.existingOnly === true) {
|
|
setArgs.push('XX')
|
|
}
|
|
|
|
if (Number.isFinite(opts.expireIn)) {
|
|
const ttl = Math.round(opts.expireIn)
|
|
if (ttl < 1) {
|
|
throw new TypeError('Misconfiguration: cannot set a TTL of less than 1 millisecond')
|
|
}
|
|
setArgs.push('PX')
|
|
setArgs.push(ttl)
|
|
}
|
|
// otherwise there is no expiration
|
|
|
|
if (opts.rollingExpiration === false) {
|
|
if (opts.newOnly === true) {
|
|
throw new TypeError('Misconfiguration: cannot keep an existing TTL on a new entry')
|
|
}
|
|
setArgs.push('KEEPTTL')
|
|
}
|
|
|
|
return setArgs
|
|
}
|
|
|
|
async set (key, value, options = {}) {
|
|
const setAsync = promisify(this._client.set).bind(this._client)
|
|
const fullKey = this.prefix(key)
|
|
|
|
if (typeof value !== 'string' || !value) {
|
|
throw new TypeError(`Value must be a non-empty string but was: ${JSON.stringify(value)}`)
|
|
}
|
|
|
|
// Handle optional arguments
|
|
const setArgs = this.constructor.translateSetArguments(options)
|
|
|
|
try {
|
|
const result = await setAsync(fullKey, value, ...setArgs)
|
|
return result === 'OK'
|
|
} catch (err) {
|
|
const errorText = `Failed to set value in Redis.
|
|
Key: ${fullKey}
|
|
Error: ${err.message}`
|
|
|
|
if (this._allowSetFailures === true) {
|
|
// Allow for graceful failure
|
|
console.error(errorText)
|
|
return false
|
|
}
|
|
|
|
throw new Error(errorText)
|
|
}
|
|
}
|
|
|
|
async get (key) {
|
|
const getAsync = promisify(this._client.get).bind(this._client)
|
|
const value = await getAsync(this.prefix(key))
|
|
return value
|
|
}
|
|
}
|
|
|
|
module.exports = RedisAccessor
|