Migrate scripts that run against NodeJS to ESM

NodeJS v24 allows us to run ESM even with no type:module in
package.json.
We do get a warning but that is harmless.

Bug: 411053158
Change-Id: I0fdbfa0e323ebfc53a0f8763fc279ca0a3446595
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/7216014
Commit-Queue: Simon Zünd <[email protected]>
Auto-Submit: Nikolay Vitkov <[email protected]>
Reviewed-by: Simon Zünd <[email protected]>

Author: Lightning00Blade

front_end/Images/generate-css-vars.js

@@ -1,9 +1,10 @@
 // Copyright 2020 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-const path = require('node:path');
+import * as path from 'node:path';
+
+import {writeIfChanged} from '../../scripts/build/ninja/write-if-changed.js';
 
-const {writeIfChanged} = require('../../scripts/build/ninja/write-if-changed.js');
 const [, , buildTimestamp, targetGenDir, targetName, ...imageSources] = process.argv;
 
 /**
@@ -15,7 +16,7 @@ function generateCSSVariableDefinition(fileName) {
       // We have to remove the `src/` part from any SVG file names for the CSS variables, while
       // we still use the full URL for the meta.url import. That's because the rollup-plugin-import-meta-assets
       // rewrites the image URLs to the new location, but doesn't modify the generated CSS variable name
-      fileName.replace('src\/', '').replace(path.extname(fileName), '')}', 'url(\\"' + new URL('./${
+      fileName.replace('src/', '').replace(path.extname(fileName), '')}', 'url(\\"' + new URL('./${
       fileName}', import.meta.url).toString() + '\\")');`;
 }
 
@@ -45,4 +46,7 @@ const tsconfigContent = `{
 }
 `;
 
-writeIfChanged(path.join(targetGenDir, `${targetName}-tsconfig.json`), tsconfigContent);
+writeIfChanged(
+    path.join(targetGenDir, `${targetName}-tsconfig.json`),
+    tsconfigContent,
+);

front_end/core/i18n/collect-ui-strings.js

@@ -2,15 +2,18 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-const glob = require('glob');
-const path = require('node:path');
-const yargs = require('yargs');
-const {hideBin} = require('yargs/helpers');
+import glob from 'glob';
+import * as path from 'node:path';
+import yargs from 'yargs';
+import {hideBin} from 'yargs/helpers';
 
-const {writeIfChanged} = require('../../../scripts/build/ninja/write-if-changed.js');
-const {bakePlaceholders} = require('../../../third_party/i18n/bake-ctc-to-lhl.js');
-const {collectAllStringsInDir, createPsuedoLocaleStrings, IGNORED_PATH_COMPONENTS} =
-    require('../../../third_party/i18n/collect-strings.js');
+import {writeIfChanged} from '../../../scripts/build/ninja/write-if-changed.js';
+import {bakePlaceholders} from '../../../third_party/i18n/bake-ctc-to-lhl.js';
+import {
+  collectAllStringsInDir,
+  createPsuedoLocaleStrings,
+  IGNORED_PATH_COMPONENTS,
+} from '../../../third_party/i18n/collect-strings.js';
 
 /** @typedef {import('../../../third_party/i18n/bake-ctc-to-lhl.js').CtcMessage} CtcMessage */
 
@@ -39,7 +42,9 @@ function convertCtcToLhLAndSave(outputDirectory, locale, strings) {
 
   /** @type {Record<string, CtcMessage>} */
   const sortedCtcStrings = {};
-  const sortedEntries = Object.entries(strings).sort(([keyA], [keyB]) => keyA.localeCompare(keyB));
+  const sortedEntries = Object.entries(strings).sort(
+      ([keyA], [keyB]) => keyA.localeCompare(keyB),
+  );
   for (const [key, defn] of sortedEntries) {
     sortedCtcStrings[key] = defn;
   }
@@ -73,7 +78,11 @@ for (const directory of inputDirectories) {
 const outputDirectory = yargsObject['output-directory'];
 convertCtcToLhLAndSave(outputDirectory, 'en-US', collectedStrings);
 if (yargsObject['include-en-xl']) {
-  convertCtcToLhLAndSave(outputDirectory, 'en-XL', createPsuedoLocaleStrings(collectedStrings));
+  convertCtcToLhLAndSave(
+      outputDirectory,
+      'en-XL',
+      createPsuedoLocaleStrings(collectedStrings),
+  );
 }
 
 // Write the depfile. This is necessary to properly rebuild en-US.json/en-XL.json

front_end/core/i18n/generate-locales-js.js

@@ -2,11 +2,11 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-const path = require('node:path');
-const yargs = require('yargs');
-const {hideBin} = require('yargs/helpers');
+import * as path from 'node:path';
+import yargs from 'yargs';
+import {hideBin} from 'yargs/helpers';
 
-const {writeIfChanged} = require('../../../scripts/build/ninja/write-if-changed.js');
+import {writeIfChanged} from '../../../scripts/build/ninja/write-if-changed.js';
 
 const yargsObject = yargs(hideBin(process.argv))
                         .option('target-gen-dir', {

front_end/panels/timeline/enable-easter-egg.js

@@ -2,9 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-const path = require('node:path');
+import * as path from 'node:path';
+
+import {writeIfChanged} from '../../../scripts/build/ninja/write-if-changed.js';
 
-const {writeIfChanged} = require('../../../scripts/build/ninja/write-if-changed.js');
 const [, , targetGenDir] = process.argv;
 
 let value = 'false';
@@ -13,4 +14,7 @@ if (process.argv.includes('--should-enable')) {
   value = 'true';
 }
 
-writeIfChanged(path.join(targetGenDir, 'EasterEgg.js'), `export const SHOULD_SHOW_EASTER_EGG = ${value};`);
+writeIfChanged(
+    path.join(targetGenDir, 'EasterEgg.js'),
+    `export const SHOULD_SHOW_EASTER_EGG = ${value};`,
+);

scripts/check_esbuild_versions.js

@@ -3,14 +3,11 @@
 // Copyright 2022 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-'use strict';
 
-const fs = require('node:fs');
-const path = require('node:path');
+import fs from 'node:fs';
+import path from 'node:path';
 
-const {
-  devtoolsRootPath,
-} = require('./devtools_paths.js');
+import {devtoolsRootPath} from './devtools_paths.js';
 
 function bail(message) {
   console.error(message);
@@ -20,7 +17,9 @@ function bail(message) {
 function findVersionFromDepsFile() {
   const filePath = path.join(devtoolsRootPath(), 'DEPS');
   const contents = fs.readFileSync(filePath, 'utf8').split('\n');
-  const esbuildPackageLine = contents.findIndex(line => line.match(/infra\/3pp\/tools\/esbuild/));
+  const esbuildPackageLine = contents.findIndex(
+      line => line.match(/infra\/3pp\/tools\/esbuild/),
+  );
   if (esbuildPackageLine === -1) {
     bail('Could not find ESBuild within DEPS file.');
   }

scripts/check_experiments.js

@@ -1,11 +1,10 @@
 // Copyright 2020 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-'use strict';
 
-const espree = require('@typescript-eslint/parser');
-const fs = require('node:fs');
-const path = require('node:path');
+import espree from '@typescript-eslint/parser';
+import fs from 'node:fs';
+import path from 'node:path';
 
 const parseOptions = {
   ecmaVersion: 'latest',
@@ -253,7 +252,7 @@ function compareExperimentLists(mainImplList, userMetricsList) {
 
 function main() {
   const mainImplPath = path.resolve(
-      __dirname,
+      import.meta.dirname,
       '..',
       'front_end',
       'entrypoints',
@@ -263,7 +262,7 @@ function main() {
   const mainImplFile = fs.readFileSync(mainImplPath, 'utf-8');
 
   const userMetricsPath = path.resolve(
-      __dirname,
+      import.meta.dirname,
       '..',
       'front_end',
       'core',
@@ -273,7 +272,7 @@ function main() {
   const userMetricsFile = fs.readFileSync(userMetricsPath, 'utf-8');
 
   const runtimePath = path.resolve(
-      __dirname,
+      import.meta.dirname,
       '..',
       'front_end',
       'core',

scripts/check_external_links.js

@@ -2,12 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
-
-const fs = require('node:fs');
-const https = require('node:https');
-const path = require('node:path');
-const ts = require('typescript');
+import fs from 'node:fs';
+import https from 'node:https';
+import path from 'node:path';
+import ts from 'typescript';
 
 const readDirAsync = fs.promises.readdir;
 const readFileAsync = fs.promises.readFile;
@@ -18,13 +16,9 @@ const ORIGIN_PATTERNS_TO_CHECK = [
   new RegExp('^https://developer[s]?.chrome.com'),
 ];
 
-const DIRECTORIES_TO_CHECK = [
-  'front_end',
-];
+const DIRECTORIES_TO_CHECK = ['front_end'];
 
-const EXCLUDE_DIRECTORIES = [
-  'front_end/third_party',
-];
+const EXCLUDE_DIRECTORIES = ['front_end/third_party'];
 
 const REQUEST_TIMEOUT = 5000;
 
@@ -34,25 +28,29 @@ const REDIRECTS_CONSIDERED_ERROR = new Set([
   /* Permament redirect */ 308,
 ]);
 
-const ROOT_REPOSITORY_PATH = path.resolve(__dirname, '..');
-const DIRECTORIES_TO_CHECK_PATHS = DIRECTORIES_TO_CHECK.map(directory => path.resolve(ROOT_REPOSITORY_PATH, directory));
+const ROOT_REPOSITORY_PATH = path.resolve(import.meta.dirname, '..');
+const DIRECTORIES_TO_CHECK_PATHS = DIRECTORIES_TO_CHECK.map(
+    directory => path.resolve(ROOT_REPOSITORY_PATH, directory),
+);
 
 async function findAllSourceFiles(directory) {
   if (EXCLUDE_DIRECTORIES.includes(path.relative(ROOT_REPOSITORY_PATH, directory))) {
     return [];
   }
 
   const dirEntries = await readDirAsync(directory, {withFileTypes: true});
-  const files = await Promise.all(dirEntries.map(dirEntry => {
-    const resolvedPath = path.resolve(directory, dirEntry.name);
-    if (dirEntry.isDirectory()) {
-      return findAllSourceFiles(resolvedPath);
-    }
-    if (dirEntry.isFile() && /\.(js|ts)$/.test(dirEntry.name)) {
-      return resolvedPath;
-    }
-    return [];  // Let Array#flat filter out files we are not interested in.
-  }));
+  const files = await Promise.all(
+      dirEntries.map(dirEntry => {
+        const resolvedPath = path.resolve(directory, dirEntry.name);
+        if (dirEntry.isDirectory()) {
+          return findAllSourceFiles(resolvedPath);
+        }
+        if (dirEntry.isFile() && /\.(js|ts)$/.test(dirEntry.name)) {
+          return resolvedPath;
+        }
+        return [];  // Let Array#flat filter out files we are not interested in.
+      }),
+  );
   return files.flat();
 }
 
@@ -63,7 +61,9 @@ function collectUrlsToCheck(node) {
     const currentNode = nodesToVisit.shift();
     if (currentNode.kind === ts.SyntaxKind.StringLiteral ||
         currentNode.kind === ts.SyntaxKind.NoSubstitutionTemplateLiteral) {
-      const checkUrl = ORIGIN_PATTERNS_TO_CHECK.some(originPattern => originPattern.test(currentNode.text));
+      const checkUrl = ORIGIN_PATTERNS_TO_CHECK.some(
+          originPattern => originPattern.test(currentNode.text),
+      );
       if (checkUrl) {
         urlsToCheck.push(currentNode.text);
       }
@@ -75,25 +75,33 @@ function collectUrlsToCheck(node) {
 
 async function collectUrlsToCheckFromFile(filePath) {
   const content = await readFileAsync(filePath, 'utf8');
-  const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.ESNext, true);
+  const sourceFile = ts.createSourceFile(
+      filePath,
+      content,
+      ts.ScriptTarget.ESNext,
+      true,
+  );
   return collectUrlsToCheck(sourceFile);
 }
 
 async function checkUrls(urls) {
   // clang-format off
-  const requestPromises = urls.map(url => new Promise(resolve => {
-    const request = https.request(url, {method: 'HEAD'}, response => {
-      resolve({url, statusCode: response.statusCode});
-    });
-
-    request.on('error', err => {
-      resolve({url, error: err});
-    });
-    request.setTimeout(REQUEST_TIMEOUT, _ => {
-      resolve({url, error: `Timed out after ${REQUEST_TIMEOUT}`});
-    });
-    request.end();
-  }));
+  const requestPromises = urls.map(
+    url =>
+      new Promise(resolve => {
+        const request = https.request(url, { method: 'HEAD' }, response => {
+          resolve({ url, statusCode: response.statusCode });
+        });
+
+        request.on('error', err => {
+          resolve({ url, error: err });
+        });
+        request.setTimeout(REQUEST_TIMEOUT, _ => {
+          resolve({ url, error: `Timed out after ${REQUEST_TIMEOUT}` });
+        });
+        request.end();
+      }),
+  );
   // clang-format on
 
   return Promise.all(requestPromises);
@@ -122,9 +130,13 @@ function printSelectedRequestResults(requestResults) {
     if (requestResult.error) {
       console.error(`[Failure] ${requestResult.error} - ${requestResult.url}`);
     } else if (isErrorStatusCode(requestResult.statusCode)) {
-      console.error(`[Failure] Status Code: ${requestResult.statusCode} - ${requestResult.url}`);
+      console.error(
+          `[Failure] Status Code: ${requestResult.statusCode} - ${requestResult.url}`,
+      );
     } else {
-      console.log(`Status Code: ${requestResult.statusCode} - ${requestResult.url}`);
+      console.log(
+          `Status Code: ${requestResult.statusCode} - ${requestResult.url}`,
+      );
     }
   }
 }