fix(cleanup): make directory removal safe and reliable

Author: danielroe

packages/nuxt-cli/src/utils/fs.ts

@@ -1,6 +1,5 @@
 import{existsSync,promisesasfsp}from'node:fs'
 import{join}from'pathe'
-import{debug}from'../utils/logger'
 
 exportasyncfunctionclearDir(path: string,exclude?: string[]){
 if(!exclude){
@@ -22,14 +21,3 @@ export async function clearDir(path: string, exclude?: string[]) {
 exportfunctionclearBuildDir(path: string){
 returnclearDir(path,['cache','analyze','nuxt.json','nuxt.lock'])
 }
-
-exportasyncfunctionrmRecursive(paths: string[]){
-awaitPromise.all(
-paths
-.filter(p=>typeofp==='string')
-.map(async(path)=>{
-debug(`Removing recursive path: ${path}`)
-awaitfsp.rm(path,{recursive: true,force: true}).catch(()=>{})
-}),
-)
-}

packages/nuxt-cli/src/utils/nuxt.ts

@@ -5,8 +5,7 @@ import { promises as fsp } from 'node:fs'
 import{hash}from'ohash'
 import{dirname,resolve}from'pathe'
 
-import{logger}from'../utils/logger'
-import{rmRecursive}from'./fs'
+import{debug,logger}from'../utils/logger'
 
 constGIT_ID_RE=/\.([0-9a-f]{7,8})$/
 
@@ -20,21 +19,29 @@ interface NuxtProjectManifest {
 }
 }
 
-/** `silent` is for callers that already report progress themselves. */
 exportasyncfunctioncleanupNuxtDirs(rootDir: string,buildDir: string,options: {silent?: boolean}={}){
+constroot=resolve(rootDir)
+constbuild=resolve(root,buildDir)
+if(build===root||root.startsWith(build.endsWith('/') ? build : `${build}/`)){
+thrownewError('Cannot clean a build directory that contains the project root.')
+}
+
 if(!options.silent){
 logger.info('Cleaning up generated Nuxt files and caches...')
 }
 
-awaitrmRecursive(
-[
-buildDir,
-'.output',
-'dist',
-'node_modules/.vite',
-'node_modules/.cache',
-].map(dir=>resolve(rootDir,dir)),
-)
+constpaths=newSet([
+build,
+'.output',
+'dist',
+'node_modules/.vite',
+'node_modules/.cache',
+].map(dir=>resolve(root,dir)))
+
+awaitPromise.all([...paths].map((path)=>{
+debug(`Removing recursive path: ${path}`)
+returnfsp.rm(path,{recursive: true,force: true})
+}))
 }
 
 exportfunctionnuxtVersionToGitIdentifier(version: string){

packages/nuxt-cli/test/unit/commands/cleanup.spec.ts

@@ -0,0 +1,73 @@
+import{existsSync}from'node:fs'
+import{mkdir,mkdtemp,rm,writeFile}from'node:fs/promises'
+import{tmpdir}from'node:os'
+
+import{runCommand}from'citty'
+import{join}from'pathe'
+import{afterEach,beforeEach,describe,expect,it,vi}from'vitest'
+
+importcleanupfrom'../../../src/commands/cleanup'
+
+const{ loadNuxtConfig }=vi.hoisted(()=>({
+loadNuxtConfig: vi.fn(),
+}))
+
+vi.mock('../../../src/utils/kit',()=>({
+loadKit: ()=>Promise.resolve({ loadNuxtConfig }),
+}))
+
+letcwd: string
+
+asyncfunctioncreateFile(path: string){
+awaitmkdir(join(path,'..'),{recursive: true})
+awaitwriteFile(path,'')
+}
+
+describe('cleanup',()=>{
+beforeEach(async()=>{
+vi.clearAllMocks()
+cwd=awaitmkdtemp(join(tmpdir(),'nuxt-cleanup-'))
+loadNuxtConfig.mockResolvedValue({rootDir: cwd,buildDir: join(cwd,'.nuxt')})
+})
+
+afterEach(async()=>{
+awaitrm(cwd,{recursive: true,force: true})
+})
+
+it('loads the development config and removes generated directories',async()=>{
+constgenerated=[
+'.nuxt/nuxt.json',
+'.output/server/index.mjs',
+'dist/index.html',
+'node_modules/.vite/cache',
+'node_modules/.cache/nuxt/client.json',
+]
+awaitPromise.all(generated.map(path=>createFile(join(cwd,path))))
+awaitcreateFile(join(cwd,'node_modules/nuxt/package.json'))
+
+awaitrunCommand(cleanup,{rawArgs: [cwd]})
+
+expect(loadNuxtConfig).toHaveBeenCalledWith({ cwd,overrides: {dev: true}})
+expect(generated.every(path=>!existsSync(join(cwd,path)))).toBe(true)
+expect(existsSync(join(cwd,'node_modules/nuxt/package.json'))).toBe(true)
+})
+
+it('removes a custom build directory only once when it overlaps a cache directory',async()=>{
+constbuildDir=join(cwd,'node_modules/.cache')
+loadNuxtConfig.mockResolvedValue({rootDir: cwd, buildDir })
+awaitcreateFile(join(buildDir,'nuxt/client.json'))
+
+awaitexpect(runCommand(cleanup,{rawArgs: [cwd]})).resolves.toBeDefined()
+})
+
+it.each([
+['the project root',()=>cwd],
+['a parent of the project root',()=>join(cwd,'..')],
+])('refuses to remove %s',async(_,getBuildDir)=>{
+loadNuxtConfig.mockResolvedValue({rootDir: cwd,buildDir: getBuildDir()})
+awaitcreateFile(join(cwd,'package.json'))
+
+awaitexpect(runCommand(cleanup,{rawArgs: [cwd]})).rejects.toThrow('Cannot clean a build directory that contains the project root.')
+expect(existsSync(join(cwd,'package.json'))).toBe(true)
+})
+})