Merge pull request #88 from saadtazi/make-encoded-first-error-cb

`fp.encoded(db)` method now accepts a error-first callback function

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0
+
+* BREAKING CHANGE: handle errors in `encoded(cb)` callback function
+
 # 0.5.0
 
 * Make sure to load user settings if existing profile (thanks @lutostag)

README.md

@@ -123,7 +123,11 @@ Make sure you have selenium server running... or use 'selenium-webdriver/remote'
 
     // you can install multiple extensions at the same time
     fp.addExtensions(['./test/extensions/firebug-1.12.4-fx.xpi'], function() {
-        fp.encoded(function(zippedProfile) {
+        fp.encoded(function(err, zippedProfile) {
+            if (err) {
+                console.error('oops, an error occured:', err);
+                return;
+            }
             browser = wd.promiseChainRemote();
             browser.init({
               browserName:'firefox',

examples/example-wd.js

@@ -25,7 +25,11 @@ fp.setPreference('saadt.coucou', 'console');
 fp.updatePreferences();
 // you can install multiple extensions at the same time
 fp.addExtensions(['../test/extensions/firebug-2.0.1-fx.xpi'], function() {
-  fp.encoded(function(zippedProfile) {
+  fp.encoded(function(err, zippedProfile) {
+    if (err) { 
+      console.log('oops, error!', err);
+      return;
+    }
     browser = wd.promiseChainRemote();
     browser.init({
       browserName:'firefox',

lib/cli.js

@@ -110,7 +110,11 @@ createProfile(function(err, fp) {
     }
     log('encoding profile...');
 
-    fp.encoded(function(zippedProfileString) {
+    fp.encoded(function(err, zippedProfileString) {
+      if (err) {
+        console.error('oops, an error occured:', err);
+        process.exit(4);
+      }
       if (encoded === true) {
         process.stdout.write(zippedProfileString);
         process.exit(0);

lib/firefox_profile.js

@@ -413,28 +413,36 @@ FirefoxProfile.prototype.setNativeEventsEnabled = function (val) {
  * return zipped, base64 encoded string of the profile directory
  * for use with remote WebDriver JSON wire protocol
  *
- * @param {Function} function a callback function with first params as a zipped, base64 encoded string of the profile directory
+ * @param {Function} function a callback function with first param: an error, and 2nd param: a zipped, base64 encoded string of the profile directory
  */
 FirefoxProfile.prototype.encoded = function(cb) {
-  var self = this,
-      tmpFolder = this._createTempFolder(),
-      zipStream = fs.createWriteStream(path.join(tmpFolder,'profile.zip')),
-      archive = archiver('zip', { forceUTC: true });
+  try {
+    var self = this,
+        tmpFolder = this._createTempFolder(),
+        zipStream = fs.createWriteStream(path.join(tmpFolder,'profile.zip')),
+        archive = archiver('zip', { forceUTC: true });
 
-  if (this._preferencesModified) {
-    this.updatePreferences();
-  }
-  zipStream.on('close', function() {
-    fs.readFile(path.join(tmpFolder,'profile.zip'), function(err, content) {
-      cb(content.toString('base64'));
-      deleteParallel([path.join(tmpFolder,'profile.zip'), tmpFolder]);
+    if (this._preferencesModified) {
+      this.updatePreferences();
+    }
+    zipStream.on('error', function (err) {
+      cb(err);
     });
-  });
-  archive.pipe(zipStream);
-  archive.glob('**', {
-    cwd: self.profileDir, expand: true
-  }, {});
-  archive.finalize();
+
+    zipStream.on('close', function() {
+      fs.readFile(path.join(tmpFolder,'profile.zip'), function(err, content) {
+        cb(null, content.toString('base64'));
+        deleteParallel([path.join(tmpFolder,'profile.zip'), tmpFolder]);
+      });
+    });
+    archive.pipe(zipStream);
+    archive.glob('**', {
+      cwd: self.profileDir, expand: true
+    }, {});
+    archive.finalize();
+  } catch (e) {
+    cb(e);
+  }
 };
 
 // only '1' found in proxy.js

package.json

@@ -1,6 +1,6 @@
 {
   "name": "firefox-profile",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "description": "firefox profile for selenium WebDriverJs, admc/wd or any other node selenium driver that supports capabilities",
   "main": "lib/firefox_profile",
   "types": "lib/firefox_profile.d.ts",
@@ -87,7 +87,7 @@
   "dependencies": {
     "adm-zip": "~0.4.x",
     "archiver": "~1.3.0",
-    "async": "~2.1.2",
+    "async": "~2.3.0",
     "fs-extra": "~2.1.2",
     "ini": "~1.3.3",
     "jetpack-id": "1.0.0",

test/firefox_profile.js

@@ -232,7 +232,7 @@ describe('firefox_profile', function() {
       spy.restore();
     });
     it('should work with a brand new profile', function(done) {
-      fp.encoded(function(zippedProfileString) {
+      fp.encoded(function(error, zippedProfileString) {
         expect(zippedProfileString).to.be.equal(testProfiles.brandNewProfile.expectedZip);
         done();
       });

test/spec/extension.spec.js

@@ -69,10 +69,8 @@ describe('install extension', function() {
         })
         .get('http://saadtazi.com')
         .sleep(1000)
-          // see http://getfirebug.com/wiki/index.php/Command_Line_API
-          // dirxml, $$ ... and console.table are defined by firebug
-          // but only console.table is available from js (not in console)
-          // because table method is probably added to the regular console
+          // note: console.table used to be exclusive to firebug,
+          // but it is now only implemented by most modern browsers
         /*jshint evil:true */
         .eval('console.table').then(function(res) {
           expect(res).to.contain('function');