Update copy-help-site-screenshots.mts

Author: Nateowami

src/SIL.XForge.Scripture/ClientApp/e2e/copy-help-site-screenshots.mts

@@ -1,10 +1,12 @@
-#!/usr/bin/env -S deno run --allow-read --allow-write
+#!/usr/bin/env -S deno run --allow-read --allow-write --allow-run
 
-import { pngImagesDiffer } from "./compare_images.mts";
-import { ScreenshotContext } from "./presets.ts";
+import { walk } from "jsr:@std/fs/walk";
+import { pngImagesDiffer } from "./compare-images.mts";
+import { ScreenshotEvent } from "./e2e-test-run-logger.ts";
 
 const runLogDir = Deno.args[0];
 const helpRepo = Deno.args[1];
+const copyFilesEvenIfIdentical = true;
 
 if (runLogDir == null || helpRepo == null) {
   console.error("Usage: ./copy-help-site-screenshots.mts <run_log_dir> <help_repo>");
@@ -17,58 +19,75 @@ if (!(await Deno.stat(helpRepo)).isDirectory) {
   Deno.exit(1);
 }
 
-const pageNameToFileName = {
-  localized_page_sign_up: "1786056439.png",
-  localized_auth0_sign_up_with_pt: "1624359167.png",
-  localized_pt_registry_login: "448045579.png",
-  localized_my_projects: "1783795116.png",
-  localized_sync: "1990846672.png",
-  sign_up_for_drafting: "Draft-Generation/sign_up_for_drafting.png",
-  configure_sources_button: "Draft-Generation/configure_sources_button.png",
-  configure_sources_draft_source: "Draft-Generation/configure_sources_draft_source.png",
-  configure_sources_draft_reference: "Draft-Generation/configure_sources_draft_reference.png",
-  configure_sources_confirm_languages: "Draft-Generation/configure_sources_confirm_languages.png",
-  generate_draft_button: "Draft-Generation/generate_draft_button.png",
-  generate_draft_confirm_sources: "Draft-Generation/generate_draft_confirm_sources.png",
-  generate_draft_select_books_to_draft: "Draft-Generation/generate_draft_select_books_to_draft.png",
-  generate_draft_select_books_to_train: "Draft-Generation/generate_draft_select_books_to_train.png",
-  generate_draft_summary: "Draft-Generation/generate_draft_summary.png"
-};
-
-const screenshotsWithNoDestination = new Set();
+const screenshotEvents: ScreenshotEvent[] = runLog.screenshotEvents;
 
 function getDirForLocale(localeCode: string): string {
   return localeCode === "en"
     ? `${helpRepo}/docs`
     : `${helpRepo}/i18n/${localeCode}/docusaurus-plugin-content-docs/current`;
 }
 
-for (const screenshot of runLog.screenshotEvents) {
-  const context: ScreenshotContext = screenshot.context;
-  const pageName = context.pageName;
-  const localeCode = context.locale;
-  if (pageName == null || localeCode == null) {
-    console.error("Screenshot context is missing pageName or locale:", JSON.stringify(context));
-    continue;
-  }
+function getScreenshotByFileNameAndLocale(fileName: string, localeCode: string): any | undefined {
+  const pageName = fileName.replace(/\.png$/, "");
+  return screenshotEvents.find(event => event.context.pageName === pageName && event.context.locale === localeCode);
+}
 
-  if (pageName in pageNameToFileName) {
-    const currentFile = `${runLogDir}/${screenshot.fileName}`;
-    const newFile = `${getDirForLocale(localeCode)}/${pageNameToFileName[pageName as keyof typeof pageNameToFileName]}`;
+function localeCodesInRunLog(): string[] {
+  return [...new Set(screenshotEvents.map(event => event.context.locale))] as string[];
+}
+
+const markdownImageRegex = /!\[.*?\]\(.\/([\w]+\.png)\)/gm;
 
-    const imageDiffers = pngImagesDiffer(currentFile, newFile);
-    if (imageDiffers) {
-      console.log(`Moving ${currentFile} to ${newFile}`);
-      await Deno.copyFile(currentFile, newFile);
-    } else {
-      console.log(`Skipping ${currentFile} as it is identical to ${newFile}`);
+async function imagesInMarkdownFile(filePath: string): Promise<string[]> {
+  const content = await Deno.readTextFile(filePath);
+  const matches = Array.from(content.matchAll(markdownImageRegex));
+  return matches.map(match => match[1]);
+}
+
+for (const locale of localeCodesInRunLog()) {
+  const localeDir = getDirForLocale(locale);
+  try {
+    console.log(`Walking directory: ${localeDir}`);
+    for await (const entry of walk(localeDir)) {
+      if (entry.isFile && entry.name.endsWith(".md")) {
+        for (const imageFileName of await imagesInMarkdownFile(entry.path)) {
+          const screenshot = getScreenshotByFileNameAndLocale(imageFileName, locale);
+          if (screenshot) {
+            console.log(`Found screenshot for image ${imageFileName} in locale ${locale}:`, screenshot.fileName);
+            const markdownFileDir = entry.path.substring(0, entry.path.lastIndexOf("/"));
+            const source = `${runLogDir}/${screenshot.fileName}`;
+            const destination = `${markdownFileDir}/${imageFileName}`;
+            await copyScreenshotIfDiffers(source, destination);
+          } else {
+            console.warn(`No screenshot found for image ${imageFileName} in locale ${locale}`);
+          }
+        }
+      }
     }
-  } else {
-    screenshotsWithNoDestination.add(pageName);
+  } catch (error) {
+    console.error(`Error reading directory ${localeDir}:`, error);
   }
 }
 
-if (screenshotsWithNoDestination.size > 0) {
-  console.error("Screenshots with no destination:", Array.from(screenshotsWithNoDestination).join(", "));
-  console.error("Please update the script to handle these screenshots.");
+/**
+ * Copies a file from point A to point B if the files differ, or if there is no file at point B, or if
+ * copyFilesEvenIfIdentical is set to true.
+ * Uses zopflipng to optimize the PNG file.
+ * @param source The source file path.
+ * @param destination The destination file path.
+ * @returns A promise that resolves when the copy is complete.
+ * @throws If the source file does not exist or if the copy fails.
+ */
+async function copyScreenshotIfDiffers(source: string, destination: string): Promise<void> {
+  const imageDiffers = pngImagesDiffer(source, destination);
+  if (imageDiffers || copyFilesEvenIfIdentical) {
+    console.log(`Copying ${source} to ${destination} using zopflipng...`);
+    const zopflipng = new Deno.Command("zopflipng", { args: ["-y", source, destination], stdout: "inherit" });
+    const status = await zopflipng.output();
+    if (status.code !== 0) {
+      throw new Error(`Failed to copy ${source} to ${destination} using zopflipng:`, status);
+    }
+  } else {
+    console.log(`Skipping ${source} as it is identical to ${destination}`);
+  }
 }