refactor: assert issuer properties, state error messages

lib/client.js

@@ -87,7 +87,7 @@ function assignErrSrc(sourceName) {
 }
 
 function authorizationParams(params) {
-  assert.equal(typeof params, 'object', 'you must provide an object');
+  assert(_.isPlainObject(params), 'pass a plain object as the first argument');
 
   const authParams = Object.assign(
     { client_id: this.client_id, scope: 'openid', response_type: 'code' },
@@ -194,6 +194,10 @@ function assertSigningAlgValuesSupport(endpoint, issuer, properties) {
   }
 }
 
+function assertIssuerConfiguration(issuer, endpoint) {
+  assert(issuer[endpoint], `${endpoint} must be configured on the issuer`);
+}
+
 class Client {
   /**
    * @name constructor
@@ -235,7 +239,7 @@ class Client {
    * @api public
    */
   authorizationUrl(params) {
-    assert(this.issuer.authorization_endpoint, 'authorization_endpoint must be configured');
+    assertIssuerConfiguration(this.issuer, 'authorization_endpoint');
     const target = url.parse(this.issuer.authorization_endpoint, true);
     target.search = null;
     Object.assign(target.query, authorizationParams.call(this, params));
@@ -321,11 +325,11 @@ class Client {
     if (this.default_max_age && !checks.max_age) checks.max_age = this.default_max_age;
 
     if (!params.state && checks.state) {
-      return Promise.reject(new Error('state missing from response'));
+      return Promise.reject(new Error('state missing from the response'));
     }
 
     if (params.state && !checks.state) {
-      return Promise.reject(new Error('checks.state missing'));
+      return Promise.reject(new Error('checks.state argument is missing'));
     }
 
     if (checks.state !== params.state) {
@@ -399,11 +403,11 @@ class Client {
     const params = _.pick(parameters, CALLBACK_PROPERTIES);
 
     if (!params.state && checks.state) {
-      return Promise.reject(new Error('state missing from response'));
+      return Promise.reject(new Error('state missing from the response'));
     }
 
     if (params.state && !checks.state) {
-      return Promise.reject(new Error('checks.state missing'));
+      return Promise.reject(new Error('checks.state argument is missing'));
     }
 
     if (checks.state !== params.state) {
@@ -744,7 +748,7 @@ class Client {
    * @api public
    */
   grant(body) {
-    assert(this.issuer.token_endpoint, 'issuer must be configured with token endpoint');
+    assertIssuerConfiguration(this.issuer, 'token_endpoint');
     return this.authenticatedPost('token', { body: _.omitBy(body, _.isUndefined) })
       .then(expectResponseWithBody(200))
       .then(response => new TokenSet(JSON.parse(response.body)));
@@ -755,7 +759,7 @@ class Client {
    * @api public
    */
   revoke(token, hint) {
-    assert(this.issuer.revocation_endpoint, 'issuer must be configured with revocation endpoint');
+    assertIssuerConfiguration(this.issuer, 'revocation_endpoint');
     assert(!hint || typeof hint === 'string', 'hint must be a string');
 
     const body = { token };
@@ -774,7 +778,7 @@ class Client {
    * @api public
    */
   introspect(token, hint) {
-    assert(this.issuer.introspection_endpoint, 'issuer must be configured with introspection endpoint');
+    assertIssuerConfiguration(this.issuer, 'introspection_endpoint');
     assert(!hint || typeof hint === 'string', 'hint must be a string');
 
     const body = { token };
@@ -943,7 +947,7 @@ class Client {
    * @api public
    */
   static register(properties, { initialAccessToken, keystore } = {}) {
-    assert(this.issuer.registration_endpoint, 'issuer does not support dynamic registration');
+    assertIssuerConfiguration(this.issuer, 'registration_endpoint');
 
     if (keystore !== undefined && !(properties.jwks || properties.jwks_uri)) {
       checkStore.call(this, keystore);
@@ -986,7 +990,7 @@ class Client {
    * @api public
    */
   requestObject(request = {}, algorithms = {}) {
-    assert.equal(typeof request, 'object', 'pass an object as the first argument');
+    assert(_.isPlainObject(request), 'pass a plain object as the first argument');
 
     _.defaults(algorithms, {
       sign: this.request_object_signing_alg,

test/client/client_instance.test.js

@@ -268,7 +268,7 @@ const encode = object => base64url.encode(JSON.stringify(object));
             state: 'should be checked for this',
           }).then(fail, (error) => {
             expect(error).to.be.instanceof(Error);
-            expect(error).to.have.property('message', 'checks.state missing');
+            expect(error).to.have.property('message', 'checks.state argument is missing');
           });
         });
 
@@ -278,7 +278,7 @@ const encode = object => base64url.encode(JSON.stringify(object));
           })
             .then(fail, (error) => {
               expect(error).to.be.instanceof(Error);
-              expect(error).to.have.property('message', 'state missing from response');
+              expect(error).to.have.property('message', 'state missing from the response');
             });
         });
 
@@ -479,7 +479,7 @@ const encode = object => base64url.encode(JSON.stringify(object));
             state: 'should be checked for this',
           }).then(fail, (error) => {
             expect(error).to.be.instanceof(Error);
-            expect(error).to.have.property('message', 'checks.state missing');
+            expect(error).to.have.property('message', 'checks.state argument is missing');
           });
         });
 
@@ -489,7 +489,7 @@ const encode = object => base64url.encode(JSON.stringify(object));
           })
             .then(fail, (error) => {
               expect(error).to.be.instanceof(Error);
-              expect(error).to.have.property('message', 'state missing from response');
+              expect(error).to.have.property('message', 'state missing from the response');
             });
         });
 

test/client/register_client.test.js

@@ -21,7 +21,7 @@ const issuer = new Issuer({
       const issuer = new Issuer({}); // eslint-disable-line no-shadow
       expect(function () {
         issuer.Client.register();
-      }).to.throw('issuer does not support dynamic registration');
+      }).to.throw('registration_endpoint must be configured on the issuer');
     });
 
     it('accepts and assigns the discovered metadata', function () {