@webex/http-core 3.0.0-beta.3 → 3.0.0-beta.300

package/dist/request/utils.js

@@ -0,0 +1,91 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.intercept = intercept;
+exports.prepareFetchOptions = prepareFetchOptions;
+var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/asyncToGenerator"));
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
+var _deleteProperty = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/delete-property"));
+var _events = require("events");
+/* eslint-disable import/prefer-default-export */
+
+/**
+ * @param {Object} options
+ * @param {Array<Object>} interceptors
+ * @param {string} key
+ * @param {Object | undefined} res
+ * @private
+ * @returns {Promise}
+ */
+function intercept(options, interceptors, key) {
+  var res = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : undefined;
+  var successKey = "on".concat(key);
+  var errorKey = "on".concat(key, "Error");
+  return interceptors.reduce(function (promise, interceptor) {
+    return promise.then(function (result) {
+      interceptor.logOptions(options);
+      if (interceptor[successKey]) {
+        return interceptor[successKey](options, result);
+      }
+      return _promise.default.resolve(result);
+    }, function (reason) {
+      interceptor.logOptions(options);
+      if (interceptor[errorKey]) {
+        return interceptor[errorKey](options, reason);
+      }
+      return _promise.default.reject(reason);
+    });
+  }, _promise.default.resolve(res));
+}
+
+/**
+ * Prepare options for a fetch.
+ * @param {object} options
+ * @returns {Promise}
+ */
+function prepareFetchOptions(_x) {
+  return _prepareFetchOptions.apply(this, arguments);
+}
+function _prepareFetchOptions() {
+  _prepareFetchOptions = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(options) {
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          if (options.url) {
+            options.uri = options.url;
+            options.url = null;
+          }
+          options.headers = options.headers || {};
+          if (options.json) {
+            // don't override existing accept header declared by user
+            options.headers.accept = options.headers.accept || options.headers.Accept || 'application/json';
+
+            // don't override existing content-type header declared by user
+            if (options.method !== 'GET' && options.method !== 'HEAD') {
+              options.headers['content-type'] = options.headers['content-type'] || options.headers['Content-Type'] || 'application/json';
+              options.body = (0, _stringify.default)(options.json === true ? options.body : options.json);
+            }
+          } else if (options.json !== undefined) {
+            (0, _deleteProperty.default)(options, 'json');
+          }
+          options.download = new _events.EventEmitter();
+          options.upload = new _events.EventEmitter();
+          options.keepalive = true;
+          return _context.abrupt("return", intercept(options, options.interceptors, 'Request').then(function () {
+            return options;
+          }));
+        case 7:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return _prepareFetchOptions.apply(this, arguments);
+}
+//# sourceMappingURL=utils.js.map

package/dist/request/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["intercept","options","interceptors","key","res","undefined","successKey","errorKey","reduce","promise","interceptor","then","result","logOptions","resolve","reason","reject","prepareFetchOptions","url","uri","headers","json","accept","Accept","method","body","download","EventEmitter","upload","keepalive"],"sources":["utils.ts"],"sourcesContent":["/* eslint-disable import/prefer-default-export */\nimport {EventEmitter} from 'events';\nimport Interceptor from '../lib/interceptor';\n\n/**\n * @param {Object} options\n * @param {Array<Object>} interceptors\n * @param {string} key\n * @param {Object | undefined} res\n * @private\n * @returns {Promise}\n */\nexport function intercept(\n  options: object,\n  interceptors: Array<Interceptor>,\n  key: string,\n  res: object = undefined\n): Promise<any> {\n  const successKey = `on${key}`;\n  const errorKey = `on${key}Error`;\n\n  return interceptors.reduce(\n    (promise, interceptor) =>\n      promise.then(\n        (result) => {\n          interceptor.logOptions(options);\n          if (interceptor[successKey]) {\n            return interceptor[successKey](options, result);\n          }\n\n          return Promise.resolve(result);\n        },\n        (reason) => {\n          interceptor.logOptions(options);\n          if (interceptor[errorKey]) {\n            return interceptor[errorKey](options, reason);\n          }\n\n          return Promise.reject(reason);\n        }\n      ),\n    Promise.resolve(res)\n  );\n}\n\n/**\n * Prepare options for a fetch.\n * @param {object} options\n * @returns {Promise}\n */\nexport async function prepareFetchOptions(options: any): Promise<any> {\n  if (options.url) {\n    options.uri = options.url;\n    options.url = null;\n  }\n\n  options.headers = options.headers || {};\n\n  if (options.json) {\n    // don't override existing accept header declared by user\n    options.headers.accept = options.headers.accept || options.headers.Accept || 'application/json';\n\n    // don't override existing content-type header declared by user\n    if (options.method !== 'GET' && options.method !== 'HEAD') {\n      options.headers['content-type'] =\n        options.headers['content-type'] || options.headers['Content-Type'] || 'application/json';\n      options.body = JSON.stringify(options.json === true ? options.body : options.json);\n    }\n  } else if (options.json !== undefined) {\n    Reflect.deleteProperty(options, 'json');\n  }\n\n  options.download = new EventEmitter();\n  options.upload = new EventEmitter();\n  options.keepalive = true;\n\n  return intercept(options, options.interceptors, 'Request').then(() => options);\n}\n"],"mappings":";;;;;;;;;;;;;;AACA;AADA;;AAIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,SAAS,CACvBC,OAAe,EACfC,YAAgC,EAChCC,GAAW,EAEG;EAAA,IADdC,GAAW,uEAAGC,SAAS;EAEvB,IAAMC,UAAU,eAAQH,GAAG,CAAE;EAC7B,IAAMI,QAAQ,eAAQJ,GAAG,UAAO;EAEhC,OAAOD,YAAY,CAACM,MAAM,CACxB,UAACC,OAAO,EAAEC,WAAW;IAAA,OACnBD,OAAO,CAACE,IAAI,CACV,UAACC,MAAM,EAAK;MACVF,WAAW,CAACG,UAAU,CAACZ,OAAO,CAAC;MAC/B,IAAIS,WAAW,CAACJ,UAAU,CAAC,EAAE;QAC3B,OAAOI,WAAW,CAACJ,UAAU,CAAC,CAACL,OAAO,EAAEW,MAAM,CAAC;MACjD;MAEA,OAAO,iBAAQE,OAAO,CAACF,MAAM,CAAC;IAChC,CAAC,EACD,UAACG,MAAM,EAAK;MACVL,WAAW,CAACG,UAAU,CAACZ,OAAO,CAAC;MAC/B,IAAIS,WAAW,CAACH,QAAQ,CAAC,EAAE;QACzB,OAAOG,WAAW,CAACH,QAAQ,CAAC,CAACN,OAAO,EAAEc,MAAM,CAAC;MAC/C;MAEA,OAAO,iBAAQC,MAAM,CAACD,MAAM,CAAC;IAC/B,CAAC,CACF;EAAA,GACH,iBAAQD,OAAO,CAACV,GAAG,CAAC,CACrB;AACH;;AAEA;AACA;AACA;AACA;AACA;AAJA,SAKsBa,mBAAmB;EAAA;AAAA;AAAA;EAAA,+FAAlC,iBAAmChB,OAAY;IAAA;MAAA;QAAA;UACpD,IAAIA,OAAO,CAACiB,GAAG,EAAE;YACfjB,OAAO,CAACkB,GAAG,GAAGlB,OAAO,CAACiB,GAAG;YACzBjB,OAAO,CAACiB,GAAG,GAAG,IAAI;UACpB;UAEAjB,OAAO,CAACmB,OAAO,GAAGnB,OAAO,CAACmB,OAAO,IAAI,CAAC,CAAC;UAEvC,IAAInB,OAAO,CAACoB,IAAI,EAAE;YAChB;YACApB,OAAO,CAACmB,OAAO,CAACE,MAAM,GAAGrB,OAAO,CAACmB,OAAO,CAACE,MAAM,IAAIrB,OAAO,CAACmB,OAAO,CAACG,MAAM,IAAI,kBAAkB;;YAE/F;YACA,IAAItB,OAAO,CAACuB,MAAM,KAAK,KAAK,IAAIvB,OAAO,CAACuB,MAAM,KAAK,MAAM,EAAE;cACzDvB,OAAO,CAACmB,OAAO,CAAC,cAAc,CAAC,GAC7BnB,OAAO,CAACmB,OAAO,CAAC,cAAc,CAAC,IAAInB,OAAO,CAACmB,OAAO,CAAC,cAAc,CAAC,IAAI,kBAAkB;cAC1FnB,OAAO,CAACwB,IAAI,GAAG,wBAAexB,OAAO,CAACoB,IAAI,KAAK,IAAI,GAAGpB,OAAO,CAACwB,IAAI,GAAGxB,OAAO,CAACoB,IAAI,CAAC;YACpF;UACF,CAAC,MAAM,IAAIpB,OAAO,CAACoB,IAAI,KAAKhB,SAAS,EAAE;YACrC,6BAAuBJ,OAAO,EAAE,MAAM,CAAC;UACzC;UAEAA,OAAO,CAACyB,QAAQ,GAAG,IAAIC,oBAAY,EAAE;UACrC1B,OAAO,CAAC2B,MAAM,GAAG,IAAID,oBAAY,EAAE;UACnC1B,OAAO,CAAC4B,SAAS,GAAG,IAAI;UAAC,iCAElB7B,SAAS,CAACC,OAAO,EAAEA,OAAO,CAACC,YAAY,EAAE,SAAS,CAAC,CAACS,IAAI,CAAC;YAAA,OAAMV,OAAO;UAAA,EAAC;QAAA;QAAA;UAAA;MAAA;IAAA;EAAA,CAC/E;EAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/http-core",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.300",
   "description": "Core HTTP library for the Cisco Webex",
   "license": "MIT",
   "main": "dist/index.js",
@@ -24,18 +24,18 @@
     ]
   },
   "devDependencies": {
-    "@webex/test-helper-chai": "3.0.0-beta.3",
-    "@webex/test-helper-file": "3.0.0-beta.3",
-    "@webex/test-helper-make-local-url": "3.0.0-beta.3",
-    "@webex/test-helper-mocha": "3.0.0-beta.3",
+    "@webex/test-helper-chai": "3.0.0-beta.300",
+    "@webex/test-helper-file": "3.0.0-beta.300",
+    "@webex/test-helper-make-local-url": "3.0.0-beta.300",
+    "@webex/test-helper-mocha": "3.0.0-beta.300",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.3",
-    "@webex/http-core": "3.0.0-beta.3",
-    "@webex/internal-plugin-device": "3.0.0-beta.3",
-    "@webex/test-helper-test-users": "3.0.0-beta.3",
-    "@webex/webex-core": "3.0.0-beta.3",
+    "@webex/common": "3.0.0-beta.300",
+    "@webex/http-core": "3.0.0-beta.300",
+    "@webex/internal-plugin-device": "3.0.0-beta.300",
+    "@webex/test-helper-test-users": "3.0.0-beta.300",
+    "@webex/webex-core": "3.0.0-beta.300",
     "file-type": "^16.0.1",
     "global": "^4.4.0",
     "is-function": "^1.0.1",

package/src/http-error-subtypes.js

@@ -182,6 +182,6 @@ export default function makeSubTypes(Base) {
       statusCode = parseInt(statusCode, 10);
 
       return Base[statusCode] || Base;
-    }
+    },
   });
 }

package/src/http-error.js

@@ -23,14 +23,7 @@ export default class HttpError extends Exception {
    *
    * @type {Array}
    */
-  static errorKeys = [
-    'error',
-    'errorString',
-    'response',
-    'errorResponse',
-    'message',
-    'msg'
-  ];
+  static errorKeys = ['error', 'errorString', 'response', 'errorResponse', 'message', 'msg'];
 
   /**
    * Default error string if no error can be extracted from the http response
@@ -55,8 +48,7 @@ export default class HttpError extends Exception {
         try {
           body = JSON.parse(body);
           message = this.parseObject(body);
-        }
-        catch (err) {
+        } catch (err) {
           message = body;
         }
         break;
@@ -73,52 +65,52 @@ export default class HttpError extends Exception {
     Object.defineProperties(this, {
       body: {
         enumerable: false,
-        value: body
+        value: body,
       },
       httpVersion: {
         enumerable: false,
-        value: res.httpVersion
+        value: res.httpVersion,
       },
       headers: {
         enumerable: false,
-        value: res.headers || {}
+        value: res.headers || {},
       },
       rawHeaders: {
         enumerable: false,
-        value: res.rawHeaders || []
+        value: res.rawHeaders || [],
       },
       trailers: {
         enumerable: false,
-        value: res.trailers || {}
+        value: res.trailers || {},
       },
       rawTrailers: {
         enumerable: false,
-        value: res.rawTrailers || []
+        value: res.rawTrailers || [],
       },
       method: {
         enumerable: false,
-        value: res.method
+        value: res.method,
       },
       url: {
         enumerable: false,
-        value: res.url
+        value: res.url,
       },
       statusCode: {
         enumerable: false,
-        value: res.statusCode
+        value: res.statusCode,
       },
       statusMessage: {
         enumerable: false,
-        value: res.statusMessage
+        value: res.statusMessage,
       },
       socket: {
         enumerable: false,
-        value: res.socket
+        value: res.socket,
       },
       _res: {
         enumerable: false,
-        value: res
-      }
+        value: res,
+      },
     });
 
     return message;

package/src/index.js

@@ -6,6 +6,7 @@ import {assign, curry, defaults as lodashDefaults, isString} from 'lodash';
 
 import HttpStatusInterceptor from './interceptors/http-status';
 import _request from './request';
+import {prepareFetchOptions as _prepareFetchOptions} from './request/utils';
 
 // Curry protorequest so we generate a function with default options built in.
 const protorequest = curry(function protorequest(defaultOptions, options) {
@@ -20,17 +21,12 @@ const protorequest = curry(function protorequest(defaultOptions, options) {
   }
 
   // Hide useless elements from logs
-  [
-    'download',
-    'interceptors',
-    'logger',
-    'upload'
-  ].forEach((prop) => {
+  ['download', 'interceptors', 'logger', 'upload'].forEach((prop) => {
     let descriptor = Reflect.getOwnPropertyDescriptor(options, prop);
 
     descriptor = assign({}, descriptor, {
       enumerable: false,
-      writable: true
+      writable: true,
     });
     Reflect.defineProperty(options, prop, descriptor);
   });
@@ -46,12 +42,66 @@ const protorequest = curry(function protorequest(defaultOptions, options) {
   return _request(options);
 });
 
+export const protoprepareFetchOptions = curry(function protoprepareFetchOptions(
+  defaultOptions,
+  options
+) {
+  // Hide useless elements from logs
+  ['download', 'interceptors', 'logger', 'upload'].forEach((prop) => {
+    let descriptor = Reflect.getOwnPropertyDescriptor(options, prop);
+
+    descriptor = assign({}, descriptor, {
+      enumerable: false,
+      writable: true,
+    });
+    Reflect.defineProperty(options, prop, descriptor);
+  });
+
+  lodashDefaults(options, defaultOptions);
+
+  options.logger = options.logger || this.logger || console;
+
+  return _prepareFetchOptions(options);
+});
+
+/**
+ * Sets the $timings value(s) before the request/fetch.
+ * This function is only useful if you are about to send a request
+ * using prepared fetch options; normally it is done in webex.request();
+ *
+ * @param {any} options
+ * @returns {any} the updated options object
+ */
+const setRequestTimings = (options) => {
+  const now = new Date().getTime();
+  options.$timings = options.$timings || {};
+  options.$timings.requestStart = now;
+  options.$timings.networkStart = now;
+
+  return options;
+};
+
+/**
+ * Submits a metric from pre-built request options via the fetch API. Updates
+ * the "$timings" values to Date.now() since the existing times were set when
+ * the options were built (not submitted).
+ *
+ * @param {any} options - the pre-built request options for submitting a metric
+ * @returns {Promise} promise that resolves to a response object
+ */
+export const setTimingsAndFetch = (options) => {
+  const opts = setRequestTimings(options);
+
+  // call the fetch API
+  return fetch(opts.uri, opts);
+};
+
 const defaultOptions = {
   json: true,
   interceptors: [
     // Reminder: this is supposed to be an instantiated interceptor.
-    HttpStatusInterceptor.create()
-  ]
+    HttpStatusInterceptor.create(),
+  ],
 };
 
 export const defaults = protorequest;

package/src/interceptors/http-status.js

@@ -18,12 +18,12 @@ export default class HttpStatusInterceptor extends Interceptor {
    */
   constructor(webex, options) {
     super(webex);
-    const ErrorConstructor = options && (options.error || options.ErrorConstructor) || HttpError;
+    const ErrorConstructor = (options && (options.error || options.ErrorConstructor)) || HttpError;
 
     Object.defineProperties(this, {
       ErrorConstructor: {
-        value: ErrorConstructor
-      }
+        value: ErrorConstructor,
+      },
     });
   }
 
@@ -46,9 +46,11 @@ export default class HttpStatusInterceptor extends Interceptor {
         return Promise.resolve(response);
       }
       // to handle locus redirects
-      if (response.statusCode === 404 &&
+      if (
+        response.statusCode === 404 &&
         response.body &&
-        response.body.errorCode === LOCUS_REDIRECT_ERROR) {
+        response.body.errorCode === LOCUS_REDIRECT_ERROR
+      ) {
         return Promise.resolve(response);
       }
     }

package/src/lib/detect.js

@@ -10,7 +10,6 @@ import {fromBuffer} from 'file-type';
  * @returns {Promise<string>}
  */
 export default async function detect(buffer) {
-  /* global Blob */
   if (
     !(buffer instanceof Blob) &&
     !(buffer instanceof ArrayBuffer) &&

package/src/lib/interceptor.js

@@ -20,7 +20,7 @@ export default class Interceptor {
 
         Reflect.defineProperty(this, key, {
           enumerable: true,
-          value
+          value,
         });
       });
     }
@@ -43,9 +43,7 @@ export default class Interceptor {
     // prepend a header for the interceptor
     logger.info('/***** Interceptor ****************************************************\\');
 
-    logger.info(
-      `${this.constructor.name} - ${JSON.stringify(options, null, 2)}`
-    );
+    logger.info(`${this.constructor.name} - ${JSON.stringify(options, null, 2)}`);
   }
 
   /**