Improvement to logging and cleanup

Author: haggholm

index.d.ts

@@ -285,11 +285,13 @@ export function setLogger(logger: Logger): void;
  * @param [options.cleanup] If truthy, the subdirectory will be deleted
  *   when the function settles. Use with caution as it may delete files
  *   still in use.
+ * @param [options.logTags] If provided, these will be passed as the first
+ *   parameter to logger calls during cleanup.
  */
 export function withSubdir<T>(
 	dir: string,
 	fn: (cleanupFn: () => Promise<void>) => Promise<T>,
-	options?: { cleanup?: boolean }
+	options?: { cleanup?: boolean, logTags?: Record<string, unknown> }
 ): Promise<T>;
 
 /**
@@ -298,4 +300,4 @@ export function withSubdir<T>(
  * This should be used advisedly, as it may delete files still in use.
  * Intended usage is at the top level between processing requests.
  */
-export function gc(): void;
+export function gc(): void;

lib/tmp.js

@@ -11,6 +11,7 @@
  */
 const asyncHooks = require("async_hooks");
 const fs = require('fs');
+const fsp = require('fs/promises');
 const os = require('os');
 const path = require('path');
 const crypto = require('crypto');
@@ -385,6 +386,8 @@ function _prepareRemoveCallback(removeFunction, fileOrDirName, sync, cleanupCall
   };
 }
 
+const sleep = (ms) => new Promise((resolve)=>setTimeout(resolve, ms));
+
 /**
  * The garbage collector.
  *
@@ -394,7 +397,7 @@ function _garbageCollector() {
   /* istanbul ignore else */
   if (!_gracefulCleanup) return;
 
-  _logger.info("lib-tmp.gc.start");
+  _logger.info("lib-tmp.gc.global.start");
 
   const attemptedObjects = _removeObjects.length;
   let removedObjects = 0;
@@ -414,7 +417,7 @@ function _garbageCollector() {
 
   _logger.info(
     { expected: attemptedObjects, actual: removedObjects, count: removedObjects, duration: dt },
-    "lib-tmp.gc.end"
+    "lib-tmp.gc.global.end"
   );
 }
 
@@ -506,7 +509,8 @@ function _parseArguments(options, callback) {
  */
 function _generateTmpName(opts) {
 
-  const tmpDir = opts.tmpdir;
+  const ctx = prefixStackStorage.getStore();
+  const tmpDir = ctx && ctx.value ? ctx.value : opts.tmpdir;
 
   /* istanbul ignore else */
   if (!_isUndefined(opts.name))
@@ -685,13 +689,6 @@ function setGracefulCleanup() {
  * @returns {string} the currently configured tmp dir
  */
 function _getTmpDir(options) {
-  if (_defaultDir) {
-    return path.resolve(
-      options && options.tmpdir,
-      _defaultDir || os.tmpdir()
-    )
-  }
-  if (options && options.tmpdir) {}
   return path.resolve(options && options.tmpdir || os.tmpdir());
 }
 
@@ -700,22 +697,26 @@ function setLogger(logger) {
 }
 
 async function withSubdir(prefix, fn, options) {
+  const ctx = prefixStackStorage.getStore();
+  const tmpDir = path.resolve(
+    ctx ? ctx.value : _getTmpDir(),
+    prefix
+  );
+  await fsp.mkdir(tmpDir, { recursive: true });
+
+  const logTags = {
+    ...(options && options.logTags ? options.logTags : {}),
+    path: tmpDir
+  };
+
   return new Promise((resolve, reject) => {
-    const currentValue = prefixStackStorage.getStore();
-    const tmpDir = path.resolve(
-      currentValue ? currentValue.value : os.tmpdir(),
-      prefix
-    );
-    fs.mkdirSync(tmpDir, { recursive: true });
-    const cleanup = (cb) => {
-      if (cb) {
-        fs.rmdir(tmpDir, { recursive: true }, cb);
-      } else {
-        return new Promise((resolve, reject) => fs.rmdir(
-          tmpDir,
-          { recursive: true },
-          (err) => err ? reject(err) : resolve)
-        );
+    const cleanup = async () => {
+      _logger.info(logTags,"lib-tmp.gc.start");
+      try {
+        await fsp.rmdir(tmpDir, { recursive: true, maxRetries: 5 });
+        _logger.info({ ...logTags, duration: Date.now() - t0 }, "lib-tmp.gc.end");
+      } catch (error) {
+        _logger.info({ ...logTags, duration: Date.now() - t0, error }, "lib-tmp.gc.error");
       }
     }
     prefixStackStorage.run({ value: tmpDir }, () => {
@@ -842,6 +843,5 @@ module.exports.tmpNameSync = tmpNameSync;
 module.exports.setGracefulCleanup = setGracefulCleanup;
 
 module.exports.setLogger = setLogger;
-module.exports.setDefaultDir = setDefaultDir;
 module.exports.gc = _garbageCollector;
-module.exports.withSubdir = withSubdir;
+module.exports.withSubdir = withSubdir;

package.json

@@ -22,7 +22,7 @@
     "url": "http://github.com/raszi/node-tmp/issues"
   },
   "engines": {
-    "node": ">=14.14"
+    "node": ">=18"
   },
   "dependencies": {},
   "devDependencies": {