webpagetest
Advanced tools
webpagetest - npm Package Compare versions
Comparing version 0.5.0 to 0.5.1
1345
lib/mapping.js
@@ -12,899 +12,910 @@ /** | ||
| common: { | ||
| 'server': { | ||
| name: 'server', | ||
| key: 's', | ||
| param: 'server', | ||
| info: 'the WPT server URL [%s]' | ||
| server: { | ||
| name: "server", | ||
| key: "s", | ||
| param: "server", | ||
| info: "the WPT server URL [%s]", | ||
| }, | ||
| 'dryrun': { | ||
| name: 'dryRun', | ||
| key: 'd', | ||
| dryrun: { | ||
| name: "dryRun", | ||
| key: "d", | ||
| bool: true, | ||
| info: 'just return the RESTful API URL' | ||
| } | ||
| info: "just return the RESTful API URL", | ||
| }, | ||
| }, | ||
| test: { | ||
| 'location': { | ||
| name: 'location', | ||
| key: 'l', | ||
| api: 'location', | ||
| param: 'location', | ||
| info: 'location to test from' | ||
| location: { | ||
| name: "location", | ||
| key: "l", | ||
| api: "location", | ||
| param: "location", | ||
| info: "location to test from", | ||
| }, | ||
| // Test Setting tab | ||
| 'connectivity': { | ||
| name: 'connectivity', | ||
| key: 'y', | ||
| api: 'connectivity', | ||
| param: 'profile', | ||
| info: 'connectivity profile (Cable|DSL|3GSlow|3G|3GFast|4G|LTE|Edge|2G|Dial|FIOS|Native|custom) [Cable]' | ||
| connectivity: { | ||
| name: "connectivity", | ||
| key: "y", | ||
| api: "connectivity", | ||
| param: "profile", | ||
| info: "connectivity profile (Cable|DSL|3GSlow|3G|3GFast|4G|LTE|Edge|2G|Dial|FIOS|Native|custom) [Cable]", | ||
| }, | ||
| 'runs': { | ||
| name: 'runs', | ||
| key: 'r', | ||
| api: 'runs', | ||
| param: 'number', | ||
| info: 'number of test runs [1]' | ||
| runs: { | ||
| name: "runs", | ||
| key: "r", | ||
| api: "runs", | ||
| param: "number", | ||
| info: "number of test runs [1]", | ||
| }, | ||
| 'first': { | ||
| name: 'firstViewOnly', | ||
| key: 'f', | ||
| api: 'fvonly', | ||
| first: { | ||
| name: "firstViewOnly", | ||
| key: "f", | ||
| api: "fvonly", | ||
| bool: true, | ||
| info: 'skip the Repeat View test' | ||
| info: "skip the Repeat View test", | ||
| }, | ||
| 'video': { | ||
| name: 'video', | ||
| key: 'v', | ||
| api: 'video', | ||
| video: { | ||
| name: "video", | ||
| key: "v", | ||
| api: "video", | ||
| bool: true, | ||
| info: 'capture video' | ||
| info: "capture video", | ||
| }, | ||
| 'private': { | ||
| name: 'private', | ||
| key: 'p', | ||
| api: 'private', | ||
| private: { | ||
| name: "private", | ||
| key: "p", | ||
| api: "private", | ||
| bool: true, | ||
| info: 'keep the test hidden from the test log' | ||
| info: "keep the test hidden from the test log", | ||
| }, | ||
| 'label': { | ||
| name: 'label', | ||
| key: 'L', | ||
| api: 'label', | ||
| param: 'label', | ||
| info: 'label for the test' | ||
| label: { | ||
| name: "label", | ||
| key: "L", | ||
| api: "label", | ||
| param: "label", | ||
| info: "label for the test", | ||
| }, | ||
| // Advanced tab | ||
| 'onload': { | ||
| name: 'stopAtDocumentComplete', | ||
| key: 'i', | ||
| api: 'web10', | ||
| onload: { | ||
| name: "stopAtDocumentComplete", | ||
| key: "i", | ||
| api: "web10", | ||
| bool: true, | ||
| info: 'stop test at document complete. typically, tests run until all activity stops' | ||
| info: "stop test at document complete. typically, tests run until all activity stops", | ||
| }, | ||
| 'noscript': { | ||
| name: 'disableJavaScript', | ||
| key: 'S', | ||
| api: 'noscript', | ||
| noscript: { | ||
| name: "disableJavaScript", | ||
| key: "S", | ||
| api: "noscript", | ||
| bool: true, | ||
| info: 'disable JavaScript (IE, Chrome, Firefox)' | ||
| info: "disable JavaScript (IE, Chrome, Firefox)", | ||
| }, | ||
| 'clearcerts': { | ||
| name: 'clearCerts', | ||
| key: 'C', | ||
| api: 'clearcerts', | ||
| clearcerts: { | ||
| name: "clearCerts", | ||
| key: "C", | ||
| api: "clearcerts", | ||
| bool: true, | ||
| info: 'clear SSL certificate caches' | ||
| info: "clear SSL certificate caches", | ||
| }, | ||
| 'ignoressl': { | ||
| name: 'ignoreSSL', | ||
| key: 'R', | ||
| api: 'ignoreSSL', | ||
| ignoressl: { | ||
| name: "ignoreSSL", | ||
| key: "R", | ||
| api: "ignoreSSL", | ||
| bool: true, | ||
| info: 'ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc' | ||
| info: "ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc", | ||
| }, | ||
| 'standards': { | ||
| name: 'disableCompatibilityView', | ||
| key: 'T', | ||
| api: 'standards', | ||
| standards: { | ||
| name: "disableCompatibilityView", | ||
| key: "T", | ||
| api: "standards", | ||
| bool: true, | ||
| info: 'forces all pages to load in standards mode (IE only)' | ||
| info: "forces all pages to load in standards mode (IE only)", | ||
| }, | ||
| 'tcpdump': { | ||
| name: 'tcpDump', | ||
| key: 'u', | ||
| api: 'tcpdump', | ||
| tcpdump: { | ||
| name: "tcpDump", | ||
| key: "u", | ||
| api: "tcpdump", | ||
| bool: true, | ||
| info: 'capture network packet trace (tcpdump)' | ||
| info: "capture network packet trace (tcpdump)", | ||
| }, | ||
| 'bodies': { | ||
| name: 'saveResponseBodies', | ||
| key: 'O', | ||
| api: 'bodies', | ||
| bodies: { | ||
| name: "saveResponseBodies", | ||
| key: "O", | ||
| api: "bodies", | ||
| bool: true, | ||
| info: 'save response bodies for text resources' | ||
| info: "save response bodies for text resources", | ||
| }, | ||
| 'keepua': { | ||
| name: 'keepOriginalUserAgent', | ||
| key: 'K', | ||
| api: 'keepua', | ||
| keepua: { | ||
| name: "keepOriginalUserAgent", | ||
| key: "K", | ||
| api: "keepua", | ||
| bool: true, | ||
| info: 'do not add PTST to the original browser User Agent string' | ||
| info: "do not add PTST to the original browser User Agent string", | ||
| }, | ||
| 'dom': { | ||
| name: 'domElement', | ||
| key: 'm', | ||
| api: 'domelement', | ||
| param: 'element', | ||
| info: 'DOM element to record for sub-measurement' | ||
| dom: { | ||
| name: "domElement", | ||
| key: "m", | ||
| api: "domelement", | ||
| param: "element", | ||
| info: "DOM element to record for sub-measurement", | ||
| }, | ||
| 'duration': { | ||
| name: 'minimumDuration', | ||
| key: 'N', | ||
| api: 'time', | ||
| param: 'seconds', | ||
| info: 'minimum test duration in seconds' | ||
| duration: { | ||
| name: "minimumDuration", | ||
| key: "N", | ||
| api: "time", | ||
| param: "seconds", | ||
| info: "minimum test duration in seconds", | ||
| }, | ||
| 'tester': { | ||
| name: 'tester', | ||
| key: 'E', | ||
| api: 'tester', | ||
| param: 'name', | ||
| info: 'run the test on a specific PC (name must match exactly or the test will not run)' | ||
| tester: { | ||
| name: "tester", | ||
| key: "E", | ||
| api: "tester", | ||
| param: "name", | ||
| info: "run the test on a specific PC (name must match exactly or the test will not run)", | ||
| }, | ||
| injectScript: { | ||
| name: "injectScript", | ||
| api: "injectScript", | ||
| param: "injectScript", | ||
| info: "JavaScript to run after the document has started loading", | ||
| }, | ||
| // Chrome tab | ||
| 'mobile': { | ||
| name: 'emulateMobile', | ||
| key: 'W', | ||
| api: 'mobile', | ||
| mobile: { | ||
| name: "emulateMobile", | ||
| key: "W", | ||
| api: "mobile", | ||
| bool: true, | ||
| info: '(experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)' | ||
| info: "(experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)", | ||
| }, | ||
| 'device': { | ||
| name: 'device', | ||
| api: 'mobileDevice', | ||
| param: 'string', | ||
| info: 'device name from mobile_devices.ini to use for mobile emulation (only when mobile=1 is specified to enable emulation and only for Chrome)' | ||
| device: { | ||
| name: "device", | ||
| api: "mobileDevice", | ||
| param: "string", | ||
| info: "device name from mobile_devices.ini to use for mobile emulation (only when mobile=1 is specified to enable emulation and only for Chrome)", | ||
| }, | ||
| 'timeline': { | ||
| name: 'timeline', | ||
| key: 'M', | ||
| api: 'timeline', | ||
| timeline: { | ||
| name: "timeline", | ||
| key: "M", | ||
| api: "timeline", | ||
| bool: true, | ||
| info: 'capture Developer Tools Timeline (Chrome only)' | ||
| info: "capture Developer Tools Timeline (Chrome only)", | ||
| }, | ||
| 'callstack': { | ||
| name: 'timelineCallStack', | ||
| key: 'J', | ||
| api: 'timelineStack', | ||
| callstack: { | ||
| name: "timelineCallStack", | ||
| key: "J", | ||
| api: "timelineStack", | ||
| bool: true, | ||
| info: 'set between 1-5 to include the JS call stack. must be used in conjunction with timeline (increases overhead) (Chrome only)', | ||
| valid: /[1-5]/ | ||
| info: "set between 1-5 to include the JS call stack. must be used in conjunction with timeline (increases overhead) (Chrome only)", | ||
| valid: /[1-5]/, | ||
| }, | ||
| 'chrometrace': { | ||
| name: 'chromeTrace', | ||
| key: 'q', | ||
| api: 'trace', | ||
| chrometrace: { | ||
| name: "chromeTrace", | ||
| key: "q", | ||
| api: "trace", | ||
| bool: true, | ||
| info: 'capture chrome trace (about://tracing) (Chrome only)' | ||
| info: "capture chrome trace (about://tracing) (Chrome only)", | ||
| }, | ||
| 'tracecategories': { | ||
| name: 'traceCategories', | ||
| api: 'traceCategories', | ||
| param: 'categories', | ||
| info: 'trace categories (when chrometrace enabled) (Chrome only)' | ||
| tracecategories: { | ||
| name: "traceCategories", | ||
| api: "traceCategories", | ||
| param: "categories", | ||
| info: "trace categories (when chrometrace enabled) (Chrome only)", | ||
| }, | ||
| 'netlog': { | ||
| name: 'netLog', | ||
| key: 'G', | ||
| api: 'netlog', | ||
| netlog: { | ||
| name: "netLog", | ||
| key: "G", | ||
| api: "netlog", | ||
| bool: true, | ||
| info: 'capture Network Log (Chrome only)' | ||
| info: "capture Network Log (Chrome only)", | ||
| }, | ||
| 'datareduction': { | ||
| name: 'dataReduction', | ||
| key: 'Q', | ||
| api: 'dataReduction', | ||
| datareduction: { | ||
| name: "dataReduction", | ||
| key: "Q", | ||
| api: "dataReduction", | ||
| bool: true, | ||
| info: 'enable data reduction on Chrome 34+ Android (Chrome only)' | ||
| info: "enable data reduction on Chrome 34+ Android (Chrome only)", | ||
| }, | ||
| 'useragent': { | ||
| name: 'userAgent', | ||
| key: 'x', | ||
| api: 'uastring', | ||
| param: 'string', | ||
| info: 'custom user agent string (Chrome only)' | ||
| useragent: { | ||
| name: "userAgent", | ||
| key: "x", | ||
| api: "uastring", | ||
| param: "string", | ||
| info: "custom user agent string (Chrome only)", | ||
| }, | ||
| 'cmdline': { | ||
| name: 'commandLine', | ||
| key: 'X', | ||
| api: 'cmdline', | ||
| param: 'switches', | ||
| info: 'use a list of custom command line switches (Chrome only)' | ||
| cmdline: { | ||
| name: "commandLine", | ||
| key: "X", | ||
| api: "cmdline", | ||
| param: "switches", | ||
| info: "use a list of custom command line switches (Chrome only)", | ||
| }, | ||
| 'lighthouse': { | ||
| name: 'lighthouse', | ||
| api: 'lighthouse', | ||
| lighthouse: { | ||
| name: "lighthouse", | ||
| api: "lighthouse", | ||
| bool: true, | ||
| info: 'perform lighthouse test (Chrome only, Linux agent only)' | ||
| info: "perform lighthouse test (Chrome only, Linux agent only)", | ||
| }, | ||
| // Auth tab | ||
| 'login': { | ||
| name: 'login', | ||
| key: 'g', | ||
| api: 'login', | ||
| param: 'username', | ||
| info: 'username for authenticating tests (http authentication)' | ||
| login: { | ||
| name: "login", | ||
| key: "g", | ||
| api: "login", | ||
| param: "username", | ||
| info: "username for authenticating tests (http authentication)", | ||
| }, | ||
| 'password': { | ||
| name: 'password', | ||
| key: 'w', | ||
| api: 'password', | ||
| param: 'password', | ||
| info: 'password for authenticating tests (http authentication)' | ||
| password: { | ||
| name: "password", | ||
| key: "w", | ||
| api: "password", | ||
| param: "password", | ||
| info: "password for authenticating tests (http authentication)", | ||
| }, | ||
| // Script tab | ||
| 'sensitive': { | ||
| name: 'sensitive', | ||
| key: 't', | ||
| api: 'sensitive', | ||
| sensitive: { | ||
| name: "sensitive", | ||
| key: "t", | ||
| api: "sensitive", | ||
| bool: true, | ||
| info: 'discard script and http headers in the result' | ||
| info: "discard script and http headers in the result", | ||
| }, | ||
| 'noheaders': { | ||
| name: 'disableHTTPHeaders', | ||
| key: 'H', | ||
| api: 'noheaders', | ||
| noheaders: { | ||
| name: "disableHTTPHeaders", | ||
| key: "H", | ||
| api: "noheaders", | ||
| bool: true, | ||
| info: 'disable saving of the http headers (as well as browser status messages and CPU utilization)' | ||
| info: "disable saving of the http headers (as well as browser status messages and CPU utilization)", | ||
| }, | ||
| // Block tab | ||
| 'block': { | ||
| name: 'block', | ||
| key: 'b', | ||
| api: 'block', | ||
| param: 'urls', | ||
| block: { | ||
| name: "block", | ||
| key: "b", | ||
| api: "block", | ||
| param: "urls", | ||
| array: true, | ||
| info: 'space-delimited list of urls to block (substring match)' | ||
| info: "space-delimited list of urls to block (substring match)", | ||
| }, | ||
| // SPOF tab | ||
| 'spof': { | ||
| name: 'spof', | ||
| key: 'Z', | ||
| api: 'spof', | ||
| param: 'domains', | ||
| spof: { | ||
| name: "spof", | ||
| key: "Z", | ||
| api: "spof", | ||
| param: "domains", | ||
| array: true, | ||
| info: 'space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests' | ||
| info: "space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests", | ||
| }, | ||
| // Custom tab | ||
| 'custom': { | ||
| name: 'customMetrics', | ||
| key: 'c', | ||
| api: 'custom', | ||
| param: 'script', | ||
| info: 'execute arbitrary JavaScript at the end of a test to collect custom metrics' | ||
| custom: { | ||
| name: "customMetrics", | ||
| key: "c", | ||
| api: "custom", | ||
| param: "script", | ||
| info: "execute arbitrary JavaScript at the end of a test to collect custom metrics", | ||
| }, | ||
| // API only settings | ||
| 'authtype': { | ||
| name: 'authenticationType', | ||
| key: 'a', | ||
| api: 'authType', | ||
| param: 'type', | ||
| info: 'type of authentication: 0 = Basic, 1 = SNS [0]' | ||
| authtype: { | ||
| name: "authenticationType", | ||
| key: "a", | ||
| api: "authType", | ||
| param: "type", | ||
| info: "type of authentication: 0 = Basic, 1 = SNS [0]", | ||
| }, | ||
| 'notify': { | ||
| name: 'notifyEmail', | ||
| key: 'n', | ||
| api: 'notify', | ||
| param: 'e-mail', | ||
| info: 'e-mail address to notify with the test results' | ||
| notify: { | ||
| name: "notifyEmail", | ||
| key: "n", | ||
| api: "notify", | ||
| param: "e-mail", | ||
| info: "e-mail address to notify with the test results", | ||
| }, | ||
| 'pingback': { | ||
| name: 'pingback', | ||
| key: 'B', | ||
| api: 'pingback', | ||
| param: 'url', | ||
| info: 'URL to ping when the test is complete (the test ID will be passed as an "id" parameter)' | ||
| pingback: { | ||
| name: "pingback", | ||
| key: "B", | ||
| api: "pingback", | ||
| param: "url", | ||
| info: 'URL to ping when the test is complete (the test ID will be passed as an "id" parameter)', | ||
| }, | ||
| 'bwdown': { | ||
| name: 'bandwidthDown', | ||
| key: 'D', | ||
| api: 'bwDown', | ||
| param: 'bandwidth', | ||
| info: 'download bandwidth in Kbps (used when specifying a custom connectivity profile)' | ||
| bwdown: { | ||
| name: "bandwidthDown", | ||
| key: "D", | ||
| api: "bwDown", | ||
| param: "bandwidth", | ||
| info: "download bandwidth in Kbps (used when specifying a custom connectivity profile)", | ||
| }, | ||
| 'bwup': { | ||
| name: 'bandwidthUp', | ||
| key: 'U', | ||
| api: 'bwUp', | ||
| param: 'bandwidth', | ||
| info: 'upload bandwidth in Kbps (used when specifying a custom connectivity profile)' | ||
| bwup: { | ||
| name: "bandwidthUp", | ||
| key: "U", | ||
| api: "bwUp", | ||
| 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)' | ||
| 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)' | ||
| 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' | ||
| 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' | ||
| 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' | ||
| 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' | ||
| 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' | ||
| 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)' | ||
| 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+)' | ||
| 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+)' | ||
| 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+)' | ||
| 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" | ||
| 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', | ||
| api: 'latency', | ||
| param: 'time', | ||
| info: 'first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)' | ||
| latency: { | ||
| name: "latency", | ||
| key: "Y", | ||
| api: "latency", | ||
| param: "time", | ||
| info: "first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)", | ||
| }, | ||
| 'plr': { | ||
| name: 'packetLossRate', | ||
| key: 'P', | ||
| api: 'plr', | ||
| param: 'percentage', | ||
| info: 'packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)' | ||
| plr: { | ||
| name: "packetLossRate", | ||
| key: "P", | ||
| api: "plr", | ||
| param: "percentage", | ||
| info: "packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)", | ||
| }, | ||
| 'noopt': { | ||
| name: 'disableOptimization', | ||
| key: 'z', | ||
| api: 'noopt', | ||
| noopt: { | ||
| name: "disableOptimization", | ||
| key: "z", | ||
| api: "noopt", | ||
| bool: true, | ||
| info: 'disable optimization checks (for faster testing)' | ||
| info: "disable optimization checks (for faster testing)", | ||
| }, | ||
| 'noimages': { | ||
| name: 'disableScreenshot', | ||
| key: 'I', | ||
| api: 'noimages', | ||
| noimages: { | ||
| name: "disableScreenshot", | ||
| key: "I", | ||
| api: "noimages", | ||
| bool: true, | ||
| info: 'disable screen shot capturing' | ||
| info: "disable screen shot capturing", | ||
| }, | ||
| 'full': { | ||
| name: 'fullResolutionScreenshot', | ||
| key: 'F', | ||
| api: 'pngss', | ||
| full: { | ||
| name: "fullResolutionScreenshot", | ||
| key: "F", | ||
| api: "pngss", | ||
| bool: true, | ||
| info: 'save a full-resolution version of the fully loaded screen shot as a PNG' | ||
| info: "save a full-resolution version of the fully loaded screen shot as a PNG", | ||
| }, | ||
| 'jpeg': { | ||
| name: 'jpegQuality', | ||
| key: 'j', | ||
| api: 'iq', | ||
| param: 'level', | ||
| info: 'jpeg compression level (30-100) for the screen shots and video capture' | ||
| jpeg: { | ||
| name: "jpegQuality", | ||
| key: "j", | ||
| api: "iq", | ||
| param: "level", | ||
| info: "jpeg compression level (30-100) for the screen shots and video capture", | ||
| }, | ||
| 'medianvideo': { | ||
| name: 'medianVideo', | ||
| key: 'A', | ||
| api: 'mv', | ||
| medianvideo: { | ||
| name: "medianVideo", | ||
| key: "A", | ||
| api: "mv", | ||
| bool: true, | ||
| info: 'store the video from the median run when capturing video is enabled' | ||
| info: "store the video from the median run when capturing video is enabled", | ||
| }, | ||
| 'htmlbody': { | ||
| name: 'htmlBody', | ||
| api: 'htmlbody', | ||
| htmlbody: { | ||
| name: "htmlBody", | ||
| api: "htmlbody", | ||
| bool: true, | ||
| info: 'save the content of only the base HTML response' | ||
| info: "save the content of only the base HTML response", | ||
| }, | ||
| 'tsview': { | ||
| name: 'tsView', | ||
| api: 'tsview_id', | ||
| param: 'id', | ||
| info: 'test name to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)' | ||
| tsview: { | ||
| name: "tsView", | ||
| api: "tsview_id", | ||
| param: "id", | ||
| info: "test name to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)", | ||
| }, | ||
| 'tsviewconfigs': { | ||
| name: 'tsViewConfigs', | ||
| api: 'tsview_configs', | ||
| param: 'string', | ||
| info: 'configs to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)' | ||
| tsviewconfigs: { | ||
| name: "tsViewConfigs", | ||
| api: "tsview_configs", | ||
| param: "string", | ||
| info: "configs to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)", | ||
| }, | ||
| 'affinity': { | ||
| name: 'affinity', | ||
| api: 'affinity', | ||
| param: 'string', | ||
| info: 'string to hash test to a specific test agent. tester will be picked by index among available testers' | ||
| affinity: { | ||
| name: "affinity", | ||
| api: "affinity", | ||
| param: "string", | ||
| info: "string to hash test to a specific test agent. tester will be picked by index among available testers", | ||
| }, | ||
| 'priority': { | ||
| name: 'priority', | ||
| api: 'priority', | ||
| param: 'number', | ||
| info: 'change test priority (0-9) [enforced by API key, otherwise 5]', | ||
| valid: /^\d$/ | ||
| priority: { | ||
| name: "priority", | ||
| api: "priority", | ||
| param: "number", | ||
| info: "change test priority (0-9) [enforced by API key, otherwise 5]", | ||
| valid: /^\d$/, | ||
| }, | ||
| // Undocumented/experimental/transitent/deprecated | ||
| 'noads': { | ||
| name: 'blockAds', | ||
| api: 'blockads', | ||
| noads: { | ||
| name: "blockAds", | ||
| api: "blockads", | ||
| bool: true, | ||
| info: 'block ads defined by adblockrules.org' | ||
| info: "block ads defined by adblockrules.org", | ||
| }, | ||
| 'continuous': { | ||
| name: 'continuousVideoCapture', | ||
| api: 'continuousVideo', | ||
| continuous: { | ||
| name: "continuousVideoCapture", | ||
| api: "continuousVideo", | ||
| bool: true, | ||
| info: 'capture video continuously (unstable/experimental, may cause tests to fail)' | ||
| info: "capture video continuously (unstable/experimental, may cause tests to fail)", | ||
| }, | ||
| 'spdy3': { | ||
| name: 'forceSpdy3', | ||
| api: 'spdy3', | ||
| spdy3: { | ||
| name: "forceSpdy3", | ||
| api: "spdy3", | ||
| bool: true, | ||
| info: 'force SPDY version 3 (Chrome only)' | ||
| info: "force SPDY version 3 (Chrome only)", | ||
| }, | ||
| 'swrender': { | ||
| name: 'forceSoftwareRendering', | ||
| api: 'swrender', | ||
| swrender: { | ||
| name: "forceSoftwareRendering", | ||
| api: "swrender", | ||
| bool: true, | ||
| info: 'force software rendering, disable GPU acceleration (Chrome only)' | ||
| info: "force software rendering, disable GPU acceleration (Chrome only)", | ||
| }, | ||
| // Synchonous tests + results | ||
| 'poll': { | ||
| name: 'pollResults', | ||
| param: 'interval', | ||
| poll: { | ||
| name: "pollResults", | ||
| param: "interval", | ||
| optional: true, | ||
| info: 'poll for results after test is scheduled at every <interval> seconds [5]' | ||
| info: "poll for results after test is scheduled at every <interval> seconds [5]", | ||
| }, | ||
| 'wait': { | ||
| name: 'waitResults', | ||
| param: 'hostname:port', | ||
| wait: { | ||
| name: "waitResults", | ||
| param: "hostname:port", | ||
| optional: true, | ||
| info: 'wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]' | ||
| info: "wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]", | ||
| }, | ||
| 'timeout': { | ||
| name: 'timeout', | ||
| param: 'seconds', | ||
| info: 'timeout for polling and waiting results [no timeout]' | ||
| } | ||
| timeout: { | ||
| name: "timeout", | ||
| param: "seconds", | ||
| info: "timeout for polling and waiting results [no timeout]", | ||
| }, | ||
| }, | ||
| request: { | ||
| 'request': { | ||
| name: 'requestId', | ||
| key: 'e', | ||
| api: 'r', | ||
| param: 'id', | ||
| info: 'echo request ID, useful to track asynchronous requests' | ||
| } | ||
| request: { | ||
| name: "requestId", | ||
| key: "e", | ||
| api: "r", | ||
| param: "id", | ||
| info: "echo request ID, useful to track asynchronous requests", | ||
| }, | ||
| }, | ||
| run: { | ||
| 'run': { | ||
| name: 'run', | ||
| key: 'r', | ||
| param: 'number', | ||
| info: 'which run number on a multiple runs test [1]' | ||
| run: { | ||
| name: "run", | ||
| key: "r", | ||
| param: "number", | ||
| info: "which run number on a multiple runs test [1]", | ||
| }, | ||
| 'cached': { | ||
| name: 'repeatView', | ||
| key: 'c', | ||
| cached: { | ||
| name: "repeatView", | ||
| key: "c", | ||
| bool: true, | ||
| info: 'get the Repeat View (cached view) instead of default First View (primed cache)' | ||
| } | ||
| info: "get the Repeat View (cached view) instead of default First View (primed cache)", | ||
| }, | ||
| }, | ||
| image: { | ||
| 'thumbnail': { | ||
| name: 'thumbnail', | ||
| key: 't', | ||
| thumbnail: { | ||
| name: "thumbnail", | ||
| key: "t", | ||
| bool: true, | ||
| info: 'get the thumbnail of actual image' | ||
| info: "get the thumbnail of actual image", | ||
| }, | ||
| 'uri': { | ||
| name: 'dataURI', | ||
| key: 'u', | ||
| uri: { | ||
| name: "dataURI", | ||
| key: "u", | ||
| bool: true, | ||
| info: 'return the base64 string representation (inline) of actual image' | ||
| } | ||
| info: "return the base64 string representation (inline) of actual image", | ||
| }, | ||
| }, | ||
| screenshot: { | ||
| 'full': { | ||
| name: 'fullResolution', | ||
| key: 'f', | ||
| full: { | ||
| name: "fullResolution", | ||
| key: "f", | ||
| bool: true, | ||
| info: 'get full resolution screenshot in PNG format if available' | ||
| info: "get full resolution screenshot in PNG format if available", | ||
| }, | ||
| 'render': { | ||
| name: 'startRender', | ||
| key: 'n', | ||
| render: { | ||
| name: "startRender", | ||
| key: "n", | ||
| bool: true, | ||
| info: 'get the page screenshot at the Start Render point (i.e.: when something was first displayed on screen)' | ||
| info: "get the page screenshot at the Start Render point (i.e.: when something was first displayed on screen)", | ||
| }, | ||
| 'complete': { | ||
| name: 'documentComplete', | ||
| key: 'p', | ||
| complete: { | ||
| name: "documentComplete", | ||
| key: "p", | ||
| bool: true, | ||
| info: 'get the page screenshot at the Document Complete point (i.e.: when window.onload was fired)' | ||
| } | ||
| info: "get the page screenshot at the Document Complete point (i.e.: when window.onload was fired)", | ||
| }, | ||
| }, | ||
| results: { | ||
| 'breakdown': { | ||
| name: 'breakDown', | ||
| key: 'b', | ||
| api: 'breakdown', | ||
| breakdown: { | ||
| name: "breakDown", | ||
| key: "b", | ||
| api: "breakdown", | ||
| bool: true, | ||
| info: 'include the breakdown of requests and bytes by mime type' | ||
| info: "include the breakdown of requests and bytes by mime type", | ||
| }, | ||
| 'domains': { | ||
| name: 'domains', | ||
| key: 'D', | ||
| api: 'domains', | ||
| domains: { | ||
| name: "domains", | ||
| key: "D", | ||
| api: "domains", | ||
| bool: true, | ||
| info: 'include the breakdown of requests and bytes by domain' | ||
| info: "include the breakdown of requests and bytes by domain", | ||
| }, | ||
| 'pagespeed': { | ||
| name: 'pageSpeed', | ||
| key: 'p', | ||
| api: 'pagespeed', | ||
| pagespeed: { | ||
| name: "pageSpeed", | ||
| key: "p", | ||
| api: "pagespeed", | ||
| bool: true, | ||
| info: 'include the PageSpeed score in the response (may be slower)' | ||
| info: "include the PageSpeed score in the response (may be slower)", | ||
| }, | ||
| 'requests': { | ||
| name: 'requests', | ||
| key: 'R', | ||
| api: 'requests', | ||
| requests: { | ||
| name: "requests", | ||
| key: "R", | ||
| api: "requests", | ||
| bool: true, | ||
| info: 'include the request data in the response (slower and results in much larger responses)' | ||
| info: "include the request data in the response (slower and results in much larger responses)", | ||
| }, | ||
| 'median': { | ||
| name: 'medianMetric', | ||
| key: 'm', | ||
| api: 'medianMetric', | ||
| param: 'metric', | ||
| info: 'set the metric used to calculate median for multiple runs tests [loadTime]' | ||
| median: { | ||
| name: "medianMetric", | ||
| key: "m", | ||
| api: "medianMetric", | ||
| param: "metric", | ||
| info: "set the metric used to calculate median for multiple runs tests [loadTime]", | ||
| }, | ||
| 'medianrun': { | ||
| name: 'medianRun', | ||
| api: 'medianRun', | ||
| param: 'metric', | ||
| info: 'set the run used for median for multiple runs tests [median]' | ||
| medianrun: { | ||
| name: "medianRun", | ||
| api: "medianRun", | ||
| param: "metric", | ||
| info: "set the run used for median for multiple runs tests [median]", | ||
| }, | ||
| 'specs': { | ||
| name: 'specs', | ||
| key: 'S', | ||
| param: 'json_or_file', | ||
| info: 'set the specs for performance test suite' | ||
| specs: { | ||
| name: "specs", | ||
| key: "S", | ||
| param: "json_or_file", | ||
| info: "set the specs for performance test suite", | ||
| }, | ||
| 'reporter': { | ||
| name: 'reporter', | ||
| key: 'r', | ||
| param: 'name', | ||
| info: 'set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity', | ||
| valid: /^(?:dot|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity)$/ | ||
| } | ||
| reporter: { | ||
| name: "reporter", | ||
| key: "r", | ||
| param: "name", | ||
| info: "set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity", | ||
| valid: | ||
| /^(?:dot|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity)$/, | ||
| }, | ||
| }, | ||
| waterfall: { | ||
| 'type': { | ||
| name: 'chartType', | ||
| api: 'type', | ||
| key: 'T', | ||
| param: 'chart', | ||
| info: 'set the chart type: waterfall or connection [waterfall]' | ||
| type: { | ||
| name: "chartType", | ||
| api: "type", | ||
| key: "T", | ||
| param: "chart", | ||
| info: "set the chart type: waterfall or connection [waterfall]", | ||
| }, | ||
| 'mime': { | ||
| name: 'colorByMime', | ||
| api: 'mime', | ||
| key: 'M', | ||
| mime: { | ||
| name: "colorByMime", | ||
| api: "mime", | ||
| key: "M", | ||
| bool: true, | ||
| info: 'set chart coloring by MIME type [false]' | ||
| info: "set chart coloring by MIME type [false]", | ||
| }, | ||
| 'width': { | ||
| name: 'chartWidth', | ||
| api: 'width', | ||
| key: 'w', | ||
| param: 'px', | ||
| info: 'chart image width in px (300-2000) [930]' | ||
| width: { | ||
| name: "chartWidth", | ||
| api: "width", | ||
| key: "w", | ||
| param: "px", | ||
| info: "chart image width in px (300-2000) [930]", | ||
| }, | ||
| 'max': { | ||
| name: 'maxTime', | ||
| api: 'max', | ||
| key: 'm', | ||
| param: 'seconds', | ||
| info: 'set maximum time in seconds [automatic]' | ||
| max: { | ||
| name: "maxTime", | ||
| api: "max", | ||
| key: "m", | ||
| param: "seconds", | ||
| info: "set maximum time in seconds [automatic]", | ||
| }, | ||
| 'requests': { | ||
| name: 'requests', | ||
| api: 'requests', | ||
| key: 'R', | ||
| param: 'items', | ||
| info: 'filter requests (e.g.:1,2,3,4-9,8) [all]' | ||
| requests: { | ||
| name: "requests", | ||
| api: "requests", | ||
| key: "R", | ||
| param: "items", | ||
| info: "filter requests (e.g.:1,2,3,4-9,8) [all]", | ||
| }, | ||
| 'nocpu': { | ||
| name: 'noCPU', | ||
| api: 'cpu', | ||
| key: 'C', | ||
| nocpu: { | ||
| name: "noCPU", | ||
| api: "cpu", | ||
| key: "C", | ||
| bool: true, | ||
| invert: true, | ||
| info: 'hide CPU utilization [false]' | ||
| info: "hide CPU utilization [false]", | ||
| }, | ||
| 'nobandwidth': { | ||
| name: 'noBandwidth', | ||
| api: 'bw', | ||
| key: 'b', | ||
| nobandwidth: { | ||
| name: "noBandwidth", | ||
| api: "bw", | ||
| key: "b", | ||
| bool: true, | ||
| invert: true, | ||
| info: 'hide bandwidth utilization [false]' | ||
| info: "hide bandwidth utilization [false]", | ||
| }, | ||
| 'noellipsis': { | ||
| name: 'noEllipsis', | ||
| api: 'dots', | ||
| key: 'i', | ||
| noellipsis: { | ||
| name: "noEllipsis", | ||
| api: "dots", | ||
| key: "i", | ||
| bool: true, | ||
| invert: true, | ||
| info: 'hide ellipsis (...) for missing items [false]' | ||
| info: "hide ellipsis (...) for missing items [false]", | ||
| }, | ||
| 'nolabels': { | ||
| name: 'noLabels', | ||
| api: 'labels', | ||
| key: 'l', | ||
| nolabels: { | ||
| name: "noLabels", | ||
| api: "labels", | ||
| key: "l", | ||
| bool: true, | ||
| invert: true, | ||
| info: 'hide labels for requests (URL) [false]' | ||
| } | ||
| info: "hide labels for requests (URL) [false]", | ||
| }, | ||
| }, | ||
| 'apikey': { | ||
| 'key': { | ||
| name: 'key', | ||
| key: 'k', | ||
| api: 'k', | ||
| param: 'api_key', | ||
| info: 'API key (if assigned). Contact the WebPageTest server administrator for a key if required' | ||
| } | ||
| apikey: { | ||
| key: { | ||
| name: "key", | ||
| key: "k", | ||
| api: "k", | ||
| param: "api_key", | ||
| info: "API key (if assigned). Contact the WebPageTest server administrator for a key if required", | ||
| }, | ||
| }, | ||
| 'video': { | ||
| 'end': { | ||
| name: 'comparisonEndPoint', | ||
| key: 'e', | ||
| api: 'end', | ||
| param: 'end_point', | ||
| info: 'frame comparison end point: [visual]=visually complete | all=last change | doc=document complete | full=fully loaded', | ||
| valid: /^(?:visual|all|doc|full)$/ | ||
| } | ||
| video: { | ||
| end: { | ||
| name: "comparisonEndPoint", | ||
| key: "e", | ||
| api: "end", | ||
| param: "end_point", | ||
| 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]' | ||
| } | ||
| response: { | ||
| request: { | ||
| name: "request", | ||
| api: "request", | ||
| key: "R", | ||
| param: "number", | ||
| info: "the request number [1]", | ||
| }, | ||
| }, | ||
| 'listen': { | ||
| 'key': { | ||
| name: 'key', | ||
| key: 'k', | ||
| param: 'file', | ||
| info: 'private key file to use for SSL' | ||
| listen: { | ||
| key: { | ||
| name: "key", | ||
| key: "k", | ||
| param: "file", | ||
| info: "private key file to use for SSL", | ||
| }, | ||
| 'cert': { | ||
| name: 'cert', | ||
| key: 'c', | ||
| param: 'file', | ||
| info: 'public x509 certificate file to use for SSL' | ||
| } | ||
| } | ||
| cert: { | ||
| name: "cert", | ||
| key: "c", | ||
| param: "file", | ||
| info: "public x509 certificate file to use for SSL", | ||
| }, | ||
| }, | ||
| }; | ||
| var commands = { | ||
| 'status': { | ||
| name: 'getTestStatus', | ||
| param: 'id', | ||
| status: { | ||
| name: "getTestStatus", | ||
| param: "id", | ||
| options: [options.request], | ||
| info: 'check test status' | ||
| info: "check test status", | ||
| }, | ||
| 'results': { | ||
| name: 'getTestResults', | ||
| param: 'id', | ||
| results: { | ||
| name: "getTestResults", | ||
| param: "id", | ||
| options: [options.results, options.request], | ||
| info: 'get test results' | ||
| info: "get test results", | ||
| }, | ||
| 'locations': { | ||
| name: 'getLocations', | ||
| options: [options.request,options.apikey], | ||
| info: 'list locations and the number of pending tests' | ||
| locations: { | ||
| name: "getLocations", | ||
| options: [options.request, options.apikey], | ||
| info: "list locations and the number of pending tests", | ||
| }, | ||
| 'testers': { | ||
| name: 'getTesters', | ||
| testBalance: { | ||
| name: "getTestBalance", | ||
| options: [options.apikey], | ||
| info: "get remaining tests for the account", | ||
| }, | ||
| testers: { | ||
| name: "getTesters", | ||
| options: [options.request], | ||
| info: 'list testers status and details' | ||
| info: "list testers status and details", | ||
| }, | ||
| 'test': { | ||
| name: 'runTest', | ||
| param: 'url_or_script', | ||
| test: { | ||
| name: "runTest", | ||
| param: "url_or_script", | ||
| options: [options.apikey, options.test, options.request, options.results], | ||
| info: 'run test', | ||
| nokey: [options.results] | ||
| info: "run test", | ||
| nokey: [options.results], | ||
| }, | ||
| 'restart': { | ||
| name: 'restartTest', | ||
| param: 'id', | ||
| restart: { | ||
| name: "restartTest", | ||
| param: "id", | ||
| options: [options.apikey], | ||
| info: 'restart test' | ||
| info: "restart test", | ||
| }, | ||
| 'cancel': { | ||
| name: 'cancelTest', | ||
| param: 'id', | ||
| cancel: { | ||
| name: "cancelTest", | ||
| param: "id", | ||
| options: [options.apikey], | ||
| info: 'cancel running/pending test' | ||
| info: "cancel running/pending test", | ||
| }, | ||
| 'har': { | ||
| name: 'getHARData', | ||
| param: 'id', | ||
| info: 'get the HTTP Archive (HAR) from test' | ||
| har: { | ||
| name: "getHARData", | ||
| param: "id", | ||
| info: "get the HTTP Archive (HAR) from test", | ||
| }, | ||
| 'pagespeed': { | ||
| name: 'getPageSpeedData', | ||
| param: 'id', | ||
| pagespeed: { | ||
| name: "getPageSpeedData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get the Google Page Speed results (if available) from test' | ||
| info: "get the Google Page Speed results (if available) from test", | ||
| }, | ||
| 'utilization': { | ||
| name: 'getUtilizationData', | ||
| param: 'id', | ||
| utilization: { | ||
| name: "getUtilizationData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get the CPU, bandwidth and memory utilization data from test' | ||
| info: "get the CPU, bandwidth and memory utilization data from test", | ||
| }, | ||
| 'request': { | ||
| name: 'getRequestData', | ||
| param: 'id', | ||
| request: { | ||
| name: "getRequestData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get the request data from test' | ||
| info: "get the request data from test", | ||
| }, | ||
| 'timeline': { | ||
| name: 'getTimelineData', | ||
| param: 'id', | ||
| timeline: { | ||
| name: "getTimelineData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get the Chrome Developer Tools Timeline data (if available) from test' | ||
| info: "get the Chrome Developer Tools Timeline data (if available) from test", | ||
| }, | ||
| 'netlog': { | ||
| name: 'getNetLogData', | ||
| param: 'id', | ||
| netlog: { | ||
| name: "getNetLogData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get the Chrome Developer Tools Net log data (if available) from test' | ||
| info: "get the Chrome Developer Tools Net log data (if available) from test", | ||
| }, | ||
| 'chrometrace': { | ||
| name: 'getChromeTraceData', | ||
| param: 'id', | ||
| chrometrace: { | ||
| name: "getChromeTraceData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get the Chrome Trace data (if available) from test' | ||
| info: "get the Chrome Trace data (if available) from test", | ||
| }, | ||
| 'console': { | ||
| name: 'getConsoleLogData', | ||
| param: 'id', | ||
| console: { | ||
| name: "getConsoleLogData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get the browser console log data (if available) from test' | ||
| info: "get the browser console log data (if available) from test", | ||
| }, | ||
| 'testinfo': { | ||
| name: 'getTestInfo', | ||
| param: 'id', | ||
| info: 'get test request info/details' | ||
| testinfo: { | ||
| name: "getTestInfo", | ||
| param: "id", | ||
| info: "get test request info/details", | ||
| }, | ||
| 'history': { | ||
| name: 'getHistory', | ||
| param: 'days', | ||
| history: { | ||
| name: "getHistory", | ||
| param: "days", | ||
| optional: true, | ||
| info: 'get history of previously run tests' | ||
| info: "get history of previously run tests", | ||
| }, | ||
| 'googlecsi': { | ||
| name: 'getGoogleCsiData', | ||
| param: 'id', | ||
| googlecsi: { | ||
| name: "getGoogleCsiData", | ||
| param: "id", | ||
| options: [options.run], | ||
| info: 'get Google CSI data (Client Side Instrumentation)' | ||
| info: "get Google CSI data (Client Side Instrumentation)", | ||
| }, | ||
| 'response': { | ||
| name: 'getResponseBody', | ||
| param: 'id', | ||
| response: { | ||
| name: "getResponseBody", | ||
| param: "id", | ||
| options: [options.run, options.response], | ||
| info: 'get response body for text resources' | ||
| info: "get response body for text resources", | ||
| }, | ||
| 'waterfall': { | ||
| name: 'getWaterfallImage', | ||
| param: 'id', | ||
| waterfall: { | ||
| name: "getWaterfallImage", | ||
| param: "id", | ||
| options: [options.run, options.image, options.waterfall], | ||
| info: 'get the waterfall PNG image' | ||
| info: "get the waterfall PNG image", | ||
| }, | ||
| 'screenshot': { | ||
| name: 'getScreenshotImage', | ||
| param: 'id', | ||
| screenshot: { | ||
| name: "getScreenshotImage", | ||
| param: "id", | ||
| options: [options.run, options.image, options.screenshot], | ||
| info: 'get the fully loaded page screenshot in JPG format (PNG if in full resolution)' | ||
| info: "get the fully loaded page screenshot in JPG format (PNG if in full resolution)", | ||
| }, | ||
| 'video': { | ||
| name: 'createVideo', | ||
| param: 'tests', | ||
| video: { | ||
| name: "createVideo", | ||
| param: "tests", | ||
| options: [options.video], | ||
| info: 'create a video from <tests> (comma separated test ids)' | ||
| info: "create a video from <tests> (comma separated test ids)", | ||
| }, | ||
| 'player': { | ||
| name: 'getEmbedVideoPlayer', | ||
| param: 'id', | ||
| info: 'get a html5 player for a video <id>' | ||
| player: { | ||
| name: "getEmbedVideoPlayer", | ||
| param: "id", | ||
| info: "get a html5 player for a video <id>", | ||
| }, | ||
| 'listen': { | ||
| name: 'listen', | ||
| param: 'hostname:port', | ||
| listen: { | ||
| name: "listen", | ||
| param: "hostname:port", | ||
| optional: true, | ||
| options: [options.listen], | ||
| info: 'start webpagetest-api proxy server on <hostname>:<port> [hostname:%s]' | ||
| } | ||
| info: "start webpagetest-api proxy server on <hostname>:<port> [hostname:%s]", | ||
| }, | ||
| }; | ||
@@ -962,3 +973,3 @@ | ||
| commands: commands, | ||
| options: options | ||
| options: options, | ||
| }; |
@@ -27,2 +27,3 @@ /** | ||
| testers: 'getTesters.php', | ||
| testBalance: 'testBalance.php', | ||
| test: 'runtest.php', | ||
@@ -319,2 +320,13 @@ gzip: 'getgzip.php', | ||
| function getTestBalance(options, callback) { | ||
| callback = callback || options; | ||
| options = options === callback ? undefined : options; | ||
| var query = helper.setQuery(mapping.commands.testBalance, options); | ||
| if (!query.k && this.config.key) { | ||
| query.k = this.config.key; | ||
| } | ||
| return api.call(this, paths.testBalance, callback, query, options); | ||
| } | ||
| function runTest(what, options, callback) { | ||
@@ -783,2 +795,3 @@ var query = {}; | ||
| getPageSpeedData: getPageSpeedData, | ||
| getTestBalance : getTestBalance, | ||
| getHARData: getHARData, | ||
@@ -785,0 +798,0 @@ getUtilizationData: getUtilizationData, |
| { | ||
| "name": "webpagetest", | ||
| "version": "0.5.0", | ||
| "version": "0.5.1", | ||
| "description": "WebPageTest API wrapper for NodeJS", | ||
@@ -5,0 +5,0 @@ "author": "WebPageTest <github@WebPageTest.com> (http://github.com/WebPageTest)", |
@@ -59,2 +59,3 @@ <p align="center"><img src="https://docs.webpagetest.org/img/wpt-navy-logo.png" alt="WebPageTest Logo" /></p> | ||
| * **test** _[options] \<url_or_script\>_: run test, _\<url_or_script\>_ can also be a path to a script file | ||
| * **testBalance** _[options]_: get remaining tests for the account | ||
| * **restart** _\<id\>_: restart test | ||
@@ -108,2 +109,3 @@ * **cancel** _\<id\>_: cancel running/pending test | ||
| * **-N, --duration** _\<seconds\>_: minimum test duration in seconds | ||
| * **--injectScript** _\<string\>_: JavaScript to run after the document has started loading | ||
| * **-E, --tester** _\<name\>_: run the test on a specific PC (name must match exactly or the test will not run) | ||
@@ -164,3 +166,3 @@ * **-W, --mobile**: (experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only) | ||
| #### API Key (works for **test**, **restart**,**locations** and **cancel** commands) | ||
| #### API Key (works for **test**, **restart**,**locations**, **testBalance** and **cancel** commands) | ||
| * **-k, --key** _\<api_key\>_:API key (if assigned). Contact the WebPageTest server administrator for a key if required or request an API key for limited testing at [webpagetest.org/getkey.php](https://www.webpagetest.org/getkey.php) | ||
@@ -357,2 +359,14 @@ | ||
| #### 7. Get remaining tests count for the account | ||
| ```bash | ||
| $ webpagetest testBalance --key 1F2A3K4E5 | ||
| ``` | ||
| ```javascript | ||
| { | ||
| "data": { | ||
| "remaining": 1175 | ||
| } | ||
| } | ||
| ``` | ||
| #### Run test on https://docs.webpagetest.org/api/integrations/ and poll results every 5 seconds timing out in 60 seconds | ||
@@ -397,2 +411,3 @@ ```bash | ||
| * `getTesters(options, callback)` | ||
| * `getTestBalance(options, callback)` | ||
| * `runTest(url_or_script, options, callback)` | ||
@@ -399,0 +414,0 @@ * `restartTest(id, options, callback)` |
@@ -330,3 +330,3 @@ /** | ||
| 'console', 'testinfo', 'history', 'googlecsi', 'response', 'waterfall', | ||
| 'screenshot', 'video', 'player', 'listen', 'batch' | ||
| 'screenshot', 'video', 'player', 'listen', 'batch','testBalance' | ||
| ].forEach(function eachCmd(command) { | ||
@@ -333,0 +333,0 @@ it('gets a ' + command + ' help input and returns the help text', function(done) { |
@@ -35,2 +35,4 @@ Usage: webpagetest test [options] <url_or_script> | ||
| match exactly or the test will not run) | ||
| --injectScript <injectScript> JavaScript to run after the document has | ||
| started loading | ||
| -W, --mobile (experimental) emulate mobile browser: | ||
@@ -94,10 +96,20 @@ Chrome mobile user agent, 640x960 screen, | ||
| -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 | ||
| -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 | ||
@@ -104,0 +116,0 @@ when specifying a custom connectivity |
@@ -17,2 +17,3 @@ Usage: webpagetest [options] [command] | ||
| tests | ||
| testBalance [options] get remaining tests for the account | ||
| testers [options] list testers status and details | ||
@@ -19,0 +20,0 @@ test [options] <url_or_script> run test |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.03%
5800957
- Number of package files
- increased by0.78%
129
- Lines of code
- increased by0.02%
116701
- Number of lines in readme file
- increased by1.95%
784
- Number of medium supply chain risk alerts
- decreased by-9.09%
10
No dependency changes