@ezs/basics 2.5.5 → 2.5.7

package/README.md

@@ -552,6 +552,7 @@ Take all recevied objects and build a tar file
 -   `location` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Location path to store files in the tarball (optional, default `data`)
 -   `json` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Convert to JSON the content of each chunk (optional, default `true`)
 -   `extension` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Choose extension fo each file (optional, default `json`)
+-   `additionalFile` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Path to an additional file that will be add to tarball
 -   `compress` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Enable gzip compression (optional, default `false`)
 
 ### TARExtract
@@ -730,14 +731,10 @@ The output will be the returned content of URL.
 
 Useful to send JSON data to an API and get results.
 
-Warning :
-if retries === 1,  it will directly use the stream
-to connect to the server otherwise the stream will be fully
-read to be buffered and sent to the server (n times)
-
 #### Parameters
 
 -   `url` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** URL to fetch
+-   `streaming` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Direct connection to the Object Stream server (disables the retries setting) (optional, default `false`)
 -   `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`)

package/lib/tar-dump.js

@@ -4,10 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = TARDump;
+var _path = require("path");
+var _util = require("util");
+var _fs = require("fs");
 var _tarStream = _interopRequireDefault(require("tar-stream"));
 var _zlib = require("zlib");
 var _lodash = _interopRequireDefault(require("lodash.merge"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Avoid importing from fs/promise to be compatible with node 12
+const readFilePromise = (0, _util.promisify)(_fs.readFile);
 const eol = '\n';
 
 /**
@@ -23,6 +28,7 @@ const eol = '\n';
  * @param {String} [location=data] Location path to store files in the tarball
  * @param {String} [json=true] Convert to JSON the content of each chunk
  * @param {String} [extension=json] Choose extension fo each file
+ * @param {String} [additionalFile] Path to an additional file that will be add to tarball
  * @param {Boolean} [compress=false] Enable gzip compression
  */
 function TARDump(data, feed) {
@@ -46,7 +52,10 @@ function TARDump(data, feed) {
     this.pack.entry({
       name: 'manifest.json'
     }, JSON.stringify(manifest, null, '  '));
-    this.pack.finalize();
+    const additionalFiles = [].concat(this.getParam('additionalFile')).filter(Boolean).map(filename => this.ezs.getPath().map(dir => (0, _path.resolve)(dir, filename)).filter(Boolean).shift()).filter(Boolean).map(fullfilename => readFilePromise(fullfilename).then(fileContent => this.pack.entry({
+      name: (0, _path.basename)(fullfilename)
+    }, fileContent)));
+    Promise.all(additionalFiles).catch(e => feed.stop(e)).finally(() => this.pack.finalize());
     return;
   }
   const json = this.getParam('json', true);

package/lib/url-connect.js

@@ -21,13 +21,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  *
  * Useful to send JSON data to an API and get results.
  *
- * Warning :
- * if retries === 1,  it will directly use the stream
- * to connect to the server otherwise the stream will be fully
- * read to be buffered and sent to the server (n times)
- *
  * @name URLConnect
  * @param {String} [url] URL to fetch
+ * @param {String} [streaming=false] Direct connection to the Object Stream server (disables the retries setting)
  * @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
@@ -37,6 +33,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 async function URLConnect(data, feed) {
   const url = this.getParam('url');
+  const streaming = Boolean(this.getParam('streaming', false));
   const retries = Number(this.getParam('retries', 5));
   const noerror = Boolean(this.getParam('noerror', false));
   const json = this.getParam('json', true);
@@ -53,7 +50,7 @@ async function URLConnect(data, feed) {
     (0, _streamWrite.default)(this.input, data, () => feed.end());
     const streamIn = this.input.pipe(ezs(encoder));
     let bodyIn;
-    if (retries === 1) {
+    if (streaming) {
       bodyIn = streamIn.pipe(ezs.toBuffer());
     } else {
       bodyIn = await (0, _getStream.default)(streamIn);
@@ -81,24 +78,22 @@ async function URLConnect(data, feed) {
           err.responseText = text;
           throw err;
         }
-        if (retries === 1) {
+        if (streaming) {
           const bodyOut = json ? response.body.pipe(_JSONStream.default.parse('*')) : response.body;
           bodyOut.once('error', e => {
             controller.abort();
             output.emit('error', e);
           });
-          bodyOut.pipe(output);
-        } else {
-          if (json) {
-            const bodyOutRaw = await (0, _getStream.default)(response.body);
-            const bodyOutArray = JSON.parse(bodyOutRaw);
-            (0, _from.default)(bodyOutArray).pipe(output);
-          } else {
-            response.body.pipe(output);
-          }
+          return bodyOut.pipe(output);
+        }
+        if (json) {
+          const bodyOutRaw = await (0, _getStream.default)(response.body);
+          const bodyOutArray = JSON.parse(bodyOutRaw);
+          return (0, _from.default)(bodyOutArray).pipe(output);
         }
+        return response.body.pipe(output);
       }, {
-        retries
+        retries: streaming ? 0 : retries
       });
     } catch (e) {
       if (!noerror) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ezs/basics",
   "description": "Basics statements for EZS",
-  "version": "2.5.5",
+  "version": "2.5.7",
   "author": "Nicolas Thouvenin <nthouvenin@gmail.com>",
   "bugs": "https://github.com/Inist-CNRS/ezs/issues",
   "dependencies": {
@@ -41,7 +41,7 @@
   "directories": {
     "test": "test"
   },
-  "gitHead": "f168e4c0002e2eb1865ae7eacda04f94904b37cd",
+  "gitHead": "0667dffb8743f46bdd5cfab7d1cf47801db925c3",
   "homepage": "https://github.com/Inist-CNRS/ezs/tree/master/packages/basics#readme",
   "keywords": [
     "ezs"