Add workload resources.txt (#554)

For supporting service workers in PR #540 we need an explicit list of resources for each workload so we can preload them.
This adds a common resources/shared/generate-resources.mjs helper that is used in all build scripts to generate a list of all files in the respective dist/ output folder.

Author: camillobruni

resources/shared/generate-resources.mjs

@@ -0,0 +1,26 @@
+import fs from "fs";
+import path from "path";
+
+function walkDir(dir, fileList = []) {
+    const files = fs.readdirSync(dir);
+    for (const file of files) {
+        const filePath = path.join(dir, file);
+        if (fs.statSync(filePath).isDirectory())
+            walkDir(filePath, fileList);
+        else
+            fileList.push(filePath);
+    }
+    return fileList;
+}
+
+export function generateResourcesFile(distPath) {
+    if (!fs.existsSync(distPath)) {
+        console.warn(`Directory ${distPath} does not exist, skipping resources.txt generation.`);
+        return;
+    }
+    const absoluteDist = path.resolve(distPath);
+    const files = walkDir(absoluteDist);
+    const relativePaths = files.map((f) => path.relative(absoluteDist, f)).filter((f) => f !== "resources.txt");
+    fs.writeFileSync(path.join(absoluteDist, "resources.txt"), `${relativePaths.join("\n")}\n`, "utf8");
+    console.log(`Generated resources.txt at ${distPath}`);
+}

suites-experimental/javascript-wc-indexeddb/dist/resources.txt

@@ -0,0 +1,39 @@
+index.html
+libs/dexie.mjs
+src/components/todo-app/todo-app.component.js
+src/components/todo-app/todo-app.template.js
+src/components/todo-bottombar/todo-bottombar.component.js
+src/components/todo-bottombar/todo-bottombar.template.js
+src/components/todo-item/todo-item.component.js
+src/components/todo-item/todo-item.template.js
+src/components/todo-list/todo-list.component.js
+src/components/todo-list/todo-list.template.js
+src/components/todo-topbar/todo-topbar.component.js
+src/components/todo-topbar/todo-topbar.template.js
+src/hooks/useDoubleClick.js
+src/hooks/useKeyListener.js
+src/hooks/useRouter.js
+src/index.mjs
+src/speedometer-utils/benchmark.mjs
+src/speedometer-utils/helpers.mjs
+src/speedometer-utils/params.mjs
+src/speedometer-utils/test-invoker.mjs
+src/speedometer-utils/test-runner.mjs
+src/speedometer-utils/todomvc-utils.mjs
+src/speedometer-utils/translations.mjs
+src/storage/base-storage-manager.js
+src/storage/dexieDB-manager.js
+src/storage/indexedDB-manager.js
+src/storage/storage-factory.js
+src/utils/nanoid.js
+src/workload-test.mjs
+styles/app.constructable.js
+styles/bottombar.constructable.js
+styles/footer.css
+styles/global.constructable.js
+styles/global.css
+styles/header.css
+styles/main.constructable.js
+styles/todo-item.constructable.js
+styles/todo-list.constructable.js
+styles/topbar.constructable.js

suites-experimental/javascript-wc-indexeddb/scripts/build.mjs

@@ -1,3 +1,5 @@
+import path from "path";
+import { generateResourcesFile } from "../../../resources/shared/generate-resources.mjs";
 import fs from "fs/promises";
 import { dirname } from "path";
 
@@ -97,7 +99,7 @@ const filesToMove = [
     { src: "node_modules/todomvc-css/dist/todo-list.constructable.js", dest: "./dist/styles/todo-list.constructable.js" },
     { src: "node_modules/todomvc-css/dist/todo-item.constructable.js", dest: "./dist/styles/todo-item.constructable.js" },
     { src: "node_modules/dexie/dist/modern/dexie.mjs", dest: "./dist/libs/dexie.mjs" },
-    { src: "node_modules/speedometer-utils/step-scheduler.mjs", dest: "./dist/src/speedometer-utils/test-invoker.mjs" },
+    { src: "node_modules/speedometer-utils/step-scheduler.mjs", dest: "./dist/src/speedometer-utils/step-scheduler.mjs" },
     { src: "node_modules/speedometer-utils/step-runner.mjs", dest: "./dist/src/speedometer-utils/step-runner.mjs" },
     { src: "node_modules/speedometer-utils/params.mjs", dest: "./dist/src/speedometer-utils/params.mjs" },
     { src: "src/speedometer-utils/benchmark.mjs", dest: "./dist/src/speedometer-utils/benchmark.mjs" },
@@ -164,4 +166,5 @@ const build = async () => {
     console.log("Done with building!");
 };
 
-build();
+await build();
+await generateResourcesFile(path.join(import.meta.dirname, "../dist"));

suites-experimental/responsive-design/dist/resources.txt

@@ -0,0 +1,39 @@
+app.js
+index.html
+public/images/5-healthy-smoothie.webp
+public/images/beef-stroganoff.webp
+public/images/beef-tacos.webp
+public/images/best-comfort-food.webp
+public/images/bread-at-home.webp
+public/images/caesar-salad.webp
+public/images/chicken-alfredo.webp
+public/images/chocolate-cake.webp
+public/images/chocolate-chip-cookies.webp
+public/images/fruit-salad.webp
+public/images/garlic-bread.webp
+public/images/gluten-free-baking.webp
+public/images/greek-salad.webp
+public/images/homemade-pizza.webp
+public/images/icons-outline.webp
+public/images/lemon-drizzle-cake.webp
+public/images/low-carb-desserts.webp
+public/images/margherita-pizza.webp
+public/images/mastering-art-of-french-cooking.webp
+public/images/meal-prepping.webp
+public/images/mediterranean-cuisine.webp
+public/images/pancakes.webp
+public/images/plant-based-protein.webp
+public/images/quinoa-stuffed-peppers.webp
+public/images/ramen-noodles.webp
+public/images/seasonal-salads.webp
+public/images/shrimp-paella.webp
+public/images/spaghetti-carbonara.webp
+public/images/superfoods-you-should-include.webp
+public/images/sushi-platter.webp
+public/images/thai-green-curry.webp
+public/images/tomato-soup.webp
+public/images/vegan-burger.webp
+public/images/vegan-desserts.webp
+public/images/vegetable-stir-fry.webp
+public/images/vegetarian-stir-fry.webp
+public/images/week-night-dinners.webp

suites-experimental/suites.mjs

@@ -7,6 +7,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "TodoMVC-LocalStorage",
         url: "suites-experimental/todomvc-localstorage/dist/index.html",
+        resources: "suites-experimental/todomvc-localstorage/dist/resources.txt",
         tags: ["todomvc", "experimental"],
         async prepare(page) {
             (await page.waitForElement(".new-todo")).focus();
@@ -36,6 +37,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "TodoMVC-Emoji",
         url: "suites/todomvc/vanilla-examples/javascript-web-components/dist/index.html",
+        resources: "suites/todomvc/vanilla-examples/javascript-web-components/dist/resources.txt",
         tags: ["todomvc", "experimental"],
         async prepare(page) {
             await page.waitForElement("todo-app");
@@ -68,6 +70,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "TodoMVC-WebComponents-PostMessage",
         url: "suites/todomvc/vanilla-examples/javascript-web-components/dist/index.html",
+        resources: "suites/todomvc/vanilla-examples/javascript-web-components/dist/resources.txt",
         tags: ["experimental", "todomvc", "webcomponents"],
         async prepare() {},
         type: "remote",
@@ -78,6 +81,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "TodoMVC-Jaspr-Dart2JS-O4",
         url: "suites-experimental/todomvc-dart-jaspr/dist/out-dart2js-O4/index.html",
+        resources: "suites-experimental/todomvc-dart-jaspr/dist/out-dart2js-O4/resources.txt",
         tags: ["todomvc", "experimental"],
         async prepare(page) {
             (await page.waitForElement(".new-todo")).focus();
@@ -106,6 +110,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "TodoMVC-Jaspr-Dart2Wasm-O2",
         url: "suites-experimental/todomvc-dart-jaspr/dist/out-dart2wasm-O2/index.html",
+        resources: "suites-experimental/todomvc-dart-jaspr/dist/out-dart2wasm-O2/resources.txt",
         tags: ["todomvc", "experimental"],
         disabled: true,
         async prepare(page) {
@@ -135,6 +140,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "NewsSite-PostMessage",
         url: "suites/newssite/news-next/dist/index.html",
+        resources: "suites/newssite/news-next/dist/resources.txt",
         tags: ["experimental", "newssite", "language"],
         async prepare() {},
         type: "remote",
@@ -145,6 +151,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "TodoMVC-WebComponents-IndexedDB",
         url: "suites-experimental/javascript-wc-indexeddb/dist/index.html?useAsyncSteps=true&storageType=vanilla",
+        resources: "suites-experimental/javascript-wc-indexeddb/dist/resources.txt",
         tags: ["todomvc", "webcomponents", "experimental"],
         async prepare() {},
         type: "remote",
@@ -155,6 +162,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "TodoMVC-WebComponents-DexieJS",
         url: "suites-experimental/javascript-wc-indexeddb/dist/index.html?useAsyncSteps=true&storageType=dexie",
+        resources: "suites-experimental/javascript-wc-indexeddb/dist/resources.txt",
         tags: ["todomvc", "webcomponents", "experimental"],
         async prepare() {},
         type: "remote",
@@ -165,6 +173,7 @@ export const ExperimentalSuites = freezeSuites([
     {
         name: "Responsive-Design",
         url: "suites-experimental/responsive-design/dist/index.html",
+        resources: "suites-experimental/responsive-design/dist/resources.txt",
         tags: ["responsive-design", "webcomponents", "experimental"],
         type: "async",
         async prepare(page) {

suites-experimental/todomvc-dart-jaspr/dist/out-dart2js-O4/resources.txt

@@ -0,0 +1,5 @@
+base.css
+favicon.ico
+index.css
+index.html
+main.dart.js

suites-experimental/todomvc-dart-jaspr/dist/out-dart2wasm-O2/resources.txt

@@ -0,0 +1,7 @@
+base.css
+favicon.ico
+index.css
+index.html
+main.dart.js
+main.mjs
+main.wasm

suites-experimental/todomvc-localstorage/dist/resources.txt

@@ -0,0 +1,10 @@
+app.js
+base.css
+controller.js
+helpers.js
+index.css
+index.html
+model.js
+store.js
+template.js
+view.js

suites-experimental/todomvc-localstorage/scripts/build.mjs

@@ -1,3 +1,4 @@
+import { generateResourcesFile } from "../../../resources/shared/generate-resources.mjs";
 import fs from "fs/promises";
 import path from "path";
 
@@ -53,4 +54,5 @@ const build = async () => {
     console.log("done!!");
 };
 
-build();
+await build();
+await generateResourcesFile(path.join(import.meta.dirname, "../dist"));

suites-experimental/todomvc-localstorage/src/resources.txt

@@ -0,0 +1,7 @@
+app.js
+controller.js
+helpers.js
+model.js
+store.js
+template.js
+view.js