Full bluebird conversion.

Author: STRML

.eslintrc

@@ -0,0 +1,27 @@
+{
+  // "parser": "babel-eslint",
+  "root": true,
+  "extends": "eslint:recommended",
+  "rules": {
+    "strict": 0,
+    "quotes": [0, "single"],
+    "comma-dangle": 0,
+    "curly": [1, "multi-line"],
+    "no-console": 0,
+    "no-use-before-define": [1, "nofunc"],
+    "no-unused-vars": [1, {
+      "vars": "local",
+      "varsIgnorePattern": "^_"
+    }],
+    "no-underscore-dangle": 0,
+    "new-cap": 0,
+    "consistent-return": 0,
+    "camelcase": 0,
+    "dot-notation": 0,
+    "semi": [1, "always"],
+  },
+  env: {
+    // "es6": true,
+    "node": true
+  }
+}

lib/asyncCallback.js

@@ -4,19 +4,20 @@
  * run workflow again or execute callback function
  */
 
-var workflow = require('./workflow.js');
 var endSession = require('./endSession.js');
 var Promise = require('bluebird');
 
 module.exports = function(err) {
+    var workflow = require('./workflow');
+    var ctx = this;
+
     /**
      * if error occured don't do another shot (if multiple screen width are set)
      */
     /*istanbul ignore next*/
     if (err) return Promise.reject(err);
     return Promise.try(function() {
 
-        var ctx = this;
 
         /**
          * on multiple screenWidth or multiple page elements

lib/compareImages.js

@@ -5,9 +5,11 @@
  */
 
 var resemble = require('node-resemble-js');
+var Promise = require('bluebird');
 
 module.exports = function() {
 
+    var ctx = this;
     /**
      * need to find done function because gm doesn't have node like callbacks (err,res)
      */
@@ -17,19 +19,19 @@ module.exports = function() {
         /**
          * if there is no need for image comparison or no images gets saved on fs, just continue
          */
-        if(!this.isComparable || !this.self.saveImages) {
+        if(!ctx.isComparable || !ctx.self.saveImages) {
             return;
         }
 
         /**
          * compare images
          */
-        var diff = resemble(this.baselinePath).compareTo(this.regressionPath);
+        var diff = resemble(ctx.baselinePath).compareTo(ctx.regressionPath);
 
         /**
          * map 'ignore' configuration to resemble options
          */
-        var ignore = this.currentArgs.ignore || "";
+        var ignore = ctx.currentArgs.ignore || "";
         if (ignore.indexOf("color") === 0) {
             diff.ignoreColors();
         } else if (ignore.indexOf("antialias") === 0) {
@@ -39,8 +41,10 @@ module.exports = function() {
         /**
          * execute the comparison
          */
-        return Promise.fromCallback(function(cb) {
-            diff.onComplete(cb.bind(null,null));
+        return new Promise(function(resolve, reject) {
+            diff.onComplete(function(res) { // this callback has bad arity
+                resolve(res);
+            });
         });
     })
     .nodeify(done);

lib/cropImage.js

@@ -14,15 +14,15 @@ module.exports = function(res, done) {
 
     var ctx = this;
     var excludeRect = res.excludeRect;
-    var shot = gm(this.screenshot).quality(100);
+    var shot = gm(ctx.screenshot).quality(100);
     var cropDim;
 
     return Promise.try(function() {
 
-        var x = parseInt(this.currentArgs.x, 10);
-        var y = parseInt(this.currentArgs.y, 10);
-        var width = parseInt(this.currentArgs.width, 10);
-        var height = parseInt(this.currentArgs.height, 10);
+        var x = parseInt(ctx.currentArgs.x, 10);
+        var y = parseInt(ctx.currentArgs.y, 10);
+        var width = parseInt(ctx.currentArgs.width, 10);
+        var height = parseInt(ctx.currentArgs.height, 10);
 
         if (!isNaN(x) && !isNaN(y) && !isNaN(width) && !isNaN(height)) {
 
@@ -59,12 +59,13 @@ module.exports = function(res, done) {
         }
     })
     .then(function() {
-        if (!ctx.self.saveImages) return;
-
-        /**
-         * save image to fs
-         */
-        return shot.writeAsync(ctx.filename || ctx.baselinePath)
+        return Promise.try(function() {
+            if (!ctx.self.saveImages) return;
+            /**
+             * save image to fs
+             */
+            return shot.writeAsync(ctx.filename || ctx.baselinePath);
+        })
         .then(function() {
             /**
              * generate image buffer

lib/documentScreenshot.js

@@ -83,7 +83,7 @@ module.exports = function documentScreenshot(fileName, cb) {
         function takeScreenshot() {
 
             // Take screenshot
-            return self.screenshot.bind(self)
+            return self.screenshot.call(self)
             // Cache image into tmp dir
             .then(function cacheImage(res) {
                 var file = tmpDir + '/' + currentXPos + '-' + currentYPos + '.png';
@@ -162,11 +162,9 @@ module.exports = function documentScreenshot(fileName, cb) {
      * crop screenshot regarding page size
      */
     .then(function cropScreenshot() {
-        return Promise.fromCallback(function(cb) {
-            gm(fileName)
-            .crop(response.execute[0].value.documentWidth, response.execute[0].value.documentHeight, 0, 0)
-            .write(fileName, cb);
-        });
+        return gm(fileName)
+        .crop(response.execute[0].value.documentWidth, response.execute[0].value.documentHeight, 0, 0)
+        .writeAsync(fileName);
     })
     /*!
      * remove tmp dir

lib/endSession.js

@@ -6,46 +6,47 @@ var request = Promise.promisify(require('request'), {multiArgs: true});
 
 module.exports = function(done) {
 
-    var that = this;
+    var ctx = this;
 
     return Promise.try(function setOriginalResolution() {
         /**
          * if screenwidth was set, get back to old resolution
          */
-        if (!that.self.defaultScreenDimension) return;
+        if (!ctx.self.defaultScreenDimension) return;
 
-        return that.instance.windowHandleSize({
-            width: that.self.defaultScreenDimension.width,
-            height: that.self.defaultScreenDimension.height
+        return ctx.instance.windowHandleSize({
+            width: ctx.self.defaultScreenDimension.width,
+            height: ctx.self.defaultScreenDimension.height
         });
     })
     /**
      * If we have an applitools session open, close it
      */
     .then(function closeApplitools() {
-        if (!that.self.usesApplitools) return;
+        if (!ctx.self.usesApplitools) return;
 
         // Whether or not we should automatically save this test as baseline.
-        var updateBaseline = (that.self.isNew && that.applitools.saveNewTests) ||
-                             (!that.self.isNew && that.applitools.saveFailedTests);
+        var updateBaseline = (ctx.self.isNew && ctx.applitools.saveNewTests) ||
+                             (!ctx.self.isNew && ctx.applitools.saveFailedTests);
 
         return request({
-            qs: {apiKey: that.applitools.apiKey, updateBaseline: updateBaseline},
-            url: that.self.host + '/api/sessions/running/' + that.self.sessionId,
+            qs: {apiKey: ctx.applitools.apiKey, updateBaseline: updateBaseline},
+            url: ctx.self.host + '/api/sessions/running/' + ctx.self.sessionId,
             method: 'DELETE',
-            headers: that.self.headers,
-            timeout: that.self.reqTimeout
+            headers: ctx.self.headers,
+            timeout: ctx.self.reqTimeout
+        })
+        .spread(function clearAndStore(res, body) {
+            if (!body) return;
+
+            ctx.self.resultObject[ctx.currentArgs.name] = merge({
+                id: ctx.self.sessionId,
+                url: ctx.self.url
+            }, JSON.parse(body));
+            ctx.self.url = undefined;
+            ctx.self.sessionId = undefined;
+            ctx.self.isNew = undefined;
         });
     })
-    .spread(function clearAndStore(res, body) {
-        if (!body) return;
-
-        that.self.resultObject[that.currentArgs.name] = merge({
-            id: that.self.sessionId,
-            url: that.self.url
-        }, JSON.parse(body));
-        that.self.url = undefined;
-        that.self.sessionId = undefined;
-        that.self.isNew = undefined;
-    }).nodeify(done);
+    .nodeify(done);
 };