WebKit / Speedometer

An open source repository for the Speedometer benchmark
Other
592 stars 68 forks source link

install speedometer-workloads #418

Open flashdesignory opened 1 month ago

flashdesignory commented 1 month ago

Use speedometer-workloads package instead of local workloads

This pr installs a package that contains all workloads, in favor of using workloads that are currently in the resource folder.

Testing

for testing purposes, only installed chart.js workload and added a tag to compare "before&after".

http://127.0.0.1:7000/?developerMode=&tags=compare

What is speedometer-workloads?

Speedometer-workloads is a standalone monorepo that contains example apps and utilities that can be installed and used, instead of the current workloads that are included in the speedometer benchmark itself.

Benefits of using speedometer-workloads

Decoupling workloads from the benchmark would allow more flexibility and control over what workloads to use for local testing and how they can be configured for these tests.

Having a more modern and dynamic development setup will promote speed of development and motivate experimentation of new workloads, without being forced to adhere to technical constraints of Speedometer itself.

Speedometer-workloads can adhere to its own release cycle and will establish a new versioning of these workloads, which will result in more granular control on what workloads to install for each release of Speedometer.

A nice side effect of this change is that the workloads would also be re-usable for other benchmarks, if the need arises in the future.

Workloads install

Workloads are now installed through a (private) npm package. Currently, one single package is used for all workloads, instead of installing each workload separately. The Benefit of using a single package is simplicity. Downside is that we can’t decide in Speedometer, which version of a specific workload should be installed. This should be an easy step to change though.

speedometer-workloads

This package should be installed as a regular dependency of Speedometer. For testing purposes, the current package is private, until the changes are approved and agreed on. Since the package is private, the npm package name is scoped: @tkober/speedometer-workloads. Link to the speedometer-workloads source: https://github.com/GoogleChromeLabs/speedometer-workloads

"dependencies": {
    "@tkober/speedometer-workloads": "^1.3.0"
}

workloads.config.folder.json

This file determines which workload should get copied over from the @tkober/speedometer-workloads package.

{
    "workloads": [
        { 
            "name": "charts-chartjs",
            "type":"static"
        }
    ]
}

copy-workloads

The copy-workloads script in the package.json file, creates a workloads folder in the root of Speedometer with a copy of the dist folders of each work that is listed in the workloads.config.folder.json file.

"scripts": {
    "copy-workloads": "npm explore @tkober/speedometer-workloads pnpm run move:apps:custom"
}

Notes

@kara