Merge pull request #48 from oat-sa/release-1.1.0

Release 1.1.0
oat-sa · Oct 22, 2019 · bbfab10 · bbfab10
2 parents 7d766aa + 183d767
commit bbfab10
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 9 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@oat-sa/tao-core-sdk",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "displayName": "TAO Core SDK",
   "description": "Core libraries of TAO",
   "homepage": "https://github.com/oat-sa/tao-core-sdk-fe#readme",

diff --git a/src/core/request.js b/src/core/request.js
@@ -87,6 +87,7 @@ const createError = (response, fallbackMessage, httpCode, httpSent) => {
  * @param {Boolean} [options.sequential] - if true, the request must join a queue to be run sequentially
  * @param {Number}  [options.timeout] - timeout in seconds for the AJAX request
  * @param {Object} [options.jwtTokenHandler] - JWT token handler instance
+ * @param {string} [options.logLevel] - Minimum log level for request
  * @returns {Promise} resolves with response, or reject if something went wrong
  */
 export default function request(options) {
@@ -99,6 +100,13 @@ export default function request(options) {
         throw new TypeError('At least give a URL...');
     }
 
+    // Request logger
+    const requestLogger = logger.child({ url: options.url });
+    const { logLevel } = options;
+    if (logLevel) {
+        requestLogger.level(logLevel);
+    }
+
     /**
      * Function wrapper which allows the contents to be run now, or added to a queue
      * @returns {Promise} resolves with response, or rejects if something went wrong
@@ -151,7 +159,7 @@ export default function request(options) {
          */
         const reEnqueueTempToken = () => {
             if (tempToken) {
-                logger.debug('re-enqueueing %s token %s', tokenHeaderName, tempToken);
+                requestLogger.debug('re-enqueueing %s token %s', tokenHeaderName, tempToken);
                 return tokenHandler.setToken(tempToken).then(() => {
                     tempToken = null;
                 });
@@ -167,7 +175,7 @@ export default function request(options) {
         const setTokenFromXhr = xhr => {
             if (_.isFunction(xhr.getResponseHeader)) {
                 const token = xhr.getResponseHeader(tokenHeaderName);
-                logger.debug('received %s header %s', tokenHeaderName, token);
+                requestLogger.debug('received %s header %s', tokenHeaderName, token);
 
                 if (token) {
                     return tokenHandler.setToken(token);
@@ -195,7 +203,7 @@ export default function request(options) {
                     timeout: options.timeout * 1000 || context.timeout * 1000 || 0,
                     beforeSend() {
                         if (!_.isEmpty(customHeaders)) {
-                            logger.debug(
+                            requestLogger.debug(
                                 'sending %s header %s',
                                 tokenHeaderName,
                                 customHeaders && customHeaders[tokenHeaderName]
@@ -245,7 +253,7 @@ export default function request(options) {
                                 );
                             })
                             .catch(error => {
-                                logger.error(error);
+                                requestLogger.error(error);
                                 reject(createError(response, error, xhr.status, xhr.readyState > 0));
                             });
                 };
@@ -319,7 +327,7 @@ export default function request(options) {
                                 );
                             })
                             .catch(error => {
-                                logger.error(error);
+                                requestLogger.error(error);
                                 reject(createError(enhancedResponse, error, xhr.status, xhr.readyState > 0));
                             });
                 };

diff --git a/test/core/request/test.html b/test/core/request/test.html
@@ -7,6 +7,24 @@
         <script type="text/javascript">
             require(['/environment/config.js'], function() {
                 require(['qunitEnv'], function() {
+                    define('core/logger', () => {
+                        const logger = {
+                            child() {
+                                return logger;
+                            },
+                            level(level) {
+                                logger.loggerLevel = level;
+                            },
+                            trace() {},
+                            debug() {},
+                            info() {},
+                            error() {},
+                            fatal() {},
+                            warn() {}
+                        };
+                        return () => logger;
+                    });
+
                     require(['test/core/request/test'], function() {
                         QUnit.start();
                     });

diff --git a/test/core/request/test.js b/test/core/request/test.js
@@ -21,12 +21,13 @@
  *
  * @author Martin Nicholson <[email protected]>
  */
-define(['jquery', 'lodash', 'core/request', 'core/tokenHandler', 'core/jwt/jwtTokenHandler', 'jquery.mockjax'], function(
+define(['jquery', 'lodash', 'core/request', 'core/tokenHandler', 'core/jwt/jwtTokenHandler', 'core/logger', 'jquery.mockjax'], function(
     $,
     _,
     request,
     tokenHandlerFactory,
-    jwtTokenHandlerFactory
+    jwtTokenHandlerFactory,
+    loggerFactory
 ) {
     'use strict';
 
@@ -848,4 +849,28 @@ define(['jquery', 'lodash', 'core/request', 'core/tokenHandler', 'core/jwt/jwtTo
             'request fails if token handler cannot provide access token'
         );
     });
+
+    QUnit.module('request logger', {
+        afterEach: function() {
+            $.mockjax.clear();
+        }
+    });
+
+    QUnit.cases.init(['warn', 'error', 'fatal']).test('request logger min level is set based on config', (logLevel, assert) => {
+        const done = assert.async();
+        assert.expect(1);
+
+        $.mockjax([
+            {
+                url: '//endpoint',
+                status: 200,
+                responseText: JSON.stringify({})
+            }
+        ]);
+
+        request({ url: '//endpoint', noToken: true, logLevel }).then(() => {
+            assert.equal(loggerFactory().loggerLevel, logLevel, `loggel level should be ${logLevel} based on config`);
+            done();
+        });
+    });
 });