@ezs/basics 1.15.4 → 1.17.0

package/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.17.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.16.0...@ezs/basics@1.17.0) (2022-03-25)
+
+
+### Features
+
+* 🎸 add retry feature ([166c913](https://github.com/Inist-CNRS/ezs/commit/166c913302b4d305ea34d3b84f9b8be6b5188cbb))
+
+
+
+
+
+# [1.16.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.15.5...@ezs/basics@1.16.0) (2022-02-07)
+
+
+### Features
+
+* 🎸 module.exports for all packages ([086a289](https://github.com/Inist-CNRS/ezs/commit/086a289ccbaa5c72ee7bc6652ab3c6c6b5578138))
+
+
+
+
+
+## [1.15.5](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.15.4...@ezs/basics@1.15.5) (2022-02-04)
+
+
+### Bug Fixes
+
+* 🐛 improve warning debug message on error ([5ff32e8](https://github.com/Inist-CNRS/ezs/commit/5ff32e8e2e6c48913d8d1abd35b9cee68ff19be4))
+
+
+
+
+
 ## [1.15.4](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.15.3...@ezs/basics@1.15.4) (2022-01-31)
 
 

package/README.md

@@ -548,6 +548,7 @@ Useful to send JSON data to an API and get results.
 -   `json` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Parse as JSON the content of URL (optional, default `false`)
 -   `timeout` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Timeout in milliseconds (optional, default `1000`)
 -   `noerror` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Ignore all errors (optional, default `false`)
+-   `retries` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** The maximum amount of times to retry the connection (optional, default `5`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
@@ -566,6 +567,7 @@ Or if no target is specified, the output will be the returned content of URL.
 -   `timeout` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** timeout in milliseconds (optional, default `1000`)
 -   `mimetype` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** mimetype for value of path  (if presents) (optional, default `"application/json"`)
 -   `noerror` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** ignore all errors, the target field will remain undefined (optional, default `false`)
+-   `retries` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** The maximum amount of times to retry the connection (optional, default `5`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
@@ -660,6 +662,7 @@ Output:
 -   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** choose the path to split JSON result (optional, default `"*"`)
 -   `timeout` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Timeout in milliseconds (optional, default `1000`)
 -   `noerror` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Ignore all errors, the target field will remain undefined (optional, default `false`)
+-   `retries` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** The maximum amount of times to retry the connection (optional, default `5`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 

package/lib/index.js

@@ -55,7 +55,7 @@ var _iniString = _interopRequireDefault(require("./ini-string"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-var _default = {
+const funcs = {
   BUFObject: _bufObject.default,
   OBJCount: _objCount.default,
   OBJNamespaces: _objNamespaces.default,
@@ -87,4 +87,6 @@ var _default = {
   split: _txtParse.default.TXTParse,
   segmenter: _txtParse.default.TXTParse
 };
-exports.default = _default;
+var _default = funcs;
+exports.default = _default;
+module.exports = funcs;

package/lib/request.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _fetchWithProxy = _interopRequireDefault(require("fetch-with-proxy"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const request = (url, parameters) => async () => {
+  const response = await (0, _fetchWithProxy.default)(url, parameters);
+
+  if (!response.ok) {
+    throw new Error(response.statusText);
+  }
+
+  return response;
+};
+
+var _default = request;
+exports.default = _default;

package/lib/url-connect.js

@@ -13,10 +13,12 @@ var _streamWrite = _interopRequireDefault(require("stream-write"));
 
 var _nodeAbortController = _interopRequireDefault(require("node-abort-controller"));
 
-var _fetchWithProxy = _interopRequireDefault(require("fetch-with-proxy"));
-
 var _parseHeaders = _interopRequireDefault(require("parse-headers"));
 
+var _asyncRetry = _interopRequireDefault(require("async-retry"));
+
+var _request = _interopRequireDefault(require("./request"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -31,10 +33,12 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {String} [json=false] Parse as JSON the content of URL
  * @param {Number} [timeout=1000] Timeout in milliseconds
  * @param {Boolean} [noerror=false] Ignore all errors
+ * @param {Number} [retries=5] The maximum amount of times to retry the connection
  * @returns {Object}
  */
-function URLConnect(data, feed) {
+async function URLConnect(data, feed) {
   const url = this.getParam('url');
+  const retries = Number(this.getParam('retries', 5));
   const noerror = Boolean(this.getParam('noerror', false));
   const json = this.getParam('json', true);
   const {
@@ -46,42 +50,51 @@ function URLConnect(data, feed) {
     const headers = (0, _parseHeaders.default)([].concat(this.getParam('header')).filter(Boolean).join('\n'));
     const controller = new _nodeAbortController.default();
     this.input = ezs.createStream(ezs.objectMode());
-    this.whenReady = (0, _fetchWithProxy.default)(url, {
+    const output = ezs.createStream(ezs.objectMode());
+    this.whenFinish = feed.flow(output);
+    (0, _streamWrite.default)(this.input, data, () => feed.end());
+    const bodyIn = this.input.pipe(ezs('dump')).pipe(ezs.toBuffer());
+    const parameters = {
       method: 'POST',
-      body: this.input.pipe(ezs('dump')).pipe(ezs.toBuffer()),
+      body: bodyIn,
       timeout,
+      headers,
       signal: controller.signal
-    }).then(({
-      body,
-      status,
-      statusText
-    }) => {
-      if (status !== 200) {
-        const msg = `Received status code ${status} (${statusText})`;
-        throw new Error(msg);
-      }
+    };
+    const options = {
+      retries
+    };
 
-      const output = json ? body.pipe(_JSONStream.default.parse('*')) : body;
-      output.once('error', () => controller.abort());
-      this.whenFinish = feed.flow(output);
-      return Promise.resolve(true);
-    }).catch(e => {
+    const onError = e => {
       controller.abort();
-      this.whenFinish = Promise.resolve(true);
 
       if (!noerror) {
+        (0, _debug.default)('ezs')(`Break item #${this.getIndex()} [URLConnect] <${e}>`);
         feed.stop(e);
       } else {
         (0, _debug.default)('ezs')(`Ignore item #${this.getIndex()} [URLConnect] <${e}>`);
       }
 
-      return Promise.resolve(true);
-    });
+      output.end();
+    };
+
+    try {
+      const response = await (0, _asyncRetry.default)((0, _request.default)(url, parameters), options);
+      const bodyOut = json ? response.body.pipe(_JSONStream.default.parse('*')) : response.body;
+      bodyOut.once('error', onError);
+      bodyOut.pipe(output);
+    } catch (e) {
+      onError(e);
+    }
+
+    ;
+    return;
   }
 
   if (this.isLast()) {
-    this.whenReady.finally(() => this.whenFinish.finally(() => feed.close()));
-    return this.input.end();
+    this.input.end();
+    this.whenFinish.finally(() => feed.close());
+    return;
   }
 
   (0, _streamWrite.default)(this.input, data, () => feed.end());

package/lib/url-fetch.js

@@ -13,10 +13,12 @@ var _lodash2 = _interopRequireDefault(require("lodash.set"));
 
 var _nodeAbortController = _interopRequireDefault(require("node-abort-controller"));
 
-var _fetchWithProxy = _interopRequireDefault(require("fetch-with-proxy"));
-
 var _parseHeaders = _interopRequireDefault(require("parse-headers"));
 
+var _asyncRetry = _interopRequireDefault(require("async-retry"));
+
+var _request = _interopRequireDefault(require("./request"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -32,6 +34,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {Number} [timeout=1000] timeout in milliseconds
  * @param {String} [mimetype="application/json"] mimetype for value of path  (if presents)
  * @param {Boolean} [noerror=false] ignore all errors, the target field will remain undefined
+ * @param {Number} [retries=5] The maximum amount of times to retry the connection
  * @returns {Object}
  */
 async function URLFetch(data, feed) {
@@ -43,6 +46,7 @@ async function URLFetch(data, feed) {
   const path = this.getParam('path');
   const target = this.getParam('target');
   const json = Boolean(this.getParam('json', false));
+  const retries = Number(this.getParam('retries', 5));
   const noerror = Boolean(this.getParam('noerror', false));
   const timeout = Number(this.getParam('timeout')) || 1000;
   const headers = (0, _parseHeaders.default)([].concat(this.getParam('header')).filter(Boolean).join('\n'));
@@ -55,6 +59,9 @@ async function URLFetch(data, feed) {
     headers,
     signal: controller.signal
   };
+  const options = {
+    retries
+  };
 
   if (body) {
     (0, _lodash2.default)(parameters, 'method', 'POST');
@@ -63,7 +70,7 @@ async function URLFetch(data, feed) {
   }
 
   try {
-    const response = await (0, _fetchWithProxy.default)(url, parameters);
+    const response = await (0, _asyncRetry.default)((0, _request.default)(url, parameters), options);
     const func = json ? 'json' : 'text';
     const value = await response[func]();
 
@@ -79,10 +86,11 @@ async function URLFetch(data, feed) {
     controller.abort();
 
     if (noerror) {
+      (0, _debug.default)('ezs')(`Ignore item #${this.getIndex()} [URLFetch] <${e}>`);
       return feed.send(data);
     }
 
-    (0, _debug.default)('ezs')(`Ignore item #${this.getIndex()} [URLConnect] <${e}>`);
+    (0, _debug.default)('ezs')(`Break item #${this.getIndex()} [URLFetch] <${e}>`);
     return feed.send(e);
   }
 }

package/lib/url-stream.js

@@ -13,10 +13,12 @@ var _nodeAbortController = _interopRequireDefault(require("node-abort-controller
 
 var _JSONStream = _interopRequireDefault(require("JSONStream"));
 
-var _fetchWithProxy = _interopRequireDefault(require("fetch-with-proxy"));
-
 var _parseHeaders = _interopRequireDefault(require("parse-headers"));
 
+var _asyncRetry = _interopRequireDefault(require("async-retry"));
+
+var _request = _interopRequireDefault(require("./request"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -82,6 +84,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {String} [path="*"] choose the path to split JSON result
  * @param {Number} [timeout=1000] Timeout in milliseconds
  * @param {Boolean} [noerror=false] Ignore all errors, the target field will remain undefined
+ * @param {Number} [retries=5] The maximum amount of times to retry the connection
  * @returns {Object}
  */
 async function URLStream(data, feed) {
@@ -91,39 +94,43 @@ async function URLStream(data, feed) {
 
   const url = this.getParam('url');
   const path = this.getParam('path', '*');
+  const retries = Number(this.getParam('retries', 5));
   const noerror = Boolean(this.getParam('noerror', false));
   const timeout = Number(this.getParam('timeout')) || 1000;
   const headers = (0, _parseHeaders.default)([].concat(this.getParam('header')).filter(Boolean).join('\n'));
   const cURL = new _url.URL(url || data);
   const controller = new _nodeAbortController.default();
+  const parameters = {
+    timeout,
+    headers,
+    signal: controller.signal
+  };
+  const options = {
+    retries
+  };
 
   if (url) {
     cURL.search = new _url.URLSearchParams(data);
   }
 
-  try {
-    const response = await (0, _fetchWithProxy.default)(cURL.href, {
-      headers,
-      timeout,
-      signal: controller.signal
-    });
-
-    if (response.status !== 200) {
-      const msg = `Received status code ${response.status} (${response.statusText})`;
-      throw new Error(msg);
-    }
-
-    const output = path ? response.body.pipe(_JSONStream.default.parse(path)) : response.body;
-    output.once('error', () => controller.abort());
-    await feed.flow(output);
-  } catch (e) {
+  const onError = e => {
     controller.abort();
 
     if (noerror) {
+      (0, _debug.default)('ezs')(`Ignore item #${this.getIndex()} [URLStream] <${e}>`);
       return feed.send(data);
     }
 
-    (0, _debug.default)('ezs')(`Ignore item #${this.getIndex()} [URLConnect] <${e}>`);
+    (0, _debug.default)('ezs')(`Break item #${this.getIndex()} [URLStream] <${e}>`);
     return feed.send(e);
+  };
+
+  try {
+    const response = await (0, _asyncRetry.default)((0, _request.default)(cURL.href, parameters), options);
+    const output = path ? response.body.pipe(_JSONStream.default.parse(path)) : response.body;
+    output.once('error', onError);
+    await feed.flow(output);
+  } catch (e) {
+    onError(e);
   }
 }

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@ezs/basics",
   "description": "Basics statements for EZS",
-  "version": "1.15.4",
+  "version": "1.17.0",
   "author": "Nicolas Thouvenin <nthouvenin@gmail.com>",
   "bugs": "https://github.com/Inist-CNRS/ezs/issues",
   "dependencies": {
     "JSONStream": "1.3.5",
+    "async-retry": "1.3.3",
     "better-https-proxy-agent": "1.0.9",
     "csv-string": "3.2.0",
     "debug": "4.3.3",
@@ -33,7 +34,7 @@
   "directories": {
     "test": "test"
   },
-  "gitHead": "653a28a1e40b088ea62b1b00c055de51e264dee1",
+  "gitHead": "7c26e58f03f6675d98f22914cf5e315a89916e2e",
   "homepage": "https://github.com/Inist-CNRS/ezs/tree/master/packages/basics#readme",
   "keywords": [
     "ezs"
@@ -41,7 +42,7 @@
   "license": "MIT",
   "main": "./lib/index.js",
   "peerDependencies": {
-    "@ezs/core": "1.27.2"
+    "@ezs/core": "*"
   },
   "publishConfig": {
     "access": "public"