SEARCH-197

- Error handling for compression and decompression

demo/search.html

@@ -103,7 +103,7 @@
 </div>
 
 <script>
-    var search = new ssf.Search("7078106230763", "k2rbHBd5CgU3/PKLFUKUYkmuhCiL2Gw2bnsD7MdaZrU=");
+    var search = new ssf.Search("16149077034436", "RSDFOiuVqF3WmY1pC4MP145qPOpUP6A4if27WG9y3fY=");
     var buttonEl = document.getElementById('search');
     var merge = document.getElementById('merge');
     var buttonIndex = document.getElementById('index');

js/compressionLib/index.js

@@ -17,38 +17,65 @@ const devPath = path.join(__dirname, '..', '..', 'library', winArchPath);
 
 const lz4Path = isDevEnv ? devPath : productionPath;
 
-function compression(pathToFolder, outputPath, cb) {
+/**
+ * Using the child process to execute the tar and lz4
+ * compression and the final output of this function
+ * will be compressed file with ext: .tar.lz4
+ * @param pathToFolder
+ * @param outputPath
+ * @param callback
+ */
+function compression(pathToFolder, outputPath, callback) {
     if (isMac) {
-        child.exec(`cd "${DATA_FOLDER_PATH}" && tar cvf - "${pathToFolder}" | lz4 > "${outputPath}.tar.lz4"`, (error, stdout) => {
+        child.exec(`cd "${DATA_FOLDER_PATH}" && tar cvf - "${pathToFolder}" | lz4 > "${outputPath}.tar.lz4"`, (error, stdout, stderr) => {
             if (error) {
-                return cb(new Error(error));
+                return callback(new Error(error), null);
             }
-            return cb(null, stdout);
+            return callback(null, {
+                stderr: stderr.toString().trim(),
+                stdout: stdout.toString().trim()
+            });
         })
     } else {
-        child.exec(`cd "${DATA_FOLDER_PATH}" && "${libraryFolderPath}\\tar-win.exe" cvf - "${pathToFolder}" | "${lz4Path}" > "${outputPath}.tar.lz4"`, (error, stdout) => {
+        child.exec(`cd "${DATA_FOLDER_PATH}" && "${libraryFolderPath}\\tar-win.exe" cvf - "${pathToFolder}" | "${lz4Path}" > "${outputPath}.tar.lz4"`, (error, stdout, stderr) => {
             if (error) {
-                return cb(new Error(error));
+                return callback(new Error(error), null);
             }
-            return cb(null, stdout);
+            return callback(null, {
+                stderr: stderr.toString().trim(),
+                stdout: stdout.toString().trim()
+            });
         })
     }
 }
 
-function deCompression(pathName, cb) {
+/**
+ * This function decompress the file
+ * and the ext should be .tar.lz4
+ * the output will be the user index folder
+ * @param pathName
+ * @param callback
+ */
+function deCompression(pathName, callback) {
     if (isMac) {
-        child.exec(`cd "${DATA_FOLDER_PATH}" && lz4 -d "${pathName}" | tar -xf - `, (error, stdout) => {
+        child.exec(`cd "${DATA_FOLDER_PATH}" && lz4 -d "${pathName}" | tar -xf - `, (error, stdout, stderr) => {
             if (error) {
-                return cb(new Error(error));
+                return callback(new Error(error), null);
             }
-            return cb(null, stdout);
+            return callback(null, {
+                stderr: stderr.toString().trim(),
+                stdout: stdout.toString().trim()
+            });
         })
     } else {
-        child.exec(`cd "${DATA_FOLDER_PATH}" && "${lz4Path}" -d "${pathName}" | "${libraryFolderPath}\\tar-win.exe" xf - `, (error, stdout) => {
+        child.exec(`cd "${DATA_FOLDER_PATH}" && "${lz4Path}" -d "${pathName}" | "${libraryFolderPath}\\tar-win.exe" xf - `, (error, stdout, stderr) => {
             if (error) {
-                return cb(new Error(error));
+                return callback(new Error(error), null);
             }
-            return cb(null, stdout);
+            return callback(null, {
+                stderr: stderr.toString().trim(),
+                stdout: stdout.toString().trim()
+            });
         })
     }
 }

js/cryptoLib/index.js

@@ -6,6 +6,8 @@ const fs = require('fs');
 const lz4 = require('../compressionLib');
 const isDevEnv = require('../utils/misc.js').isDevEnv;
 const crypto = require('./crypto');
+const log = require('../log.js');
+const logLevels = require('../enums/logLevels.js');
 
 const userData = path.join(app.getPath('userData'));
 const DATA_FOLDER = isDevEnv ? './data' : path.join(userData, 'data');
@@ -25,23 +27,27 @@ class Crypto {
     }
 
     /**
-     * Creates a zip of the data folder and encrypting
+     * Compressing the user index folder and
-     * removing the data folder and the dump files
+     * encrypting it
      * @returns {Promise}
      */
     encryption() {
         return new Promise((resolve, reject) => {
 
             if (!fs.existsSync(this.indexDataFolder)){
-                // will be handling after implementing in client app
+                log.send(logLevels.ERROR, 'user index folder not found');
                 reject();
                 return;
             }
 
-            lz4.compression(`data/${this.permanentIndexFolderName}`, `${this.permanentIndexFolderName}`, (error) => {
+            lz4.compression(`data/${this.permanentIndexFolderName}`, `${this.permanentIndexFolderName}`, (error, response) => {
                 if (error) {
+                    log.send(logLevels.ERROR, 'lz4 compression error: ' + error);
                     reject(error);
+                    return;
                 }
+
+                log.send(logLevels.WARN, 'compression stderr, ' + response.stderr);
                 const input = fs.createReadStream(`${this.dump}/${this.permanentIndexFolderName}.tar.lz4`);
                 const outputEncryption = fs.createWriteStream(this.encryptedIndex);
                 let config = {
@@ -53,7 +59,9 @@ class Crypto {
 
                 encryptionProcess.on('finish', (err) => {
                     if (err) {
+                        log.send(logLevels.ERROR, 'encryption error: ' + err);
                         reject(new Error(err));
+                        return;
                     }
                     fs.unlinkSync(`${this.dump}/${this.permanentIndexFolderName}.tar.lz4`);
                     resolve('Success');
@@ -71,7 +79,7 @@ class Crypto {
         return new Promise((resolve, reject) => {
 
             if (!fs.existsSync(this.encryptedIndex)){
-                // will be handling after implementing in client app
+                log.send(logLevels.ERROR, 'encrypted file not found');
                 reject();
                 return;
             }
@@ -88,12 +96,18 @@ class Crypto {
             decryptionProcess.on('finish', () => {
 
                 if (!fs.existsSync(`${this.dump}/decrypted.tar.lz4`)){
-                    // will be handling after implementing in client app
+                    log.send(logLevels.ERROR, 'decrypted.tar.lz4 file not found');
                     reject();
                     return;
                 }
 
-                lz4.deCompression(`${this.dump}/decrypted.tar.lz4`,() => {
+                lz4.deCompression(`${this.dump}/decrypted.tar.lz4`,(error, response) => {
+                    if (error) {
+                        log.send(logLevels.ERROR, 'lz4 deCompression error, ' + error);
+                        // no return, need to unlink if error
+                    }
+
+                    log.send(logLevels.WARN, 'deCompression stderr, ' + response.stderr);
                     fs.unlink(`${this.dump}/decrypted.tar.lz4`, () => {
                         resolve('success');
                     });

js/search/search.js

@@ -67,6 +67,10 @@ class Search {
         this.decryptAndInit();
     }
 
+    /**
+     * Decrypting the existing user .enc file
+     * and initialing the library
+     */
     decryptAndInit() {
         this.crypto.decryption().then(() => {
             console.timeEnd('Decrypting');