rimraf
Version:
A deep deletion module for node (like `rm -rf`)
138 lines • 5.83 kB
JavaScript
;
// https://youtu.be/uhRWMGBjlO8?t=537
//
// 1. readdir
// 2. for each entry
// a. if a non-empty directory, recurse
// b. if an empty directory, move to random hidden file name in $TEMP
// c. unlink/rmdir $TEMP
//
// This works around the fact that unlink/rmdir is non-atomic and takes
// a non-deterministic amount of time to complete.
//
// However, it is HELLA SLOW, like 2-10x slower than a naive recursive rm.
Object.defineProperty(exports, "__esModule", { value: true });
exports.rimrafMoveRemoveSync = exports.rimrafMoveRemove = void 0;
const path_1 = require("path");
const default_tmp_js_1 = require("./default-tmp.js");
const ignore_enoent_js_1 = require("./ignore-enoent.js");
const fs_js_1 = require("./fs.js");
const readdir_or_error_js_1 = require("./readdir-or-error.js");
const fix_eperm_js_1 = require("./fix-eperm.js");
const error_js_1 = require("./error.js");
const { lstat, rename, unlink, rmdir } = fs_js_1.promises;
// crypto.randomBytes is much slower, and Math.random() is enough here
const uniqueFilename = (path) => `.${(0, path_1.basename)(path)}.${Math.random()}`;
const unlinkFixEPERM = (0, fix_eperm_js_1.fixEPERM)(unlink);
const unlinkFixEPERMSync = (0, fix_eperm_js_1.fixEPERMSync)(fs_js_1.unlinkSync);
const rimrafMoveRemove = async (path, opt) => {
opt?.signal?.throwIfAborted();
return ((await (0, ignore_enoent_js_1.ignoreENOENT)(lstat(path).then(stat => rimrafMoveRemoveDir(path, opt, stat)))) ?? true);
};
exports.rimrafMoveRemove = rimrafMoveRemove;
const rimrafMoveRemoveDir = async (path, opt, ent) => {
opt?.signal?.throwIfAborted();
if (!opt.tmp) {
return rimrafMoveRemoveDir(path, { ...opt, tmp: await (0, default_tmp_js_1.defaultTmp)(path) }, ent);
}
if (path === opt.tmp && (0, path_1.parse)(path).root !== path) {
throw new Error('cannot delete temp directory used for deletion');
}
const entries = ent.isDirectory() ? await (0, readdir_or_error_js_1.readdirOrError)(path) : null;
if (!Array.isArray(entries)) {
// this can only happen if lstat/readdir lied, or if the dir was
// swapped out with a file at just the right moment.
/* c8 ignore start */
if (entries) {
if ((0, error_js_1.errorCode)(entries) === 'ENOENT') {
return true;
}
if ((0, error_js_1.errorCode)(entries) !== 'ENOTDIR') {
throw entries;
}
}
/* c8 ignore stop */
if (opt.filter && !(await opt.filter(path, ent))) {
return false;
}
await (0, ignore_enoent_js_1.ignoreENOENT)(tmpUnlink(path, opt.tmp, unlinkFixEPERM));
return true;
}
const removedAll = (await Promise.all(entries.map(ent => rimrafMoveRemoveDir((0, path_1.resolve)(path, ent.name), opt, ent)))).every(v => v === true);
if (!removedAll) {
return false;
}
// we don't ever ACTUALLY try to unlink /, because that can never work
// but when preserveRoot is false, we could be operating on it.
// No need to check if preserveRoot is not false.
if (opt.preserveRoot === false && path === (0, path_1.parse)(path).root) {
return false;
}
if (opt.filter && !(await opt.filter(path, ent))) {
return false;
}
await (0, ignore_enoent_js_1.ignoreENOENT)(tmpUnlink(path, opt.tmp, rmdir));
return true;
};
const tmpUnlink = async (path, tmp, rm) => {
const tmpFile = (0, path_1.resolve)(tmp, uniqueFilename(path));
await rename(path, tmpFile);
return await rm(tmpFile);
};
const rimrafMoveRemoveSync = (path, opt) => {
opt?.signal?.throwIfAborted();
return ((0, ignore_enoent_js_1.ignoreENOENTSync)(() => rimrafMoveRemoveDirSync(path, opt, (0, fs_js_1.lstatSync)(path))) ?? true);
};
exports.rimrafMoveRemoveSync = rimrafMoveRemoveSync;
const rimrafMoveRemoveDirSync = (path, opt, ent) => {
opt?.signal?.throwIfAborted();
if (!opt.tmp) {
return rimrafMoveRemoveDirSync(path, { ...opt, tmp: (0, default_tmp_js_1.defaultTmpSync)(path) }, ent);
}
const tmp = opt.tmp;
if (path === opt.tmp && (0, path_1.parse)(path).root !== path) {
throw new Error('cannot delete temp directory used for deletion');
}
const entries = ent.isDirectory() ? (0, readdir_or_error_js_1.readdirOrErrorSync)(path) : null;
if (!Array.isArray(entries)) {
// this can only happen if lstat/readdir lied, or if the dir was
// swapped out with a file at just the right moment.
/* c8 ignore start */
if (entries) {
if ((0, error_js_1.errorCode)(entries) === 'ENOENT') {
return true;
}
if ((0, error_js_1.errorCode)(entries) !== 'ENOTDIR') {
throw entries;
}
}
/* c8 ignore stop */
if (opt.filter && !opt.filter(path, ent)) {
return false;
}
(0, ignore_enoent_js_1.ignoreENOENTSync)(() => tmpUnlinkSync(path, tmp, unlinkFixEPERMSync));
return true;
}
let removedAll = true;
for (const ent of entries) {
const p = (0, path_1.resolve)(path, ent.name);
removedAll = rimrafMoveRemoveDirSync(p, opt, ent) && removedAll;
}
if (!removedAll) {
return false;
}
if (opt.preserveRoot === false && path === (0, path_1.parse)(path).root) {
return false;
}
if (opt.filter && !opt.filter(path, ent)) {
return false;
}
(0, ignore_enoent_js_1.ignoreENOENTSync)(() => tmpUnlinkSync(path, tmp, fs_js_1.rmdirSync));
return true;
};
const tmpUnlinkSync = (path, tmp, rmSync) => {
const tmpFile = (0, path_1.resolve)(tmp, uniqueFilename(path));
(0, fs_js_1.renameSync)(path, tmpFile);
return rmSync(tmpFile);
};
//# sourceMappingURL=rimraf-move-remove.js.map