build-start-rebuild-perf 0.2.3 → 0.3.0

package/.release-plan.json

@@ -1,18 +1,18 @@
 {
   "solution": {
     "build-start-rebuild-perf": {
-      "impact": "patch",
-      "oldVersion": "0.2.2",
-      "newVersion": "0.2.3",
+      "impact": "minor",
+      "oldVersion": "0.2.3",
+      "newVersion": "0.3.0",
       "tagName": "latest",
       "constraints": [
         {
-          "impact": "patch",
-          "reason": "Appears in changelog section :memo: Documentation"
+          "impact": "minor",
+          "reason": "Appears in changelog section :rocket: Enhancement"
         }
       ],
       "pkgJSONPath": "./package.json"
     }
   },
-  "description": "## Release (2025-08-13)\n\n* build-start-rebuild-perf 0.2.3 (patch)\n\n#### :memo: Documentation\n* `build-start-rebuild-perf`\n  * [#34](https://github.com/mainmatter/build-start-rebuild-perf/pull/34) Fix typo in README.md ([@KevinBongart](https://github.com/KevinBongart))\n\n#### Committers: 1\n- Kevin Bongart ([@KevinBongart](https://github.com/KevinBongart))\n"
+  "description": "## Release (2025-08-25)\n\n* build-start-rebuild-perf 0.3.0 (minor)\n\n#### :rocket: Enhancement\n* `build-start-rebuild-perf`\n  * [#41](https://github.com/mainmatter/build-start-rebuild-perf/pull/41) add option to have a custom page-load-timeout ([@mansona](https://github.com/mansona))\n\n#### Committers: 1\n- Chris Manson ([@mansona](https://github.com/mansona))\n"
 }

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Release (2025-08-25)
+
+* build-start-rebuild-perf 0.3.0 (minor)
+
+#### :rocket: Enhancement
+* `build-start-rebuild-perf`
+  * [#41](https://github.com/mainmatter/build-start-rebuild-perf/pull/41) add option to have a custom page-load-timeout ([@mansona](https://github.com/mansona))
+
+#### Committers: 1
+- Chris Manson ([@mansona](https://github.com/mansona))
+
 ## Release (2025-08-13)
 
 * build-start-rebuild-perf 0.2.3 (patch)

package/README.md

@@ -24,12 +24,14 @@ pnpm dlx build-start-rebuild-perf --file "app/router.js" --wait-for ".logo"
 ## Options
 
 ```
-	-u, --url <url>            URL to load (default: "http://localhost:4200")
-	-f, --file <path>          File to touch to trigger a reload (no default, but app/router.js is an option)
-	-c, --command <cmd>        Command to start dev server (default: "pnpm start")
-	-w, --wait-for <selector>  Element selector to wait for (default: "body")
-	-l, --log-level <level>    Set the log level (choices: "log", "warn", "error")
-	-h, --help                 display help for command
+	-u, --url <url>                   URL to load (default: "http://localhost:4200")
+  -f, --file <path>                 File to touch to trigger a reload (no default, but app/router.js is an option)
+  -c, --command <cmd>               Command to start dev server (default: "pnpm start")
+  -w, --wait-for <selector>         Element selector to wait for (default: "body")
+  -t, --timeout <timeout ms>        number of ms to wait for the server to become ready (default: "120000")
+  --page-load-timeout <timeout ms>  number of ms to wait in the browser for the pageload event (default: "60000")
+  -l, --log-level <level>           Set the log level (choices: "log", "warn", "error")
+  -h, --help                        display help for command
 ```
 
 ## Example Output

package/lib/browser.js

@@ -49,11 +49,11 @@ export async function initBrowser() {
   }
 }
 
-export async function measurePageLoad(url, waitForSelector = "body") {
+export async function measurePageLoad(url, waitForSelector = "body", pageLoadTimeout = 60_000) {
   log(`Loading page: ${url}`);
 
   const response = await page.goto(url, {
-    timeout: 60_000,
+    timeout: pageLoadTimeout,
     waitUntil: "load",
   });
 

package/lib/measure.js

@@ -28,7 +28,11 @@ export async function measure(options) {
     const atStart = performance.now();
     const serverURL = await startServer(options);
     const atServerUp = performance.now();
-    const pageLoadMetrics = await measurePageLoad(serverURL, options.waitFor);
+    const pageLoadMetrics = await measurePageLoad(
+      serverURL,
+      options.waitFor,
+      options.pageLoadTimeout,
+    );
     const reloadMetrics = await measureFileReload(options.file);
     await terminateServer();
 

package/lib/program.js

@@ -14,6 +14,11 @@ program
     "number of ms to wait for the server to become ready",
     "120000",
   )
+  .option(
+    "--page-load-timeout <timeout ms>",
+    "number of ms to wait in the browser for the pageload event",
+    "60000",
+  )
   .addOption(
     new Option("-l, --log-level <level>", "Set the log level", "warn").choices([
       "log",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "build-start-rebuild-perf",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "",
   "keywords": [],
   "repository": {

package/test/cli.test.js

@@ -2,9 +2,23 @@ import { resolve } from "node:path";
 import { execa } from "execa";
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
 
+/**
+ *
+ * @param {string[]} extraArgs an array of args to pass to the script
+ * @returns
+ */
+function runCommand(extraArgs) {
+  return execa("node", ["../bin/cli.js", "--command", "pnpm start", ...extraArgs], {
+    cwd: resolve(import.meta.dirname, "..", "test-ember-app"),
+  });
+}
+
 describe("CLI Tests", () => {
   describe(
     "Returns result for an Ember CLI app",
+    {
+      timeout: 120000,
+    },
     () => {
       const killStrays = async () => {
         try {
@@ -17,21 +31,7 @@ describe("CLI Tests", () => {
       afterEach(killStrays);
 
       it("should return measurements", async () => {
-        const cmd = await execa(
-          "node",
-          [
-            "../bin/cli.js",
-            "--command",
-            "pnpm start",
-            "--wait-for",
-            "h1",
-            "--file",
-            "./app/router.js",
-          ],
-          {
-            cwd: resolve(import.meta.dirname, "..", "test-ember-app"),
-          },
-        );
+        const cmd = await runCommand(["--wait-for", "h1", "--file", "./app/router.js"]);
 
         console.log(cmd.stdout);
         console.error(cmd.stderr);
@@ -42,9 +42,24 @@ describe("CLI Tests", () => {
           "| Dev Server Ready | First Paint | App Loaded | Reload after change |",
         );
       });
-    },
-    {
-      timeout: 120000,
+
+      it("should throw an error if --page-load-timeout is passed as something very low", async () => {
+        let cmd;
+        try {
+          cmd = await runCommand([
+            "--wait-for",
+            "h1",
+            "--file",
+            "./app/router.js",
+            "--page-load-timeout",
+            "100",
+          ]);
+        } catch (err) {
+          expect(err.stderr).toContain(`TimeoutError: Navigation timeout of 100 ms exceeded`);
+        }
+        // we expect the runCommand to throw. This is to make sure that we go into the catch block and don't "accidentally succeed"
+        expect(cmd).to.be.undefined;
+      });
     },
   );
 });