refactor to allow retrying using 7za when full 7z fails, which is the case on Linux and Mac OS, bug fix, update Readme

TheTechsTech · TheTechsTech · commit 6badf2804157 · 2020-12-02T13:44:29.000-05:00
diff --git a/README.md b/README.md
@@ -37,13 +37,13 @@ __How to create Sfx - Self Extracting Archives.__
 Executables will be built using 7-zip version _19.00_ on **Windows OS** for Windows targets.
 **Linux** and **Apple macOS** will use 7-zip version _16.04_ for all targets.
 
-import { createWindowsSfx, createLinuxSfx, createMacSfx } from 'node-7z-archive';
+import { createSfxWindows, createSfxLinux, createSfxMac } from 'node-7z-archive';
 
-- **createWindowsSfx**(name, files, destination, options, type);
+- **createSfxWindows**(name, files, destination, options, type);
 
-- **createLinuxSfx**(name, files, destination, options);
+- **createSfxLinux**(name, files, destination, options);
 
-- **createMacSfx**(name, files, destination, options);
+- **createSfxMac**(name, files, destination, options);
 
 Each will in turn call:
 **createSfx**(name, files, destination, options, type, platform, extension) as:
@@ -98,7 +98,7 @@ For using full **7zip** from command line without installation package.
 npm install -g node-7z-archive
 ```
 
-Will have **`createArchive`, `deleteArchive`, `extractArchive`, `fullArchive`, `listArchive`, `renameArchive`, `testArchive`, `updateArchive`** available globally. To always see available commands type:
+Will have **`createArchive`, `deleteArchive`, `extractArchive`, `fullArchive`, `listArchive`, `renameArchive`, `testArchive`, `updateArchive`**, **`createSfx`** available globally. To always see available commands, and binary location type:
 
 ```shell
 7zip
@@ -136,6 +136,12 @@ Full 7zip Console Commands.
 
  Update older files in the archive and add files that are not already in the archive.
  Usage: `updateArchive` archivePath files ...options
+
+ Create an Sfx - self extracting installation package for targeted platform.
+ Usage: `createSfx` platform packageName files -destination ...options
+
+-----------------------------------------------------------------
+ The `7z` and `7za` binary on your system is located in directory: ...\...\node-7z-archive\binaries\...
 ```
 
 > ____This package is a rewrite of [node-7z-forall](https://github.com/techno-express/node-7z-forall)____. The original author has removed the version it was a fork of [node-7z](https://github.com/quentinrossetti/node-7z). The author's current version has over `600` dependency tree without dev. This package dependency is `130` with dev.
diff --git a/cli/7zip.js b/cli/7zip.js
@@ -8,13 +8,15 @@
  * Dependencies.
  */
 import minimist from 'minimist';
+import platformBinary from '../util/binary.mjs';
 import {
   createRequire
 } from 'module';
 
 const require = createRequire(
   import.meta.url);
-const pack = require('../package.json');
+const pack = require('../package.json'),
+  sevenBinary = platformBinary();
 
 /*
  * Arguments.
@@ -62,6 +64,12 @@ function help() {
     '',
     'Update older files in the archive and add files that are not already in the archive.',
     'Usage: `updateArchive` archivePath files ...options',
+    '',
+    'Create an Sfx - self extracting installation package for targeted platform.',
+    'Usage: `createSfx` platform packageName files -destination ...options',
+    '',
+    '----------------------------------------------------------------',
+    'The `7z` and `7za` binary on your system is located in directory: ' + sevenBinary.path,
   ].join('\n ') + '\n';
 }
 
diff --git a/lib/createArchive.mjs b/lib/createArchive.mjs
@@ -54,8 +54,19 @@ export default function (filepath, files, options, override = false) {
       })
 
       // Catch the error and pass it to the reject function of the Promise.
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('CreateArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
   });
 };
diff --git a/lib/createSfx.mjs b/lib/createSfx.mjs
@@ -160,7 +160,7 @@ export default function (
       sfx: sfxModule
     });
 
-    return createArchive(sfx, list, params, '7z', override)
+    createArchive(sfx, list, params, override)
       .progress((data) => {
         return progress(data);
       })
@@ -176,28 +176,9 @@ export default function (
           }
         });
       })
-      .catch(() => {
-        // Override try different binary
-        return createArchive(sfx, list, params, override)
-          .progress((data) => {
-            return progress(data);
-          })
-          .then((data) => {
-            fs.unlink(configFile, (err) => {
-              if (err) console.error(err);
-              if (fs.existsSync(sfx)) {
-                return resolve(sfx);
-                /* c8 ignore next 4 */
-              } else {
-                console.error(data);
-                return reject('Failed! The Sfx application could not be created!');
-              }
-            });
-          })
-          .catch((err) => {
-            fs.removeSync(configFile);
-            return reject(err);
-          });
+      .catch((err) => {
+        fs.removeSync(configFile);
+        return reject(err);
       });
   });
 }
diff --git a/lib/deleteArchive.mjs b/lib/deleteArchive.mjs
@@ -34,9 +34,15 @@ export default function (filepath, files, options, override = false) {
       })
 
       // Catch the error and pass it to the reject function of the Promise.
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('DeleteArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
-
   });
 };
diff --git a/lib/extractArchive.mjs b/lib/extractArchive.mjs
@@ -50,8 +50,18 @@ export default function (filepath, dest = '*', options = {}, override = false) {
       })
 
       // Catch the error and pass it to the reject function of the Promise.
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('ExtractArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
   });
 };
diff --git a/lib/fullArchive.mjs b/lib/fullArchive.mjs
@@ -45,8 +45,18 @@ export default function (filepath, dest = '*', options = {}, override = false) {
       .then(function (args) {
         return resolve(args);
       })
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('FullArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
   });
 };
diff --git a/lib/index.mjs b/lib/index.mjs
@@ -24,14 +24,14 @@ export const renameArchive = SevenZip.renameArchive = _renameArchive;
 export const testArchive = SevenZip.testArchive = _testArchive;
 export const updateArchive = SevenZip.updateArchive = _updateArchive;
 
-export const createWindowsSfx = SevenZip.windowsSfx = function (name, files, destination, options, type) {
+export const createSfxWindows = SevenZip.windowsSfx = function (name, files, destination, options, type) {
   return createSfx(name, files, destination, options, type, 'win32', '.exe');
 };
 
-export const createLinuxSfx = SevenZip.linuxSfx = function (name, files, destination, options) {
+export const createSfxLinux = SevenZip.linuxSfx = function (name, files, destination, options) {
   return createSfx(name, files, destination, options, 'console', 'linux', '.elf');
 };
 
-export const createMacSfx = SevenZip.macSfx = function (name, files, destination, options) {
+export const createSfxMac = SevenZip.macSfx = function (name, files, destination, options) {
   return createSfx(name, files, destination, options, 'console', 'darwin', '.pkg');
 };
diff --git a/lib/listArchive.mjs b/lib/listArchive.mjs
@@ -79,8 +79,18 @@ export default function (filepath, options, override = false) {
       .then(function () {
         return resolve(spec);
       })
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('ListArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
   });
 };
diff --git a/lib/renameArchive.mjs b/lib/renameArchive.mjs
@@ -50,8 +50,18 @@ export default function (filepath, files, options, override = false) {
       .then(function () {
         return resolve();
       })
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('RenameArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
   });
 };
diff --git a/lib/testArchive.mjs b/lib/testArchive.mjs
@@ -19,24 +19,28 @@ import Run from '../util/run.mjs';
  */
 export default function (filepath, options, override = false) {
   return when.promise(function (resolve, reject, progress) {
+    /**
+     * When a stdout is emitted, parse each line and search for a pattern.When
+     * the pattern is found, extract the file (or directory) name from it and
+     * pass it to an array. Finally returns this array.
+     */
+    function onprogress(data) {
+      let entries = [];
+      data.split('\n').forEach(function (line) {
+        if (line.substr(0, 1) === 'T') {
+          entries.push(ReplaceNativeSeparator(line.substr(2, line.length)));
+        }
+      });
+      return entries;
+    }
 
     // Create a string that can be parsed by `run`.
     let command = 't "' + filepath + '"';
 
     // Start the command
     Run('7z', command, options, override)
-
-      // When a stdout is emitted, parse each line and search for a pattern. When
-      // the pattern is found, extract the file (or directory) name from it and
-      // pass it to an array. Finally returns this array.
       .progress(function (data) {
-        let entries = [];
-        data.split('\n').forEach(function (line) {
-          if (line.substr(0, 1) === 'T') {
-            entries.push(ReplaceNativeSeparator(line.substr(2, line.length)));
-          }
-        });
-        return progress(entries);
+        return progress(onprogress(data));
       })
 
       // When all is done resolve the Promise.
@@ -45,8 +49,18 @@ export default function (filepath, options, override = false) {
       })
 
       // Catch the error and pass it to the reject function of the Promise.
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('TestArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
 
   });
diff --git a/lib/updateArchive.mjs b/lib/updateArchive.mjs
@@ -21,6 +21,20 @@ import Run from '../util/run.mjs';
  */
 export default function (filepath, files, options, override = false) {
   return when.promise(function (resolve, reject, progress) {
+    /**
+     * When a stdout is emitted, parse each line and search for a pattern.When
+     * the pattern is found, extract the file (or directory) name from it and
+     * pass it to an array. Finally returns this array.
+     */
+    function onprogress(data) {
+      let entries = [];
+      data.split('\n').forEach(function (line) {
+        if (line.substr(0, 1) === 'U') {
+          entries.push(ReplaceNativeSeparator(line.substr(2, line.length)));
+        }
+      });
+      return entries;
+    }
 
     // Convert array of files into a string if needed.
     files = Files(files);
@@ -30,18 +44,8 @@ export default function (filepath, files, options, override = false) {
 
     // Start the command
     Run('7z', command, options, override)
-
-      // When a stdout is emitted, parse each line and search for a pattern. When
-      // the pattern is found, extract the file (or directory) name from it and
-      // pass it to an array. Finally returns this array.
       .progress(function (data) {
-        let entries = [];
-        data.split('\n').forEach(function (line) {
-          if (line.substr(0, 1) === 'U') {
-            entries.push(ReplaceNativeSeparator(line.substr(2, line.length)));
-          }
-        });
-        return progress(entries);
+        return progress(onprogress(data));
       })
 
       // When all is done resolve the Promise.
@@ -50,8 +54,18 @@ export default function (filepath, files, options, override = false) {
       })
 
       // Catch the error and pass it to the reject function of the Promise.
-      .catch(function (err) {
-        return reject(err);
+      .catch(function () {
+        console.error('UpdateArchive failed using `7z`, retying with `7za`.');
+        Run('7za', command, options, override)
+          .progress(function (data) {
+            return progress(onprogress(data));
+          })
+          .then(function (args) {
+            return resolve(args);
+          })
+          .catch(function (err) {
+            return reject(err);
+          });
       });
 
   });
diff --git a/test/lib/createSfxLinux.test.js b/test/lib/createSfxLinux.test.js
@@ -2,15 +2,15 @@
 'use strict';
 import chai from 'chai';
 import {
-  createLinuxSfx
+  createSfxLinux
 } from '../../lib/index.mjs';
 import fs from 'fs-extra';
 const expect = chai.expect;
 
-describe('Method: `CreateLinuxSfx`', function () {
+describe('Method: `createSfxLinux`', function () {
 
   it('should return successfully on an Linux Sfx build', function (done) {
-    createLinuxSfx('test', ['*.js'], './test/')
+    createSfxLinux('test', ['*.js'], './test/')
       .then(function (data) {
         expect(data).to.exist;
         expect(fs.existsSync('./test/SfxPackages/test.elf')).to.be.eql(true);
diff --git a/test/lib/createSfxMac.test.js b/test/lib/createSfxMac.test.js
diff --git a/test/lib/createSfxWindows.test.js b/test/lib/createSfxWindows.test.js
diff --git a/test/util/run.test.js b/test/util/run.test.js
diff --git a/util/binary.mjs b/util/binary.mjs
diff --git a/util/run.mjs b/util/run.mjs
