Aurora Workloads is a collection of open source example apps and sites that aim to be representative of the web. These workloads can be consumed by benchmarks for testing and benchmarking purposes.
This repo contains two distinct directories, which groups containing projects into apps and packages.
apps: Main directory for workload apps and websites.packages: Reusable projects that can be consumed by workloads or benchmarks.
Table of content:
This monorepo is managed by pnpm. In order to develop or test locally, please ensure that pnpm is installed on your machine.
Install pnpm globally with npm:
npm install -g pnpmFor troubleshooting, refer to this guide.
Once pnpm is available, the following script installs all dependencies for all projects:
pnpm installTo run a single app, a filter function from pnpm can be used from the root directory. Each app can be targeted by referencing its package name.
For example to run the news-site-next app in development mode, the following command can be used:
pnpm -F news-site-next devSee Workloads Manager.
pnpm -F workloads-manager startThe following scripts are currently supported by all workloads:
dev: Run a workload in dev mode locally.build:static: Bundles all necessary files and copies them into adistfolder.start:static: Starts a node server to serve files from thedistfolder.
These scripts can be used either by opening a terminal in each workloads directory itself, or from the root of this repo.
From a workloads directory, by navigating to the folder in your finder and opening a terminal.
Example news-site-next:
npm run dev
npm run build:static
npm run start:staticFrom the root of the repo with pnpm and a filter flag.
Example news-site-next:
pnpm -F news-site-next dev
pnpm -F news-site-next build:static
pnpm -F news-site-next start:staticTo enable communication between the workloads and a benchmark using postMessage, the benchmark-connector package is used.
Each workload that opts into this feature has the benchmark-connector package installed.
Some workloads use a prepare script to copy the relevant JavaScript file to the appropriate directory.
To run the build script on all apps, the following command can be used:
pnpm run build:appsMain directory for all workloads, which are grouped by categories:
news-site: Various versions of a news site.todomvc: Various versions of a todo application.
A news site that allows testing of a single-page application. The content is derrived from a static local source and is available in english, japanese and arabic. Styling supports left-to-right (LTR) and right-to-left (RTL) and can be forced by passing in the following url parameters:
dir: "rtl" or "ltr"lang: "en", "jp" or "ar" (defaults to "en" if language is not found)
Several interactions are available, such as:
- navigating to different pages
- expanding and collapsing a sitebar
- showing and hiding of login modal
- showing and hiding of settings modal
- toggling of drop-down menu
pnpm -F news-site-next dev
pnpm -F news-site-next build
pnpm -F news-site-next build:static
pnpm -F news-site-next start
pnpm -F news-site-next start:staticpnpm -F news-site-nuxt dev
pnpm -F news-site-nuxt build
pnpm -F news-site-nuxt build:static
pnpm -F news-site-nuxt start
pnpm -F news-site-next start:staticTodoMVC is a to-do application that allows a user to keep track of tasks. The user can enter a new task, update an existing one, mark a task as completed, or delete it. In addition to the basic CRUD operations, the TodoMVC app has some added functionality: filters are available to change the view to “all”, “active” or “completed” tasks and a status text displays the number of active tasks to complete.
pnpm -F todomvc-web-components dev
pnpm -F todomvc-web-components build:static
pnpm -F todomvc-web-components start:staticDirectory that contains shareable utilities that can be consumed by the apps, or installed by a benchmark.
To format all packages or to build all packages, the following script can be used:
pnpm run format:packages
pnpm run build:packagesVarious plugins for bundlers.
pnpm -F rollup-constructable-css format
pnpm -F rollup-constructable-css buildpnpm -F rollup-copy-files format
pnpm -F rollup-copy-files buildStyles for workloads.
pnpm -F news-site-css format
pnpm -F news-site-css buildpnpm -F todomvc-css format
pnpm -F todomvc-css buildTools that are used by workloads or benchmarks.
A script that helps moving workload files to an output folder. This script also takes care or renaming references in the index.html file, to ensure the output folder contains a locally contained build.
pnpm -F app-build-scripts format
pnpm -F app-build-scripts buildEnables communication between benchmarks and workloads.
- benchmark-connector.min.js: communication between benchmark and workload.
- prepare.min.js: script to copy benchmark-connector.min.js file to the public folder of workload.
pnpm -F benchmark-connector format
pnpm -F benchmark-connector buildUsed to generate a complex dom for todomvc apps.
pnpm -F big-dom-generator buildUtility to remove words from output files that should be ommited.
pnpm -F sanitize-language format
pnpm -F sanitize-language buildManages all workloads, by using the following commands:
- connect: waits for a connection on all ports from the workloads.config.json file.
- start: starts node server for static workloads from the workloads.config.json file.
pnpm -F workloads-manager format
pnpm -F workloads-manager build
pnpm -F workloads-manager connect
pnpm -F workloads-manager startThe workloads manager depends on a workloads.config.json file, which contains a list of apps to run.
- The
portskey is a list of ports to start a server on. - The
workloadskey contains an array of workloads.
Each workload contains the following keys:
name: Package name of the workload.type: Build type, to determine how to run it Currently onlystaticis supported.
{
"ports": [8080, 8081]
"workloads": [
{
"name": "news-site-next",
"type": "static",
}
]
}