Merge pull request #145 from abdulsuhail/issue-142-fix

added missing api parameters
catchpoint · Aug 11, 2021 · 5e68097 · 5e68097
2 parents 1b6c221 + efc2bb8
commit 5e68097
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,12 @@
 ## WebPageTest API Wrapper for NodeJS
 
-[![Build Status](https://secure.travis-ci.org/marcelduran/webpagetest-api.svg?branch=master)](https://travis-ci.org/marcelduran/webpagetest-api)
+[![Build Status](https://travis-ci.com/WebPageTest/webpagetest-api.svg?branch=master)](https://travis-ci.com/WebPageTest/webpagetest-api)
 [![NPM Version](https://img.shields.io/npm/v/webpagetest.svg?style=flat)](https://www.npmjs.org/package/webpagetest)
 [![NPM Downloads](https://img.shields.io/npm/dm/webpagetest.svg?style=flat)](https://www.npmjs.org/package/webpagetest)
-[![Dependencies Status](https://david-dm.org/marcelduran/webpagetest-api.svg)](https://david-dm.org/marcelduran/webpagetest-api)
+[![Dependencies Status](https://david-dm.org/WebPageTest/webpagetest-api.svg)](https://david-dm.org/WebPageTest/webpagetest-api)
+
+WebPageTest API Wrapper is a [NPM](https://npmjs.org) package that wraps [WebPageTest](https://github.com/WPO-Foundation/webpagetest) API for [NodeJS](https://nodejs.org) as a module and a command-line tool.
 
-[WebPageTest API Wrapper](https://marcelduran.com/webpagetest-api) is a [NPM](https://npmjs.org) package that wraps [WebPageTest](https://github.com/WPO-Foundation/webpagetest) API for [NodeJS](https://nodejs.org) as a module and a command-line tool.
 
 ## Getting started
 
@@ -17,7 +18,7 @@ $ npm install webpagetest -g
 
 ### Command line
 ```bash
-$ webpagetest test http://marcelduran.com/webpagetest-api
+$ webpagetest test https://docs.webpagetest.org/api/integrations/
 ```
 
 ### Docker
@@ -27,23 +28,19 @@ $ docker build -t webpagetest-api .
 ```
 #### Run
 ```bash
-$ docker run -it --rm webpagetest-api -k YOURAPIKEY test http://marcelduran.com/webpagetest-api
+$ docker run -it --rm webpagetest-api -k YOURAPIKEY test https://docs.webpagetest.org/api/integrations/
 ```
 
 ### Module
 ```javascript
 const WebPageTest = require('webpagetest');
 const wpt = new WebPageTest('www.webpagetest.org');
 
-wpt.runTest('http://marcelduran.com/webpagetest-api', (err, data) => {
+wpt.runTest('https://docs.webpagetest.org/api/integrations/', (err, data) => {
   console.log(err || data);
 });
 ```
 
-## API Console Demo
-
-[marcelduran.com/webpagetest-api](http://marcelduran.com/webpagetest-api/console/)
-
 ## Command Line
 
 ### Help
@@ -128,6 +125,18 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
 * **-B, --pingback** _\<url\>_: URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
 * **-D, --bwdown** _\<bandwidth\>_: download bandwidth in Kbps (used when specifying a custom connectivity profile)
 * **-U, --bwup** _\<bandwidth\>_: upload bandwidth in Kbps (used when specifying a custom connectivity profile)
+* **-bw, --browserwidth** _\<pixels\>_: Browser window width (in display pixels)
+* **-bh, --browserheight** _\<pixels\>_: Browser window height (in display pixels)
+* **-vh, --viewportheight** _\<pixels\>_: Viewport Height in css pixels
+* **-vw, --viewportwidth** _\<pixels\>_: Viewport Width in css pixels
+* **-dpr, --devicetopixelratio** _\<ratio\>_: Device To Pixel Ratio
+* **-au, --appendua** _\<string\>_: String to append to the user agent string. This is in addition to the default PTST/ver string
+* **-tt, --testtype** _\<string\>_: For running alternative test types, can specify traceroute or lighthouse
+* **-pr, --profiler** _\<number\>_: Set to 1 to enable the V8 sampling profiler (Chromium only)
+* **-avif, --disableAVIF** _\<number\>_: Set to 1 to disable AVIF support (Chromium 88+)
+* **-webp, --disableWEBP** _\<number\>_: Set to 1 to disable WEBP support (Chromium 88+)
+* **-jxl, --disableJXL** _\<number\>_: Set to 1 to disable JXL support (Chromium 88+)
+* **-dts, --dtShaper** _\<number\>_: Set to 1 to use Chrome's built-in traffic-shaping instead of the packet-level netem shaping usually used by the test agents
 * **-Y, --latency** _\<time\>_: first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
 * **-P, --plr** _\<percentage\>_: packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
 * **-z, --noopt**: disable optimization checks (for faster testing)
@@ -257,9 +266,9 @@ $ webpagetest locations --key 1F2A3K4E5
 }
 ```
 
-#### 3. Run test on http://marcelduran.com/webpagetest-api from San Jose on IE9
+#### 3. Run test on https://docs.webpagetest.org/api/integrations/ from San Jose on IE9
 ```bash
-$ webpagetest test http://marcelduran.com/webpagetest-api --key 1F2A3K4E5 --location SanJose_IE9
+$ webpagetest test https://docs.webpagetest.org/api/integrations/ --key 1F2A3K4E5 --location SanJose_IE9
 ```
 ```javascript
 {
@@ -307,7 +316,7 @@ $ webpagetest results 121025_PT_N8K
     "data": {
       "testId": "121025_PT_N8K",
       "summary": "https://www.webpagetest.org/result/121025_PT_N8K/",
-      "testUrl": "http://marcelduran.com/webpagetest-api",
+      "testUrl": "https://docs.webpagetest.org/api/integrations/",
       "location": "SanJose_IE9",
       "connectivity": "DSL",
       "bwDown": 1500, "bwUp": 384, "latency": 50, "plr": 0,
@@ -340,21 +349,21 @@ $ webpagetest waterfall 121025_PT_N8K --thumbnail --cached --uri
 }
 ```
 
-#### Run test on http://marcelduran.com/webpagetest-api and poll results every 5 seconds timing out in 60 seconds
+#### Run test on https://docs.webpagetest.org/api/integrations/ and poll results every 5 seconds timing out in 60 seconds
 ```bash
-$ webpagetest test http://marcelduran.com/webpagetest-api --poll 5 --timeout 60
+$ webpagetest test https://docs.webpagetest.org/api/integrations/ --poll 5 --timeout 60
 ```
-#### Or run test on http://marcelduran.com/webpagetest-api and wait for results listening on localhost\* port 8000\**
+#### Or run test on https://docs.webpagetest.org/api/integrations/ and wait for results listening on localhost\* port 8000\**
 ```bash
-$ webpagetest test http://marcelduran.com/webpagetest-api --wait 8000
+$ webpagetest test https://docs.webpagetest.org/api/integrations/ --wait 8000
 ```
 ```javascript
 {
   "response": {
     "statusCode": 200, "statusText": "Ok",
     "data": {
       "testId": "121025_PT_N8K",
-      "testUrl": "http://marcelduran.com/webpagetest-api",
+      "testUrl": "https://docs.webpagetest.org/api/integrations/",
       ...
       "median": {
         "firstView": {
@@ -484,6 +493,18 @@ wpt.runTest(script, (err, data) => {
 * **pingback**: _String_, URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
 * **bandwidthDown**: _String_, download bandwidth in Kbps (used when specifying a custom connectivity profile)
 * **bandwidthUp**: _String_, upload bandwidth in Kbps (used when specifying a custom connectivity profile)
+* **browserwidth**: _String_, Browser window width (in display pixels)
+* **browserheight**: _String_, Browser window height (in display pixels)
+* **viewportheight**: _String_, Viewport Height in css pixels
+* **viewportwidth**: _String_, Viewport Width in css pixels
+* **devicetopixelratio**: _String_, Device To Pixel Ratio
+* **appendua**: _String_, String to append to the user agent string. This is in addition to the default PTST/ver string
+* **testtype**: _String_, For running alternative test types, can specify traceroute or lighthouse
+* **profiler**: _Number_, Set to 1 to enable the V8 sampling profiler (Chromium only)
+* **disableAVIF**: _Number_, Set to 1 to disable AVIF support (Chromium 88+)
+* **disableWEBP**: _Number_, Set to 1 to disable WEBP support (Chromium 88+)
+* **disableJXL**: _Number_, Set to 1 to disable JpegXL support (Chromium 88+)
+* **dtShaper**: _Number_, Set to 1 to use Chrome's built-in traffic-shaping instead of the packet-level netem shaping usually used by the test agents
 * **latency**: _String_, first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
 * **packetLossRate**: _Number_, packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
 * **disableOptimization**: _Boolean_, disable optimization checks (for faster testing)
@@ -574,9 +595,9 @@ wpt.getLocations((err, data) => {
 });
 ```
 
-#### 3. Run test on http://marcelduran.com/webpagetest-api from San Jose on IE9
+#### 3. Run test on https://docs.webpagetest.org/api/integrations/ from San Jose on IE9
 ```javascript
-wpt.runTest('http://marcelduran.com/webpagetest-api', {location: 'SanJose_IE9'}, (err, data) => {
+wpt.runTest('https://docs.webpagetest.org/api/integrations/', {location: 'SanJose_IE9'}, (err, data) => {
   console.log(err || data);
 });
 ```
@@ -606,16 +627,16 @@ wpt.getWaterfallImage('121025_PT_N8K', {
 });
 ```
 
-#### Run test on http://marcelduran.com/webpagetest-api and poll results every 5 seconds timing out in 60 seconds
+#### Run test on https://docs.webpagetest.org/api/integrations/ and poll results every 5 seconds timing out in 60 seconds
 ```javascript
-wpt.runTest('http://marcelduran.com/webpagetest-api', {pollResults: 5, timeout: 60}, (err, data) => {
+wpt.runTest('https://docs.webpagetest.org/api/integrations/', {pollResults: 5, timeout: 60}, (err, data) => {
   console.log(err || data);
 });
 ```
 
-#### Or run test on http://marcelduran.com/webpagetest-api and wait results listening on localhost\* port 8000\*\*
+#### Or run test on https://docs.webpagetest.org/api/integrations/ and wait results listening on localhost\* port 8000\*\*
 ```javascript
-wpt.runTest('http://marcelduran.com/webpagetest-api', {waitResults: 'localhost:8000'}, (err, data) => {
+wpt.runTest('https://docs.webpagetest.org/api/integrations/', {waitResults: 'localhost:8000'}, (err, data) => {
   console.log(err || data);
 });
 ```
@@ -636,7 +657,7 @@ http://localhost:8080
 ```
 ```bash
 $ curl http://localhost:8080/help
-$ curl http://localhost:8080/test/marcelduran.com/?location=SanJose_IE9
+$ curl http://localhost:8080/test/webpagetest.org/?location=SanJose_IE9
 ```
 ```bash
 $ webpagetest listen 8443 --key key.pem --cert cert.pem --server wpt.foo.com
@@ -674,8 +695,8 @@ $ webpagetest batch commands.txt
 ```
 where `commands.txt` contains:
 ```
-test marcelduran.com --first --location foo
-test marcelduran.com --first --location bar
+test https://docs.webpagetest.org/api/integrations/ --first --location foo
+test https://docs.webpagetest.org/api/integrations/ --first --location bar
 ```
 It schedules the 2 tests above returning an array of size 2 in the same order as in `commands.txt` file:
 ```javascript
@@ -706,15 +727,15 @@ By running multiple sync tests, i.e. with either `--poll` or `--wait`, all tests
 
 `commands.txt`:
 ```
-test marcelduran.com --first --location foo --poll --timeout 60
-test marcelduran.com --first --location bar --poll --timeout 60
+test https://docs.webpagetest.org/api/integrations/ --first --location foo --poll --timeout 60
+test https://docs.webpagetest.org/api/integrations/ --first --location bar --poll --timeout 60
 ```
 
 ## Test Specs (Continuous Integration)
 
 WebPageTest API Wrapper provides a simple seamless way to integrate WebPageTest with Continuous Integration tools.
 
-[See dedicated page](https://github.com/marcelduran/webpagetest-api/wiki/Test-Specs)
+[See dedicated page](https://github.com/WebPageTest/webpagetest-api/wiki/Test-Specs)
 
 ## Tests
 ```bash
@@ -725,18 +746,18 @@ $ npm test
 
 Have a bug/feature request? Please create an issue here on GitHub!
 
-https://github.com/marcelduran/webpagetest-api/issues
+https://github.com/WebPageTest/webpagetest-api/issues
 
 ## Author
 
-**Marcel Duran**
+**WebPageTest**
 
-+ https://github.com/marcelduran
++ https://github.com/WebPageTest
 
 ## License
 
 Copyright 2013 Twitter Inc.
 Copyright 2020 Google Inc.
 Copyright 2020 Marcel Duran and other contributors
 
-Licensed under the [MIT License](https://github.com/marcelduran/webpagetest-api/raw/master/LICENSE)
+Licensed under the [MIT License](https://github.com/WebPageTest/webpagetest-api/raw/master/LICENSE)
diff --git a/lib/mapping.js b/lib/mapping.js
@@ -328,6 +328,91 @@ var options = {
       param: 'bandwidth',
       info: 'upload bandwidth in Kbps (used when specifying a custom connectivity profile)'
     },
+    'browserwidth': {
+      name: 'browserwidth',
+      key: 'bw',
+      api: 'browser_width',
+      param: 'pixels',
+      info: 'Browser window width (in display pixels)'
+    },
+    'browserheight': {
+      name: 'browserheight',
+      key: 'bh',
+      api: 'browser_height',
+      param: 'pixels',
+      info: 'Browser window height (in display pixels)'
+    },
+    'viewportheight': {
+      name: 'viewportheight',
+      key: 'vh',
+      api: 'height',
+      param: 'pixels',
+      info: 'Viewport Height in css pixels'
+    },
+    'viewportwidth': {
+      name: 'viewportwidth',
+      key: 'vw',
+      api: 'width',
+      param: 'pixels',
+      info: 'Viewport Width in css pixels'
+    },
+    'devicetopixelratio' : {
+      name : 'devicetopixelratio',
+      key : 'dpr',
+      api : 'dpr',
+      param : 'ratio',
+      info : 'Device To Pixel Ratio'
+
+    },
+    'appendua' : {
+      name : 'appendua',
+      key : 'au',
+      api : 'appendua',
+      param : 'string',
+      info : 'String to append to the user agent string. This is in addition to the default PTST/ver string'
+    },
+    'testtype' : {
+      name : 'testtype',
+      key : 'tt',
+      api : 'type',
+      param : 'string',
+      info : 'For running alternative test types, can specify traceroute or lighthouse'
+    },
+    'profiler' : {
+      name : 'profiler',
+      key : 'pr',
+      api : 'profiler',
+      param : 'number',
+      info : 'Set to 1 to enable the V8 sampling profiler (Chromium only)'
+    },
+    'disableAVIF' : {
+      name : 'disableAVIF',
+      key : 'avif',
+      api : 'disableAVIF',
+      param : 'number',
+      info : 'Set to 1 to disable AVIF support (Chromium 88+)'
+    },
+    'disableWEBP' : {
+      name : 'disableWEBP',
+      key : 'webp',
+      api : 'disableWEBP',
+      param : 'number',
+      info : 'Set to 1 to disable WEBP support (Chromium 88+)'
+    },
+    'disableJXL' : {
+      name : 'disableJXL',
+      key : 'jxl',
+      api : 'disableJXL',
+      param : 'number',
+      info : 'Set to 1 to disable JpegXL support (Chromium 88+)'
+    },
+    'dtShaper' : {
+      name : 'dtShaper',
+      key : 'dts',
+      api : 'dtShaper',
+      param : 'number',
+      info : "Set to 1 to use Chrome's built-in traffic-shaping instead of the packet-level netem shaping usually used by the test agents"
+    },
     'latency': {
       name: 'latency',
       key: 'Y',

diff --git a/package.json b/package.json
@@ -2,8 +2,8 @@
   "name": "webpagetest",
   "version": "0.4.0",
   "description": "WebPageTest API wrapper for NodeJS",
-  "author": "Marcel Duran <github@marcelduran.com> (http://github.com/marcelduran)",
-  "homepage": "http://github.com/marcelduran/webpagetest-api",
+  "author": "WebPageTest <github@WebPageTest.com> (http://github.com/WebPageTest)",
+  "homepage": "http://github.com/WebPageTest/webpagetest-api",
   "keywords": [
     "webpagetest",
     "api",
@@ -14,10 +14,10 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git://github.com/marcelduran/webpagetest-api.git"
+    "url": "git://github.com/WebPageTest/webpagetest-api.git"
   },
   "bugs": {
-    "url": "http://github.com/marcelduran/webpagetest-api/issues"
+    "url": "http://github.com/WebPageTest/webpagetest-api/issues"
   },
   "main": "lib/webpagetest.js",
   "bin": "bin/webpagetest",

diff --git a/test/fixtures/command-line/help-test.txt b/test/fixtures/command-line/help-test.txt
@@ -86,6 +86,18 @@ Options:
                                       specifying a custom connectivity profile)
   -U, --bwup <bandwidth>              upload bandwidth in Kbps (used when
                                       specifying a custom connectivity profile)
+  -bw, --browserwidth <pixels>        Browser window width (in display pixels)
+  -bh, --browserheight <pixels>       Browser window height (in display pixels)
+  -vh, --viewportheight <pixels>      Viewport Height in css pixels
+  -vw, --viewportwidth <pixels>       Viewport Width in css pixels
+  -dpr, --devicetopixelratio <ratio>    Device To Pixel Ratio
+  -au, --appendua <string>            String to append to the user agent string. This is in addition to the default PTST/ver string
+  -tt, --testtype <string>            For running alternative test types, can specify traceroute or lighthouse
+  -pr, --profiler <number>            Set to 1 to enable the V8 sampling profiler (Chromium only)
+  -avif, --disableAVIF <number>       Set to 1 to disable AVIF support (Chromium 88+)
+  -webp, --disableWEBP <number>       Set to 1 to disable WEBP support (Chromium 88+)
+  -jxl, --disableJXL <number>         Set to 1 to disable JpegXL support (Chromium 88+)
+  -dts, --dtShaper <number>           Set to 1 to use Chrome's built-in traffic-shaping instead of the packet-level netem shaping usually used by the test agents
   -Y, --latency <time>                first-hop Round Trip Time in ms (used
                                       when specifying a custom connectivity
                                       profile)