Clean up the classes that handle run results, and correctly import JSON files with multiple runs #77
Conversation
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
Fix a bug where we failed to pass the event to a the “benchmark-options” radio changed handler.
Add test-data-import.js which tests creating a `ResultsDashboard` with imported JSON, which is the JSON produced by running the test via the browser. The test validates that the results analysis produces output data in the correct format, but does not validate the score calculation. To make the unit test run faster, we make `bootstrapIterations` be configurable via an option. The unit test sets this to a small value. Fix a bug that prevented the JSON results dialog being shown by using arrow functions in `BenchmarkController` so that `this` is correctly bound.
`BenchmarkRunnerClient.results` becomes `BenchmarkRunnerClient.scoreCalculator`. Add a public getter for `targetFrameRate`.
This class encapsulates the tuple of options, version and run data. ScoreCalculator can then store this in `runData`, replacing the separate storage of `options`, `version` and the confusingly named `_iterationsSamplers`.
When importing a file which is the result of a benchmark run with multiple iterations (which contains a `debugOutput` key), store all the runs in `RunData`. Add static methods to `RunData` to handle both types of JSON, and move the data migration code there. The score computation already correctly computed the arithmetic mean of the runs. The code already correctly built the results table for multiple runs.
rniwa
reviewed
Sep 16, 2024
| @@ -704,38 +691,38 @@ class DebugBenchmarkController extends BenchmarkController { | |||
| this.addedKeyEvent = true; | |||
| } | |||
|
|
|||
| var dashboard = this.runnerClient.results; | |||
| if (dashboard.options["controller"] == "ramp") | |||
| var scoreCalculator = this.runnerClient.scoreCalculator; | |||
rniwa
reviewed
Sep 16, 2024
| "% / +" + ((dashboard.scoreUpperBound / score - 1) * 100).toFixed(2) + "%"; | ||
| var fps = dashboard._systemFrameRate; | ||
| sectionsManager.setSectionVersion("results", dashboard.version); | ||
| var score = scoreCalculator.score; |
rniwa
reviewed
Sep 17, 2024
| RunData.#migrateImportedData(singleRunData); | ||
|
|
||
| if (!singleRunData.data instanceof Array) { | ||
| console.log('Imported singleRunData.data is not an array. Bailing'); |
rniwa
reviewed
Sep 17, 2024
| static resultsDataFromBenchmarkRunnerData(benchmarkData) | ||
| { | ||
| if (!benchmarkData instanceof Array) { | ||
| console.log('Imported benchmarkData is not an array. Bailing'); |
There was a problem hiding this comment.
Ditto and ditto for the rest of console.log in this file.
rniwa
reviewed
Sep 17, 2024
| } | ||
|
|
||
| let runData = []; | ||
| for (let run of benchmarkData) { |
rniwa
reviewed
Sep 17, 2024
| class ScoreCalculator { | ||
| constructor(runData) | ||
| { | ||
| this._runData = runData; |
There was a problem hiding this comment.
Why not use private member variables?
There was a problem hiding this comment.
The whole codebase needs a switch to private variables. For now I was following existing code.
rniwa
reviewed
Sep 17, 2024
| constructor(element, headers) | ||
| { | ||
| this.element = element; | ||
| this._headers = headers; |
There was a problem hiding this comment.
Why not use a private member variable?
rniwa
reviewed
Sep 17, 2024
| this.element = element; | ||
| this._headers = headers; | ||
|
|
||
| this._flattenedHeaders = []; |
rniwa
reviewed
Sep 17, 2024
| this._headers = headers; | ||
|
|
||
| this._flattenedHeaders = []; | ||
| this._headers.forEach(function(header) { |
rniwa
reviewed
Sep 17, 2024
| function findRegression(series, profile) { | ||
| var minIndex = Math.round(.025 * series.length); | ||
| var maxIndex = Math.round(.975 * (series.length - 1)); | ||
| var minComplexity = series.getFieldInDatum(minIndex, Strings.json.complexity); |
There was a problem hiding this comment.
Instead of keep accessing Strings.json.complexity over and over, can we just store in a local const variable and use that?
rniwa
reviewed
Sep 17, 2024
|
|
||
| // Convert these samples into SampleData objects if needed | ||
| [Strings.json.complexity, Strings.json.controller].forEach(function(seriesName) { | ||
| var series = samples[seriesName]; |
rniwa
reviewed
Sep 17, 2024
| const desiredFrameLength = 1000 / this._targetFrameRate; | ||
|
|
||
| function findRegression(series, profile) { | ||
| var minIndex = Math.round(.025 * series.length); |
There was a problem hiding this comment.
It seems like these could all be const. If not, let?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This series of commits clean up
ResultsDashboard(nowScoreCalculator), and addsRunData.It also adds unit tests for data import.