Merge pull request #267 from josmo/debug-jwks-logger-to-require

Idiomatic use of debug lib

Author: adamjmcgrath

src/JwksClient.js

@@ -1,4 +1,4 @@
-const debug = require('debug');
+const logger = require('debug')('jwks');
 const { retrieveSigningKeys } = require('./utils') ;
 const { request, cacheSigningKey, rateLimitSigningKey, getKeysInterceptor, callbackSupport } = require('./wrappers');
 const JwksError = require('./errors/JwksError');
@@ -12,7 +12,6 @@ class JwksClient {
       timeout: 30000,
       ...options
     };
-    this.logger = debug('jwks');
 
     // Initialize wrappers.
     if (this.options.getKeysInterceptor) {
@@ -30,7 +29,7 @@ class JwksClient {
   }
 
   async getKeys() {
-    this.logger(`Fetching keys from '${this.options.jwksUri}'`);
+    logger(`Fetching keys from '${this.options.jwksUri}'`);
 
     try {
       const res = await request({
@@ -41,11 +40,11 @@ class JwksClient {
         fetcher: this.options.fetcher
       });
 
-      this.logger('Keys:', res.keys);  
+      logger('Keys:', res.keys);
       return res.keys;
     } catch (err) {
       const { errorMsg } = err;
-      this.logger('Failure:', errorMsg || err);
+      logger('Failure:', errorMsg || err);
       throw (errorMsg ? new JwksError(errorMsg) : err);
     }
   }
@@ -63,25 +62,25 @@ class JwksClient {
       throw new JwksError('The JWKS endpoint did not contain any signing keys');
     }
 
-    this.logger('Signing Keys:', signingKeys);
+    logger('Signing Keys:', signingKeys);
     return signingKeys;
   }
 
   async getSigningKey (kid) {
-    this.logger(`Fetching signing key for '${kid}'`);
+    logger(`Fetching signing key for '${kid}'`);
     const keys = await this.getSigningKeys();
 
     const kidDefined = kid !== undefined && kid !== null;
     if (!kidDefined && keys.length > 1) {
-      this.logger('No KID specified and JWKS endpoint returned more than 1 key');
+      logger('No KID specified and JWKS endpoint returned more than 1 key');
       throw new SigningKeyNotFoundError('No KID specified and JWKS endpoint returned more than 1 key');
     }
 
     const key = keys.find(k => !kidDefined || k.kid === kid);
     if (key) {
       return key;
     } else {
-      this.logger(`Unable to find a signing key that matches '${kid}'`);
+      logger(`Unable to find a signing key that matches '${kid}'`);
       throw new SigningKeyNotFoundError(`Unable to find a signing key that matches '${kid}'`);
     }
   }

src/wrappers/cache.js

@@ -1,8 +1,7 @@
-const debug = require('debug');
+const logger = require('debug')('jwks');
 const memoizer = require('lru-memoizer');
 
 function cacheWrapper(client, { cacheMaxEntries = 5, cacheMaxAge = 600000 }) {
-  const logger = debug('jwks');
   logger(`Configured caching of signing keys. Max: ${cacheMaxEntries} / Age: ${cacheMaxAge}`);
   return memoizer.sync({
     hash: (kid) => kid,

src/wrappers/rateLimit.js

@@ -1,10 +1,9 @@
-const debug = require('debug');
+const logger = require('debug')('jwks');
 const { RateLimiter } = require('limiter');
 
 const JwksRateLimitError = require('../errors/JwksRateLimitError');
 
 function rateLimtWrapper(client, { jwksRequestsPerMinute = 10 }) {
-  const logger = debug('jwks');
   const getSigningKey = client.getSigningKey.bind(client);
 
   const limiter = new RateLimiter(jwksRequestsPerMinute, 'minute', true);