@webex/http-core 3.0.0-beta.196 → 3.0.0-beta.197

package/dist/index.js

@@ -36,7 +36,7 @@ _Object$defineProperty(exports, "detect", {
     return _detect.default;
   }
 });
-exports.request = exports.protoprepareFetchOptions = void 0;
+exports.setTimingsAndFetch = exports.request = exports.protoprepareFetchOptions = void 0;
 var _getOwnPropertyDescriptor = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/get-own-property-descriptor"));
 var _defineProperty = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/define-property"));
 var _deleteProperty = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/delete-property"));
@@ -96,7 +96,37 @@ var protoprepareFetchOptions = (0, _curry2.default)(function protoprepareFetchOp
   options.logger = options.logger || this.logger || console;
   return (0, _utils.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
+ */
 exports.protoprepareFetchOptions = protoprepareFetchOptions;
+var setRequestTimings = function setRequestTimings(options) {
+  var 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
+ */
+var setTimingsAndFetch = function setTimingsAndFetch(options) {
+  // call the fetch API
+  return fetch(setRequestTimings(options));
+};
+exports.setTimingsAndFetch = setTimingsAndFetch;
 var defaultOptions = {
   json: true,
   interceptors: [

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["protorequest","defaultOptions","options","uri","arguments","forEach","prop","descriptor","enumerable","writable","json","logger","console","_request","protoprepareFetchOptions","_prepareFetchOptions","interceptors","HttpStatusInterceptor","create","defaults","request"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {assign, curry, defaults as lodashDefaults, isString} from 'lodash';\n\nimport HttpStatusInterceptor from './interceptors/http-status';\nimport _request from './request';\nimport {prepareFetchOptions as _prepareFetchOptions} from './request/utils';\n\n// Curry protorequest so we generate a function with default options built in.\nconst protorequest = curry(function protorequest(defaultOptions, options) {\n  // allow for options to be a string (and therefore expect options in the third\n  // position) to match request's api.\n  if (isString(options)) {\n    const uri = options;\n\n    /* eslint prefer-rest-params: [0] */\n    options = arguments[2] || {};\n    options.uri = uri;\n  }\n\n  // Hide useless elements from logs\n  ['download', 'interceptors', 'logger', 'upload'].forEach((prop) => {\n    let descriptor = Reflect.getOwnPropertyDescriptor(options, prop);\n\n    descriptor = assign({}, descriptor, {\n      enumerable: false,\n      writable: true,\n    });\n    Reflect.defineProperty(options, prop, descriptor);\n  });\n\n  lodashDefaults(options, defaultOptions);\n\n  if (!options.json && options.json !== false) {\n    Reflect.deleteProperty(options, 'json');\n  }\n\n  options.logger = options.logger || this.logger || console;\n\n  return _request(options);\n});\n\nexport const protoprepareFetchOptions = curry(function protoprepareFetchOptions(\n  defaultOptions,\n  options\n) {\n  // Hide useless elements from logs\n  ['download', 'interceptors', 'logger', 'upload'].forEach((prop) => {\n    let descriptor = Reflect.getOwnPropertyDescriptor(options, prop);\n\n    descriptor = assign({}, descriptor, {\n      enumerable: false,\n      writable: true,\n    });\n    Reflect.defineProperty(options, prop, descriptor);\n  });\n\n  lodashDefaults(options, defaultOptions);\n\n  if (!options.json && options.json !== false) {\n    Reflect.deleteProperty(options, 'json');\n  }\n\n  options.logger = options.logger || this.logger || console;\n\n  return _prepareFetchOptions(options);\n});\n\nconst defaultOptions = {\n  json: true,\n  interceptors: [\n    // Reminder: this is supposed to be an instantiated interceptor.\n    HttpStatusInterceptor.create(),\n  ],\n};\n\nexport const defaults = protorequest;\nexport const request = protorequest(defaultOptions);\nexport {default as ProgressEvent} from './progress-event';\nexport {default as Interceptor} from './lib/interceptor';\nexport {default as HttpError} from './http-error';\nexport {default as HttpStatusInterceptor} from './interceptors/http-status';\nexport {default as detect} from './lib/detect';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA;AACA;AACA;AAwEA;AACA;AACA;AAEA;AA1EA;AACA,IAAMA,YAAY,GAAG,qBAAM,SAASA,YAAY,CAACC,cAAc,EAAEC,OAAO,EAAE;EACxE;EACA;EACA,IAAI,wBAASA,OAAO,CAAC,EAAE;IACrB,IAAMC,GAAG,GAAGD,OAAO;;IAEnB;IACAA,OAAO,GAAGE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5BF,OAAO,CAACC,GAAG,GAAGA,GAAG;EACnB;;EAEA;EACA,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAACE,OAAO,CAAC,UAACC,IAAI,EAAK;IACjE,IAAIC,UAAU,GAAG,uCAAiCL,OAAO,EAAEI,IAAI,CAAC;IAEhEC,UAAU,GAAG,sBAAO,CAAC,CAAC,EAAEA,UAAU,EAAE;MAClCC,UAAU,EAAE,KAAK;MACjBC,QAAQ,EAAE;IACZ,CAAC,CAAC;IACF,6BAAuBP,OAAO,EAAEI,IAAI,EAAEC,UAAU,CAAC;EACnD,CAAC,CAAC;EAEF,wBAAeL,OAAO,EAAED,cAAc,CAAC;EAEvC,IAAI,CAACC,OAAO,CAACQ,IAAI,IAAIR,OAAO,CAACQ,IAAI,KAAK,KAAK,EAAE;IAC3C,6BAAuBR,OAAO,EAAE,MAAM,CAAC;EACzC;EAEAA,OAAO,CAACS,MAAM,GAAGT,OAAO,CAACS,MAAM,IAAI,IAAI,CAACA,MAAM,IAAIC,OAAO;EAEzD,OAAO,IAAAC,iBAAQ,EAACX,OAAO,CAAC;AAC1B,CAAC,CAAC;AAEK,IAAMY,wBAAwB,GAAG,qBAAM,SAASA,wBAAwB,CAC7Eb,cAAc,EACdC,OAAO,EACP;EACA;EACA,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAACG,OAAO,CAAC,UAACC,IAAI,EAAK;IACjE,IAAIC,UAAU,GAAG,uCAAiCL,OAAO,EAAEI,IAAI,CAAC;IAEhEC,UAAU,GAAG,sBAAO,CAAC,CAAC,EAAEA,UAAU,EAAE;MAClCC,UAAU,EAAE,KAAK;MACjBC,QAAQ,EAAE;IACZ,CAAC,CAAC;IACF,6BAAuBP,OAAO,EAAEI,IAAI,EAAEC,UAAU,CAAC;EACnD,CAAC,CAAC;EAEF,wBAAeL,OAAO,EAAED,cAAc,CAAC;EAEvC,IAAI,CAACC,OAAO,CAACQ,IAAI,IAAIR,OAAO,CAACQ,IAAI,KAAK,KAAK,EAAE;IAC3C,6BAAuBR,OAAO,EAAE,MAAM,CAAC;EACzC;EAEAA,OAAO,CAACS,MAAM,GAAGT,OAAO,CAACS,MAAM,IAAI,IAAI,CAACA,MAAM,IAAIC,OAAO;EAEzD,OAAO,IAAAG,0BAAoB,EAACb,OAAO,CAAC;AACtC,CAAC,CAAC;AAAC;AAEH,IAAMD,cAAc,GAAG;EACrBS,IAAI,EAAE,IAAI;EACVM,YAAY,EAAE;EACZ;EACAC,mBAAqB,CAACC,MAAM,EAAE;AAElC,CAAC;AAEM,IAAMC,QAAQ,GAAGnB,YAAY;AAAC;AAC9B,IAAMoB,OAAO,GAAGpB,YAAY,CAACC,cAAc,CAAC;AAAC"}
+{"version":3,"names":["protorequest","defaultOptions","options","uri","arguments","forEach","prop","descriptor","enumerable","writable","json","logger","console","_request","protoprepareFetchOptions","_prepareFetchOptions","setRequestTimings","now","Date","getTime","$timings","requestStart","networkStart","setTimingsAndFetch","fetch","interceptors","HttpStatusInterceptor","create","defaults","request"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {assign, curry, defaults as lodashDefaults, isString} from 'lodash';\n\nimport HttpStatusInterceptor from './interceptors/http-status';\nimport _request from './request';\nimport {prepareFetchOptions as _prepareFetchOptions} from './request/utils';\n\n// Curry protorequest so we generate a function with default options built in.\nconst protorequest = curry(function protorequest(defaultOptions, options) {\n  // allow for options to be a string (and therefore expect options in the third\n  // position) to match request's api.\n  if (isString(options)) {\n    const uri = options;\n\n    /* eslint prefer-rest-params: [0] */\n    options = arguments[2] || {};\n    options.uri = uri;\n  }\n\n  // Hide useless elements from logs\n  ['download', 'interceptors', 'logger', 'upload'].forEach((prop) => {\n    let descriptor = Reflect.getOwnPropertyDescriptor(options, prop);\n\n    descriptor = assign({}, descriptor, {\n      enumerable: false,\n      writable: true,\n    });\n    Reflect.defineProperty(options, prop, descriptor);\n  });\n\n  lodashDefaults(options, defaultOptions);\n\n  if (!options.json && options.json !== false) {\n    Reflect.deleteProperty(options, 'json');\n  }\n\n  options.logger = options.logger || this.logger || console;\n\n  return _request(options);\n});\n\nexport const protoprepareFetchOptions = curry(function protoprepareFetchOptions(\n  defaultOptions,\n  options\n) {\n  // Hide useless elements from logs\n  ['download', 'interceptors', 'logger', 'upload'].forEach((prop) => {\n    let descriptor = Reflect.getOwnPropertyDescriptor(options, prop);\n\n    descriptor = assign({}, descriptor, {\n      enumerable: false,\n      writable: true,\n    });\n    Reflect.defineProperty(options, prop, descriptor);\n  });\n\n  lodashDefaults(options, defaultOptions);\n\n  if (!options.json && options.json !== false) {\n    Reflect.deleteProperty(options, 'json');\n  }\n\n  options.logger = options.logger || this.logger || console;\n\n  return _prepareFetchOptions(options);\n});\n\n/**\n * Sets the $timings value(s) before the request/fetch.\n * This function is only useful if you are about to send a request\n * using prepared fetch options; normally it is done in webex.request();\n *\n * @param {any} options\n * @returns {any} the updated options object\n */\nconst setRequestTimings = (options) => {\n  const now = new Date().getTime();\n  options.$timings = options.$timings || {};\n  options.$timings.requestStart = now;\n  options.$timings.networkStart = now;\n\n  return options;\n};\n\n/**\n * Submits a metric from pre-built request options via the fetch API. Updates\n * the \"$timings\" values to Date.now() since the existing times were set when\n * the options were built (not submitted).\n *\n * @param {any} options - the pre-built request options for submitting a metric\n * @returns {Promise} promise that resolves to a response object\n */\nexport const setTimingsAndFetch = (options) => {\n  // call the fetch API\n  return fetch(setRequestTimings(options));\n};\n\nconst defaultOptions = {\n  json: true,\n  interceptors: [\n    // Reminder: this is supposed to be an instantiated interceptor.\n    HttpStatusInterceptor.create(),\n  ],\n};\n\nexport const defaults = protorequest;\nexport const request = protorequest(defaultOptions);\nexport {default as ProgressEvent} from './progress-event';\nexport {default as Interceptor} from './lib/interceptor';\nexport {default as HttpError} from './http-error';\nexport {default as HttpStatusInterceptor} from './interceptors/http-status';\nexport {default as detect} from './lib/detect';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA;AACA;AACA;AAsGA;AACA;AACA;AAEA;AAxGA;AACA,IAAMA,YAAY,GAAG,qBAAM,SAASA,YAAY,CAACC,cAAc,EAAEC,OAAO,EAAE;EACxE;EACA;EACA,IAAI,wBAASA,OAAO,CAAC,EAAE;IACrB,IAAMC,GAAG,GAAGD,OAAO;;IAEnB;IACAA,OAAO,GAAGE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5BF,OAAO,CAACC,GAAG,GAAGA,GAAG;EACnB;;EAEA;EACA,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAACE,OAAO,CAAC,UAACC,IAAI,EAAK;IACjE,IAAIC,UAAU,GAAG,uCAAiCL,OAAO,EAAEI,IAAI,CAAC;IAEhEC,UAAU,GAAG,sBAAO,CAAC,CAAC,EAAEA,UAAU,EAAE;MAClCC,UAAU,EAAE,KAAK;MACjBC,QAAQ,EAAE;IACZ,CAAC,CAAC;IACF,6BAAuBP,OAAO,EAAEI,IAAI,EAAEC,UAAU,CAAC;EACnD,CAAC,CAAC;EAEF,wBAAeL,OAAO,EAAED,cAAc,CAAC;EAEvC,IAAI,CAACC,OAAO,CAACQ,IAAI,IAAIR,OAAO,CAACQ,IAAI,KAAK,KAAK,EAAE;IAC3C,6BAAuBR,OAAO,EAAE,MAAM,CAAC;EACzC;EAEAA,OAAO,CAACS,MAAM,GAAGT,OAAO,CAACS,MAAM,IAAI,IAAI,CAACA,MAAM,IAAIC,OAAO;EAEzD,OAAO,IAAAC,iBAAQ,EAACX,OAAO,CAAC;AAC1B,CAAC,CAAC;AAEK,IAAMY,wBAAwB,GAAG,qBAAM,SAASA,wBAAwB,CAC7Eb,cAAc,EACdC,OAAO,EACP;EACA;EACA,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAACG,OAAO,CAAC,UAACC,IAAI,EAAK;IACjE,IAAIC,UAAU,GAAG,uCAAiCL,OAAO,EAAEI,IAAI,CAAC;IAEhEC,UAAU,GAAG,sBAAO,CAAC,CAAC,EAAEA,UAAU,EAAE;MAClCC,UAAU,EAAE,KAAK;MACjBC,QAAQ,EAAE;IACZ,CAAC,CAAC;IACF,6BAAuBP,OAAO,EAAEI,IAAI,EAAEC,UAAU,CAAC;EACnD,CAAC,CAAC;EAEF,wBAAeL,OAAO,EAAED,cAAc,CAAC;EAEvC,IAAI,CAACC,OAAO,CAACQ,IAAI,IAAIR,OAAO,CAACQ,IAAI,KAAK,KAAK,EAAE;IAC3C,6BAAuBR,OAAO,EAAE,MAAM,CAAC;EACzC;EAEAA,OAAO,CAACS,MAAM,GAAGT,OAAO,CAACS,MAAM,IAAI,IAAI,CAACA,MAAM,IAAIC,OAAO;EAEzD,OAAO,IAAAG,0BAAoB,EAACb,OAAO,CAAC;AACtC,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAPA;AAQA,IAAMc,iBAAiB,GAAG,SAApBA,iBAAiB,CAAId,OAAO,EAAK;EACrC,IAAMe,GAAG,GAAG,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE;EAChCjB,OAAO,CAACkB,QAAQ,GAAGlB,OAAO,CAACkB,QAAQ,IAAI,CAAC,CAAC;EACzClB,OAAO,CAACkB,QAAQ,CAACC,YAAY,GAAGJ,GAAG;EACnCf,OAAO,CAACkB,QAAQ,CAACE,YAAY,GAAGL,GAAG;EAEnC,OAAOf,OAAO;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,IAAMqB,kBAAkB,GAAG,SAArBA,kBAAkB,CAAIrB,OAAO,EAAK;EAC7C;EACA,OAAOsB,KAAK,CAACR,iBAAiB,CAACd,OAAO,CAAC,CAAC;AAC1C,CAAC;AAAC;AAEF,IAAMD,cAAc,GAAG;EACrBS,IAAI,EAAE,IAAI;EACVe,YAAY,EAAE;EACZ;EACAC,mBAAqB,CAACC,MAAM,EAAE;AAElC,CAAC;AAEM,IAAMC,QAAQ,GAAG5B,YAAY;AAAC;AAC9B,IAAM6B,OAAO,GAAG7B,YAAY,CAACC,cAAc,CAAC;AAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/http-core",
-  "version": "3.0.0-beta.196",
+  "version": "3.0.0-beta.197",
   "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.196",
-    "@webex/test-helper-file": "3.0.0-beta.196",
-    "@webex/test-helper-make-local-url": "3.0.0-beta.196",
-    "@webex/test-helper-mocha": "3.0.0-beta.196",
+    "@webex/test-helper-chai": "3.0.0-beta.197",
+    "@webex/test-helper-file": "3.0.0-beta.197",
+    "@webex/test-helper-make-local-url": "3.0.0-beta.197",
+    "@webex/test-helper-mocha": "3.0.0-beta.197",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.196",
-    "@webex/http-core": "3.0.0-beta.196",
-    "@webex/internal-plugin-device": "3.0.0-beta.196",
-    "@webex/test-helper-test-users": "3.0.0-beta.196",
-    "@webex/webex-core": "3.0.0-beta.196",
+    "@webex/common": "3.0.0-beta.197",
+    "@webex/http-core": "3.0.0-beta.197",
+    "@webex/internal-plugin-device": "3.0.0-beta.197",
+    "@webex/test-helper-test-users": "3.0.0-beta.197",
+    "@webex/webex-core": "3.0.0-beta.197",
     "file-type": "^16.0.1",
     "global": "^4.4.0",
     "is-function": "^1.0.1",

package/src/index.js

@@ -68,6 +68,36 @@ export const protoprepareFetchOptions = curry(function protoprepareFetchOptions(
   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) => {
+  // call the fetch API
+  return fetch(setRequestTimings(options));
+};
+
 const defaultOptions = {
   json: true,
   interceptors: [

package/test/unit/spec/index.js

@@ -4,7 +4,7 @@ import sinon from 'sinon';
 import * as utils from '@webex/http-core/src/request/utils';
 import WebexTrackingIdInterceptor from '@webex/webex-core/src/interceptors/webex-tracking-id';
 import UserAgentInterceptor from '@webex/webex-core/src/interceptors/webex-user-agent';
-import {protoprepareFetchOptions} from '@webex/http-core/src/index';
+import {protoprepareFetchOptions, setTimingsAndFetch} from '@webex/http-core/src/index';
 
 describe('http-core index tests', () => {
   describe('#protoprepareFetchOptions()', () => {
@@ -31,4 +31,26 @@ describe('http-core index tests', () => {
       assert.isArray(options.interceptors);
     });
   });
+
+  describe('#setTimingsAndFetch()', () => {
+    const now = Date.now();
+    let stubbedFetch;
+
+    beforeEach(() => {
+      global.fetch = sinon.stub();
+    });
+
+    it('calls fetch with expected options', async () => {
+      sinon.useFakeTimers(now);
+      const options = {};
+
+      const newOptions = setTimingsAndFetch(options);
+
+      sinon.assert.calledOnce(global.fetch);
+      sinon.assert.calledWith(global.fetch, {
+        $timings: {requestStart: now, networkStart: now},
+      });
+      sinon.restore();
+    });
+  });
 });