lighthouse-reporting 1.6.8 → 1.6.9

package/dist/lighthouse-reporting.umd.cjs

@@ -1,257 +1,281 @@
 (function(global, factory) {
-  typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("os"), require("path"), require("fs-extra"), require("url"), require("net"), require("@playwright/test")) : typeof define === "function" && define.amd ? define(["exports", "os", "path", "fs-extra", "url", "net", "@playwright/test"], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global.lh_rep = {}, global.os, global.path, global.fse, global.url, global.net, global["@playwright/test"]));
-})(this, (function(exports2, os, path, fse, url, net, test) {
-  "use strict";
-  var _documentCurrentScript = typeof document !== "undefined" ? document.currentScript : null;
-  const INDEX_HTML = "index.html";
-  const LH_OUT_DIR = "lighthouse";
-  const PW_TMP_DIR = "pwlh";
-  let dirname;
-  if (typeof __dirname !== "string") {
-    const filename = url.fileURLToPath(typeof document === "undefined" && typeof location === "undefined" ? require("url").pathToFileURL(__filename).href : typeof document === "undefined" ? location.href : _documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === "SCRIPT" && _documentCurrentScript.src || new URL("lighthouse-reporting.umd.cjs", document.baseURI).href);
-    dirname = path.dirname(filename);
-  } else {
-    dirname = __dirname;
-  }
-  const reportDir = path.join(process.cwd(), process.env.LH_REPORT_DIR || LH_OUT_DIR);
-  const htmlTemplatePath = path.join(dirname, "lighthouse.html");
-  async function lighthouseSetup() {
-    await fse.ensureDir(reportDir);
-    await fse.copyFile(htmlTemplatePath, path.join(reportDir, INDEX_HTML));
-  }
-  async function lighthousePlaywrightTeardown() {
-    await fse.remove(path.join(os.tmpdir(), PW_TMP_DIR));
-  }
-  const writeCsvResult = async (reportDir2, name, scores, thresholds = {}, swimlanes = []) => {
-    let csvData = Object.keys(scores).join(",");
-    if (swimlanes.length > 0) {
-      csvData += "," + swimlanes.map((swimlane) => `${swimlane}_threshold`);
-    }
-    csvData += "\n";
-    csvData += Object.values(scores).join(",");
-    if (swimlanes.length > 0 && Object.keys(thresholds).length > 0) {
-      csvData += "," + swimlanes.map((swimlane) => thresholds[swimlane]);
-    }
-    await fse.writeFile(path.join(reportDir2, `${name}.csv`), csvData);
-  };
-  const writeHtmlListEntry = async (htmlFilePath, name, scores, thresholds, error, addReportLink) => {
-    const htmlFileData = (await fse.readFile(htmlFilePath)).toString("utf-8").split("\n");
-    const insertIdx = htmlFileData.findIndex((v) => v.includes("// lighthouse-page-results"));
-    if (insertIdx < 0) {
-      throw new Error("Failed to write results to index.html");
-    }
-    htmlFileData.splice(insertIdx + 1, 0, JSON.stringify({ href: `${name}.html`, name, scores, thresholds, error, addReportLink }) + ",");
-    await fse.writeFile(htmlFilePath, htmlFileData.join("\n"));
-  };
-  const writeHtmlListEntryWithRetry = async (htmlFilePath, name, scores, thresholds, comparisonError, addReportLink = true) => {
-    let attempts = 10;
-    let error;
-    while (attempts > 0) {
-      attempts--;
-      try {
-        await writeHtmlListEntry(htmlFilePath, name, scores, thresholds, comparisonError, addReportLink);
-        return;
-      } catch (e) {
-        error = e;
-      }
-      await new Promise((resolve) => setTimeout(resolve, 10));
-    }
-    throw error;
-  };
-  const getScores = (result) => Object.entries(result.lhr.categories).reduce(
-    (prev, [key, c]) => {
-      const score = typeof c.score === "number" ? c.score : 0;
-      prev[key] = Math.floor(score * 100);
-      return prev;
-    },
-    {}
-  );
-  const writeScoresToJson = async (lhScoresDir, name, scores, result) => {
-    const json = Object.entries(scores).reduce(
-      (prev, [k, score]) => {
-        prev[k] = { score };
-        return prev;
-      },
-      {}
-    );
-    const accessibilityViolations = result.artifacts.Accessibility ? result.artifacts.Accessibility.violations.map((v) => {
-      return {
-        title: result.lhr.audits[v.id].title,
-        nodes: v.nodes.length
-      };
-    }) : [];
-    if (accessibilityViolations.length > 0) {
-      json.accessibility.issues = accessibilityViolations;
-    }
-    await fse.writeFile(path.join(lhScoresDir, `${name}.json`), JSON.stringify(json, null, 2));
-  };
-  const buildAverageCsv = async (lhScoresDir, reportDir2) => {
-    const files = await fse.readdir(lhScoresDir);
-    const jsonFiles = files.filter((f) => f.endsWith(".json"));
-    if (jsonFiles.length === 0) {
-      return;
-    }
-    const scores = {};
-    for (const fileName of jsonFiles) {
-      const score = await fse.readJson(
-        path.join(lhScoresDir, fileName)
-      );
-      Object.entries(score).forEach(([k, v]) => {
-        if (!scores[k]) {
-          scores[k] = 0;
-        }
-        scores[k] += v.score;
-      });
-    }
-    Object.entries(scores).forEach(([k, v]) => {
-      scores[k] = v / jsonFiles.length;
-    });
-    await writeCsvResult(reportDir2, "_AVERAGE_", scores);
-  };
-  class Locked extends Error {
-    constructor(port) {
-      super(`${port} is locked`);
-    }
-  }
-  const lockedPorts = {
-    old: /* @__PURE__ */ new Set(),
-    young: /* @__PURE__ */ new Set()
-  };
-  const releaseOldLockedPortsIntervalMs = 1e3 * 15;
-  let timeout;
-  const getLocalHosts = () => {
-    const interfaces = os.networkInterfaces();
-    const results = /* @__PURE__ */ new Set([void 0, "0.0.0.0"]);
-    for (const _interface of Object.values(interfaces)) {
-      for (const config of _interface) {
-        results.add(config.address);
-      }
-    }
-    return results;
-  };
-  const checkAvailablePort = (options) => new Promise((resolve, reject) => {
-    const server = net.createServer();
-    server.unref();
-    server.on("error", reject);
-    server.listen(options, () => {
-      const { port } = server.address();
-      server.close(() => {
-        resolve(port);
-      });
-    });
-  });
-  const getAvailablePort = async (options, hosts) => {
-    if (options.host || options.port === 0) {
-      return checkAvailablePort(options);
-    }
-    for (const host of hosts) {
-      try {
-        await checkAvailablePort({ port: options.port, host });
-      } catch (error) {
-        if (!["EADDRNOTAVAIL", "EINVAL"].includes(error.code)) {
-          throw error;
-        }
-      }
-    }
-    return options.port;
-  };
-  const portCheckSequence = function* (ports) {
-    yield 0;
-  };
-  async function getPorts(options) {
-    let exclude = /* @__PURE__ */ new Set();
-    if (timeout === void 0) {
-      timeout = setTimeout(() => {
-        timeout = void 0;
-        lockedPorts.old = lockedPorts.young;
-        lockedPorts.young = /* @__PURE__ */ new Set();
-      }, releaseOldLockedPortsIntervalMs);
-      if (timeout.unref) {
-        timeout.unref();
-      }
-    }
-    const hosts = getLocalHosts();
-    for (const port of portCheckSequence()) {
-      try {
-        if (exclude.has(port)) {
-          continue;
-        }
-        let availablePort = await getAvailablePort({ ...options, port }, hosts);
-        while (lockedPorts.old.has(availablePort) || lockedPorts.young.has(availablePort)) {
-          if (port !== 0) {
-            throw new Locked(port);
-          }
-          availablePort = await getAvailablePort({ ...options, port }, hosts);
-        }
-        lockedPorts.young.add(availablePort);
-        return availablePort;
-      } catch (error) {
-        if (!["EADDRINUSE", "EACCES"].includes(error.code) && !(error instanceof Locked)) {
-          throw error;
-        }
-      }
-    }
-    throw new Error("No available ports found");
-  }
-  const playwrightLighthouseTest = test.test.extend({
-    port: [
-      // eslint-disable-next-line no-empty-pattern
-      async ({}, use) => {
-        const port = await getPorts();
-        await use(port);
-      },
-      { scope: "worker" }
-    ],
-    context: [
-      async ({ port, launchOptions }, use) => {
-        const context = await test.chromium.launchPersistentContext(
-          path.join(os.tmpdir(), PW_TMP_DIR, `${Math.random()}`.replace(".", "")),
-          {
-            args: [...launchOptions.args || [], `--remote-debugging-port=${port}`]
-          }
-        );
-        await use(context);
-        await context.close();
-      },
-      { scope: "test" }
-    ]
-  });
-  const storybookPlaywright = {
-    getStories: (pathToStorybookIndexJson, storyFilterFn) => {
-      if (!fse.existsSync(pathToStorybookIndexJson)) {
-        console.log(pathToStorybookIndexJson, "doesn't exist.");
-        throw new Error("Please build storybook before running tests!");
-      }
-      const storybookIndexJson = fse.readJsonSync(pathToStorybookIndexJson);
-      const storyObject = storybookIndexJson.entries || storybookIndexJson.stories;
-      const stories = Object.values(storyObject).filter(storyFilterFn);
-      return stories;
-    },
-    captureScreenshot: async (story, context, screenshotOptions, options = {
-      waitForLoadStateTimeout: 2e3
-    }, actionBeforeScreenshot) => {
-      const page = context.pages()[0];
-      await page.goto(`/iframe.html?id=${story.id}`);
-      await test.expect(page.locator(".sb-show-main")).toBeVisible();
-      await test.expect(page.locator(".sb-show-errordisplay")).not.toBeVisible();
-      try {
-        await page.waitForLoadState("networkidle", { timeout: options.waitForLoadStateTimeout });
-      } catch {
-      }
-      if (actionBeforeScreenshot) {
-        await actionBeforeScreenshot(page);
-      }
-      await test.expect(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
-    }
-  };
-  exports2.buildAverageCsv = buildAverageCsv;
-  exports2.getScores = getScores;
-  exports2.lighthousePlaywrightTeardown = lighthousePlaywrightTeardown;
-  exports2.lighthouseSetup = lighthouseSetup;
-  exports2.playwrightLighthouseTest = playwrightLighthouseTest;
-  exports2.storybookPlaywright = storybookPlaywright;
-  exports2.writeCsvResult = writeCsvResult;
-  exports2.writeHtmlListEntryWithRetry = writeHtmlListEntryWithRetry;
-  exports2.writeScoresToJson = writeScoresToJson;
-  Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
-}));
+	typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("os"), require("path"), require("fs-extra"), require("url"), require("net"), require("@playwright/test")) : typeof define === "function" && define.amd ? define([
+		"exports",
+		"os",
+		"path",
+		"fs-extra",
+		"url",
+		"net",
+		"@playwright/test"
+	], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global.lh_rep = {}, global.os, global.path, global.fse, global.url, global.net, global["@playwright/test"]));
+})(this, function(exports, os, path, fs_extra, url, net, _playwright_test) {
+	Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+	//#region \0rolldown/runtime.js
+	var __create = Object.create;
+	var __defProp = Object.defineProperty;
+	var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+	var __getOwnPropNames = Object.getOwnPropertyNames;
+	var __getProtoOf = Object.getPrototypeOf;
+	var __hasOwnProp = Object.prototype.hasOwnProperty;
+	var __copyProps = (to, from, except, desc) => {
+		if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+				get: ((k) => from[k]).bind(null, key),
+				enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+			});
+		}
+		return to;
+	};
+	var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+		value: mod,
+		enumerable: true
+	}) : target, mod));
+	//#endregion
+	os = __toESM(os, 1);
+	path = __toESM(path, 1);
+	fs_extra = __toESM(fs_extra, 1);
+	url = __toESM(url, 1);
+	net = __toESM(net, 1);
+	//#region src/constants.ts
+	var INDEX_HTML = "index.html";
+	var PW_TMP_DIR = "pwlh";
+	//#endregion
+	//#region src/hooks.ts
+	var dirname;
+	if (typeof __dirname !== "string") {
+		const filename = url.default.fileURLToPath({}.url);
+		dirname = path.default.dirname(filename);
+	} else dirname = __dirname;
+	var reportDir = path.default.join(process.cwd(), process.env.LH_REPORT_DIR || "lighthouse");
+	var htmlTemplatePath = path.default.join(dirname, "lighthouse.html");
+	async function lighthouseSetup() {
+		await fs_extra.default.ensureDir(reportDir);
+		await fs_extra.default.copyFile(htmlTemplatePath, path.default.join(reportDir, INDEX_HTML));
+	}
+	async function lighthousePlaywrightTeardown() {
+		await fs_extra.default.remove(path.default.join(os.default.tmpdir(), PW_TMP_DIR));
+	}
+	//#endregion
+	//#region src/lighthouseReports.ts
+	var writeCsvResult = async (reportDir, name, scores, thresholds = {}, swimlanes = []) => {
+		let csvData = Object.keys(scores).join(",");
+		if (swimlanes.length > 0) csvData += "," + swimlanes.map((swimlane) => `${swimlane}_threshold`);
+		csvData += "\n";
+		csvData += Object.values(scores).join(",");
+		if (swimlanes.length > 0 && Object.keys(thresholds).length > 0) csvData += "," + swimlanes.map((swimlane) => thresholds[swimlane]);
+		await fs_extra.default.writeFile(path.default.join(reportDir, `${name}.csv`), csvData);
+	};
+	var writeHtmlListEntry = async (htmlFilePath, name, scores, thresholds, error, addReportLink) => {
+		const htmlFileData = (await fs_extra.default.readFile(htmlFilePath)).toString("utf-8").split("\n");
+		const insertIdx = htmlFileData.findIndex((v) => v.includes("// lighthouse-page-results"));
+		if (insertIdx < 0) throw new Error("Failed to write results to index.html");
+		htmlFileData.splice(insertIdx + 1, 0, JSON.stringify({
+			href: `${name}.html`,
+			name,
+			scores,
+			thresholds,
+			error,
+			addReportLink
+		}) + ",");
+		await fs_extra.default.writeFile(htmlFilePath, htmlFileData.join("\n"));
+	};
+	/**
+	* workaround conflicts when multiple threads write the same file
+	*/
+	var writeHtmlListEntryWithRetry = async (htmlFilePath, name, scores, thresholds, comparisonError, addReportLink = true) => {
+		let attempts = 10;
+		let error;
+		while (attempts > 0) {
+			attempts--;
+			try {
+				await writeHtmlListEntry(htmlFilePath, name, scores, thresholds, comparisonError, addReportLink);
+				return;
+			} catch (e) {
+				error = e;
+			}
+			await new Promise((resolve) => setTimeout(resolve, 10));
+		}
+		throw error;
+	};
+	var getScores = (result) => Object.entries(result.lhr.categories).reduce((prev, [key, c]) => {
+		const score = typeof c.score === "number" ? c.score : 0;
+		prev[key] = Math.floor(score * 100);
+		return prev;
+	}, {});
+	var writeScoresToJson = async (lhScoresDir, name, scores, result) => {
+		const json = Object.entries(scores).reduce((prev, [k, score]) => {
+			prev[k] = { score };
+			return prev;
+		}, {});
+		const accessibilityViolations = result.artifacts.Accessibility ? result.artifacts.Accessibility.violations.map((v) => {
+			return {
+				title: result.lhr.audits[v.id].title,
+				nodes: v.nodes.length
+			};
+		}) : [];
+		if (accessibilityViolations.length > 0) json.accessibility.issues = accessibilityViolations;
+		await fs_extra.default.writeFile(path.default.join(lhScoresDir, `${name}.json`), JSON.stringify(json, null, 2));
+	};
+	/**
+	* Generate average csv file. Make sure to use `writeScoresToJson` in your test!
+	* @param lhScoresDir path to folder with lighthouse json files. See `writeScoresToJson`.
+	* @param reportDir folder where `_AVERAGE_.json` will be generated
+	*/
+	var buildAverageCsv = async (lhScoresDir, reportDir) => {
+		const jsonFiles = (await fs_extra.default.readdir(lhScoresDir)).filter((f) => f.endsWith(".json"));
+		if (jsonFiles.length === 0) return;
+		const scores = {};
+		for (const fileName of jsonFiles) {
+			const score = await fs_extra.default.readJson(path.default.join(lhScoresDir, fileName));
+			Object.entries(score).forEach(([k, v]) => {
+				if (!scores[k]) scores[k] = 0;
+				scores[k] += v.score;
+			});
+		}
+		Object.entries(scores).forEach(([k, v]) => {
+			scores[k] = v / jsonFiles.length;
+		});
+		await writeCsvResult(reportDir, "_AVERAGE_", scores);
+	};
+	//#endregion
+	//#region node_modules/get-port/index.js
+	var Locked = class extends Error {
+		constructor(port) {
+			super(`${port} is locked`);
+		}
+	};
+	var lockedPorts = {
+		old: /* @__PURE__ */ new Set(),
+		young: /* @__PURE__ */ new Set()
+	};
+	var releaseOldLockedPortsIntervalMs = 1e3 * 15;
+	var reservedPorts = /* @__PURE__ */ new Set();
+	var timeout;
+	var getLocalHosts = () => {
+		const interfaces = os.default.networkInterfaces();
+		const results = /* @__PURE__ */ new Set([void 0, "0.0.0.0"]);
+		for (const _interface of Object.values(interfaces)) for (const config of _interface) results.add(config.address);
+		return results;
+	};
+	var checkAvailablePort = (options) => new Promise((resolve, reject) => {
+		const server = net.default.createServer();
+		server.unref();
+		server.on("error", reject);
+		server.listen(options, () => {
+			const { port } = server.address();
+			server.close(() => {
+				resolve(port);
+			});
+		});
+	});
+	var getAvailablePort = async (options, hosts) => {
+		if (options.host || options.port === 0) return checkAvailablePort(options);
+		for (const host of hosts) try {
+			await checkAvailablePort({
+				port: options.port,
+				host
+			});
+		} catch (error) {
+			if (!["EADDRNOTAVAIL", "EINVAL"].includes(error.code)) throw error;
+		}
+		return options.port;
+	};
+	var isLockedPort = (port) => lockedPorts.old.has(port) || lockedPorts.young.has(port) || reservedPorts.has(port);
+	var portCheckSequence = function* (ports) {
+		if (ports) yield* ports;
+		yield 0;
+	};
+	async function getPorts(options) {
+		let ports;
+		let exclude = /* @__PURE__ */ new Set();
+		if (options) {
+			if (options.port) ports = typeof options.port === "number" ? [options.port] : options.port;
+			if (options.exclude) {
+				const excludeIterable = options.exclude;
+				if (typeof excludeIterable[Symbol.iterator] !== "function") throw new TypeError("The `exclude` option must be an iterable.");
+				for (const element of excludeIterable) {
+					if (typeof element !== "number") throw new TypeError("Each item in the `exclude` option must be a number corresponding to the port you want excluded.");
+					if (!Number.isSafeInteger(element)) throw new TypeError(`Number ${element} in the exclude option is not a safe integer and can't be used`);
+				}
+				exclude = new Set(excludeIterable);
+			}
+		}
+		const { reserve, ...netOptions } = options ?? {};
+		if (timeout === void 0) {
+			timeout = setTimeout(() => {
+				timeout = void 0;
+				lockedPorts.old = lockedPorts.young;
+				lockedPorts.young = /* @__PURE__ */ new Set();
+			}, releaseOldLockedPortsIntervalMs);
+			if (timeout.unref) timeout.unref();
+		}
+		const hosts = getLocalHosts();
+		for (const port of portCheckSequence(ports)) try {
+			if (exclude.has(port)) continue;
+			let availablePort = await getAvailablePort({
+				...netOptions,
+				port
+			}, hosts);
+			while (isLockedPort(availablePort)) {
+				if (port !== 0) throw new Locked(port);
+				availablePort = await getAvailablePort({
+					...netOptions,
+					port
+				}, hosts);
+			}
+			if (reserve) reservedPorts.add(availablePort);
+			else lockedPorts.young.add(availablePort);
+			return availablePort;
+		} catch (error) {
+			if (!["EADDRINUSE", "EACCES"].includes(error.code) && !(error instanceof Locked)) throw error;
+		}
+		throw new Error("No available ports found");
+	}
+	//#endregion
+	//#region src/playwrightLighthouseTest.ts
+	var playwrightLighthouseTest = _playwright_test.test.extend({
+		port: [async ({}, use) => {
+			await use(await getPorts());
+		}, { scope: "worker" }],
+		context: [async ({ port, launchOptions }, use) => {
+			const context = await _playwright_test.chromium.launchPersistentContext(path.default.join(os.default.tmpdir(), PW_TMP_DIR, `${Math.random()}`.replace(".", "")), { args: [...launchOptions.args || [], `--remote-debugging-port=${port}`] });
+			await use(context);
+			await context.close();
+		}, { scope: "test" }]
+	});
+	//#endregion
+	//#region src/storybookPlaywright.ts
+	var storybookPlaywright = {
+		getStories: (pathToStorybookIndexJson, storyFilterFn) => {
+			if (!fs_extra.default.existsSync(pathToStorybookIndexJson)) {
+				console.log(pathToStorybookIndexJson, "doesn't exist.");
+				throw new Error("Please build storybook before running tests!");
+			}
+			const storybookIndexJson = fs_extra.default.readJsonSync(pathToStorybookIndexJson);
+			const storyObject = storybookIndexJson.entries || storybookIndexJson.stories;
+			return Object.values(storyObject).filter(storyFilterFn);
+		},
+		captureScreenshot: async (story, context, screenshotOptions, options = { waitForLoadStateTimeout: 2e3 }, actionBeforeScreenshot) => {
+			const page = context.pages()[0];
+			await page.goto(`/iframe.html?id=${story.id}`);
+			await (0, _playwright_test.expect)(page.locator(".sb-show-main")).toBeVisible();
+			await (0, _playwright_test.expect)(page.locator(".sb-show-errordisplay")).not.toBeVisible();
+			try {
+				await page.waitForLoadState("networkidle", { timeout: options.waitForLoadStateTimeout });
+			} catch {}
+			if (actionBeforeScreenshot) await actionBeforeScreenshot(page);
+			await (0, _playwright_test.expect)(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
+		}
+	};
+	//#endregion
+	exports.buildAverageCsv = buildAverageCsv;
+	exports.getScores = getScores;
+	exports.lighthousePlaywrightTeardown = lighthousePlaywrightTeardown;
+	exports.lighthouseSetup = lighthouseSetup;
+	exports.playwrightLighthouseTest = playwrightLighthouseTest;
+	exports.storybookPlaywright = storybookPlaywright;
+	exports.writeCsvResult = writeCsvResult;
+	exports.writeHtmlListEntryWithRetry = writeHtmlListEntryWithRetry;
+	exports.writeScoresToJson = writeScoresToJson;
+});