Add Image Optimization rule to the dashbard

test/core/imageOptimizerTest.js

@@ -6,7 +6,7 @@ var path = require('path');
 describe('imageOptimizer', function() {
     
     it('should optimize a JPEG image losslessly', function(done) {
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/jpeg-image.jpg'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/jpeg-image.jpg'));
 
         var fileSize = fileContent.length;
 
@@ -20,7 +20,7 @@ describe('imageOptimizer', function() {
     });
 
     it('should optimize a JPEG image lossly', function(done) {
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/jpeg-image.jpg'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/jpeg-image.jpg'));
 
         var fileSize = fileContent.length;
 
@@ -34,7 +34,7 @@ describe('imageOptimizer', function() {
     });
 
     it('should find the best optimization for a jpeg', function(done) {
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/jpeg-image.jpg'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/jpeg-image.jpg'));
         var fileSize = fileContent.length;
 
         var entry = {
@@ -77,7 +77,7 @@ describe('imageOptimizer', function() {
     });
 
     it('should optimize a PNG image losslessly', function(done) {
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/png-image.png'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/png-image.png'));
 
         var fileSize = fileContent.length;
 
@@ -90,8 +90,36 @@ describe('imageOptimizer', function() {
         });
     });
 
+    it('should fail to optimize an already optimized PNG', function(done) {
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/logo-large.png'));
+
+        var fileSize = fileContent.length;
+
+        imageOptimizer.compressPngLosslessly(fileContent).then(function(newFile) {
+            var newFileSize = newFile.contents.length;
+            newFileSize.should.equal(fileSize);
+            done();
+        }).fail(function(err) {
+            done(err);
+        });
+    });
+
+    it('should fail to optimize a non-PNG', function(done) {
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/svg-image.svg'));
+
+        var fileSize = fileContent.length;
+
+        imageOptimizer.compressPngLosslessly(fileContent).then(function(newFile) {
+            var newFileSize = newFile.contents.length;
+            newFileSize.should.equal(fileSize);
+            done();
+        }).fail(function(err) {
+            done(err);
+        });
+    });
+
     it('should optimize a png', function(done) {
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/png-image.png'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/png-image.png'));
         var fileSize = fileContent.length;
 
         var entry = {
@@ -132,9 +160,8 @@ describe('imageOptimizer', function() {
         });
     });
 
-
     it('should optimize an SVG image losslessly', function(done) {
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/svg-image.svg'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/svg-image.svg'));
 
         var fileSize = fileContent.length;
 
@@ -148,7 +175,7 @@ describe('imageOptimizer', function() {
     });
 
     it('should optimize an SVG', function(done) {
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/svg-image.svg'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/svg-image.svg'));
         var fileSize = fileContent.length;
 
         var entry = {
@@ -194,7 +221,7 @@ describe('imageOptimizer', function() {
 
         // In this test, we try to optimize a PNG but with a falsy "image/jpeg" content type
 
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/png-image.png'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/png-image.png'));
         var fileSize = fileContent.length;
 
         var entry = {
@@ -237,7 +264,7 @@ describe('imageOptimizer', function() {
 
         // In this test, we try to optimize a JPEG but with a falsy "image/png" content type
 
-        var fileContent = fs.readFileSync(path.resolve(__dirname, '../fixtures/jpeg-image.jpg'));
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/jpeg-image.jpg'));
         var fileSize = fileContent.length;
 
         var entry = {
@@ -276,4 +303,15 @@ describe('imageOptimizer', function() {
         });
     });
 
+    it('should determine if gain is enough', function() {
+        imageOptimizer.gainIsEnough(20000, 10000).should.equal(true);
+        imageOptimizer.gainIsEnough(2000, 1000).should.equal(true);
+        imageOptimizer.gainIsEnough(20000, 21000).should.equal(false);
+        imageOptimizer.gainIsEnough(20000, 40000).should.equal(false);
+        imageOptimizer.gainIsEnough(20000, 19500).should.equal(false);
+        imageOptimizer.gainIsEnough(200, 100).should.equal(true);
+        imageOptimizer.gainIsEnough(2000, 1900).should.equal(false);
+        imageOptimizer.gainIsEnough(200000, 197000).should.equal(true);
+    });
+
 });

test/core/weightCheckerTest.js

@@ -1,5 +1,7 @@
 var should = require('chai').should();
 var weightChecker = require('../../lib/tools/weightChecker/weightChecker');
+var fs = require('fs');
+var path = require('path');
 
 describe('weightChecker', function() {
     
@@ -14,7 +16,8 @@ describe('weightChecker', function() {
                    Accept: '*/*'
                 },
                 status: 200,
-                isHTML: true
+                isHTML: true,
+                type: 'html'
             },
             {
                 method: 'GET',
@@ -25,7 +28,34 @@ describe('weightChecker', function() {
                    Accept: '*/*'
                 },
                 status: 200,
-                isJS: true
+                isJS: true,
+                type: 'js'
+            },
+            {
+                method: 'GET',
+                url: 'http://localhost:8388/jpeg-image.jpg',
+                requestHeaders: {
+                    'User-Agent': 'something',
+                   Referer: 'http://www.google.fr/',
+                   Accept: '*/*'
+                },
+                status: 200,
+                isImage: true,
+                type: 'image',
+                contentType: 'image/jpeg'
+            },
+            {
+                method: 'GET',
+                url: 'http://localhost:8388/svg-image.svg',
+                requestHeaders: {
+                    'User-Agent': 'something',
+                   Referer: 'http://www.google.fr/',
+                   Accept: '*/*'
+                },
+                status: 200,
+                isImage: true,
+                type: 'image',
+                contentType: 'image/svg+xml'
             }
         ];
 
@@ -48,6 +78,18 @@ describe('weightChecker', function() {
             data.toolsResults.should.have.a.property('weightChecker');
             data.toolsResults.weightChecker.should.have.a.property('metrics');
             data.toolsResults.weightChecker.should.have.a.property('offenders');
+
+            data.toolsResults.weightChecker.offenders.should.have.a.property('totalWeight');
+            data.toolsResults.weightChecker.offenders.totalWeight.totalWeight.should.be.above(0);
+            data.toolsResults.weightChecker.offenders.totalWeight.byType.html.requests.length.should.equal(1);
+            data.toolsResults.weightChecker.offenders.totalWeight.byType.js.requests.length.should.equal(1);
+            data.toolsResults.weightChecker.offenders.totalWeight.byType.image.requests.length.should.equal(2);
+
+            data.toolsResults.weightChecker.offenders.should.have.a.property('imageOptimization');
+            data.toolsResults.weightChecker.offenders.imageOptimization.totalGain.should.be.above(0);
+            data.toolsResults.weightChecker.offenders.imageOptimization.byType.jpeg.requests.length.should.equal(1);
+            data.toolsResults.weightChecker.offenders.imageOptimization.byType.svg.requests.length.should.equal(1);
+
             done();
         })
 
@@ -77,7 +119,7 @@ describe('weightChecker', function() {
             newEntry.weightCheck.uncompressedSize.should.equal(newEntry.weightCheck.bodySize);
             newEntry.weightCheck.isCompressed.should.equal(false);
             newEntry.weightCheck.headersSize.should.be.above(200).and.below(400);
-            newEntry.weightCheck.body.should.have.string('1.8.3');
+            newEntry.weightCheck.body.toString().should.have.string('1.8.3');
 
             done();
         })
@@ -87,6 +129,45 @@ describe('weightChecker', function() {
         });
     });
 
+    it('should download a PNG image and find the same body as fs.readFile', function(done) {
+        var fileContent = fs.readFileSync(path.resolve(__dirname, '../www/logo-large.png'));
+
+        var entry = {
+            method: 'GET',
+            url: 'http://localhost:8388/logo-large.png',
+            requestHeaders: {
+                'User-Agent': 'something',
+               Referer: 'http://www.google.fr/',
+               Accept: '*/*'
+            },
+            status: 200,
+            isImage: true,
+            contentType: 'image/png'
+        };
+
+        weightChecker.redownloadEntry(entry)
+
+        .then(function(newEntry) {
+
+            newEntry.weightCheck.bodySize.should.equal(4193);
+            newEntry.weightCheck.body.should.equal(fileContent.toString('binary'));
+
+            // Opening the image in lwip to check if the format is good
+            var lwip = require('lwip');
+            var buffer = new Buffer(newEntry.weightCheck.body, 'binary');
+            lwip.open(buffer, 'png', function(err, image) {
+                image.width().should.equal(620);
+                image.height().should.equal(104);
+                done(err);
+            });
+            
+        })
+
+        .fail(function(err) {
+            done(err);
+        });
+    });
+
     it('should fail downloading a file in error', function(done) {
         var entry = {
             method: 'GET',
@@ -103,7 +184,7 @@ describe('weightChecker', function() {
 
         weightChecker.redownloadEntry(entry)
 
-        .then(function(errnewEntry) {
+        .then(function(newEntry) {
             newEntry.weightCheck.should.have.a.property('message').that.equals('error while downloading: 404');
 
             done();