Optimize golden check script

Takes ~1 sec now instead of ~170 sec.

Fixed: 408406314
Change-Id: I9f2f2a693a28fb93e34e6d98aaffa724cc1ef1d0
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6450888
Reviewed-by: Jack Franklin <[email protected]>
Commit-Queue: Alex Rudenko <[email protected]>

Author: OrKoN

scripts/test/check_obsolete_goldens.js

@@ -4,6 +4,7 @@
 
 const childProcess = require('child_process');
 const fs = require('fs');
+const glob = require('glob');
 const path = require('path');
 const util = require('util');
 const yargs = require('yargs');
@@ -20,10 +21,16 @@ const yargsObject = yargs
 const shouldRemoveFiles = yargsObject.removeFiles === true;
 const SOURCE_ROOT = path.resolve(__dirname, path.join('..', '..'));
 const interactionTestRoot = path.join(SOURCE_ROOT, 'test', 'interactions');
-// TODO: grep seems slow on the entire front_end folder.
-const unitTestRoot = path.join(SOURCE_ROOT, 'front_end', 'panels');
+
+const unitTestRoot = path.join(SOURCE_ROOT, 'front_end');
+// TODO: update the goldens location once interaction tests are
+// migrated.
 const GOLDENS_LOCATION = path.join(interactionTestRoot, 'goldens');
 
+const interactionTestFiles =
+    glob.sync('**/*_test.ts', {cwd: interactionTestRoot}).map(file => path.join(interactionTestRoot, file));
+const unitTestFiles = glob.sync('**/*.test.ts', {cwd: unitTestRoot}).map(file => path.join(unitTestRoot, file));
+
 function findScreenshotsToCheck(folder) {
   const filesToCheck = [];
   const filesInFolder = fs.readdirSync(folder);
@@ -39,63 +46,42 @@ function findScreenshotsToCheck(folder) {
   return filesToCheck;
 }
 
-async function checkFolder(relativeGoldenPath, searchRoot) {
-  // Filepaths in screenshot tests assertions are used using forward slashes.
-  // If this is executed in windows `relativeGoldenPath` will come with
-  // backward slashes, so the path needs to be fixed.
-  const unixRelativeGoldenPath = relativeGoldenPath.replace(/\\/g, '/');
-  const isWin = process.platform === 'win32';
-  if (isWin) {
-    // Currently, we do not assert screenshots on Windows.
-    // Eventually, if we support all platforms we can remove this early
-    // exit.
-    return true;
-  }
-  const textSearchCommand = isWin ?
-      `GET-CHILDITEM ${searchRoot}* -recurs | Select-String -Pattern "${unixRelativeGoldenPath}" -CaseSensitive` :
-      `grep -r ${unixRelativeGoldenPath} ${searchRoot}`;
-  try {
-    // If this doesn't throw, that means we found a match and we're fine.
-    await exec(
-        textSearchCommand,
-        isWin ? {shell: 'powershell.exe'} : undefined,
-    );
-    return true;
-  } catch (error) {
-    if (error.code === 1) {
-      return false;
+function checkFolder(relativeGoldenPath, filesToSearch) {
+  for (const file of filesToSearch) {
+    const content = fs.readFileSync(file, 'utf-8');
+    if (content.includes(relativeGoldenPath)) {
+      return true;
     }
-    console.warn(error);
-    return false;
   }
+  return false;
 }
 
-async function checkGoldensForPlatform(platform) {
+function checkGoldensForPlatform(platform) {
   const obsoleteImages = [];
 
   const platformRoot = path.join(GOLDENS_LOCATION, platform);
   const goldens = findScreenshotsToCheck(platformRoot);
-  for await (const golden of goldens) {
-    const relativeGoldenPath = path.relative(platformRoot, golden);
-    const interactions = await checkFolder(
+
+  for (const golden of goldens) {
+    const relativeGoldenPath = path.relative(platformRoot, golden).replace(/\\/g, '/');
+    const interactions = checkFolder(
         relativeGoldenPath,
-        interactionTestRoot,
+        interactionTestFiles,
     );
-    const units = await checkFolder(relativeGoldenPath, unitTestRoot);
+    const units = checkFolder(relativeGoldenPath, unitTestFiles);
 
     if (!interactions && !units) {
       obsoleteImages.push(path.join(platform, relativeGoldenPath));
     }
   }
-
   return obsoleteImages;
 }
 
 async function run() {
   const obsoleteImages = [
-    ...(await checkGoldensForPlatform('linux')),
-    ...(await checkGoldensForPlatform('mac')),
-    ...(await checkGoldensForPlatform('win32')),
+    ...checkGoldensForPlatform('linux'),
+    ...checkGoldensForPlatform('mac'),
+    ...checkGoldensForPlatform('win32'),
   ];
   if (obsoleteImages.length > 0) {
     console.log(