Remote Runner / PostMessge api #456
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| <!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><meta name="next-head-count" content="2"/><link rel="preload" href="./_next/static/css/a0dca1379a01e5cf.css" as="style"/><link rel="stylesheet" href="./_next/static/css/a0dca1379a01e5cf.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="./_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script src="./_next/static/chunks/webpack-e50e9853db18b759.js" defer=""></script><script src="./_next/static/chunks/framework-2c79e2a64abdb08b.js" defer=""></script><script src="./_next/static/chunks/main-2ba37e62325cc71b.js" defer=""></script><script src="./_next/static/chunks/pages/_app-77983e68be50f72a.js" defer=""></script><script src="./_next/static/chunks/pages/_error-54de1933a164a1ff.js" defer=""></script><script src="./_next/static/0WioSK_GYKwlHihOM6Gxq/_buildManifest.js" defer=""></script><script src="./_next/static/0WioSK_GYKwlHihOM6Gxq/_ssgManifest.js" defer=""></script></head><body><div id="__next"></div><div id="settings-container"></div><div id="notifications-container"></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"0WioSK_GYKwlHihOM6Gxq","assetPrefix":".","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html> |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| <!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><meta name="next-head-count" content="2"/><link rel="preload" href="./_next/static/css/a0dca1379a01e5cf.css" as="style"/><link rel="stylesheet" href="./_next/static/css/a0dca1379a01e5cf.css" data-n-g=""/><link rel="preload" href="./_next/static/css/2cf5163b53bb0adb.css" as="style"/><link rel="stylesheet" href="./_next/static/css/2cf5163b53bb0adb.css" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="./_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script src="./_next/static/chunks/webpack-e50e9853db18b759.js" defer=""></script><script src="./_next/static/chunks/framework-2c79e2a64abdb08b.js" defer=""></script><script src="./_next/static/chunks/main-2ba37e62325cc71b.js" defer=""></script><script src="./_next/static/chunks/pages/_app-77983e68be50f72a.js" defer=""></script><script src="./_next/static/chunks/743-fd706aeabb7828e3.js" defer=""></script><script src="./_next/static/chunks/pages/index-bca4656243ade034.js" defer=""></script><script src="./_next/static/0WioSK_GYKwlHihOM6Gxq/_buildManifest.js" defer=""></script><script src="./_next/static/0WioSK_GYKwlHihOM6Gxq/_ssgManifest.js" defer=""></script></head><body><div id="__next"></div><div id="settings-container"></div><div id="notifications-container"></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/","query":{},"buildId":"0WioSK_GYKwlHihOM6Gxq","assetPrefix":".","nextExport":true,"autoExport":true,"isFallback":false,"scriptLoader":[]}</script></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| import { BenchmarkStep, BenchmarkSuite, BenchmarkSuitesManager, forceLayout, getElement } from "speedometer-utils/workload-testing-utils.mjs"; | ||
|
|
||
| export function getBenchmarkSuitesManager() { | ||
| return new BenchmarkSuitesManager(window.name, [ | ||
| new BenchmarkSuite("default", [ | ||
| new BenchmarkStep("Navigate-to-US-page", () => { | ||
| for (let i = 0; i < 25; i++) { | ||
| getElement("#navbar-dropdown-toggle").click(); | ||
| forceLayout(); | ||
| getElement("#navbar-dropdown-toggle").click(); | ||
| forceLayout(); | ||
| } | ||
|
|
||
| getElement("#navbar-navlist-us-link").click(); | ||
| forceLayout(); | ||
| }), | ||
| new BenchmarkStep("Navigate-to-World-page", () => { | ||
| for (let i = 0; i < 25; i++) { | ||
| getElement("#navbar-dropdown-toggle").click(); | ||
| forceLayout(); | ||
| getElement("#navbar-dropdown-toggle").click(); | ||
| forceLayout(); | ||
| } | ||
|
|
||
| getElement("#navbar-navlist-world-link").click(); | ||
| forceLayout(); | ||
| }), | ||
| new BenchmarkStep("Navigate-to-Politics-page", () => { | ||
| for (let i = 0; i < 25; i++) { | ||
| getElement("#navbar-dropdown-toggle").click(); | ||
| forceLayout(); | ||
| getElement("#navbar-dropdown-toggle").click(); | ||
| forceLayout(); | ||
| } | ||
|
|
||
| getElement("#navbar-navlist-politics-link").click(); | ||
| forceLayout(); | ||
| }), | ||
| ]), | ||
| ]); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| import { TestRunner } from "./test-runner.mjs"; | ||
| import { Params } from "./params.mjs"; | ||
|
|
||
| /** | ||
| * BenchmarkStep | ||
| * | ||
| * A single test step, with a common interface to interact with. | ||
| */ | ||
| export class BenchmarkStep { | ||
| constructor(name, run) { | ||
| this.name = name; | ||
| this.run = run; | ||
| } | ||
|
|
||
| async runAndRecord(params, suite, test, callback) { | ||
| const testRunner = new TestRunner(null, null, params, suite, test, callback); | ||
| const result = await testRunner.runTest(); | ||
|
There was a problem hiding this comment. Do we need an explicit await here? Can't we just return the result of There was a problem hiding this comment. yes, since the RAFTestInvoker has this line:
|
||
| return result; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * BenchmarkSuite | ||
| * | ||
| * A single test suite that contains one or more test steps. | ||
| */ | ||
| export class BenchmarkSuite { | ||
| constructor(name, tests) { | ||
| this.name = name; | ||
| this.tests = tests; | ||
| } | ||
|
|
||
| record(_test, syncTime, asyncTime) { | ||
| const total = syncTime + asyncTime; | ||
| const results = { | ||
| tests: { Sync: syncTime, Async: asyncTime }, | ||
| total: total, | ||
| }; | ||
|
|
||
| return results; | ||
| } | ||
|
|
||
| async runAndRecord(params, onProgress) { | ||
| const measuredValues = { | ||
| tests: {}, | ||
| total: 0, | ||
| }; | ||
| const suiteStartLabel = `suite-${this.name}-start`; | ||
| const suiteEndLabel = `suite-${this.name}-end`; | ||
|
|
||
| performance.mark(suiteStartLabel); | ||
|
|
||
| for (const test of this.tests) { | ||
| const result = await test.runAndRecord(params, this, test, this.record); | ||
| measuredValues.tests[test.name] = result; | ||
| measuredValues.total += result.total; | ||
| onProgress?.(test.name); | ||
| } | ||
|
|
||
| performance.mark(suiteEndLabel); | ||
| performance.measure(`suite-${this.name}`, suiteStartLabel, suiteEndLabel); | ||
|
|
||
| return { | ||
| type: "suite-tests-complete", | ||
| status: "success", | ||
| result: measuredValues, | ||
| suitename: this.name, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * BenchmarkSuitesManager | ||
| * | ||
| * A collection of test suites for a single workload. | ||
| */ | ||
| export class BenchmarkSuitesManager { | ||
| constructor(name, suites) { | ||
| this.name = name; | ||
| this.suites = suites; | ||
| } | ||
|
|
||
| getSuiteByName(name) { | ||
| return this.suites.find((suite) => suite.name === name); | ||
| } | ||
| } | ||
|
|
||
| /** ********************************************************************** | ||
| * BenchmarkConnector | ||
| * | ||
| * postMessage is used to communicate between app and benchmark. | ||
| * When the app is ready, an 'app-ready' message is sent to signal that the app can receive instructions. | ||
| * | ||
| * A prepare script within the apps appends window.name and window.version from the package.json file. | ||
| * The appId is build by appending name-version | ||
| * It's used as an additional safe-guard to ensure the correct app responds to a message. | ||
| *************************************************************************/ | ||
| export class BenchmarkConnector { | ||
| constructor(benchmarkSuitesManager, name, version) { | ||
| this.benchmarkSuitesManager = benchmarkSuitesManager; | ||
| this.name = name; | ||
| this.version = version; | ||
|
|
||
| if (!name || !version) | ||
| console.warn("No name or version supplied, to create a unique appId"); | ||
|
|
||
| this.appId = name && version ? `${name}-${version}` : -1; | ||
| this.onMessage = this.onMessage.bind(this); | ||
| } | ||
|
|
||
| async onMessage(event) { | ||
| if (event.data.id !== this.appId || event.data.key !== "benchmark-connector") | ||
| return; | ||
|
|
||
| switch (event.data.type) { | ||
| case "benchmark-suite": | ||
| // eslint-disable-next-line no-case-declarations | ||
| const params = new Params(new URLSearchParams(window.location.search)); | ||
| // eslint-disable-next-line no-case-declarations | ||
| const { result } = await this.benchmarkSuitesManager.getSuiteByName(event.data.name).runAndRecord(params, (test) => this.sendMessage({ type: "step-complete", status: "success", appId: this.appId, name: this.name, test })); | ||
| this.sendMessage({ type: "suite-complete", status: "success", appId: this.appId, result }); | ||
| this.disconnect(); | ||
| break; | ||
| default: | ||
| console.error(`Message data type not supported: ${event.data.type}`); | ||
| } | ||
| } | ||
|
|
||
| sendMessage(message) { | ||
| window.top.postMessage(message, "*"); | ||
| } | ||
|
|
||
| connect() { | ||
| window.addEventListener("message", this.onMessage); | ||
| this.sendMessage({ type: "app-ready", status: "success", appId: this.appId }); | ||
| } | ||
|
|
||
| disconnect() { | ||
| window.removeEventListener("message", this.onMessage); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /** | ||
| * Helper Methods | ||
| * | ||
| * Various methods that are extracted from the Page class. | ||
| */ | ||
| export function getParent(lookupStartNode, path) { | ||
| lookupStartNode = lookupStartNode.shadowRoot ?? lookupStartNode; | ||
| const parent = path.reduce((root, selector) => { | ||
| const node = root.querySelector(selector); | ||
| return node.shadowRoot ?? node; | ||
| }, lookupStartNode); | ||
|
|
||
| return parent; | ||
| } | ||
|
|
||
| export function getElement(selector, path = [], lookupStartNode = document) { | ||
| const element = getParent(lookupStartNode, path).querySelector(selector); | ||
| return element; | ||
| } | ||
|
|
||
| export function getAllElements(selector, path = [], lookupStartNode = document) { | ||
| const elements = Array.from(getParent(lookupStartNode, path).querySelectorAll(selector)); | ||
| return elements; | ||
| } | ||
|
|
||
| export function forceLayout() { | ||
| const rect = document.body.getBoundingClientRect(); | ||
| const e = document.elementFromPoint((rect.width / 2) | 0, (rect.height / 2) | 0); | ||
| return e; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "name": "speedometer-utils", | ||
| "version": "1.0.0", | ||
| "description": "Utility files for Speedometer & Workloads" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So a bunch of tests are all going to have their own getBenchmarkSuitesManager?
That would make grep'ing harder. Why not name this after each suite?
e.g.
import { NewsNextSuite } from "@/workload-test.mjs";There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A workload can have multiple suites, but we could name it after the workload.
What's the benefit of renaming it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
with the mentioned suites object, which is exported as default, we could easily rename the import if that's desired.