Replaced xmlResult.php by jsonResult.php WPT API endpoint for fetching test results

Author: marcelduran

README.md

@@ -670,6 +670,7 @@ $ npm test
 
 ## Changelog
 
+* 0.3.0: Replaced xmlResult.php by jsonResult.php WPT API endpoint for fetching test results
 * 0.2.5: Added test options: custom, chrometrace, callstack, tester; Added chrometrace command (`getChromeTraceData` method)
 * 0.2.4: Added test options: clearcerts, medianvideo, datareduction, useragent and tsview; HTTPS support to listen/proxy server
 * 0.2.3: Updated DevTools Timeline API url endpoint for timeline command

lib/specs.js

@@ -108,8 +108,7 @@ function specsRunner(specs, reporter, callback, err, data) {
       path = [];
 
   // bail if test not complete
-  if (!err && (!data || data && data.response &&
-      data.response.statusCode !== 200)) {
+  if (!err && (!data || data.statusCode !== 200)) {
     return callback(err, data);
   }
 
@@ -141,15 +140,15 @@ function specsRunner(specs, reporter, callback, err, data) {
   // error handling
   if (specs instanceof Error) {
     err = err || specs;
-  } else if (!(data && data.response && data.response.data)) {
+  } else if (!(data && data.data)) {
     err = err || new Error('no data');
   }
 
   if (err) {
     tests.push({text: err.message, result: err});
   } else {
     defaults = specs.defaults || {};
-    traverse(specs, data.response.data);
+    traverse(specs, data.data);
   }
 
   // run mocha suite

lib/webpagetest.js

@@ -21,7 +21,7 @@ var reSpace = /\s/,
 
 var paths = {
   testStatus: 'testStatus.php',
-  testResults: 'xmlResult.php',
+  testResults: 'jsonResult.php',
   locations: 'getLocations.php',
   testers: 'getTesters.php',
   test: 'runtest.php',
@@ -404,7 +404,7 @@ function runTest(what, options, callback) {
 
   // poll results
   if (options.pollResults && !options.dryRun) {
-    options.pollResults = (parseInt(options.pollResults, 10) || 5) * 1000;
+    options.pollResults = parseInt(options.pollResults * 1000, 10) || 5000;
 
     return api.call(this, paths.test, testCallback.bind(this, poll),
       query, options);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpagetest",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "WebPageTest API wrapper for NodeJS",
   "author": "Marcel Duran <github@marcelduran.com> (http://github.com/marcelduran)",
   "homepage": "http://github.com/marcelduran/webpagetest-api",
@@ -34,12 +34,12 @@
   },
   "dependencies": {
     "commander": "~2.3.0",
-    "csv": "~0.4.0",
+    "csv": "~0.4.1",
     "entities": "~1.1.1",
     "mocha": "~1.21.4",
     "xml2js": "~0.4.4"
   },
   "devDependencies": {
-    "nock": "~0.48.0"
+    "nock": "~0.48.2"
   }
 }

test/command-line-test.js

@@ -41,7 +41,7 @@ describe('WebPageTest Command Line', function() {
     exec(mock('results 120816_V2_2'), function(err, data) {
       if (err) return done(err);
       data = JSON.parse(data);
-      assert.equal(data.url, wptServer + 'xmlResult.php?test=120816_V2_2');
+      assert.equal(data.url, wptServer + 'jsonResult.php?test=120816_V2_2');
       done();
     });
   });
@@ -51,17 +51,17 @@ describe('WebPageTest Command Line', function() {
       if (err) return done(err);
       data = JSON.parse(data);
       assert.equal(data.url, wptServer +
-        'xmlResult.php?test=120816_V2_2&medianMetric=TTFB');
+        'jsonResult.php?test=120816_V2_2&medianMetric=TTFB');
       done();
     });
   });
 
   it('gets a test results with extra data input returns the API url', function(done) {
-    exec(mock('results 130724_YD_8JX -bDpR'), function(err, data) {
+    exec(mock('results 141106_8N_ZRC -bDpR'), function(err, data) {
       if (err) return done(err);
       data = JSON.parse(data);
         assert.equal(data.url, wptServer +
-          'xmlResult.php?test=130724_YD_8JX&breakdown=1&domains=1&pagespeed=1&requests=1');
+          'jsonResult.php?test=141106_8N_ZRC&breakdown=1&domains=1&pagespeed=1&requests=1');
       done();
     });
   });
@@ -328,7 +328,7 @@ describe('WebPageTest Command Line', function() {
       if (err) return done(err);
       data = JSON.parse(data);
       assert.equal(data[0].url, wptServer + 'testStatus.php?test=120816_V2_2');
-      assert.equal(data[1].url, wptServer + 'xmlResult.php?test=120816_V2_2');
+      assert.equal(data[1].url, wptServer + 'jsonResult.php?test=120816_V2_2');
       done();
     });
   });

test/dryrun-test.js

@@ -36,7 +36,7 @@ describe('Dry Run', function() {
     it('gets a test results request', function(done) {
       wpt.getTestResults('120816_V2_2', {dryRun: true}, function (err, data) {
         if (err) return done(err);
-        assert.equal(data.url, wptServer + 'xmlResult.php?test=120816_V2_2');
+        assert.equal(data.url, wptServer + 'jsonResult.php?test=120816_V2_2');
         done();
       });
     });
@@ -47,7 +47,7 @@ describe('Dry Run', function() {
         dryRun: true
       }, function (err, data) {
         if (err) return done(err);
-        assert.equal(data.url, wptServer + 'xmlResult.php?test=120816_V2_2&r=12345');
+        assert.equal(data.url, wptServer + 'jsonResult.php?test=120816_V2_2&r=12345');
         done();
       });
     });
@@ -59,13 +59,13 @@ describe('Dry Run', function() {
         }, function (err, data) {
         if (err) return done(err);
         assert.equal(data.url, wptServer +
-          'xmlResult.php?test=120816_V2_2&medianMetric=TTFB');
+          'jsonResult.php?test=120816_V2_2&medianMetric=TTFB');
         done();
       });
     });
 
     it('gets a test results with extra data request', function(done) {
-      wpt.getTestResults('130724_YD_8JX', {
+      wpt.getTestResults('141106_8N_ZRC', {
         breakDown: true,
         domains: true,
         pageSpeed: true,
@@ -74,7 +74,7 @@ describe('Dry Run', function() {
       }, function (err, data) {
         if (err) return done(err);
         assert.equal(data.url, wptServer +
-          'xmlResult.php?test=130724_YD_8JX&breakdown=1&domains=1&pagespeed=1&requests=1');
+          'jsonResult.php?test=141106_8N_ZRC&breakdown=1&domains=1&pagespeed=1&requests=1');
         done();
       });
     });

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

@@ -14,7 +14,7 @@
     -L, --label <label>           label for the test
     -i, --onload                  stop test at document complete. typically, tests run until all activity stops
     -S, --noscript                disable javascript (IE, Chrome, Firefox)
-    -C, --clearcerts              clear SSL cetificate caches
+    -C, --clearcerts              clear SSL certificate caches
     -R, --ignoressl               ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
     -T, --standards               forces all pages to load in standards mode (IE only)
     -u, --tcpdump                 capture network packet trace (tcpdump)

test/fixtures/command-line/help.txt

@@ -22,7 +22,7 @@
        cancel running/pending test
 
     har <id>
-       get the HTTPS Archive (HAR) from test
+       get the HTTP Archive (HAR) from test
 
     pagespeed [options] <id>
        get the Google Page Speed results (if available) from test