@xapp/stentor-service 1.40.228 → 1.40.231

package/lib/FetchService.d.ts

@@ -1,9 +1,15 @@
 /*! Copyright (c) 2019, XAPPmedia */
 import "isomorphic-fetch";
+import "abort-controller/polyfill";
 import { AbstractService } from "./Service";
+export declare class TimeoutError extends Error {
+    constructor(message: string);
+}
 /**
  * Abstract service for services that primarily rely on the fetch API.
  *
+ * It includes built-in timeout feature to better keep track of external APIs.
+ *
  * @export
  * @abstract
  * @class FetchService
@@ -13,11 +19,13 @@ export declare abstract class FetchService extends AbstractService {
     /**
      * Wrapper around fetch to add some basic diagnostics
      *
+     * Will throw a TimeoutError if the timeout is reached.
+     *
      * @protected
      * @param {string} url
      * @param {RequestInit} options
      * @returns {Promise<Response>}
      * @memberof AbstractResourceService
      */
-    protected fetch(url: string, options: RequestInit): Promise<Response>;
+    protected fetch(url: string, options?: RequestInit): Promise<Response>;
 }

package/lib/FetchService.js

@@ -1,13 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchService = void 0;
+exports.FetchService = exports.TimeoutError = void 0;
 /*! Copyright (c) 2019, XAPPmedia */
 require("isomorphic-fetch");
+require("abort-controller/polyfill");
 const Service_1 = require("./Service");
 const now = require("performance-now");
+class TimeoutError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "TimeoutError";
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.TimeoutError = TimeoutError;
 /**
  * Abstract service for services that primarily rely on the fetch API.
  *
+ * It includes built-in timeout feature to better keep track of external APIs.
+ *
  * @export
  * @abstract
  * @class FetchService
@@ -17,6 +28,8 @@ class FetchService extends Service_1.AbstractService {
     /**
      * Wrapper around fetch to add some basic diagnostics
      *
+     * Will throw a TimeoutError if the timeout is reached.
+     *
      * @protected
      * @param {string} url
      * @param {RequestInit} options
@@ -25,12 +38,33 @@ class FetchService extends Service_1.AbstractService {
      */
     fetch(url, options) {
         const start = now();
+        const controller = new AbortController();
+        if (options) {
+            if (!options.signal) {
+                options.signal = controller.signal;
+            }
+        }
+        else {
+            options = {
+                signal: controller.signal
+            };
+        }
+        const timeout = setTimeout(() => {
+            controller.abort();
+        }, this.timeout);
         return fetch(url, options).then(response => {
             const end = now();
             if (this.logs) {
-                console.info(`Resource took ${url} ${end - start}ms to receive`);
+                console.info(`Resource took ${url} ${end - start} ms to receive`);
             }
             return response;
+        }).catch((error) => {
+            if (error.name === "AbortError") {
+                throw new TimeoutError(`Timeout of ${this.timeout} ms reached.`);
+            }
+            throw error;
+        }).finally(() => {
+            clearTimeout(timeout);
         });
     }
 }

package/lib/FetchService.js.map

@@ -1 +1 @@
-{"version":3,"file":"FetchService.js","sourceRoot":"","sources":["../src/FetchService.ts"],"names":[],"mappings":";;;AAAA,oCAAoC;AACpC,4BAA0B;AAC1B,uCAA4C;AAE5C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEvC;;;;;;;GAOG;AACH,MAAsB,YAAa,SAAQ,yBAAe;IACtD;;;;;;;;OAQG;IACO,KAAK,CAAC,GAAW,EAAE,OAAoB;QAC7C,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC;QAEpB,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACvC,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,IAAI,EAAE;gBACX,OAAO,CAAC,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,GAAG,KAAK,eAAe,CAAC,CAAC;aACpE;YACD,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AArBD,oCAqBC"}
+{"version":3,"file":"FetchService.js","sourceRoot":"","sources":["../src/FetchService.ts"],"names":[],"mappings":";;;AAAA,oCAAoC;AACpC,4BAA0B;AAC1B,qCAAkC;AAElC,uCAA4C;AAE5C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEvC,MAAa,YAAa,SAAQ,KAAK;IAEnC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;CACJ;AAPD,oCAOC;AAGD;;;;;;;;;GASG;AACH,MAAsB,YAAa,SAAQ,yBAAe;IACtD;;;;;;;;;;OAUG;IACO,KAAK,CAAC,GAAW,EAAE,OAAqB;QAC9C,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC;QAEpB,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;QAExC,IAAI,OAAO,EAAE;YACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACjB,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;aACtC;SACJ;aAAM;YACH,OAAO,GAAG;gBACN,MAAM,EAAE,UAAU,CAAC,MAAM;aAC5B,CAAA;SACJ;QAED,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,UAAU,CAAC,KAAK,EAAE,CAAA;QACtB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAEjB,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACvC,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,IAAI,EAAE;gBACX,OAAO,CAAC,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,GAAG,KAAK,gBAAgB,CAAC,CAAC;aACrE;YACD,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;YAEtB,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;gBAC7B,MAAM,IAAI,YAAY,CAAC,cAAc,IAAI,CAAC,OAAO,cAAc,CAAC,CAAC;aACpE;YAED,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACZ,YAAY,CAAC,OAAO,CAAC,CAAA;QACzB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAhDD,oCAgDC"}

package/lib/Service/AbstractService.js

@@ -11,7 +11,7 @@ exports.AbstractService = void 0;
  */
 class AbstractService {
     constructor(props) {
-        this.timeout = 500;
+        this.timeout = 1000;
         this.retryAttempts = 0;
         this.logs = false;
         if (props) {

package/lib/Service/AbstractService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractService.js","sourceRoot":"","sources":["../../src/Service/AbstractService.ts"],"names":[],"mappings":";;;AAGA;;;;;;;GAOG;AACH,MAAsB,eAAe;IAKjC,YAAY,KAAe;QAJlB,YAAO,GAAW,GAAG,CAAC;QACtB,kBAAa,GAAW,CAAC,CAAC;QAC1B,SAAI,GAAY,KAAK,CAAC;QAG3B,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1E,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;YAClG,IAAI,CAAC,IAAI,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACxE;IACL,CAAC;CACJ;AAZD,0CAYC"}
+{"version":3,"file":"AbstractService.js","sourceRoot":"","sources":["../../src/Service/AbstractService.ts"],"names":[],"mappings":";;;AAGA;;;;;;;GAOG;AACH,MAAsB,eAAe;IAKjC,YAAY,KAAe;QAJlB,YAAO,GAAW,IAAI,CAAC;QACvB,kBAAa,GAAW,CAAC,CAAC;QAC1B,SAAI,GAAY,KAAK,CAAC;QAG3B,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1E,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;YAClG,IAAI,CAAC,IAAI,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACxE;IACL,CAAC;CACJ;AAZD,0CAYC"}

package/lib/Service/Service.d.ts

@@ -1,8 +1,17 @@
 /*! Copyright (c) 2019, XAPPmedia */
 export interface Service {
     name?: string;
+    /**
+     * Timeout
+     */
     timeout?: number;
+    /**
+     * How many attempts to make on the API
+     */
     retryAttempts?: number;
     type?: string;
+    /**
+     * Log information from the service
+     */
     logs?: boolean;
 }

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.40.228",
+  "version": "1.40.231",
   "description": "Base service to be extended for making API calls",
   "types": "lib/index",
   "main": "lib/index",
@@ -16,24 +16,29 @@
   },
   "devDependencies": {
     "@types/chai": "4.3.1",
+    "@types/chai-as-promised": "7.1.5",
     "@types/jsonpath": "0.2.0",
     "@types/lodash": "4.14.182",
     "@types/sinon": "4.3.3",
     "@types/sinon-chai": "3.2.8",
     "@xapp/config": "0.2.3",
     "chai": "4.3.6",
+    "chai-as-promised": "7.1.1",
     "fetch-mock": "9.11.0",
+    "mocha": "10.0.0",
     "sinon": "14.0.0",
     "sinon-chai": "3.7.0",
-    "stentor-constants": "1.56.41",
-    "stentor-context": "1.56.41",
-    "stentor-models": "1.56.41",
-    "stentor-request": "1.56.41",
-    "stentor-utils": "1.56.41",
+    "stentor-constants": "1.56.43",
+    "stentor-context": "1.56.43",
+    "stentor-models": "1.56.43",
+    "stentor-request": "1.56.43",
+    "stentor-utils": "1.56.43",
+    "ts-node": "10.6.0",
     "typescript": "4.7.4"
   },
   "dependencies": {
-    "@xapp/stentor-app": "1.40.228",
+    "@xapp/stentor-app": "1.40.231",
+    "abort-controller": "3.0.0",
     "isomorphic-fetch": "3.0.0",
     "jsonpath": "1.1.1",
     "lodash.find": "4.6.0",
@@ -53,7 +58,8 @@
   },
   "scripts": {
     "build": "tsc -d true -p .",
-    "clean": "rm -rf ./lib/*"
+    "clean": "rm -rf ./lib/*",
+    "ftest": "mocha --recursive -r ts-node/register \"./src/**/*.ftest.ts\""
   },
-  "gitHead": "e719a31ecd33ac4ca0edde867ad00af44532a4cc"
+  "gitHead": "3a2133f5b86c4b26bcc962f2b4fc8151bfa67d97"
 }