Migrate build/commands to ESM (#34222)

Migrate `build/commands` code to ESM to allow `.js`/`.ts` imports to work correctly in any direction. This allows for gradual migration to `.ts` while keeping `.js` files around.

Few notes on migration:
1. `import.meta.*` cannot be used reliably with Jest. I tried different versions and approaches, eventually came up with a `.cjs` module that still uses `__dirName`, but can be imported into ESM and CommonJS modules without issues. I also considered rewriting Jest tests into built-in Node test runner, but since I was able to make Jest work, this was abandoned.
2. `tsc` accepts both `file.js`/`file.ts` in imports and passes a compiler check without errors, but Node requires an import of a real file (type stripping is based on a file type). This means an incorrect import will pass `test:scripts`, but fail on real execution (see [related discussion](microsoft/TypeScript#61021)). An eslint rule was added to enforce that.
3. local `require()` calls replaced with async/global imports depending on context.

Author: goodov

build/commands/lib/actionGuard.js

@@ -3,9 +3,9 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // You can obtain one at https://mozilla.org/MPL/2.0/.
 
-const assert = require('assert')
-const fs = require('fs-extra')
-const path = require('path')
+import assert from 'assert'
+import fs from 'fs-extra'
+import path from 'path'
 
 // This function is used to get the call stack of the guarded operation. It is
 // stored in the guard file.
@@ -21,7 +21,7 @@ function getGuardCallStack() {
 
 // This class is used to ensure that a given action is successfully completed,
 // otherwise a rerun might be required.
-class ActionGuard {
+export default class ActionGuard {
   // Path to the guard file.
   #guardFilePath
   // Cleanup closure to perform a cleanup (optional) before running the action.
@@ -86,5 +86,3 @@ class ActionGuard {
     }
   }
 }
-
-module.exports = ActionGuard

build/commands/lib/actionGuard.test.js

@@ -3,9 +3,9 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // You can obtain one at https://mozilla.org/MPL/2.0/.
 
-const fs = require('fs-extra')
-const path = require('path')
-const ActionGuard = require('./actionGuard')
+import fs from 'fs-extra'
+import path from 'path'
+import ActionGuard from './actionGuard.js'
 
 describe('ActionGuard', () => {
   const guardFilePath = '/path/to/guard/file'

build/commands/lib/affectedTests.js

@@ -3,19 +3,21 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // You can obtain one at https://mozilla.org/MPL/2.0/.
 
-const { promisify } = require('util')
-const { readFile, writeFile } = require('fs/promises')
-const exec = promisify(require('child_process').execFile)
-const path = require('path')
-const config = require('./config')
-const { unlink } = require('fs-extra')
-const { randomUUID } = require('crypto')
-const {
+import { promisify } from 'node:util'
+import { readFile, writeFile } from 'fs/promises'
+import child_process from 'node:child_process'
+import path from 'path'
+import config from './config.js'
+import fs from 'fs-extra'
+import { randomUUID } from 'crypto'
+import { tmpdir } from 'os'
+import {
   getApplicableFilters,
   getTestsToRun,
   gnTargetToExecutableName,
-} = require('./testUtils')
-const { tmpdir } = require('os')
+} from './testUtils.js'
+
+const exec = promisify(child_process.execFile)
 
 const getTestTargets = (outDir, filters = ['//*']) => {
   const { env, shell } = config.defaultOptions
@@ -113,7 +115,7 @@ async function analyzeAffectedTests(
 
   const output = await readFile(analyzeOutJson, 'utf-8').then(JSON.parse)
 
-  await Promise.all([unlink(analyzeJson), unlink(analyzeOutJson)])
+  await Promise.all([fs.unlink(analyzeJson), fs.unlink(analyzeOutJson)])
 
   return {
     outDir,
@@ -167,7 +169,4 @@ async function getAffectedTests(args = {}) {
   return [...new Set([...affectedTests, ...testAffectedDueModifiedFilterFiles])]
 }
 
-module.exports = {
-  analyzeAffectedTests,
-  getAffectedTests,
-}
+export { analyzeAffectedTests, getAffectedTests }

build/commands/lib/applyPatches.js

@@ -3,8 +3,8 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // You can obtain one at https://mozilla.org/MPL/2.0/.
 
-const config = require('../lib/config')
-const util = require('../lib/util')
+import config from './config.js'
+import util from './util.js'
 
 const applyPatches = (
   buildConfig = config.defaultBuildConfig,
@@ -22,4 +22,4 @@ const applyPatches = (
   })
 }
 
-module.exports = applyPatches
+export default applyPatches

build/commands/lib/branding.js

@@ -3,14 +3,14 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // You can obtain one at https://mozilla.org/MPL/2.0/.
 
-const path = require('path')
-const config = require('./config')
-const fs = require('fs-extra')
-const l10nUtil = require('./l10nUtil')
-const util = require('./util')
-const Log = require('./logging')
+import path from 'path'
+import config from './config.js'
+import fs from 'fs-extra'
+import l10nUtil from './l10nUtil.js'
+import util from './util.js'
+import Log from './logging.js'
 
-exports.update = () => {
+const update = () => {
   Log.progressStart('update branding')
   const chromeComponentsDir = path.join(config.srcDir, 'components')
   const braveComponentsDir = path.join(config.braveCoreDir, 'components')
@@ -515,3 +515,5 @@ exports.update = () => {
   }
   Log.progressFinish('update branding')
 }
+
+export default { update }

build/commands/lib/build.js

@@ -3,12 +3,12 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // You can obtain one at https://mozilla.org/MPL/2.0/.
 
-const config = require('../lib/config')
-const util = require('../lib/util')
-const path = require('path')
-const fs = require('fs-extra')
-const Log = require('../lib/logging')
-const branding = require('../lib/branding')
+import config from './config.js'
+import util from './util.js'
+import path from 'path'
+import fs from 'fs-extra'
+import Log from './logging.js'
+import branding from './branding.js'
 
 /**
  * Checks to make sure the src/chrome/VERSION matches brave-core's package.json version
@@ -55,4 +55,4 @@ const build = async (buildConfig = config.defaultBuildConfig, options = {}) => {
   }
 }
 
-module.exports = build
+export default build

build/commands/lib/buildChromiumRelease.js

@@ -8,13 +8,13 @@
 // Designed to be used on CI, but should work locally too.
 // The script includes syncing; there is no need to run npm run sync before.
 
-const config = require('./config')
-const util = require('./util')
-const path = require('path')
-const fs = require('fs-extra')
-const depotTools = require('./depotTools')
-const syncUtil = require('./syncUtils')
-const Log = require('./logging')
+import config from './config.js'
+import util from './util.js'
+import path from 'path'
+import fs from 'fs-extra'
+import depotTools from './depotTools.js'
+import syncUtil from './syncUtils.js'
+import Log from './logging.js'
 
 // Use the same filename as for Brave archive.
 const getOutputFilename = () => {
@@ -212,4 +212,4 @@ function buildChromiumRelease(buildOptions = {}) {
   })
 }
 
-module.exports = buildChromiumRelease
+export default buildChromiumRelease

build/commands/lib/calculateFileChecksum.js

@@ -3,13 +3,10 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // you can obtain one at https://mozilla.org/MPL/2.0/.
 
-const crypto = require('crypto')
-const fs = require('fs')
+import crypto from 'crypto'
+import fs from 'fs'
 
-module.exports = function CalculateFileChecksum(
-  filePath,
-  algorithm = 'sha256',
-) {
+export default function calculateFileChecksum(filePath, algorithm = 'sha256') {
   return new Promise((resolve, reject) => {
     try {
       const checksumGenerator = crypto.createHash(algorithm)

build/commands/lib/calculateFileChecksum.test.js

@@ -3,10 +3,10 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this file,
 // You can obtain one at https://mozilla.org/MPL/2.0/.
 
-const path = require('path')
-const fs = require('fs-extra')
-const os = require('os')
-const calculateFileChecksum = require('./calculateFileChecksum')
+import path from 'path'
+import fs from 'fs-extra'
+import os from 'os'
+import calculateFileChecksum from './calculateFileChecksum.js'
 
 const dirPrefixTmp = 'brave-browser-test-calculate-file-checksum-'
 const testFile1Name = 'file1'

build/commands/lib/checkEnvironment.js

@@ -3,10 +3,10 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  * You can obtain one at https://mozilla.org/MPL/2.0/. */
 
-const fs = require('fs')
-const path = require('path')
-const semver = require('semver')
-const Log = require('./logging')
+import fs from 'fs'
+import path from 'path'
+import semver from 'semver'
+import Log from './logging.js'
 
 checkNodeVersion()
 checkNpmVersion()