fix: devtools is causing a severe memory leak
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 44/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- node.js, nuxt, typescript
调研方向
首先,在使用 Node v22+ 的 Windows 上通过提供的 nuxi init 和 npm run dev 序列复现内存泄漏,然后比较启用和禁用 devtools 时的运行结果。检查 unstorage/readdirp、readable-stream 和 defineNuxtSchema 周围的快照,包括由 nuxt.config.ts 触发的重启;当重复启动开发服务器不再显示无限的内存增长或异常的 CPU 使用率时,即表示完成。
由索引模型根据 Issue 内容生成。
描述
🐛 The bug
Creating a bare Nuxt project with npx nuxi@latest init project and starting it with npm run dev causes severe memory leak (most of the time). This happens on Windows with Node v22+. This happens on a bare Nuxt starter with no additional Nuxt modules or npm packages added. Importantly, the memory leak occurs without any incoming requests happening or the app open in a browser. You only need to npm run dev after doing the nuxi project init and it will start leaking immediately. This is going to be a pain in the ass because I noticed it usually doesn't happen on the first run of npm run dev but if you stop the dev server and run the command again it will happen (you know you have it when the CPU is high and the memory starts incrementing).
I believe this is different than https://github.com/nuxt/nuxt/issues/30164 as that is in a built project with requests.
Observations:
- It does not leak when building and running
npm run preview. - Requests to the dev server are not needed to leak memory.
- Disabling devtools prevents the memory leak.
- It does not leak every time the dev server is started, maybe 10% of the time it will run normally on the bare project.
- It also leaks with Node v22.12.0 in addition to v23.3.0.
- Abnormally high CPU usage is occurring.
- It ticks up by 2.7-2.9 MB per second.
Proof
These images were taken after enabling/disabling Nuxt devtools and running npm run dev and waiting for exactly 5 minutes.
devtools: { enabled: true }
devtools: { enabled: false}
Snapshots
These make it seem like there is something with \node_modules\unstorage\node_modules\readdirp\index.js and/or are-we-there-yet\node_modules\readable-stream. But also defineNuxtSchema.
Here's how I did this:
npx nuxi dev --inspectwith devtools disabled- Open Chrome and go to
chrome://inspectand inspect the Node project - Let it run 5 minutes, collect garbage and take another snapshot (Snapshot 1, control)
- Edit
nuxt.config.tsand enable devtools, let it restart with HMR - Let it run 10 minutes, then collect garbage and take another snapshot (Snapshot 2)
- Let it run 10 more minutes, then collect garbage and take final snapshot (Snapshot 3)
Snapshot 2 vs Snapshot 3 (devtools enabled short vs longer leak)
Full reproduction
Since I don't think stackblitz is going to show this issue:
npx nuxi init@latest projectcd projectnpm run dev- Quit the process and re-run
npm run dev - Observe memory leak
npx nuxi devtools disablenpm run dev- Observe no memory leak
🛠️ To reproduce
https://stackblitz.com/edit/github-4exzk3tl
🌈 Expected behavior
devtools should not be causing a memory leak in a bare project created with npx nuxi@latest init project
ℹ️ Additional context
npx nuxi info
- Operating System: Windows_NT
- Node Version: v23.3.0
- Nuxt Version: 3.14.1592
- CLI Version: 3.16.0
- Nitro Version: 2.10.4
- Package Manager: [email protected]
- Builder: -
- User Config: default
- Runtime Modules: -
- Build Modules: -
Full nuxt.config.ts (devtools enabled)
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
devtools: {
enabled: true,
timeline: { enabled: true },
},
compatibilityDate: '2024-11-01',
})
Full nuxt.config.ts (devtools disabled)
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
devtools: {
enabled: false,
timeline: { enabled: true },
},
compatibilityDate: '2024-11-01',
})
- 主要语言
- TypeScript
- 星标
- 3.3k
- 派生
- 214
- 平均合并
- 19 小时 45 分钟
- 30 天内合并 PR
- 12
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
nuxt/devtools 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
-
bug
难度 3/5 1-2 天 新手友好度 68/100
-
enhancement
难度 5/5 一周以上 新手友好度 25/100
-
bug needs reproduction
难度 4/5 3-5 天 新手友好度 38/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
receptron/mulmoterminal#2264 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 78/100
components-web-app/docs#96 ·
-
enhancement
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 68/100
simonsobs/tileviewer#114 ·
-
难度 2/5 1-3 小时 新手友好度 75/100