2025-01-04 15:25:12 -08:00
|
|
|
#!/usr/bin/env -S deno run --allow-read --allow-write --allow-env --allow-net --allow-run --allow-sys
|
2022-05-18 23:00:38 -07:00
|
|
|
// Usage: ./make.js command. Use -l to list commands.
|
2020-02-10 13:28:17 -08:00
|
|
|
// This is a set of tasks for building and testing Vimium in development.
|
2025-01-04 18:07:29 -08:00
|
|
|
import * as fs from "@std/fs";
|
|
|
|
|
import * as path from "@std/path";
|
2023-12-08 21:40:46 -08:00
|
|
|
import { abort, desc, run, task } from "https://deno.land/x/drake@v1.5.1/mod.ts";
|
2025-01-20 18:25:57 -08:00
|
|
|
import puppeteer from "npm:puppeteer";
|
2025-01-11 21:46:40 -08:00
|
|
|
// We use a vendored version of shoulda, rather than jsr:@philc/shoulda, because shoulda.js is used
|
|
|
|
|
// in dom_tests.js which is loaded by Puppeteer, which doesn't have access to Deno's module system.
|
|
|
|
|
import * as shoulda from "./tests/vendor/shoulda.js";
|
2025-01-04 12:21:26 -08:00
|
|
|
import JSON5 from "npm:json5";
|
2025-01-04 18:07:29 -08:00
|
|
|
import { DOMParser } from "@b-fuze/deno-dom";
|
|
|
|
|
import * as fileServer from "@std/http/file-server";
|
2022-05-18 23:00:38 -07:00
|
|
|
|
|
|
|
|
const projectPath = new URL(".", import.meta.url).pathname;
|
|
|
|
|
|
|
|
|
|
async function shell(procName, argsArray = []) {
|
|
|
|
|
// NOTE(philc): Does drake's `sh` function work on Windows? If so, that can replace this function.
|
|
|
|
|
if (Deno.build.os == "windows") {
|
2020-02-10 13:28:17 -08:00
|
|
|
// if win32, prefix arguments with "/c {original command}"
|
2020-05-19 17:48:04 -07:00
|
|
|
// e.g. "mkdir c:\git\vimium" becomes "cmd.exe /c mkdir c:\git\vimium"
|
2023-02-26 20:59:05 -08:00
|
|
|
optArray.unshift("/c", procName);
|
|
|
|
|
procName = "cmd.exe";
|
2020-02-10 13:28:17 -08:00
|
|
|
}
|
2022-05-18 23:00:38 -07:00
|
|
|
const p = Deno.run({ cmd: [procName].concat(argsArray) });
|
|
|
|
|
const status = await p.status();
|
2023-02-26 20:59:05 -08:00
|
|
|
if (!status.success) {
|
2022-05-18 23:00:38 -07:00
|
|
|
throw new Error(`${procName} ${argsArray} exited with status ${status.code}`);
|
2023-02-26 20:59:05 -08:00
|
|
|
}
|
2020-02-10 13:28:17 -08:00
|
|
|
}
|
|
|
|
|
|
2023-07-08 13:01:13 -07:00
|
|
|
// Clones and augments the manifest.json that we use for Chrome with the keys needed for Firefox.
|
|
|
|
|
function createFirefoxManifest(manifest) {
|
|
|
|
|
manifest = JSON.parse(JSON.stringify(manifest)); // Deep clone.
|
|
|
|
|
|
|
|
|
|
manifest.permissions = manifest.permissions
|
|
|
|
|
// The favicon permission is not yet supported by Firefox.
|
|
|
|
|
.filter((p) => p != "favicon")
|
|
|
|
|
// Firefox needs clipboardRead and clipboardWrite for commands like "copyCurrentUrl", but Chrome
|
|
|
|
|
// does not. See #4186.
|
|
|
|
|
.concat(["clipboardRead", "clipboardWrite"]);
|
|
|
|
|
|
|
|
|
|
// As of 2023-07-08 Firefox doesn't yet support background.service_worker.
|
|
|
|
|
delete manifest.background["service_worker"];
|
2023-07-11 22:57:59 -07:00
|
|
|
Object.assign(manifest.background, {
|
2025-03-31 21:13:03 -07:00
|
|
|
"scripts": ["background_scripts/main.js"],
|
2023-07-11 22:57:59 -07:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
// This key is only supported by Firefox.
|
|
|
|
|
Object.assign(manifest.action, {
|
|
|
|
|
"default_area": "navbar",
|
|
|
|
|
});
|
2023-07-08 13:01:13 -07:00
|
|
|
|
|
|
|
|
Object.assign(manifest, {
|
|
|
|
|
"browser_specific_settings": {
|
|
|
|
|
"gecko": {
|
|
|
|
|
// This ID was generated by the Firefox store upon first submission. It's needed in
|
|
|
|
|
// development mode, or many extension APIs don't work.
|
|
|
|
|
"id": "{d7742d87-e61d-4b78-b8a1-b469842139fa}",
|
2023-07-10 23:49:21 -07:00
|
|
|
"strict_min_version": "112.0",
|
2025-11-04 21:25:02 -08:00
|
|
|
"data_collection_permissions": {
|
|
|
|
|
"required": ["none"],
|
|
|
|
|
},
|
2023-07-08 13:01:13 -07:00
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
2024-07-12 21:45:54 +02:00
|
|
|
// Firefox supports SVG icons.
|
|
|
|
|
Object.assign(manifest, {
|
|
|
|
|
"icons": {
|
2024-09-04 11:41:02 -07:00
|
|
|
"16": "icons/icon.svg",
|
|
|
|
|
"32": "icons/icon.svg",
|
|
|
|
|
"48": "icons/icon.svg",
|
|
|
|
|
"64": "icons/icon.svg",
|
|
|
|
|
"96": "icons/icon.svg",
|
|
|
|
|
"128": "icons/icon.svg",
|
2024-07-12 21:45:54 +02:00
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
2024-07-29 23:50:48 +02:00
|
|
|
Object.assign(manifest.action, {
|
|
|
|
|
"default_icon": "icons/action_disabled.svg",
|
|
|
|
|
});
|
|
|
|
|
|
2023-07-08 13:01:13 -07:00
|
|
|
return manifest;
|
|
|
|
|
}
|
|
|
|
|
|
2023-07-08 13:09:39 -07:00
|
|
|
async function parseManifestFile() {
|
|
|
|
|
// Chrome's manifest.json supports JavaScript comment syntax. However, the Chrome Store rejects
|
|
|
|
|
// manifests with JavaScript comments in them! So here we use the JSON5 library, rather than JSON
|
|
|
|
|
// library, to parse our manifest.json and remove its comments.
|
|
|
|
|
return JSON5.parse(await Deno.readTextFile("./manifest.json"));
|
|
|
|
|
}
|
|
|
|
|
|
2026-03-07 11:59:32 -08:00
|
|
|
async function checkForCommonBuildIssues() {
|
2025-12-29 14:56:25 -08:00
|
|
|
// Ensure the version number is properly formed.
|
|
|
|
|
const chromeManifest = await parseManifestFile();
|
|
|
|
|
const version = chromeManifest["version"];
|
|
|
|
|
const versionRegexp = /^\d\.\d+\.\d+$/;
|
|
|
|
|
if (!versionRegexp.test(version)) {
|
|
|
|
|
throw new Error(`The version string "${version}" is malformed.`);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Ensure debug logging is turned off.
|
|
|
|
|
const text = await Deno.readTextFile("./lib/utils.js");
|
|
|
|
|
if (!text.includes("debug: false")) {
|
|
|
|
|
throw new Error(
|
|
|
|
|
"It looks like debug logging is turned on in lib/utils.js. " +
|
|
|
|
|
"It should be off in builds for the store.",
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2026-03-07 11:59:32 -08:00
|
|
|
// Verify all files referenced in the manifest are present in dist.
|
|
|
|
|
async function checkFilesFromManifestArePresent(manifest) {
|
|
|
|
|
const t = getPathsFromManifest(manifest);
|
|
|
|
|
const missing = [];
|
|
|
|
|
|
|
|
|
|
for (const file of getPathsFromManifest(manifest)) {
|
|
|
|
|
const exists = await fs.exists(path.join("dist/vimium", file));
|
|
|
|
|
if (!exists) {
|
|
|
|
|
missing.push(file);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (missing.length > 0) {
|
|
|
|
|
const msg = "These files are referenced in manifest.json but missing from the build:\n" +
|
|
|
|
|
missing.map((f) => ` ${f}`).join("\n");
|
|
|
|
|
throw new Error(msg);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Returns all file paths referenced in a parsed manifest object, excluding glob patterns.
|
|
|
|
|
function getPathsFromManifest(manifest) {
|
|
|
|
|
let files = [];
|
|
|
|
|
|
|
|
|
|
files = files.concat(Object.values(manifest.icons));
|
|
|
|
|
|
|
|
|
|
if (manifest.background.service_worker) {
|
|
|
|
|
files.push(manifest.background.service_worker);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (manifest.background.scripts) {
|
|
|
|
|
files = files.concat(manifest.background.scripts);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
files.push(manifest.options_ui.page);
|
|
|
|
|
files.push(manifest.action.default_popup);
|
|
|
|
|
|
|
|
|
|
// The shape of the default_icon structure is different in Chrome vs. Firefox.
|
|
|
|
|
const icon = manifest.action.default_icon;
|
|
|
|
|
if (typeof icon === "string") {
|
|
|
|
|
files.push(icon);
|
|
|
|
|
} else {
|
|
|
|
|
files = files.concat(Object.values(icon));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (const script of manifest.content_scripts) {
|
|
|
|
|
if (script.js) {
|
|
|
|
|
files = files.concat(script.js);
|
|
|
|
|
}
|
|
|
|
|
if (script.css) {
|
|
|
|
|
files = files.concat(script.css);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (const obj of manifest.web_accessible_resources) {
|
|
|
|
|
for (const resource of (obj.resources)) {
|
|
|
|
|
// Skip files with glob patterns.
|
|
|
|
|
if (resource.includes("*")) {
|
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
files.push(resource);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (files.some((f) => f == null)) {
|
|
|
|
|
throw new Error("manifest.json is missing a path that was expected by getPathsFromManifest");
|
|
|
|
|
}
|
|
|
|
|
// Remove duplicates.
|
|
|
|
|
return Array.from(new Set(files)).sort();
|
|
|
|
|
}
|
|
|
|
|
|
2022-01-19 23:16:55 -08:00
|
|
|
// Builds a zip file for submission to the Chrome and Firefox stores. The output is in dist/.
|
2022-05-18 23:00:38 -07:00
|
|
|
async function buildStorePackage() {
|
2026-03-07 11:59:32 -08:00
|
|
|
await checkForCommonBuildIssues();
|
2025-12-29 14:56:25 -08:00
|
|
|
|
2021-07-14 09:29:15 -06:00
|
|
|
const excludeList = [
|
|
|
|
|
"*.md",
|
|
|
|
|
".*",
|
|
|
|
|
"CREDITS",
|
|
|
|
|
"MIT-LICENSE.txt",
|
2025-06-28 22:07:12 -07:00
|
|
|
"build_scripts",
|
2021-07-14 09:29:15 -06:00
|
|
|
"dist",
|
|
|
|
|
"make.js",
|
2023-09-28 10:37:28 -07:00
|
|
|
"deno.json",
|
|
|
|
|
"deno.lock",
|
2025-06-22 21:20:28 -07:00
|
|
|
// These reload scripts are used for development only and shouldn't appear in the build.
|
|
|
|
|
"reload.html",
|
|
|
|
|
"reload.js",
|
2021-07-14 09:29:15 -06:00
|
|
|
"test_harnesses",
|
|
|
|
|
"tests",
|
|
|
|
|
];
|
2023-07-08 12:56:43 -07:00
|
|
|
|
2023-07-08 13:09:39 -07:00
|
|
|
const chromeManifest = await parseManifestFile();
|
2021-07-14 09:29:15 -06:00
|
|
|
const rsyncOptions = ["-r", ".", "dist/vimium"].concat(
|
2023-02-26 20:59:05 -08:00
|
|
|
...excludeList.map((item) => ["--exclude", item]),
|
2021-07-14 09:29:15 -06:00
|
|
|
);
|
2024-01-08 20:41:00 -08:00
|
|
|
const version = chromeManifest["version"];
|
2023-07-08 13:01:13 -07:00
|
|
|
const writeDistManifest = async (manifest) => {
|
|
|
|
|
await Deno.writeTextFile("dist/vimium/manifest.json", JSON.stringify(manifest, null, 2));
|
2020-05-19 19:29:25 -07:00
|
|
|
};
|
2020-02-24 12:38:24 -08:00
|
|
|
// cd into "dist/vimium" before building the zip, so that the files in the zip don't each have the
|
|
|
|
|
// path prefix "dist/vimium".
|
2023-07-08 12:24:58 -07:00
|
|
|
// --filesync ensures that files in the archive which are no longer on disk are deleted. It's
|
|
|
|
|
// equivalent to removing the zip file before the build.
|
2020-02-24 12:38:24 -08:00
|
|
|
const zipCommand = "cd dist/vimium && zip -r --filesync ";
|
|
|
|
|
|
2022-05-18 23:00:38 -07:00
|
|
|
await shell("rm", ["-rf", "dist/vimium"]);
|
2023-02-26 20:59:05 -08:00
|
|
|
await shell("mkdir", [
|
|
|
|
|
"-p",
|
|
|
|
|
"dist/vimium",
|
|
|
|
|
"dist/chrome-canary",
|
|
|
|
|
"dist/chrome-store",
|
|
|
|
|
"dist/firefox",
|
|
|
|
|
]);
|
2022-05-18 23:00:38 -07:00
|
|
|
await shell("rsync", rsyncOptions);
|
2020-05-19 19:29:25 -07:00
|
|
|
|
2026-03-07 11:59:32 -08:00
|
|
|
await checkFilesFromManifestArePresent(chromeManifest);
|
|
|
|
|
|
2025-11-04 21:25:02 -08:00
|
|
|
// Build the Firefox / Mozilla Addons store package.
|
2023-07-08 13:01:13 -07:00
|
|
|
const firefoxManifest = createFirefoxManifest(chromeManifest);
|
|
|
|
|
await writeDistManifest(firefoxManifest);
|
2024-08-04 22:05:38 -07:00
|
|
|
// Exclude PNG icons from the Firefox build, because we use the SVG directly.
|
2024-09-04 11:41:02 -07:00
|
|
|
await shell("bash", [
|
|
|
|
|
"-c",
|
|
|
|
|
`${zipCommand} ../firefox/vimium-firefox-${version}.zip . -x icons/*.png`,
|
|
|
|
|
]);
|
2020-02-24 12:38:24 -08:00
|
|
|
|
2026-03-07 11:59:32 -08:00
|
|
|
await checkFilesFromManifestArePresent(firefoxManifest);
|
|
|
|
|
|
2022-12-17 12:02:38 -08:00
|
|
|
// Build the Chrome Store package.
|
2023-07-08 13:01:13 -07:00
|
|
|
await writeDistManifest(chromeManifest);
|
2023-02-26 20:59:05 -08:00
|
|
|
await shell("bash", [
|
|
|
|
|
"-c",
|
2024-01-08 20:41:00 -08:00
|
|
|
`${zipCommand} ../chrome-store/vimium-chrome-store-${version}.zip .`,
|
2023-02-26 20:59:05 -08:00
|
|
|
]);
|
2020-02-10 13:28:17 -08:00
|
|
|
|
|
|
|
|
// Build the Chrome Store dev package.
|
2023-07-08 13:01:13 -07:00
|
|
|
await writeDistManifest(Object.assign({}, chromeManifest, {
|
2021-07-14 09:29:15 -06:00
|
|
|
name: "Vimium Canary",
|
|
|
|
|
description: "This is the development branch of Vimium (it is beta software).",
|
|
|
|
|
}));
|
2023-02-26 20:59:05 -08:00
|
|
|
await shell("bash", [
|
|
|
|
|
"-c",
|
2024-01-08 20:41:00 -08:00
|
|
|
`${zipCommand} ../chrome-canary/vimium-canary-${version}.zip .`,
|
2023-02-26 20:59:05 -08:00
|
|
|
]);
|
2020-02-10 13:28:17 -08:00
|
|
|
}
|
|
|
|
|
|
2025-06-28 21:44:48 -07:00
|
|
|
async function runUnitTests() {
|
2022-05-18 23:00:38 -07:00
|
|
|
// Import every test file.
|
|
|
|
|
const dir = path.join(projectPath, "tests/unit_tests");
|
|
|
|
|
const files = Array.from(Deno.readDirSync(dir)).map((f) => f.name).sort();
|
|
|
|
|
for (let f of files) {
|
|
|
|
|
if (f.endsWith("_test.js")) {
|
|
|
|
|
await import(path.join(dir, f));
|
2021-07-14 09:27:12 -06:00
|
|
|
}
|
2022-05-18 23:00:38 -07:00
|
|
|
}
|
2020-02-10 13:28:17 -08:00
|
|
|
|
2023-12-08 21:40:46 -08:00
|
|
|
return await shoulda.run();
|
2025-06-28 21:44:48 -07:00
|
|
|
}
|
2020-02-14 22:43:36 -08:00
|
|
|
|
2024-09-04 12:21:32 -07:00
|
|
|
function setupPuppeteerPageForTests(page) {
|
2024-09-04 11:45:56 -07:00
|
|
|
// The "console" event emitted has arguments which are promises. To obtain the values to be
|
|
|
|
|
// printed, we must resolve those promises. However, if many console messages are emitted at once,
|
|
|
|
|
// resolving the promises often causes the console.log messages to be printed out of order. Here,
|
|
|
|
|
// we use a queue to strictly enforce that the messages appear in the order in which they were
|
|
|
|
|
// logged.
|
|
|
|
|
const messageQueue = [];
|
|
|
|
|
let processing = false;
|
|
|
|
|
const processMessageQueue = async () => {
|
|
|
|
|
while (messageQueue.length > 0) {
|
|
|
|
|
const values = await Promise.all(messageQueue.shift());
|
|
|
|
|
console.log(...values);
|
|
|
|
|
}
|
|
|
|
|
processing = false;
|
|
|
|
|
};
|
2023-12-08 21:00:01 -08:00
|
|
|
page.on("console", async (msg) => {
|
2024-09-04 11:45:56 -07:00
|
|
|
const values = msg.args().map((a) => a.jsonValue());
|
|
|
|
|
messageQueue.push(values);
|
|
|
|
|
if (!processing) {
|
|
|
|
|
processing = true;
|
|
|
|
|
processMessageQueue();
|
|
|
|
|
}
|
2023-12-08 21:00:01 -08:00
|
|
|
});
|
2024-09-04 11:45:56 -07:00
|
|
|
|
2023-12-08 21:00:01 -08:00
|
|
|
page.on("error", (err) => {
|
2024-09-04 12:21:32 -07:00
|
|
|
// NOTE(philc): As far as I can tell, this handler never gets executed.
|
2023-12-08 21:00:01 -08:00
|
|
|
console.error(err);
|
|
|
|
|
});
|
|
|
|
|
// pageerror catches the same events that window.onerror would, like JavaScript parsing errors.
|
|
|
|
|
page.on("pageerror", (error) => {
|
2024-09-04 12:21:32 -07:00
|
|
|
// This is an arbitrary field we're writing to the page object.
|
|
|
|
|
page.receivedErrorOutput = true;
|
2023-12-08 21:00:01 -08:00
|
|
|
// Whatever type error is, it requires toString() to print the message.
|
|
|
|
|
console.log(error.toString());
|
|
|
|
|
});
|
2024-09-04 12:21:32 -07:00
|
|
|
page.on("requestfailed", (request) => {
|
|
|
|
|
console.log(`${request.failure().errorText} ${request.url()}`);
|
|
|
|
|
});
|
|
|
|
|
}
|
2023-12-08 21:00:01 -08:00
|
|
|
|
2024-09-04 12:21:32 -07:00
|
|
|
// Navigates the Puppeteer `page` to `url` and invokes shoulda.run().
|
|
|
|
|
async function runPuppeteerTest(page, url) {
|
|
|
|
|
page.goto(url);
|
2023-12-08 21:00:01 -08:00
|
|
|
await page.waitForNavigation({ waitUntil: "load" });
|
2023-12-08 21:40:46 -08:00
|
|
|
const success = await page.evaluate(async () => {
|
|
|
|
|
return await shoulda.run();
|
2023-12-08 21:00:01 -08:00
|
|
|
});
|
2023-12-08 21:40:46 -08:00
|
|
|
return success;
|
2024-09-04 12:21:32 -07:00
|
|
|
}
|
2022-05-18 23:00:38 -07:00
|
|
|
|
2023-12-08 20:52:39 -08:00
|
|
|
desc("Download and parse list of top-level domains (TLDs)");
|
|
|
|
|
task("fetch-tlds", [], async () => {
|
|
|
|
|
const suffixListUrl = "https://www.iana.org/domains/root/db";
|
|
|
|
|
const response = await fetch(suffixListUrl);
|
|
|
|
|
const text = await response.text();
|
|
|
|
|
const doc = new DOMParser().parseFromString(text, "text/html");
|
|
|
|
|
const els = doc.querySelectorAll("span.domain.tld");
|
|
|
|
|
// Each span contains a TLD, e.g. ".com". Trim off the leading period.
|
2025-04-03 22:32:34 -07:00
|
|
|
const domains = Array.from(els).map((el) => el.textContent.slice(1));
|
2023-12-08 20:52:39 -08:00
|
|
|
const str = domains.join("\n");
|
|
|
|
|
await Deno.writeTextFile("./resources/tlds.txt", str);
|
|
|
|
|
});
|
|
|
|
|
|
2022-05-18 23:00:38 -07:00
|
|
|
desc("Run unit tests");
|
|
|
|
|
task("test-unit", [], async () => {
|
2023-12-08 21:40:46 -08:00
|
|
|
const success = await runUnitTests();
|
|
|
|
|
if (!success) {
|
|
|
|
|
abort("test-unit failed");
|
2023-02-26 20:59:05 -08:00
|
|
|
}
|
2022-05-18 23:00:38 -07:00
|
|
|
});
|
|
|
|
|
|
2025-01-04 18:08:11 -08:00
|
|
|
function isPortAvailable(number) {
|
|
|
|
|
try {
|
|
|
|
|
const listener = Deno.listen({ port: number });
|
|
|
|
|
listener.close();
|
|
|
|
|
return true;
|
|
|
|
|
} catch (error) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function getAvailablePort() {
|
|
|
|
|
const min = 7000;
|
|
|
|
|
const max = 65535;
|
|
|
|
|
let count = 0;
|
|
|
|
|
const getRandomInt = (min, max) => Math.floor(Math.random() * (max - min + 1)) + min;
|
|
|
|
|
let port = getRandomInt(min, max);
|
|
|
|
|
while (!isPortAvailable(port) && count < max - min) {
|
|
|
|
|
port++;
|
|
|
|
|
if (port > max) {
|
|
|
|
|
port = min;
|
|
|
|
|
}
|
|
|
|
|
if (isPortAvailable(port)) {
|
|
|
|
|
return port;
|
|
|
|
|
}
|
|
|
|
|
count++;
|
|
|
|
|
if (count >= max - min) {
|
|
|
|
|
throw new Error(`No port is available in the range ${min} - ${max}`);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return port;
|
|
|
|
|
}
|
|
|
|
|
|
2024-09-04 12:21:32 -07:00
|
|
|
async function testDom() {
|
2025-01-04 18:08:11 -08:00
|
|
|
const port = getAvailablePort();
|
2023-12-08 21:42:35 -08:00
|
|
|
let served404 = false;
|
|
|
|
|
const httpServer = Deno.serve({ port }, async (req) => {
|
|
|
|
|
const url = new URL(req.url);
|
|
|
|
|
let path = decodeURIComponent(url.pathname);
|
|
|
|
|
if (path.startsWith("/")) {
|
|
|
|
|
path = "." + path;
|
|
|
|
|
}
|
|
|
|
|
if (!(await fs.exists(path))) {
|
|
|
|
|
console.error("dom-tests: requested missing file (not found):", path);
|
|
|
|
|
served404 = true;
|
|
|
|
|
return new Response(null, { status: 404 });
|
|
|
|
|
} else {
|
|
|
|
|
return fileServer.serveFile(req, path);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2025-03-01 20:49:21 -08:00
|
|
|
const files = ["dom_tests.html"];
|
2024-09-04 12:21:32 -07:00
|
|
|
const browser = await puppeteer.launch();
|
|
|
|
|
let success = true;
|
|
|
|
|
for (const file of files) {
|
|
|
|
|
const page = await browser.newPage();
|
|
|
|
|
console.log("Running", file);
|
|
|
|
|
setupPuppeteerPageForTests(page);
|
|
|
|
|
const url = `http://localhost:${port}/tests/dom_tests/${file}?dom_tests=true`;
|
|
|
|
|
const result = await runPuppeteerTest(page, url);
|
|
|
|
|
success = success && result;
|
|
|
|
|
if (served404) {
|
|
|
|
|
console.log(`${file} failed: a background or content script requested a missing file.`);
|
|
|
|
|
}
|
|
|
|
|
if (page.receivedErrorOutput) {
|
|
|
|
|
console.log(`${file} failed: there was a page level error.`);
|
|
|
|
|
success = false;
|
|
|
|
|
}
|
|
|
|
|
// If we close the puppeteer page (tab) via page.close(), we can get innocuous but noisy output
|
|
|
|
|
// like this:
|
2025-04-01 17:18:18 -07:00
|
|
|
// net::ERR_ABORTED http://localhost:43524/pages/hud_page.html?dom_tests=true
|
2024-09-04 12:21:32 -07:00
|
|
|
// There's probably a way to prevent that, but as a work around, we avoid closing the page.
|
|
|
|
|
// browser.close() will close all of its owned pages.
|
2023-12-08 21:42:35 -08:00
|
|
|
}
|
2024-09-04 12:21:32 -07:00
|
|
|
// NOTE(philc): At one point in development, I noticed that the output from Deno would suddenly
|
|
|
|
|
// pause, prior to the tests fully finishing, so closing the browser here may be racy. If it
|
|
|
|
|
// occurs again, we may need to add "await delay(200)".
|
|
|
|
|
await browser.close();
|
2023-12-08 21:42:35 -08:00
|
|
|
await httpServer.shutdown();
|
|
|
|
|
if (served404 || !success) {
|
2023-12-08 21:40:46 -08:00
|
|
|
abort("test-dom failed.");
|
2023-02-26 20:59:05 -08:00
|
|
|
}
|
2024-09-04 12:21:32 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
desc("Run DOM tests");
|
|
|
|
|
task("test-dom", [], testDom);
|
2022-05-18 23:00:38 -07:00
|
|
|
|
|
|
|
|
desc("Run unit and DOM tests");
|
2023-12-08 21:40:46 -08:00
|
|
|
task("test", ["test-unit", "test-dom"]);
|
2022-05-18 23:00:38 -07:00
|
|
|
|
|
|
|
|
desc("Builds a zip file for submission to the Chrome and Firefox stores. The output is in dist/");
|
2025-06-28 21:46:38 -07:00
|
|
|
task("package", ["write-command-listing"], async () => {
|
2022-05-18 23:00:38 -07:00
|
|
|
await buildStorePackage();
|
|
|
|
|
});
|
|
|
|
|
|
2025-06-28 21:46:38 -07:00
|
|
|
desc("Build a static version of command_listing.html, to be hosted on vimium.gihub.io");
|
|
|
|
|
task("write-command-listing", [], async () => {
|
|
|
|
|
// Run this script in a separate shell so it doesn't pollute our JS environment.
|
|
|
|
|
await shell("./build_scripts/write_command_listing_page.js", []);
|
|
|
|
|
});
|
|
|
|
|
|
2023-07-08 13:09:39 -07:00
|
|
|
desc("Replaces manifest.json with a Firefox-compatible version, for development");
|
|
|
|
|
task("write-firefox-manifest", [], async () => {
|
|
|
|
|
const firefoxManifest = createFirefoxManifest(await parseManifestFile());
|
|
|
|
|
await Deno.writeTextFile("./manifest.json", JSON.stringify(firefoxManifest, null, 2));
|
|
|
|
|
});
|
|
|
|
|
|
2022-05-18 23:00:38 -07:00
|
|
|
run();
|
