added response body

Author: marcelduran

README.md

@@ -53,6 +53,7 @@ $ webpagetest --help
 * **testinfo** _\<id\>_: get test request info/details
 * **history** _[days]_: get history of previously run tests
 * **googlecsi** _[options] \<id\>_: get Google CSI data (Client Side Instrumentation)
+* **response** _[options] \<id\>_: get response body for text resources
 * **waterfall** _[options] \<id\>_: get the waterfall PNG image
 * **screenshot** _[options] \<id\>_: get the fully loaded page screenshot in JPG format (PNG if in full resolution)
 * **video** _[options] \<tests\>_: create a video from _\<tests\>_ (comma separated test ids)
@@ -135,7 +136,7 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
 * **-S, --specs** _\<json_or_file\>_: set the specs for performance test suite
 * **-r, --reporter** _\<name\>_: set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity
 
-#### Run (works for **pagespeed**, **utilization**, **request**, **timeline**, **netlog**, **console**, **googlecsi**, **waterfall** and **screenshot** commands)
+#### Run (works for **pagespeed**, **utilization**, **request**, **timeline**, **netlog**, **console**, **googlecsi**, **response**, **waterfall** and **screenshot** commands)
 * **-r, --run** _\<number\>_: which run number on a multiple runs test [1]
 * **-c, --cached**: get the Repeat View (cached view) instead of default First View (primed cache)
 
@@ -162,6 +163,9 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
 #### Video (works for **video** command only)
 * **-e, --end** _\<end_point\>_: frame comparison end point: [visual]=visually complete | all=last change | doc=document complete | full=fully loaded
 
+#### Response (works for **response** command only)
+* **-R, --request** _\<number\>_: the request number [1]
+
 ### Examples
 #### 1. Get available locations
 ```bash
@@ -326,6 +330,7 @@ Methods and options (including the one letter shorthands) are the same when usin
 * `getTestInfo(id, options, callback)`
 * `getHistory(days, options, callback)`
 * `getGoogleCsiData(id, options, callback)`
+* `getResponseBody(id, options, callback)`
 * `getWaterfallImage(id, options, callback)`
 * `getScreenshotImage(id, options, callback)`
 * `createVideo(tests, options, callback)`
@@ -440,7 +445,7 @@ wpt.runTest(script, function(err, data) {
 * **specs**: _String_, set the specs for performance test suite
 * **reporter**: _String_, set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity
 
-#### Run (works for `getPageSpeedData`, `getUtilizationData`, `getRequestData`, `getTimelineData`, `getNetLogData`, `getConsoleLogData`, `getGoogleCsiData`, `getWaterfallImage` and `getScreenshotImage` methods)
+#### Run (works for `getPageSpeedData`, `getUtilizationData`, `getRequestData`, `getTimelineData`, `getNetLogData`, `getConsoleLogData`, `getGoogleCsiData`, `getResponseBody`, `getWaterfallImage` and `getScreenshotImage` methods)
 * **run**: _Number_, the test run number for multiple runs tests (default: 1, first test)
 * **repeatView**: _Boolean_, if `true` returns the repeat view (cached) data
 
@@ -467,6 +472,9 @@ wpt.runTest(script, function(err, data) {
 #### Video (works for `createVideo` method only)
 * **comparisonEndPoint** _String_: frame comparison end point: [visual]=visually complete | all=last change | doc=document complete | full=fully loaded
 
+#### Response (works for `getResponseBody` method only)
+* **request** _Number_: the request number [1]
+
 ### Examples
 
 #### 1. Instantiating
@@ -625,6 +633,7 @@ $ npm test
 
 ## Changelog
 
+* 0.2.2: Added response body command/method
 * 0.2.1: Added history, video, player, googleCsi commands and continuous option 
 * 0.2.0: Replaced jsonml by xml2js dependency
 * 0.1.3: Test results extra data (breakdown, domains, requests, pagespeed)

lib/mapping.js

@@ -556,6 +556,15 @@ var options = {
       info: 'frame comparison end point: [visual]=visually complete | all=last change | doc=document complete | full=fully loaded',
       valid: /^(?:visual|all|doc|full)$/
     }
+  },
+  'response': {
+    'request': {
+      name: 'request',
+      api: 'request',
+      key: 'R',
+      param: 'number',
+      info: 'the request number [1]'
+    }
   }
 };
 
@@ -653,6 +662,12 @@ var commands = {
     options: [options.run],
     info: 'get Google CSI data (Client Side Instrumentation)'
   },
+  'response': {
+    name: 'getResponseBody',
+    param: 'id',
+    options: [options.run, options.response],
+    info: 'get response body for text resources'
+  },
   'waterfall': {
     name: 'getWaterfallImage',
     param: 'id',

lib/webpagetest.js

@@ -33,7 +33,8 @@ var paths = {
   history: 'testlog.php',
   videoCreation: 'video/create.php',
   videoView: 'video/view.php',
-  googleCsi: 'google/google_csi.php'
+  googleCsi: 'google/google_csi.php',
+  responseBody: 'response_body.php'
 };
 
 var filenames = {
@@ -184,6 +185,8 @@ function api(pathname, callback, query, options) {
                 asyncParserCallback.bind(callback, options));
             } else if (info.type === 'text/html') {
               data = {result: (reHTMLOutput.exec(data) || [])[1]};
+            } else if (info.type === 'text/plain') {
+              data = {result: data.toString()};
             }
           }
         } catch (ex) {
@@ -565,6 +568,20 @@ function getGoogleCsiData(id, options, callback) {
   return api.call(this, paths.googleCsi, callback, query, options);
 }
 
+function getResponseBody(id, options, callback) {
+  var query;
+
+  callback = callback || options;
+  options = options === callback ? {} : options;
+  options.args = options.args || {
+    type: 'text/plain'
+  };
+  query = setFilename({test: id}, options);
+  query.request = options.request || 1;
+
+  return api.call(this, paths.responseBody, callback, query, options);
+}
+
 function getWaterfallImage(id, options, callback) {
   var query,
       pathname = paths.waterfall;
@@ -707,6 +724,7 @@ WebPageTest.prototype = {
   getWaterfallImage: getWaterfallImage,
   getScreenshotImage: getScreenshotImage,
   getGoogleCsiData: getGoogleCsiData,
+  getResponseBody: getResponseBody,
   getEmbedVideoPlayer: getEmbedVideoPlayer,
   createVideo: createVideo,
   scriptToString: WebPageTest.scriptToString,
@@ -729,6 +747,7 @@ WebPageTest.prototype = {
   testinfo: getTestInfo,
   history: getHistory,
   googlecsi: getGoogleCsiData,
+  response: getResponseBody,
   player: getEmbedVideoPlayer,
   video: createVideo,
   waterfall: getWaterfallImage,

test/dryrun-test.js

@@ -409,5 +409,26 @@ describe('Dry Run', function() {
       });
     });
 
+    it('get response body for first run first request', function(done) {
+      wpt.getResponseBody('140101_AB_12', {dryRun: true}, function(err, data) {
+        if (err) throw err;
+        assert.equal(data.url, wptServer + 'response_body.php?test=140101_AB_12&run=1&cached=0&request=1');
+        done();
+      });
+    });
+
+    it('get response body for cached 3rd run 5th request', function(done) {
+      wpt.getResponseBody('140101_AB_12', {
+        dryRun: true,
+        repeatView: true,
+        run: 3,
+        request: 5
+      }, function(err, data) {
+        if (err) throw err;
+        assert.equal(data.url, wptServer + 'response_body.php?test=140101_AB_12&run=3&cached=1&request=5');
+        done();
+      });
+    });
+
   });
 });

test/fixtures/command-line/help-response.txt

@@ -0,0 +1,10 @@
+
+  Usage: response [options] <id>
+
+  Options:
+
+    -h, --help              output usage information
+    -r, --run <number>      which run number on a multiple runs test [1]
+    -c, --cached            get the Repeat View (cached view) instead of default First View (primed cache)
+    -R, --request <number>  the request number [1]
+

test/fixtures/command-line/help.txt

@@ -19,6 +19,7 @@
     testinfo <id>          get test request info/details
     history [days]         get history of previously run tests
     googlecsi [options] <id> get Google CSI data (Client Side Instrumentation)
+    response [options] <id> get response body for text resources
     waterfall [options] <id> get the waterfall PNG image
     screenshot [options] <id> get the fully loaded page screenshot in JPG format (PNG if in full resolution)
     video [options] <tests> create a video from <tests> (comma separated test ids)

test/fixtures/objects/response.json

@@ -0,0 +1,6 @@
+{
+  "type": "text/plain",
+  "data": {
+    "result": "foobar"
+  }
+}

test/fixtures/responses/response.txt

@@ -0,0 +1 @@
+foobar

test/helpers/nock-server.js

@@ -38,6 +38,7 @@ var reqResMap = {
   '/video/view.php?embed=1&id=130416_36ed6e37013655a14b2b857cdccec99db72adcaa': 'embeddedVideoPlayer.html',
   '/google/google_csi.php?test=140101_AB_12': 'googleCsiData.csv',
   '/google/google_csi.php?test=140101_AB_12&run=2': 'googleCsiDataRun2.csv',
+  '/response_body.php?test=140101_AB_12&run=1&cached=0&request=1': 'response.txt',
 
   // test results for multi runs with/without custom median metric
   '/xmlResult.php?test=130619_KK_6A2': 'testResultsMultiRunsDefaultMedianMetric.xml',

test/nock-test.js

@@ -287,6 +287,14 @@ describe('Example WebPageTest', function() {
       });
     });
 
+    it('gets response body', function(done) {
+      wpt.getResponseBody('140101_AB_12', function(err, data) {
+        if (err) throw err;
+        assert.deepEqual(data.result.trim(), ResponseObjects.response.data.result);
+        done();
+      });
+    });
+
     // not found / invalid
 
     it('gets an invalid test status request then returns a not found test status object', function(done) {