Refactor ClientStore initialization, add comments

Author: dmitrizagidulin

src/client-store.js

@@ -3,13 +3,29 @@ const KVPFileStore = require('kvplus-files')
 const COLLECTION_NAME = 'clients'
 
 module.exports = class OIDCClientStore {
+  /**
+   * @constructor
+   *
+   * @param [options={}] {Object}
+   *
+   * @param [options.collectionName='clients'] {string}
+   *
+   * @param [options.backend] {KVPFileStore} Either pass in a backend store
+   * @param [options.path] {string} Or initialize the store from path.
+   */
   constructor (options = {}) {
-    let backend = options.backend || new KVPFileStore(options)
-    backend.serialize = (client) => { return client.serialize() }
-    backend.deserialize = (data) => { return JSON.parse(data) }
-    this.backend = backend
     this.collectionName = options.collectionName || COLLECTION_NAME
+
+    this.backend = options.backend ||
+      new KVPFileStore({
+        path: options.path,
+        collections: [ this.collectionName ]
+      })
+
+    this.backend.serialize = (client) => { return client.serialize() }
+    this.backend.deserialize = (data) => { return JSON.parse(data) }
   }
+
   del (client) {
     if (!this.backend) {
       return Promise.reject(new Error('Client store not configured'))
@@ -20,6 +36,7 @@ module.exports = class OIDCClientStore {
     let issuer = encodeURIComponent(client.provider.url)
     return this.backend.del(this.collectionName, issuer)
   }
+
   put (client) {
     if (!this.backend) {
       return Promise.reject(new Error('Client store not configured'))
@@ -34,6 +51,7 @@ module.exports = class OIDCClientStore {
         return client
       })
   }
+
   get (issuer) {
     if (!this.backend) {
       return Promise.reject(new Error('Client store not configured'))

src/index.js

@@ -1,6 +1,3 @@
 'use strict'
 
-module.exports = {
-  'ClientStore': require('./store'),
-  'MultiRpClient': require('./multi-rp-client')
-}
+module.exports = require('./multi-rp-client')

src/multi-rp-client.js

@@ -1,18 +1,38 @@
 'use strict'
-const ClientStore = require('./store')
+const ClientStore = require('./client-store')
 const OIDCRelyingParty = require('oidc-rp')
 const DEFAULT_MAX_AGE = 86400
 
 class MultiRpClient {
+  /**
+   * @constructor
+   * @param [options={}] {Object}
+   *
+   * @param [options.localConfig={}] {Object}
+   * @param [options.localConfig.issuer] {string}
+   * @param [options.localConfig.redirect_uri] {string}
+   * @param [options.localConfig.post_logout_redirect_uris] {Array<string>}
+   *
+   * Needed to initialize the ClientStore:
+   *
+   * @param [options.backend] {KVPFileStore} Either pass in a backend store
+   * @param [options.path] {string} Or initialize the store from path.
+   * @param [options.collectionName='clients'] {string}
+   *
+   * @param [options.debug] {Function}
+   */
   constructor (options = {}) {
-    this.store = new ClientStore(options.store)
+    this.store = new ClientStore(options)
+
     this.localConfig = options.localConfig || {}
+
     this.debug = options.debug || console.log.bind(console)
   }
 
   /**
-   * Returns the authorization (signin) URL for a given OIDC client (which
+   * Returns the authorization (login) URL for a given OIDC client (which
    * is tied to / registered with a specific OIDC Provider).
+   *
    * @method authUrl
    * @param client {RelyingParty}
    * @param session {Session} req.session or similar
@@ -47,6 +67,7 @@ class MultiRpClient {
   /**
    * Returns a constructed `/authorization` URL for a given issuer. Used for
    * starting the OIDC workflow.
+   *
    * @param issuer {string} OIDC Provider URL
    * @param workflow {string} OIDC workflow type, one of 'code' or 'implicit'
    * @returns {Promise<string>}
@@ -140,6 +161,8 @@ class MultiRpClient {
     config.redirect_uris = config.redirect_uris || [ redirectUri ]
     config.response_types = config.response_types ||
       ['code', 'id_token token', 'code id_token token']
+    config.post_logout_redirect_uris = config.post_logout_redirect_uris ||
+      this.localConfig.post_logout_redirect_uris || []
     config.scope = config.scope || 'openid profile'
     // client_uri: 'https://github.com/solid/node-solid-server',
     // logo_uri: 'solid logo',

test/unit/client-store-test.js

@@ -3,7 +3,7 @@
 const test = require('tape')
 const KVPFileStore = require('kvplus-files')
 
-const ClientStore = require('../../src/store')
+const ClientStore = require('../../src/client-store')
 const OIDCRelyingParty = require('oidc-rp')
 
 const storeBasePath = './test/store/'

test/unit/multi-rp-client-test.js

@@ -1,10 +1,13 @@
 'use strict'
 
 const test = require('tape')
-const OIDCRelyingParty = require('oidc-rp')
-const { ClientStore, MultiRpClient } = require('../../src/index')
 const sinon = require('sinon')
 
+
+const OIDCRelyingParty = require('oidc-rp')
+const MultiRpClient = require('../../src/index')
+const ClientStore = require('../../src/client-store')
+
 const storeBasePath = './test/store/'
 const storeOptions = { path: storeBasePath }
 
@@ -25,7 +28,10 @@ test('MultiRpClient constructor test', t => {
   let localConfig = {
     issuer: localIssuer
   }
-  let options = { store: storeOptions, localConfig }
+  let options = {
+    path: storeBasePath,
+    localConfig
+  }
   let multiClient = new MultiRpClient(options)
   t.equal(multiClient.store.backend.path, storeBasePath)
   t.equal(multiClient.localConfig, localConfig)