[Babel 8] Use more native fs methods (#16459)

* bump @types/node to the latest version * use recursive fs.mkdirSync * use fs.rmSync * use fs.readdirSync recursive * optimize: remove 14.14 version check as fs.rmSync is a new method
babel · May 2, 2024 · fed85fb · fed85fb
1 parent 71c247a
commit fed85fb
Show file tree

Hide file tree

Showing 8 changed files with 109 additions and 66 deletions.
diff --git a/babel.config.js b/babel.config.js
@@ -496,6 +496,40 @@ function pluginPolyfillsOldNode({ template, types: t }) {
       // https://github.com/nodejs/node/blob/main/doc/changelogs/CHANGELOG_V16.md#v8-93
       replacement: template`hasOwnProperty.call`,
     },
+    {
+      name: "fs.rmSync",
+      necessary({ node, parent }) {
+        // To avoid infinite replacement loops
+        return !t.isLogicalExpression(parent, { operator: "||", left: node });
+      },
+      supported({ parent: { arguments: args } }) {
+        return (
+          t.isObjectExpression(args[1]) &&
+          args[1].properties.length === 2 &&
+          t.isIdentifier(args[1].properties[0].key, { name: "force" }) &&
+          t.isBooleanLiteral(args[1].properties[0].value, { value: true }) &&
+          t.isIdentifier(args[1].properties[1].key, { name: "recursive" }) &&
+          t.isBooleanLiteral(args[1].properties[1].value, { value: true })
+        );
+      },
+      // fs.rmSync has been introduced in Node.js 14.14
+      // https://nodejs.org/api/fs.html#fsrmsyncpath-options
+      replacement: template`
+        fs.rmSync || function d(/* path */ p) {
+            if (fs.existsSync(p)) {
+              fs.readdirSync(p).forEach(function (f) {
+                const /* currentPath */ c = p + "/" + f;
+                if (fs.lstatSync(c).isDirectory()) {
+                  d(c);
+                } else {
+                  fs.unlinkSync(c);
+                }
+              });
+              fs.rmdirSync(p);
+            }
+          }
+      `,
+    },
   ];
 
   return {

diff --git a/package.json b/package.json
@@ -45,7 +45,7 @@
     "@rollup/plugin-replace": "^5.0.5",
     "@rollup/plugin-terser": "^0.4.4",
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.5",
+    "@types/node": "^20.12.7",
     "@yarnpkg/types": "^4.0.0",
     "babel-plugin-transform-charcodes": "^0.2.0",
     "c8": "^8.0.1",

diff --git a/packages/babel-cli/src/babel/dir.ts b/packages/babel-cli/src/babel/dir.ts
@@ -119,9 +119,7 @@ export default async function ({
 
       const files = util.readdir(dirname, cliOptions.includeDotfiles);
       for (const filename of files) {
-        const src = path.join(dirname, filename);
-
-        const written = await handleFile(src, dirname);
+        const written = await handleFile(filename, dirname);
         if (written) count += 1;
       }
 

diff --git a/packages/babel-cli/src/babel/file.ts b/packages/babel-cli/src/babel/file.ts
@@ -158,17 +158,13 @@ export default async function ({
 
       const stat = fs.statSync(filename);
       if (stat.isDirectory()) {
-        const dirname = filename;
-
-        util
-          .readdirForCompilable(
+        _filenames.push(
+          ...util.readdirForCompilable(
             filename,
             cliOptions.includeDotfiles,
             cliOptions.extensions,
-          )
-          .forEach(function (filename) {
-            _filenames.push(path.join(dirname, filename));
-          });
+          ),
+        );
       } else {
         _filenames.push(filename);
       }

diff --git a/packages/babel-cli/src/babel/options.ts b/packages/babel-cli/src/babel/options.ts
@@ -3,6 +3,7 @@ import fs from "fs";
 import commander from "commander";
 import { version, DEFAULT_EXTENSIONS } from "@babel/core";
 import * as glob from "glob";
+import { alphasort } from "./util.ts";
 
 import type { InputOptions } from "@babel/core";
 
@@ -216,9 +217,7 @@ export default function parseArgv(args: Array<string>): CmdOptions | null {
     let files = process.env.BABEL_8_BREAKING
       ? // glob 9+ no longer sorts the result, here we maintain the glob 7 behaviour
         // https://github.com/isaacs/node-glob/blob/c3cd57ae128faa0e9190492acc743bb779ac4054/common.js#L151
-        glob.sync(input, { dotRelative: true }).sort(function alphasort(a, b) {
-          return a.localeCompare(b, "en");
-        })
+        glob.sync(input, { dotRelative: true }).sort(alphasort)
       : // @ts-expect-error When USE_ESM is true and BABEL_8_BREAKING is off,
         // the glob package is an ESM wrapper of the CJS glob 7
         (USE_ESM ? glob.default.sync : glob.sync)(input);

diff --git a/packages/babel-cli/src/babel/util.ts b/packages/babel-cli/src/babel/util.ts
@@ -15,22 +15,54 @@ export function chmod(src: string, dest: string): void {
   }
 }
 
+export function alphasort(a: string, b: string) {
+  return a.localeCompare(b, "en");
+}
+
 type ReaddirFilter = (filename: string) => boolean;
 
 export function readdir(
   dirname: string,
   includeDotfiles: boolean,
   filter?: ReaddirFilter,
 ): Array<string> {
-  return readdirRecursive(dirname, (filename, index, currentDirectory) => {
-    const stat = fs.statSync(path.join(currentDirectory, filename));
-
-    if (stat.isDirectory()) return true;
-
+  if (process.env.BABEL_8_BREAKING) {
     return (
-      (includeDotfiles || filename[0] !== ".") && (!filter || filter(filename))
+      fs
+        .readdirSync(dirname, { recursive: true, withFileTypes: true })
+        .filter(dirent => {
+          // exclude directory entries from readdir results
+          if (dirent.isDirectory()) return false;
+          const filename = dirent.name;
+          return (
+            (includeDotfiles || filename[0] !== ".") &&
+            (!filter || filter(filename))
+          );
+        })
+        .map(dirent => path.join(dirent.path, dirent.name))
+        // readdirSyncRecursive conducts BFS, sort the entries so we can match the DFS behaviour of fs-readdir-recursive
+        // https://github.com/nodejs/node/blob/d6b12f5b77e35c58a611d614cf0aac674ec2c3ed/lib/fs.js#L1421
+        .sort(alphasort)
     );
-  });
+  } else {
+    return readdirRecursive(
+      "",
+      (filename, index, currentDirectory) => {
+        const stat = fs.statSync(path.join(currentDirectory, filename));
+
+        // ensure we recurse into .* folders
+        if (stat.isDirectory()) return true;
+
+        return (
+          (includeDotfiles || filename[0] !== ".") &&
+          (!filter || filter(filename))
+        );
+      },
+      // @ts-expect-error improve @types/fs-readdir-recursive typings
+      [],
+      dirname,
+    );
+  }
 }
 
 export function readdirForCompilable(
@@ -109,19 +141,7 @@ export async function compile(filename: string, opts: InputOptions) {
 }
 
 export function deleteDir(path: string): void {
-  if (fs.existsSync(path)) {
-    fs.readdirSync(path).forEach(function (file) {
-      const curPath = path + "/" + file;
-      if (fs.lstatSync(curPath).isDirectory()) {
-        // recurse
-        deleteDir(curPath);
-      } else {
-        // delete file
-        fs.unlinkSync(curPath);
-      }
-    });
-    fs.rmdirSync(path);
-  }
+  fs.rmSync(path, { force: true, recursive: true });
 }
 
 process.on("uncaughtException", function (err) {

diff --git a/packages/babel-helper-transform-fixture-test-runner/src/index.ts b/packages/babel-helper-transform-fixture-test-runner/src/index.ts
@@ -26,8 +26,7 @@ import { diff } from "jest-diff";
 import type { ChildProcess } from "child_process";
 import { spawn } from "child_process";
 import os from "os";
-import { sync as makeDir } from "make-dir";
-import readdir from "fs-readdir-recursive";
+import readdirRecursive from "fs-readdir-recursive";
 
 import { createRequire } from "module";
 const require = createRequire(import.meta.url);
@@ -664,39 +663,36 @@ const nodeGte8 = parseInt(process.versions.node, 10) >= 8;
 // https://github.com/nodejs/node/issues/11422#issue-208189446
 const tmpDir = realpathSync(os.tmpdir());
 
-const readDir = function (loc: string, filter: Parameters<typeof readdir>[1]) {
+const readDir = function (loc: string, pathFilter: (arg0: string) => boolean) {
   const files: Record<string, string> = {};
   if (fs.existsSync(loc)) {
-    readdir(loc, filter).forEach(function (filename) {
-      files[filename] = readFile(path.join(loc, filename));
-    });
+    if (process.env.BABEL_8_BREAKING) {
+      fs.readdirSync(loc, { withFileTypes: true, recursive: true })
+        .filter(dirent => dirent.isFile() && pathFilter(dirent.name))
+        .forEach(dirent => {
+          const fullpath = path.join(dirent.path, dirent.name);
+          files[path.relative(loc, fullpath)] = readFile(fullpath);
+        });
+    } else {
+      readdirRecursive(loc, pathFilter).forEach(function (filename) {
+        files[filename] = readFile(path.join(loc, filename));
+      });
+    }
   }
   return files;
 };
 
 const outputFileSync = function (filePath: string, data: string) {
-  makeDir(path.dirname(filePath));
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
   fs.writeFileSync(filePath, data);
 };
 
 function deleteDir(path: string): void {
-  if (fs.existsSync(path)) {
-    fs.readdirSync(path).forEach(function (file) {
-      const curPath = path + "/" + file;
-      if (fs.lstatSync(curPath).isDirectory()) {
-        // recurse
-        deleteDir(curPath);
-      } else {
-        // delete file
-        fs.unlinkSync(curPath);
-      }
-    });
-    fs.rmdirSync(path);
-  }
+  fs.rmSync(path, { force: true, recursive: true });
 }
 
-const fileFilter = function (x: string) {
-  return x !== ".DS_Store";
+const pathFilter = function (x: string) {
+  return path.basename(x) !== ".DS_Store";
 };
 
 const assertTest = function (
@@ -751,7 +747,7 @@ const assertTest = function (
   }
 
   if (opts.outFiles) {
-    const actualFiles = readDir(tmpDir, fileFilter);
+    const actualFiles = readDir(tmpDir, pathFilter);
 
     Object.keys(actualFiles).forEach(function (filename) {
       try {
@@ -865,8 +861,8 @@ export function buildProcessTests(
       }
 
       opts.testLoc = testLoc;
-      opts.outFiles = readDir(path.join(testLoc, "out-files"), fileFilter);
-      opts.inFiles = readDir(path.join(testLoc, "in-files"), fileFilter);
+      opts.outFiles = readDir(path.join(testLoc, "out-files"), pathFilter);
+      opts.inFiles = readDir(path.join(testLoc, "in-files"), pathFilter);
 
       const babelrcLoc = path.join(testLoc, ".babelrc");
       const babelIgnoreLoc = path.join(testLoc, ".babelignore");
@@ -903,7 +899,7 @@ export function buildProcessTests(
             createHash("sha1").update(testLoc).digest("hex"),
           );
           deleteDir(tmpLoc);
-          makeDir(tmpLoc);
+          fs.mkdirSync(tmpLoc, { recursive: true });
 
           const { inFiles } = opts;
           for (const filename of Object.keys(inFiles)) {

diff --git a/yarn.lock b/yarn.lock
@@ -5496,12 +5496,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/node@npm:*, @types/node@npm:^20.11.5":
-  version: 20.11.5
-  resolution: "@types/node@npm:20.11.5"
+"@types/node@npm:*, @types/node@npm:^20.12.7":
+  version: 20.12.7
+  resolution: "@types/node@npm:20.12.7"
   dependencies:
     undici-types: "npm:~5.26.4"
-  checksum: 10/9f31c471047d7b3e240ce7b77ff29b0d15e83be7e3feafb3d0b0d0931122b438b1eefa302a5a2e1e9849914ff3fd76aafbd8ccb372efb1331ba048da63bce6f8
+  checksum: 10/b4a28a3b593a9bdca5650880b6a9acef46911d58cf7cfa57268f048e9a7157a7c3196421b96cea576850ddb732e3b54bc982c8eb5e1e5ef0635d4424c2fce801
   languageName: node
   linkType: hard
 
@@ -7145,7 +7145,7 @@ __metadata:
     "@rollup/plugin-replace": "npm:^5.0.5"
     "@rollup/plugin-terser": "npm:^0.4.4"
     "@types/jest": "npm:^29.5.11"
-    "@types/node": "npm:^20.11.5"
+    "@types/node": "npm:^20.12.7"
     "@yarnpkg/types": "npm:^4.0.0"
     babel-plugin-transform-charcodes: "npm:^0.2.0"
     c8: "npm:^8.0.1"