summaryrefslogtreecommitdiffstats
path: root/browser/components/newtab/bin
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:22:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:22:09 +0000
commit43a97878ce14b72f0981164f87f2e35e14151312 (patch)
tree620249daf56c0258faa40cbdcf9cfba06de2a846 /browser/components/newtab/bin
parentInitial commit. (diff)
downloadfirefox-43a97878ce14b72f0981164f87f2e35e14151312.tar.xz
firefox-43a97878ce14b72f0981164f87f2e35e14151312.zip
Adding upstream version 110.0.1.upstream/110.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'browser/components/newtab/bin')
-rw-r--r--browser/components/newtab/bin/render-activity-stream-html.js131
-rw-r--r--browser/components/newtab/bin/try-runner.js200
-rw-r--r--browser/components/newtab/bin/vendor.js38
3 files changed, 369 insertions, 0 deletions
diff --git a/browser/components/newtab/bin/render-activity-stream-html.js b/browser/components/newtab/bin/render-activity-stream-html.js
new file mode 100644
index 0000000000..540352963b
--- /dev/null
+++ b/browser/components/newtab/bin/render-activity-stream-html.js
@@ -0,0 +1,131 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/* eslint-disable no-console */
+const fs = require("fs");
+const { mkdir } = require("shelljs");
+const path = require("path");
+
+// Note: DEFAULT_OPTIONS.baseUrl should match BASE_URL in aboutNewTabService.js
+// in mozilla-central.
+const DEFAULT_OPTIONS = {
+ addonPath: "..",
+ baseUrl: "resource://activity-stream/",
+};
+
+/**
+ * templateHTML - Generates HTML for activity stream, given some options and
+ * prerendered HTML if necessary.
+ *
+ * @param {obj} options
+ * {str} options.baseUrl The base URL for all local assets
+ * {bool} options.debug Should we use dev versions of JS libraries?
+ * {bool} options.noscripts Should we include scripts in the prerendered files?
+ * @return {str} An HTML document as a string
+ */
+function templateHTML(options) {
+ const debugString = options.debug ? "-dev" : "";
+ // This list must match any similar ones in AboutNewTabService.jsm.
+ const scripts = [
+ "chrome://browser/content/contentSearchUI.js",
+ "chrome://browser/content/contentSearchHandoffUI.js",
+ "chrome://browser/content/contentTheme.js",
+ `${options.baseUrl}vendor/react${debugString}.js`,
+ `${options.baseUrl}vendor/react-dom${debugString}.js`,
+ `${options.baseUrl}vendor/prop-types.js`,
+ `${options.baseUrl}vendor/redux.js`,
+ `${options.baseUrl}vendor/react-redux.js`,
+ `${options.baseUrl}vendor/react-transition-group.js`,
+ `${options.baseUrl}data/content/activity-stream.bundle.js`,
+ `${options.baseUrl}data/content/newtab-render.js`,
+ ];
+
+ // Add spacing and script tags
+ const scriptRender = `\n${scripts
+ .map(script => ` <script src="${script}"></script>`)
+ .join("\n")}`;
+
+ return `
+<!-- This Source Code Form is subject to the terms of the Mozilla Public
+ - License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ - You can obtain one at http://mozilla.org/MPL/2.0/. -->
+
+<!doctype html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="Content-Security-Policy" content="default-src 'none'; object-src 'none'; script-src resource: chrome:; connect-src https:; img-src https: data: blob: chrome:; style-src 'unsafe-inline';">
+ <meta name="color-scheme" content="light dark">
+ <title data-l10n-id="newtab-page-title"></title>
+ <link rel="icon" type="image/png" href="chrome://branding/content/icon32.png"/>
+ <link rel="localization" href="branding/brand.ftl" />
+ <link rel="localization" href="browser/branding/brandings.ftl" />
+ <link rel="localization" href="browser/newtab/newtab.ftl" />
+ <link rel="stylesheet" href="chrome://browser/content/contentSearchUI.css" />
+ <link rel="stylesheet" href="chrome://activity-stream/content/css/activity-stream.css" />
+ </head>
+ <body class="activity-stream">
+ <div id="root"></div>
+ <div id="footer-asrouter-container" role="presentation"></div>${
+ options.noscripts ? "" : scriptRender
+ }
+ </body>
+</html>
+`.trimLeft();
+}
+
+/**
+ * writeFiles - Writes to the desired files the result of a template given
+ * various prerendered data and options.
+ *
+ * @param {string} destPath Path to write the files to
+ * @param {Map} filesMap Mapping of a string file name to templater
+ * @param {Object} options Various options for the templater
+ */
+function writeFiles(destPath, filesMap, options) {
+ for (const [file, templater] of filesMap) {
+ console.log("\x1b[32m", `✓ ${file}`, "\x1b[0m");
+ fs.writeFileSync(path.join(destPath, file), templater({ options }));
+ }
+}
+
+const STATIC_FILES = new Map([
+ ["activity-stream.html", ({ options }) => templateHTML(options)],
+ [
+ "activity-stream-debug.html",
+ ({ options }) => templateHTML(Object.assign({}, options, { debug: true })),
+ ],
+ [
+ "activity-stream-noscripts.html",
+ ({ options }) =>
+ templateHTML(Object.assign({}, options, { noscripts: true })),
+ ],
+]);
+
+/**
+ * main - Parses command line arguments, generates html and js with templates,
+ * and writes files to their specified locations.
+ */
+function main() {
+ // eslint-disable-line max-statements
+ // This code parses command line arguments passed to this script.
+ // Note: process.argv.slice(2) is necessary because the first two items in
+ // process.argv are paths
+ const args = require("minimist")(process.argv.slice(2), {
+ alias: {
+ addonPath: "a",
+ baseUrl: "b",
+ },
+ });
+
+ const options = Object.assign({ debug: false }, DEFAULT_OPTIONS, args || {});
+ const addonPath = path.resolve(__dirname, options.addonPath);
+ const prerenderedPath = path.join(addonPath, "prerendered");
+ console.log(`Writing prerendered files to ${prerenderedPath}:`);
+
+ mkdir("-p", prerenderedPath);
+ writeFiles(prerenderedPath, STATIC_FILES, options);
+}
+
+main();
diff --git a/browser/components/newtab/bin/try-runner.js b/browser/components/newtab/bin/try-runner.js
new file mode 100644
index 0000000000..8b240465b6
--- /dev/null
+++ b/browser/components/newtab/bin/try-runner.js
@@ -0,0 +1,200 @@
+/* eslint-disable no-console */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at <http://mozilla.org/MPL/2.0/>. */
+
+/*
+ * A small test runner/reporter for node-based tests,
+ * which are run via taskcluster node(debugger).
+ *
+ * Forked from
+ * https://searchfox.org/mozilla-central/source/devtools/client/debugger/bin/try-runner.js
+ */
+
+const { execFileSync } = require("child_process");
+const { readFileSync } = require("fs");
+const path = require("path");
+
+function logErrors(tool, errors) {
+ for (const error of errors) {
+ console.log(`TEST-UNEXPECTED-FAIL ${tool} | ${error}`);
+ }
+ return errors;
+}
+
+function execOut(...args) {
+ let exitCode = 0;
+ let out;
+ let err;
+
+ try {
+ out = execFileSync(...args, {
+ silent: false,
+ });
+ } catch (e) {
+ // For debugging on (eg) try server...
+ //
+ // if (e) {
+ // logErrors("execOut", ["execFileSync returned exception: ", e]);
+ // }
+
+ out = e && e.stdout;
+ err = e && e.stderr;
+ exitCode = e && e.status;
+ }
+ return { exitCode, out: out && out.toString(), err: err && err.toString() };
+}
+
+function logStart(name) {
+ console.log(`TEST START | ${name}`);
+}
+
+function checkBundles() {
+ logStart("checkBundles");
+
+ const ASbundle = path.join("data", "content", "activity-stream.bundle.js");
+ const AWbundle = path.join(
+ "aboutwelcome",
+ "content",
+ "aboutwelcome.bundle.js"
+ );
+ let errors = [];
+
+ let ASbefore = readFileSync(ASbundle, "utf8");
+ let AWbefore = readFileSync(AWbundle, "utf8");
+
+ execOut("npm", ["run", "bundle"]);
+
+ let ASafter = readFileSync(ASbundle, "utf8");
+ let AWafter = readFileSync(AWbundle, "utf8");
+
+ if (ASbefore !== ASafter) {
+ errors.push("Activity Stream bundle out of date");
+ }
+
+ if (AWbefore !== AWafter) {
+ errors.push("About:welcome bundle out of date");
+ }
+
+ logErrors("checkBundles", errors);
+ return errors.length === 0;
+}
+
+function karma() {
+ logStart("karma");
+
+ const errors = [];
+ const { exitCode, out } = execOut("npm", [
+ "run",
+ "testmc:unit",
+ // , "--", "--log-level", "--verbose",
+ // to debug the karma integration, uncomment the above line
+ ]);
+
+ // karma spits everything to stdout, not stderr, so if nothing came back on
+ // stdout, give up now.
+ if (!out) {
+ return false;
+ }
+
+ // Detect mocha failures
+ let jsonContent;
+ try {
+ // Note that this will be overwritten at each run, but that shouldn't
+ // matter.
+ jsonContent = readFileSync(path.join("logs", "karma-run-results.json"));
+ } catch (ex) {
+ console.error("exception reading karma-run-results.json: ", ex);
+ return false;
+ }
+ const results = JSON.parse(jsonContent);
+ // eslint-disable-next-line guard-for-in
+ for (let testArray in results.result) {
+ let failedTests = Array.from(results.result[testArray]).filter(
+ test => !test.success && !test.skipped
+ );
+
+ errors.push(
+ ...failedTests.map(
+ test => `${test.suite.join(":")} ${test.description}: ${test.log[0]}`
+ )
+ );
+ }
+
+ // Detect istanbul failures (coverage thresholds set in karma config)
+ const coverage = out.match(/ERROR.+coverage-istanbul.+/g);
+ if (coverage) {
+ errors.push(...coverage.map(line => line.match(/Coverage.+/)[0]));
+ }
+
+ logErrors("karma", errors);
+
+ console.log("-----karma stdout below this line---");
+ console.log(out);
+ console.log("-----karma stdout above this line---");
+
+ // Pass if there's no detected errors and nothing unexpected.
+ return errors.length === 0 && !exitCode;
+}
+
+function sasslint() {
+ logStart("sasslint");
+ const { exitCode, out } = execOut("npm", [
+ "run",
+ "--silent",
+ "lint:sasslint",
+ "--",
+ "--format",
+ "json",
+ ]);
+
+ // Successful exit and no output means sasslint passed.
+ if (!exitCode && !out.length) {
+ return true;
+ }
+
+ let fileObjects = JSON.parse(out);
+ let filesWithIssues = fileObjects.filter(
+ file => file.warningCount || file.errorCount
+ );
+
+ let errs = [];
+ let errorString;
+ filesWithIssues.forEach(file => {
+ file.messages.forEach(messageObj => {
+ errorString = `${file.filePath}(${messageObj.line}, ${messageObj.column}): ${messageObj.message} (${messageObj.ruleId})`;
+ errs.push(errorString);
+ });
+ });
+
+ const errors = logErrors("sasslint", errs);
+
+ // Pass if there's no detected errors and nothing unexpected.
+ return errors.length === 0 && !exitCode;
+}
+
+function zipCodeCoverage() {
+ logStart("zipCodeCoverage");
+ const { exitCode, out } = execOut("zip", [
+ "-j",
+ "logs/coverage/code-coverage-grcov",
+ "logs/coverage/lcov.info",
+ ]);
+
+ console.log("zipCodeCoverage log output: ", out);
+
+ if (!exitCode) {
+ return true;
+ }
+
+ return false;
+}
+
+const tests = {};
+const success = [checkBundles, karma, zipCodeCoverage, sasslint].every(
+ t => (tests[t.name] = t())
+);
+console.log(tests);
+
+process.exitCode = success ? 0 : 1;
+console.log("CODE", process.exitCode);
diff --git a/browser/components/newtab/bin/vendor.js b/browser/components/newtab/bin/vendor.js
new file mode 100644
index 0000000000..3d929dcf4b
--- /dev/null
+++ b/browser/components/newtab/bin/vendor.js
@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/* eslint-disable no-console */
+
+const { cp, set } = require("shelljs");
+const path = require("path");
+
+const filesToVendor = {
+ // XXX currently these two licenses are identical. Perhaps we should check
+ // in case that changes at some point in the future.
+ "react/LICENSE": "REACT_AND_REACT_DOM_LICENSE",
+ "react/umd/react.production.min.js": "react.js",
+ "react/umd/react.development.js": "react-dev.js",
+ "react-dom/umd/react-dom.production.min.js": "react-dom.js",
+ "react-dom/umd/react-dom.development.js": "react-dom-dev.js",
+ "react-dom/umd/react-dom-server.browser.production.min.js":
+ "react-dom-server.js",
+ "react-redux/LICENSE.md": "REACT_REDUX_LICENSE",
+ "react-redux/dist/react-redux.min.js": "react-redux.js",
+ "react-transition-group/dist/react-transition-group.min.js":
+ "react-transition-group.js",
+ "react-transition-group/LICENSE": "REACT_TRANSITION_GROUP_LICENSE",
+};
+
+set("-v"); // Echo all the copy commands so the user can see what's going on
+for (let srcPath of Object.keys(filesToVendor)) {
+ cp(
+ path.join("node_modules", srcPath),
+ path.join("vendor", filesToVendor[srcPath])
+ );
+}
+
+console.log(`
+Check to see if any license files have changed, and, if so, be sure to update
+https://searchfox.org/mozilla-central/source/toolkit/content/license.html`);