Merge pull request #145 from KTH/feat/add-redis-dependency

Feat/add redis dependency

Author: nsandstrom

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes for major version updates will be documented here.
 
+## 4.3.0
+
+### Changed
+
+Will fail and exit on statup if an unsupported "redis" instance is passed.
+
 ## 4.0.0
 
 Name change kth-node-api-call -> @kth/api-call

README.md

@@ -42,7 +42,7 @@ const apiKey = {
 const options = {
   timeout: 5000, // milliseconds, retry interval if getting API-paths fails
   log: myLogger, // your logger instance
-  redis: myRedis, // your redis instance
+  redis: myRedis, // optional kth-node-redis instance
   cache: cacheConfig, // your api cache options
   checkAPIs: true,
 }

basic.js

@@ -136,28 +136,14 @@ function _wrapCallback(api, options, method, callback) {
       const redisData = { ...result, body }
       const value = JSON.stringify(redisData)
 
-      let redisMaybeFnc = api._redis.client
-      if (typeof api._redis.client === 'function') {
-        const { clientName, clientOptions } = api._redis
-        if (clientName == null && clientOptions == null) {
-          redisMaybeFnc = api._redis.client()
-        } else {
-          redisMaybeFnc = api._redis.client(clientName || 'default', clientOptions || null)
-        }
-      }
+      const redisClient = api._redis.client
 
-      Promise.resolve(redisMaybeFnc)
-        .then(client => {
-          client.set(key, value, err => {
-            if (err) callback(err)
-          })
-          client.expire(key, api._redis.expire || 300, err => {
-            if (err) callback(err)
-          })
-        })
-        .catch(err => {
-          callback(err)
-        })
+      redisClient.set(key, value, err => {
+        if (err) callback(err)
+      })
+      redisClient.expire(key, api._redis.expire || 300, err => {
+        if (err) callback(err)
+      })
     }
 
     callback(error, result, body)

basic.test.js

@@ -32,14 +32,12 @@ const opts = {
   log: mockLogger,
   redis: {
     prefix: 'mocktest',
-    client() {
-      return Promise.resolve({
-        set: redisSet,
-        get: redisGet,
-        expire: (key, limit, callback) => {
-          callback(undefined, 'OK')
-        },
-      })
+    client: {
+      set: redisSet,
+      get: redisGet,
+      expire: (key, limit, callback) => {
+        callback(undefined, 'OK')
+      },
     },
     expire: undefined,
   },

connections.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const { createRedisWrapper } = require('./redisWrapper')
+
 const urlJoin = require('url-join')
 const BasicAPI = require('./basic')
 
@@ -146,7 +148,7 @@ function getRedisClient(apiName, opts) {
     try {
       if (cache[apiName]) {
         const cacheConfig = getRedisConfig(apiName, cache)
-        resolve(() => redis(apiName, cacheConfig.redis))
+        resolve(createRedisWrapper(apiName, redis, cacheConfig.redis))
       }
     } catch (err) {
       opts.log.error('Error creating Redis client', err)
@@ -171,6 +173,10 @@ function configureApiCache(connectedApi, opts) {
       })
       .catch(err => {
         opts.log.error('Unable to create redisClient', { error: err })
+        if (err.message.includes('unsupported Redis version')) {
+          opts.log.error(err)
+          process.exit(1)
+        }
         connectedApi.client._hasRedis = false // eslint-disable-line no-param-reassign
       })
     opts.log.debug(`API configured to use redis cache: ${apiName}`)

connections.test.js

@@ -1,5 +1,8 @@
 /* eslint-disable no-console */
-const redisClient = require('redis-mock').createClient()
+
+jest.mock('./redisWrapper')
+
+const redisClient = {}
 
 const { IS_ACCESSIBLE } = require('./test-utils')
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@kth/api-call",
-  "version": "4.2.1",
+  "version": "4.3.0-1",
   "description": "Node.js module to make JSON calls against APIs.",
   "main": "index.js",
   "repository": {
@@ -45,8 +45,7 @@
     "jest": "^29.7.0",
     "jest-extended": "^6.0.0",
     "prettier": "^3.6.2",
-    "pretty-quick": "^4.2.2",
-    "redis-mock": "^0.56.3"
+    "pretty-quick": "^4.2.2"
   },
   "// (prettier)": "configuration version 2020-06-15 - might also reside in .prettierrc.json",
   "prettier": {

package.json

@@ -0,0 +1,30 @@
+const createRedisWrapper = async (apiName, redisDependency, config) => {
+  const client = await redisDependency(apiName, config)
+
+  if (isKthRedis3(redisDependency, client)) {
+    return createKthRedis3Wrapper(client)
+  }
+  throw new Error('@kth/api-call was configured with an unsupported Redis version. Only kth-node-redis@3 must be used.')
+}
+
+const isKthRedis3 = (redisDependency, client) =>
+  typeof redisDependency.getClient === 'function' &&
+  typeof client.set === 'function' &&
+  typeof client.setAsync === 'function'
+
+const createKthRedis3Wrapper = client => ({
+  detectedVersion: 'kth-node-redis@3',
+  set: async (key, value, callback) => {
+    return client.set(key, value, callback)
+  },
+  get: async (key, callback) => {
+    return client.get(key, callback)
+  },
+  expire: async (key, ttl, callback) => {
+    return client.expire(key, ttl, callback)
+  },
+})
+
+module.exports = {
+  createRedisWrapper,
+}

redisWrapper.js

@@ -0,0 +1,33 @@
+const { createRedisWrapper } = require('./redisWrapper')
+
+describe('createRedisWrapper', () => {
+  test('Works fine for the supported version', async () => {
+    const validRedisDependency = () => ({
+      set: jest.fn(),
+      setAsync: jest.fn(),
+    })
+    validRedisDependency.getClient = jest.fn()
+
+    await expect(createRedisWrapper('apiName', validRedisDependency, {})).toResolve()
+  })
+  test('throws error for library that dont have an exported "getClient" function', async () => {
+    const invalidRedisDependency = () => ({
+      set: jest.fn(),
+      setAsync: jest.fn(),
+    })
+
+    await expect(createRedisWrapper('apiName', invalidRedisDependency, {})).rejects.toThrow(
+      '@kth/api-call was configured with an unsupported Redis version'
+    )
+  })
+  test('throws error for library that dont generate a "setAsync" function', async () => {
+    const invalidRedisDependency = () => ({
+      set: jest.fn(),
+    })
+    invalidRedisDependency.getClient = jest.fn()
+
+    await expect(createRedisWrapper('apiName', invalidRedisDependency, {})).rejects.toThrow(
+      '@kth/api-call was configured with an unsupported Redis version'
+    )
+  })
+})