@jsenv/filesystem 2.3.1 → 2.6.0

package/src/removeFileSystemNode.js

@@ -1,4 +1,5 @@
 import { unlink, rmdir, openSync, closeSync } from "node:fs"
+import { Abort } from "@jsenv/abort"
 
 import { ensureUrlTrailingSlash } from "./internal/ensureUrlTrailingSlash.js"
 import { assertAndNormalizeFileUrl } from "./assertAndNormalizeFileUrl.js"
@@ -10,6 +11,7 @@ import { resolveUrl } from "./resolveUrl.js"
 export const removeFileSystemNode = async (
   source,
   {
+    signal = new AbortController().signal,
     allowUseless = false,
     recursive = false,
     maxRetries = 3,
@@ -19,40 +21,49 @@ export const removeFileSystemNode = async (
 ) => {
   const sourceUrl = assertAndNormalizeFileUrl(source)
 
-  const sourceStats = await readFileSystemNodeStat(sourceUrl, {
-    nullIfNotFound: true,
-    followLink: false,
-  })
-  if (!sourceStats) {
-    if (allowUseless) {
-      return
+  const removeOperation = Abort.startOperation()
+  removeOperation.addAbortSignal(signal)
+
+  try {
+    removeOperation.throwIfAborted()
+    const sourceStats = await readFileSystemNodeStat(sourceUrl, {
+      nullIfNotFound: true,
+      followLink: false,
+    })
+    if (!sourceStats) {
+      if (allowUseless) {
+        return
+      }
+      throw new Error(`nothing to remove at ${urlToFileSystemPath(sourceUrl)}`)
     }
-    throw new Error(`nothing to remove at ${urlToFileSystemPath(sourceUrl)}`)
-  }
 
-  // https://nodejs.org/dist/latest-v13.x/docs/api/fs.html#fs_class_fs_stats
-  // FIFO and socket are ignored, not sure what they are exactly and what to do with them
-  // other libraries ignore them, let's do the same.
-  if (
-    sourceStats.isFile() ||
-    sourceStats.isSymbolicLink() ||
-    sourceStats.isCharacterDevice() ||
-    sourceStats.isBlockDevice()
-  ) {
-    await removeNonDirectory(
-      sourceUrl.endsWith("/") ? sourceUrl.slice(0, -1) : sourceUrl,
-      {
+    // https://nodejs.org/dist/latest-v13.x/docs/api/fs.html#fs_class_fs_stats
+    // FIFO and socket are ignored, not sure what they are exactly and what to do with them
+    // other libraries ignore them, let's do the same.
+    if (
+      sourceStats.isFile() ||
+      sourceStats.isSymbolicLink() ||
+      sourceStats.isCharacterDevice() ||
+      sourceStats.isBlockDevice()
+    ) {
+      await removeNonDirectory(
+        sourceUrl.endsWith("/") ? sourceUrl.slice(0, -1) : sourceUrl,
+        {
+          maxRetries,
+          retryDelay,
+        },
+      )
+    } else if (sourceStats.isDirectory()) {
+      await removeDirectory(ensureUrlTrailingSlash(sourceUrl), {
+        signal: removeOperation.signal,
+        recursive,
         maxRetries,
         retryDelay,
-      },
-    )
-  } else if (sourceStats.isDirectory()) {
-    await removeDirectory(ensureUrlTrailingSlash(sourceUrl), {
-      recursive,
-      maxRetries,
-      retryDelay,
-      onlyContent,
-    })
+        onlyContent,
+      })
+    }
+  } finally {
+    await removeOperation.end()
   }
 }
 
@@ -105,9 +116,13 @@ const unlinkNaive = (sourcePath, { handleTemporaryError = null } = {}) => {
 
 const removeDirectory = async (
   rootDirectoryUrl,
-  { maxRetries, retryDelay, recursive, onlyContent },
+  { signal, maxRetries, retryDelay, recursive, onlyContent },
 ) => {
+  const removeDirectoryOperation = Abort.startOperation()
+  removeDirectoryOperation.addAbortSignal(signal)
+
   const visit = async (sourceUrl) => {
+    removeDirectoryOperation.throwIfAborted()
     const sourceStats = await readFileSystemNodeStat(sourceUrl, {
       nullIfNotFound: true,
       followLink: false,
@@ -141,6 +156,7 @@ const removeDirectory = async (
           },
         }
       : {}
+    removeDirectoryOperation.throwIfAborted()
     await removeDirectoryNaive(directoryPath, {
       ...optionsFromRecursive,
       // Workaround for https://github.com/joyent/node/issues/4337
@@ -179,6 +195,7 @@ const removeDirectory = async (
   }
 
   const removeDirectoryContent = async (directoryUrl) => {
+    removeDirectoryOperation.throwIfAborted()
     const names = await readDirectory(directoryUrl)
     await Promise.all(
       names.map(async (name) => {
@@ -196,10 +213,14 @@ const removeDirectory = async (
     await removeNonDirectory(symbolicLinkUrl, { maxRetries, retryDelay })
   }
 
-  if (onlyContent) {
-    await removeDirectoryContent(rootDirectoryUrl)
-  } else {
-    await visitDirectory(rootDirectoryUrl)
+  try {
+    if (onlyContent) {
+      await removeDirectoryContent(rootDirectoryUrl)
+    } else {
+      await visitDirectory(rootDirectoryUrl)
+    }
+  } finally {
+    await removeDirectoryOperation.end()
   }
 }