Add option 'errorIfStatusIsNot200'.

Author: amyboyd

README.md

@@ -175,6 +175,11 @@ the callback in a call to webshot.
       <td>Wait for the web page to signal to webshot when to take the photo
       using <code>window.callPhantom('takeShot');</code></td>
     </tr>
+    <tr>
+      <th>errorIfStatusIsNot200</th>
+      <td>false</td>
+      <td>If the loaded page has a non-200 status code, don't take a screenshot, cause an error instead.</td>
+    </tr>
   </tbody>
 </table>
 

lib/options.js

@@ -20,6 +20,7 @@ exports.phantom = {
 , siteType: 'url'
 , renderDelay: 0
 , quality: 75
+, errorIfStatusIsNot200: false
 };
 
 // Options that are just passed to the phantom page object

lib/webshot.js

@@ -232,6 +232,12 @@ function spawnPhantom(site, path, streaming, options, cb) {
       s.emit('data', new Buffer(''+data, 'base64'));
     });
 
+    phantomProc.stderr.on('data', function(data) {
+      clearTimeout(timeoutID);
+      cb(new Error(data));
+      this.kill();
+    });
+
     phantomProc.on('exit', function() {
       s.emit('end');
       this.kill();

lib/webshot.phantom.js

@@ -9,6 +9,12 @@ var path = system.args.length == 4 ? null : system.args[2];
 var streaming = ((system.args.length == 4 ? system.args[2] : system.args[3]) === 'true');
 var options = JSON.parse(system.args.length == 4 ? system.args[3] : system.args[4]);
 
+var failToStderr = function(message) {
+    system.stderr.write(message);
+    page.close();
+    phantom.exit(1);
+};
+
 page.viewportSize = {
   width: options.windowSize.width
 , height: options.windowSize.height
@@ -17,6 +23,16 @@ page.viewportSize = {
 // Capture JS errors and ignore them
 page.onError = function(msg, trace) {};
 
+if (options.errorIfStatusIsNot200) {
+  page.onResourceReceived = function(response) {
+    // If request to the page is not 200 status, fail.
+    if (response.url === site && response.status !== 200) {
+        failToStderr('Status must be 200; is ' + response.status);
+        return;
+    }
+  };
+}
+
 // Register user-provided callbacks
 optUtils.phantomCallback.forEach(function(cbName) {
   var cb = options[cbName];

test/tests.js

@@ -409,6 +409,35 @@ describe('Handling miscellaneous options', function() {
       });
     });
   });
+
+  it('screenshots a non-200 page status if errorIfStatusIsNot200 not set', function(done) {
+    var options = {
+    };
+
+    this.timeout(20000);
+
+    webshot('google.com/404-page-for-webshot-tests', testPNG, options, function(err) {
+      fs.exists(testPNG, function(exists) {
+        exists.should.equal(true);
+        done();
+      });
+    });
+  });
+
+  it('errors on non-200 page status if errorIfStatusIsNot200 set', function(done) {
+    var options = {
+      errorIfStatusIsNot200: true
+    };
+
+    this.timeout(20000);
+
+    webshot('google.com/404-page-for-webshot-tests', testPNG, options, function(err) {
+      fs.exists(testPNG, function(exists) {
+        exists.should.equal(false);
+        done();
+      });
+    });
+  });
 });
 
 afterEach(function(done) {