restructure options

Author: felixheck

src/cache.js

@@ -7,15 +7,15 @@ let instance
  * Initiate a cache singleton
  *
  * @param {Hapi.Server} server The created server instance
- * @param {Object|false} opts The instance its options
+ * @param {Object|boolean} opts The instance its options
  * @returns {Object} The cache instance
  */
 function init (server, opts) {
   if (instance === undefined) {
     if (opts === false) {
       instance = false
     } else {
-      instance = server.cache(opts)
+      instance = server.cache(opts === true ? {} : opts)
     }
   }
 

src/index.js

@@ -8,20 +8,15 @@ const pkg = require('../package.json')
  * @type Object
  * @private
  *
- * Internally used properties
+ * The plugin related options
  */
-const internals = {
-  clientOptions: undefined,
-  userInfoFields: undefined
-}
+let options
 
 function validateOnline (token) {
-  const opts = internals.clientOptions
-
-  return axios.post(`${opts.realmUrl}/protocol/openid-connect/token/introspect`, {
+  return axios.post(`${options.realmUrl}/protocol/openid-connect/token/introspect`, {
     token,
-    client_secret: opts.secret,
-    client_id: opts.clientId
+    client_secret: options.secret,
+    client_id: options.clientId
   }).then(({ data }) => {
     if (!data.active) {
       throw Error(error.msg.invalid)
@@ -42,7 +37,7 @@ function validateOnline (token) {
  */
 function handleKeycloakValidation (tkn, reply) {
   validateOnline(tkn.get()).then((res) => {
-    const { expiresIn, credentials } = tkn.getData(internals.userInfoFields)
+    const { expiresIn, credentials } = tkn.getData(options.userInfo)
     const userData = { credentials }
 
     cache.set(tkn.get(), userData, expiresIn)
@@ -113,11 +108,8 @@ function strategy (server) {
  * @param {Function} next The callback handler
  */
 function plugin (server, opts, next) {
-  opts = verify(opts)
-  cache.init(server, opts.cache)
-
-  internals.clientOptions = opts.client
-  internals.userInfoFields = opts.userInfo
+  options = verify(opts)
+  cache.init(server, options.cache)
 
   server.auth.scheme('keycloak-jwt', strategy)
   server.decorate('server', 'kjwt', { validate })

src/utils.js

@@ -8,16 +8,14 @@ const joi = require('joi')
  * The plugin options scheme
  */
 const scheme = joi.object({
-  client: joi.object({
-    realmUrl: joi.string().uri().required(),
-    clientId: joi.string().min(1).required(),
-    secret: joi.string().min(1).required()
-  }).unknown(true).required(),
+  realmUrl: joi.string().uri().required(),
+  clientId: joi.string().min(1).required(),
+  secret: joi.string().min(1).required(),
   cache: joi.alternatives().try(joi.object({
     segment: joi.string().default('keycloakJwt')
-  }), joi.boolean().invalid(true)).default(false),
+  }), joi.boolean()).default(false),
   userInfo: joi.array().items(joi.string().min(1))
-}).unknown(true).required()
+}).required()
 
 /**
  * @function

test/_helpers.js

@@ -9,10 +9,22 @@ const fixtures = require('./_fixtures')
  *
  * The default plugin configuration
  */
-const defaults = {
-  client: fixtures.clientConfig,
-  cache: false,
+const defaults = Object.assign({
+  cache: undefined,
   userInfo: undefined
+}, fixtures.clientConfig)
+
+/**
+ * @function
+ * @public
+ *
+ * Get overriden valid default options with customs.
+ *
+ * @param {Object} customs The options to be changed
+ * @returns {Object} The customized options
+ */
+function getOptions (customs) {
+  return Object.assign({}, defaults, customs)
 }
 
 /**
@@ -131,6 +143,7 @@ function getServer (options, done) {
 }
 
 module.exports = {
+  getOptions,
   getServer,
   registerPlugin,
   mock

test/index.spec.js

@@ -1,7 +1,7 @@
 const test = require('ava')
 const nock = require('nock')
 const cache = require('../src/cache')
-const { mock, getServer, registerPlugin } = require('./_helpers')
+const helpers = require('./_helpers')
 const fixtures = require('./_fixtures')
 
 test.afterEach('reset instances and prototypes', () => {
@@ -10,16 +10,16 @@ test.afterEach('reset instances and prototypes', () => {
 })
 
 test.cb.serial('throw error if plugin gets registered twice', (t) => {
-  getServer(undefined, (server) => {
-    t.throws(() => registerPlugin(server), Error)
+  helpers.getServer(undefined, (server) => {
+    t.throws(() => helpers.registerPlugin(server), Error)
     t.end()
   })
 })
 
 test.cb.serial('authentication does succeed', (t) => {
-  mock(200, fixtures.content.userData)
+  helpers.mock(200, fixtures.content.userData)
 
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.inject({
       method: 'GET',
       url: '/',
@@ -35,7 +35,7 @@ test.cb.serial('authentication does succeed', (t) => {
 })
 
 test.cb.serial('authentication does succeed – cached', (t) => {
-  mock(200, fixtures.content.userData)
+  helpers.mock(200, fixtures.content.userData)
 
   const mockReq = {
     method: 'GET',
@@ -45,10 +45,9 @@ test.cb.serial('authentication does succeed – cached', (t) => {
     }
   }
 
-  getServer({
-    client: fixtures.clientConfig,
-    cache: {}
-  }, (server) => {
+  helpers.getServer(helpers.getOptions({
+    cache: true
+  }), (server) => {
     server.inject(mockReq, () => {
       server.inject(mockReq, (res) => {
         t.truthy(res)
@@ -60,9 +59,9 @@ test.cb.serial('authentication does succeed – cached', (t) => {
 })
 
 test.cb.serial('authentication does success – valid roles', (t) => {
-  mock(200, fixtures.content.userData)
+  helpers.mock(200, fixtures.content.userData)
 
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.inject({
       method: 'GET',
       url: '/role',
@@ -78,9 +77,9 @@ test.cb.serial('authentication does success – valid roles', (t) => {
 })
 
 test.cb.serial('authentication does fail – invalid roles', (t) => {
-  mock(200, fixtures.content.userData)
+  helpers.mock(200, fixtures.content.userData)
 
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.inject({
       method: 'GET',
       url: '/role/guest',
@@ -96,9 +95,9 @@ test.cb.serial('authentication does fail – invalid roles', (t) => {
 })
 
 test.cb.serial('authentication does fail – invalid token', (t) => {
-  mock(200, { active: false })
+  helpers.mock(200, { active: false })
 
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.inject({
       method: 'GET',
       url: '/',
@@ -115,7 +114,7 @@ test.cb.serial('authentication does fail – invalid token', (t) => {
 })
 
 test.cb.serial('authentication does fail – invalid header', (t) => {
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.inject({
       method: 'GET',
       url: '/',
@@ -132,9 +131,9 @@ test.cb.serial('authentication does fail – invalid header', (t) => {
 })
 
 test.cb.serial('server method validates token', (t) => {
-  mock(200, fixtures.content.userData)
+  helpers.mock(200, fixtures.content.userData)
 
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.kjwt.validate(`bearer ${fixtures.jwt.userData}`, (err, res) => {
       t.falsy(err)
       t.truthy(res)
@@ -145,9 +144,9 @@ test.cb.serial('server method validates token', (t) => {
 })
 
 test.cb.serial('server method invalidates token – validation error', (t) => {
-  mock(400, 'an error', true)
+  helpers.mock(400, 'an error', true)
 
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.kjwt.validate(`bearer ${fixtures.jwt.userData}`, (err, res) => {
       t.falsy(res)
       t.truthy(err)
@@ -160,9 +159,9 @@ test.cb.serial('server method invalidates token – validation error', (t) => {
 })
 
 test.cb.serial('server method invalidates token – invalid', (t) => {
-  mock(200, { active: false })
+  helpers.mock(200, { active: false })
 
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.kjwt.validate(`bearer ${fixtures.jwt.userData}`, (err, res) => {
       t.falsy(res)
       t.truthy(err)
@@ -175,7 +174,7 @@ test.cb.serial('server method invalidates token – invalid', (t) => {
 })
 
 test.cb.serial('server method invalidates token – wrong format', (t) => {
-  getServer(undefined, (server) => {
+  helpers.getServer(undefined, (server) => {
     server.kjwt.validate(fixtures.jwt.userData, (err, res) => {
       t.falsy(res)
       t.truthy(err)