merge krausest#1478

Author: krausest

cli/check-obsolete.js

@@ -20,9 +20,7 @@ const frameworks = getFrameworks();
  */
 function findDuplicateFrameworks(frameworks) {
   const names = frameworks.map((framework) => framework.name); // Creates an array with framework names only
-  const duplicateNames = names.filter(
-    (name, index) => names.indexOf(name) !== index,
-  ); // Filters out repetitive framework names
+  const duplicateNames = names.filter((name, index) => names.indexOf(name) !== index); // Filters out repetitive framework names
 
   return duplicateNames;
 }
@@ -59,11 +57,7 @@ function maybeObsolete(packageName) {
     }
 
     const now = new Date();
-    const obsoleteDate = new Date(
-      now.getFullYear() - 1,
-      now.getMonth(),
-      now.getDay(),
-    );
+    const obsoleteDate = new Date(now.getFullYear() - 1, now.getMonth(), now.getDay());
 
     const modifiedDate = new Date(timeData.modified);
     const isObsolete = modifiedDate < obsoleteDate;
@@ -72,7 +66,7 @@ function maybeObsolete(packageName) {
     return { isObsolete, lastUpdate: formattedDate, packageName };
   } catch (error) {
     console.error(
-      `Failed to execute npm view for ${packageName}. Error Code ${error.status} and message: ${error.message}`,
+      `Failed to execute npm view for ${packageName}. Error Code ${error.status} and message: ${error.message}`
     );
     return { isObsolete: false, lastUpdate: null, packageName };
   }
@@ -95,15 +89,12 @@ function checkObsoleteFrameworks(options) {
     const packageJSONPath = path.join(frameworkPath, "package.json");
 
     if (!fs.existsSync(packageJSONPath)) {
-      missingPackageWarnings.push(
-        `WARN: skipping ${type}/${name} since there's no package.json`,
-      );
+      missingPackageWarnings.push(`WARN: skipping ${type}/${name} since there's no package.json`);
       continue;
     }
 
     const packageJSON = JSON.parse(fs.readFileSync(packageJSONPath, "utf-8"));
-    const mainPackages =
-      packageJSON?.["js-framework-benchmark"]?.frameworkVersionFromPackage;
+    const mainPackages = packageJSON?.["js-framework-benchmark"]?.frameworkVersionFromPackage;
 
     if (!mainPackages) {
       manualChecks.push(`${type}/${name} has no frameworkVersionFromPackage`);
@@ -121,35 +112,25 @@ function checkObsoleteFrameworks(options) {
       console.log(`Results for ${type}/${name} ${isPackageObsolete}`);
     }
 
-    const anyPackageObsolete = isPackageObsolete.some(
-      (packageFramework) => packageFramework.isObsolete,
-    );
+    const anyPackageObsolete = isPackageObsolete.some((packageFramework) => packageFramework.isObsolete);
 
     if (anyPackageObsolete) {
       const formattedPackages = isPackageObsolete
         .map((result) => `${result.packageName}:${result.lastUpdate}`)
         .join(", ");
 
-      console.log(
-        `Last npm update for ${type}/${name} - ${mainPackages} is older than a year: ${formattedPackages}`,
-      );
+      console.log(`Last npm update for ${type}/${name} - ${mainPackages} is older than a year: ${formattedPackages}`);
       continue;
     }
 
     if (DEBUG) {
-      console.log(
-        `Last npm update for ${type}/${name} ${mainPackages} is newer than a year`,
-      );
+      console.log(`Last npm update for ${type}/${name} ${mainPackages} is newer than a year`);
     }
   }
 
-  if (missingPackageWarnings.length > 0)
-    console.warn("\nWarnings:\n" + missingPackageWarnings.join("\n"));
+  if (missingPackageWarnings.length > 0) console.warn("\nWarnings:\n" + missingPackageWarnings.join("\n"));
   if (manualChecks.length > 0)
-    console.warn(
-      "\nThe following frameworks must be checked manually\n" +
-        manualChecks.join("\n"),
-    );
+    console.warn("\nThe following frameworks must be checked manually\n" + manualChecks.join("\n"));
 }
 
 export { checkObsoleteFrameworks };

cli/cleanup.js

@@ -1,14 +1,7 @@
 import * as fs from "node:fs";
 import path from "node:path";
 
-const filesToDelete = [
-  "package-lock.json",
-  "yarn-lock",
-  "dist",
-  "elm-stuff",
-  "bower_components",
-  "node_modules",
-];
+const filesToDelete = ["package-lock.json", "yarn-lock", "dist", "elm-stuff", "bower_components", "node_modules"];
 
 /**
  * Delete specified files in the framework directory

cli/configure-styles.js

@@ -12,10 +12,7 @@ async function copyAndGenerateSharedStyles(sourceCss, mainCss) {
   const sharedStylesContent = `<dom-module id="shared-styles"><template><style>${mainCssContent}</style></template></dom-module>`;
 
   // Write shared-styles.html
-  await fs.promises.writeFile(
-    path.join("polymer-v2.0.0-non-keyed", "src", "shared-styles.html"),
-    sharedStylesContent,
-  );
+  await fs.promises.writeFile(path.join("polymer-v2.0.0-non-keyed", "src", "shared-styles.html"), sharedStylesContent);
 }
 
 /**
@@ -37,13 +34,10 @@ async function configureStyles(options) {
     if (bootstrap) {
       await copyAndGenerateSharedStyles(
         path.join("css", "useOriginalBootstrap.css"),
-        path.join("css", "bootstrap", "dist", "css", "bootstrap.min.css"),
+        path.join("css", "bootstrap", "dist", "css", "bootstrap.min.css")
       );
     } else {
-      await copyAndGenerateSharedStyles(
-        path.join("css", "useMinimalCss.css"),
-        path.join("css", "useMinimalCss.css"),
-      );
+      await copyAndGenerateSharedStyles(path.join("css", "useMinimalCss.css"), path.join("css", "useMinimalCss.css"));
     }
   } catch (error) {
     console.error("An error occurred:", error.message);

cli/copy.js

@@ -17,7 +17,7 @@ function shouldInclude(name) {
     const isTargetWeb = name.includes("/target/web");
 
     console.log(
-      `File: ${name}\nIs Binding Scala: ${isBindingScala}\nIs Target: ${isTarget}\nIs Target Web: ${isTargetWeb}`,
+      `File: ${name}\nIs Binding Scala: ${isBindingScala}\nIs Target: ${isTarget}\nIs Target Web: ${isTargetWeb}`
     );
 
     if (isTarget) {
@@ -72,15 +72,10 @@ function copyFolderRecursiveSync(sourcePath, destinationPath) {
  */
 function processDirectories() {
   const directories = fs.readdirSync(".");
-  const nonHiddenDirectories = directories.filter(
-    (directory) => !directory.startsWith("."),
-  );
+  const nonHiddenDirectories = directories.filter((directory) => !directory.startsWith("."));
 
   for (const directory of nonHiddenDirectories) {
-    if (
-      fs.statSync(directory).isDirectory() &&
-      !rootExclude.includes(directory)
-    ) {
+    if (fs.statSync(directory).isDirectory() && !rootExclude.includes(directory)) {
       const dirPath = path.join("dist", directory);
       console.log(dirPath);
       fs.mkdirSync(dirPath);
@@ -97,10 +92,7 @@ function copyProjectToDist() {
   fs.rmSync("dist", { force: true, recursive: true });
   fs.mkdirSync(path.join("dist", "webdriver-ts"), { recursive: true });
 
-  fs.copyFileSync(
-    path.join("webdriver-ts", "table.html"),
-    path.join("dist", "webdriver-ts", "table.html"),
-  );
+  fs.copyFileSync(path.join("webdriver-ts", "table.html"), path.join("dist", "webdriver-ts", "table.html"));
   fs.copyFileSync("index.html", path.join("dist", "index.html"));
 
   processDirectories();

rebuild-build-single.js renamed to cli/rebuild-build-single.js

@@ -1,43 +1,6 @@
 import { execSync } from "node:child_process";
 import * as fs from "node:fs";
 import path from "node:path";
-import yargs from "yargs";
-
-const args = yargs(process.argv.slice(2))
-  .usage("$0 [--ci keyed/framework1 ... non-keyed/frameworkN]")
-  .boolean("ci")
-  .default("ci", false)
-  .describe("ci", "Use npm ci or npm install ?")
-  .argv;
-
-/**
- * Use npm ci or npm install?
- * @type {boolean}
- */
-const useCi = args.ci;
-
-/**
- * @type {string}
- */
-const frameworks = args._.filter((arg) => !arg.startsWith("--"));
-
-console.log(
-  "rebuild-build-single.js started: args",
-  args,
-  "useCi",
-  useCi,
-  "frameworks",
-  frameworks
-);
-
-const filesToDelete = [
-  "yarn-lock",
-  "dist",
-  "elm-stuff",
-  "bower_components",
-  "node_modules",
-  "output",
-].concat(useCi ? [] : ["package-lock.json"]);
 
 /*
 rebuild-single.js [--ci] [keyed/framework1 ... non-keyed/frameworkN]
@@ -55,7 +18,7 @@ Pass list of frameworks
 /**
  * Run a command synchronously in the specified directory and log command
  * @param {string} command - The command to run
- * @param {string} cwd - The current working directory (optional)
+ * @param {string|undefined} cwd - The current working directory (optional)
  */
 function runCommand(command, cwd = undefined) {
   console.log(command);
@@ -82,43 +45,53 @@ function deleteFrameworkFiles(frameworkPath, filesToDelete) {
 
 /**
  * @param {string} framework
+ * @param {boolean} useCi
  */
-function rebuildFramework(framework) {
+function rebuildFramework(framework, useCi) {
   const components = framework.split("/");
 
   if (components.length !== 2) {
-    console.log(
-      `ERROR: invalid name ${framework}. It must contain exactly one /.`
-    );
+    console.log(`ERROR: invalid name ${framework}. It must contain exactly one /.`);
     process.exit(1);
   }
 
   const [keyed, name] = components;
   const frameworkPath = path.join("frameworks", keyed, name);
 
+  const filesToDelete = [
+    "yarn-lock",
+    "dist",
+    "elm-stuff",
+    "bower_components",
+    "node_modules",
+    "output",
+  ].concat(useCi ? [] : ["package-lock.json"]);
+
   deleteFrameworkFiles(frameworkPath, filesToDelete);
 
   const installCmd = `npm ${useCi ? "ci" : "install"}`;
   runCommand(installCmd, frameworkPath);
 
   const buildCmd = "npm run build-prod";
   runCommand(buildCmd, frameworkPath);
-
 }
 
-function rebuildFrameworks() {
+/**
+ * @param {string[]} frameworks
+ * @param {boolean} useCi
+ */
+export function rebuildFrameworks(frameworks, useCi) {
+  console.log("rebuild-build-single.js started: useCi", useCi, "frameworks", frameworks);
+
   if (!frameworks.length) {
-    console.log(
-      "ERROR: Missing arguments. Command: rebuild keyed/framework1 non-keyed/framework2 ..."
-    );
+    console.log("ERROR: Missing arguments. Command: rebuild keyed/framework1 non-keyed/framework2 ...");
     process.exit(1);
   }
 
   for (const framework of frameworks) {
-    rebuildFramework(framework);
+    rebuildFramework(framework, useCi);
   }
 
   console.log("rebuild-build-single.js finished: Build finsished sucessfully!");
 }
 
-rebuildFrameworks();

cli/rebuild-check-single.js

@@ -0,0 +1,47 @@
+import { execSync } from "node:child_process";
+
+/*
+rebuild-check-single.js [keyed/framework1 ... non-keyed/frameworkN]
+
+This script is used to run benchmarks and check if the specified frameworks are keyed.
+
+It performs the following steps:
+1. Executes benchmarks for the specified frameworks with the necessary options.
+2. Checks if the specified frameworks are keyed.
+
+Pass list of frameworks
+*/
+
+/**
+ * Run a command synchronously in the specified directory and log command
+ * @param {string} command - The command to run
+ * @param {string|undefined} cwd - The current working directory (optional)
+ */
+function runCommand(command, cwd = undefined) {
+  console.log(command);
+  execSync(command, { stdio: "inherit", cwd });
+}
+
+/**
+ * @param {string[]} frameworks
+ */
+export function rebuildCheckSingle(frameworks) {
+  console.log("rebuild-check-single.js started: frameworks", frameworks);
+
+  const frameworkNames = frameworks.join(" ");
+
+  try {
+    const benchCmd = `npm run bench -- --headless true --smoketest true ${frameworkNames}`;
+    runCommand(benchCmd, "webdriver-ts");
+
+    const keyedCmd = `npm run isKeyed -- --headless true ${frameworkNames}`;
+    runCommand(keyedCmd, "webdriver-ts");
+
+    console.log("rebuild-check-single.js finished");
+    console.log("All checks are fine!");
+    console.log(`======> Please rerun the benchmark: npm run bench ${frameworkNames}`);
+  } catch (e) {
+    console.log(`rebuild-check-single failed for ${frameworks.join(" ")}`);
+    process.exit(-1);
+  }
+}

cli/update-lockfiles.js

@@ -49,11 +49,7 @@ function getPackageLockJSONVersion(packageLockJSONPath) {
  * @param {number} latestLockfileVersion
  * @param {string} frameworkDirPath
  */
-function updateFrameworkLockfile(
-  framework,
-  latestLockfileVersion,
-  frameworkDirPath,
-) {
+function updateFrameworkLockfile(framework, latestLockfileVersion, frameworkDirPath) {
   const { name, type } = framework;
 
   console.log(`Checking ${type} ${name} lockfile`);
@@ -85,11 +81,7 @@ function updateLockfilesOfAllFrameworks(options) {
   const frameworks = getFrameworks(frameworksDirPath, frameworksTypes);
 
   for (const framework of frameworks) {
-    updateFrameworkLockfile(
-      framework,
-      latestLockfileVersion,
-      frameworksDirPath,
-    );
+    updateFrameworkLockfile(framework, latestLockfileVersion, frameworksDirPath);
   }
 }