browsertime 19.3.1 → 21.0.0

package/browsersupport/firefox-profile/chrome/userChrome.css

@@ -1,4 +0,0 @@
-@namespace url("http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"); /* only needed once */
-
-/* use this code to hide all messages */
-statuspanel { display:none!important; }

package/docs/examples/README.md

@@ -1,9 +0,0 @@
-Examples
-========
-All examples are under the assumption that the tool was installed via npm. If you have cloned the git repository you will need to substitute "browsertime" with the path to the JS file "bin/browsertime.js" relative to the checked out repository.
-
-- [Basic](basic.md)
-- [Advance](advance.md)
-- [Firefox](firefox.md)
-- [Chrome](chrome.md)
-- [Android](android.md)

package/docs/examples/advance.md

@@ -1,12 +0,0 @@
-Advance Examples
-================
-
-This page shows a few of the more advance examples of browsertime
-
-browsertime https://www.sitespeed.io --script ~/browserscripts/scripts.js
-
-- The script option allows for a single file or a directory to be passed to gather custom values that will be available in the JSON output. An additional page will be created to cover this option in the future.
-
-bin/browsertime.js https://www.sitespeed.io --pageCompleteCheck 'return window.performance.timing.loadEventEnd>0'
-
-- You can pass in a javascript snippet that is repeatedly queried to see if page has completed loading (indicated by the script returning true). Default script is 'return window.performance.timing.loadEventEnd>0'.

package/docs/examples/android.md

@@ -1,54 +0,0 @@
-Android Examples
-================
-
-This page will give a few example to get you up and running with
-browsertime on Android devices.  Generally, add `--android` and then
-configure the browser vehicle.
-
-`browsertime --android https://www.sitespeed.io`
-
-- The `--android` flag targets Chrome for Android by
-  default.
-- Chrome for Android means the `com.android.chrome` package (and the
-  `com.google.android.apps.chrome.Main` activity).
-
-`browsertime --android --browser chrome --chrome.android.deviceSerial SERIAL https://www.sitespeed.io`
-
-- Use `chrome.android.deviceSerial` to target a specific device (by
-  serial or by ADB-over-TCP/IP address.
-
-`browsertime --android --browser firefox https://www.sitespeed.io`
-
-- The `firefox` browser means GeckoView example by default.
-- GeckoView example means the `org.mozilla.geckoview_example` package
-  and the `org.mozilla.geckoview_example.GeckoViewActivity` activity.
-
-`browsertime --android --browser firefox --firefox.android.deviceSerial '127.0.0.1:555' https://www.sitespeed.io`
-
-- Use `firefox.android.deviceSerial` to target a specific device (by
-  serial or by ADB-over-TCP/IP address.
-
-`browsertime --android --browser firefox --firefox.android.package org.mozilla.fenix.debug --firefox.android.activity org.mozilla.fenix.IntentReceiverActivity https://www.sitespeed.io`
-
-- Use `firefox.android.{package,activity}` to configure which Android
-  package and activity is invoked for GeckoView (`--browser firefox`)
-  Apps.
-
-`browsertime --android --browser firefox --firefox.android.package org.mozilla.firefox --firefox.android.activity org.mozilla.gecko.BrowserApp --firefox.android.intentArgument=--ez --firefox.android.intentArgument=skipstartpane --firefox.android.intentArgument=true https://www.sitespeed.io`
-
-- Use `firefox.android.intentArgument` to configure how the Android
-  intent is launched.
-- Prefer `firefox.android.intentArgument=...`, especially with
-  arguments starting with hyphens, to avoid a browsertime parsing
-  issue where the `--...` will be interpreted as an argument to
-  browsertime itself.
-- Passed through to `adb shell am start ...` follow the format at
-  [https://developer.android.com/studio/command-line/adb#IntentSpec](https://developer.android.com/studio/command-line/adb#IntentSpec).
-- To add multiple arguments, repeat `--firefox.android.intentArgument`
-  arguments.
-
-`browsertime --android --browser chrome --chrome.android.package org.mozilla.tv.firefox.debug --firefox.android.activity .MainActivity https://www.sitespeed.io`
-
-- Use `chrome.android.{package,activity}` to configure which Android
-  package and activity is invoked for WebView (`--browser chrome`)
-  Apps.

package/docs/examples/basic.md

@@ -1,36 +0,0 @@
-Basic Examples
-==============
-
-This page will give a few example to get you up and running with browsertime.
-
-browsertime --help
-
-- Use the help option if you would like to know what options are available.
-
-browsertime https://www.sitespeed.io
-
-- The only required option when running browsertime is the URL you want to test.
-
-browsertime https://www.sitespeed.io -n 5
-
-- If you would like to override the default number of runs. It defaults to 3.
-
-browsertime https://www.sitespeed.io --screenshot
-
-- If you would like to capture screenshots during your run(s). It will capture a screenshot for each run.
-
-browsertime https://www.sitespeed.io -b chrome
-
-- If you would like to override the default browser used. Defaults to Firefox.
-
-browsertime https://www.sitespeed.io --prettyPrint
-
-- If you would like to output the HAR in a more human readable format.
-
-browsertime https://www.sitespeed.io --delay 5000
-
-- If you would like to deploy the time in between test runs. This option takes milliseconds and defaults no delay(0).
-
-browsertime https://www.sitespeed.io --userAgent 'Googlebot/2.1 (+http://www.googlebot.com/bot.html)'
-
-- If you want to customize the user agent passed to the test runs you can do so with the user agent option.

package/docs/examples/chrome.md

@@ -1,28 +0,0 @@
-Chrome Examples
-===============
-
-This page shows a few of the options specific to Chrome.
-
-browsertime https://www.sitespeed.io -b chrome
-
-- Will use chrome's native performance logs to generate a HAR file.
-
-browsertime https://www.sitespeed.io --chrome.collectPerfLog -b chrome
-
-- Used for debugging  chrome's native HAR export you can have it additionally output the Chrome performance logs.
-
-browsertime https://www.sitespeed.io --chrome.args -b chrome                        
-
-- Extra command line args to pass directly to the chrome process. (e.g. --no-sandbox)
-
-browsertime https://www.sitespeed.io --chrome.binaryPath -b chrome                  
-
-- Path to custom Chrome binary (e.g. Chrome Canary). On OS X, the path should be to the binary inside the app bundle. (e.g. /Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary)
-
-browsertime https://www.sitespeed.io --chrome.mobileEmulation.deviceName 'Apple iPad' -b chrome
-
-- Name of device to emulate (see list in Chrome DevTools)
-
-browsertime https://www.sitespeed.io --chrome.mobileEmulation.width 360 --chrome.mobileEmulation.height 640 --chrome.mobileEmulation.pixelRatio 2.0 -b chrome
-
-- Width in pixels of emulated mobile screen (e.g. 360), Height in pixels of emulated mobile screen (e.g. 640), Pixel ration of emulated mobile screen (e.g. 2.0)

package/docs/examples/firefox.md

@@ -1,10 +0,0 @@
-Firefox Examples
-================
-
-This page shows a few of the options specific to Firefox.
-
-```
-browsertime https://www.sitespeed.io -b firefox --firefox.binaryPath '/Applications/Firefox.app/Contents/MacOS/firefox-bin'
-```
-
-- Path to custom Firefox binary (e.g. Firefox Nightly). On OS X, the path should be to the binary inside the app bundle. (e.g. /Applications/Firefox.app/Contents/MacOS/firefox-bin)

package/docs/issues.md

@@ -1,18 +0,0 @@
-Running one of the example from the example docs produces the following error:
-
-``` shellsession
-browsertime https://www.sitespeed.io/             
-[2016-04-06 22:40:03] Running chrome for url: https://www.sitespeed.io/
-events.js:141
-      throw er; // Unhandled 'error' event
-      ^
-
-Error: spawn java ENOENT
-    at exports._errnoException (util.js:870:11)
-    at Process.ChildProcess._handle.onexit (internal/child_process.js:178:32)
-    at onErrorNT (internal/child_process.js:344:16)
-    at nextTickCallbackWith2Args (node.js:442:9)
-    at process._tickCallback (node.js:356:17)
-```
-
-Solution: Java is missing from your system and you will need install it.

package/docs/new-style-script-objects.md

@@ -1,38 +0,0 @@
-# New-style script objects:
-
-A new-style object allows the user to write a script that executes in an environment that meets certain requirements. The script writer specifies the requirements for their script and the browser will meet those requirements before executing the script's functionality. If the requirements cannot be met, then the script's functionality will not be executed.
-
-A new-style script object is defined in a script file by a single object that is assigned to `module.exports`. A new-style script object has the following keys:
-
-  * *requires*: An object whose keys define the requirements for executing this script object's functionality.
-  * *function*: A possibly asynchronous function that actually performs the script object's actions. The function will be invoked with no parameters. If the function is asynchronous, it must return a `Promise`. The value `resolve`d by that promise is serialized into browsertime's result output. If the function is not asynchronous, any value returned by this function is written into browsertime's result output.
-
-At the moment, browsertime only supports one requirement in new-style script objects, the `privilege` requirement. If the `privilege` requirement is set to `true`, the new-style script object's functionality will execute with access to the browser's privileged APIs (which is currently only available in Firefox). If the browser cannot guarantee that the script can execute with access to the browser's privileged API (for whatever reason), it will not be executed.
-
-For example,
-
-    module.exports = {
-        requires: { privilege: true },
-        function: function() {
-            const { AppConstants } = ChromeUtils.import(
-                'resource://gre/modules/AppConstants.jsm'
-            );
-            return AppConstants;
-        }
-    };
-
-defines a new-style script object that requires access to the browser's privileged API in order to fetch its constants.
-
-The equivalent functionality can be accomplished asynchronously:
-
-    module.exports = {
-        requires: { privilege: true },
-        function: async function() {
-                return new Promise(resolve => {
-                        const { AppConstants } = ChromeUtils.import(
-                                'resource://gre/modules/AppConstants.jsm'
-                        );
-                        resolve(AppConstants);
-                });
-        }
-    };

package/docs/sequence-diagrams/loadAndWait.wsd

@@ -1,24 +0,0 @@
-title Load a url and wait for load to complete
-
-caller -> SeleniumRunner: loadAndWait
-SeleniumRunner -> Browser: set page load timeout
-SeleniumRunner -> Browser: set script timeout
-SeleniumRunner -> Browser: Load url
-
-note right of Browser
-Wait at most "page load timeout"
-milliseconds
-end note
-
-Browser -> SeleniumRunner :
-SeleniumRunner -> Browser: executeScript "pageCompleteCheck"
-
-note right of Browser
-Keep testing script
-at most "wait script timeout"
-milliseconds
-end note
-
-Browser -> SeleniumRunner :
-
-SeleniumRunner -> caller :

package/docs/sequence-diagrams/run.wsd

@@ -1,24 +0,0 @@
-title Run one url via Engine
-
-caller -> Engine: run
-Engine -> EngineDelegate: onStartRun (BmpRunner - start proxy)
-
-loop n times
-  Engine -> SeleniumRunner: start
-  SeleniumRunner -> Browser: launch browser
-  Engine -> EngineDelegate: onStartIteration (createHAR OR startNewPage)
-  Engine -> SeleniumRunner: loadAndWait
-  SeleniumRunner -> Browser: get url and execute pageCompleteCheck
-  loop for each script
-    Engine -> SeleniumRunner: runScript
-    SeleniumRunner -> Browser: executeScript
-  end
-  Engine -> EngineDelegate: onStopIteration
-  Engine -> SeleniumRunner: stop
-  SeleniumRunner -> Browser: quit browser
-  Engine -> Engine: optionally wait for short delay
-end
-
-Engine -> EngineDelegate: onStopRun (BmpRunner - getHAR, stop proxy)
-
-Engine -> caller : [return HAR and script results]

package/visualmetrics/__init__.py

@@ -1 +0,0 @@
-#

package/visualmetrics/test_visualmetrics.py

@@ -1,34 +0,0 @@
-import unittest
-import os
-
-from browsertime.visualmetrics import (
-    calculate_contentful_speed_index,
-    calculate_perceptual_speed_index,
-)
-
-HERE = os.path.dirname(__file__)
-
-
-class TestVisualMetrics(unittest.TestCase):
-    def setUp(self):
-        self.directory = "test_data"
-        images = os.listdir(os.path.join(HERE, self.directory))
-
-        def _p(image):
-            p = {}
-            p["time"] = int(image.split(".")[0].split("ms_")[-1])
-            return p
-
-        progress = [_p(image) for image in images if image.startswith("ms_")]
-        self.sorted_progress = sorted(progress,
-                                      key = lambda image: image['time'])
-
-    def test_calculate_contentful_speed_index(self):
-        res = calculate_contentful_speed_index(self.sorted_progress,
-                                               self.directory)
-        self.assertEqual(res[0], 1188)
-
-    def test_calculate_perceptual_speed_index(self):
-        res = calculate_perceptual_speed_index(self.sorted_progress,
-                                               self.directory)
-        self.assertEqual(res[0], 946)