无sudo权限时文件监视器数量达上限ENOSPC报错的解决方法

问题背景 #

无系统管理员权限，无法修改系统级文件监视器数量上限，运行小型React Native项目时触发如下报错：

Error: ENOSPC: System limit for number of file watchers reached, watch '/home/ludkl571/Documents/TDDC73/test/node_modules/@react-native-community/cli-tools/node_modules/chalk'
    at FSWatcher.start (internal/fs/watchers.js:210:26)
    at Object.watch (fs.js:1444:11)
    at NodeWatcher.watchdir (/home/ludkl571/Documents/TDDC73/test/node_modules/sane/src/node_watcher.js:159:22)
    at Walker.<anonymous> (/home/ludkl571/Documents/TDDC73/test/node_modules/sane/src/common.js:109:31)
    at Walker.emit (events.js:314:20)
    at /home/ludkl571/Documents/TDDC73/test/node_modules/walker/lib/walker.js:69:16
    at FSReqCallback.oncomplete (fs.js:156:23) {
  errno: -28,
  syscall: 'watch',
  code: 'ENOSPC',
  path: '/home/ludkl571/Documents/TDDC73/test/node_modules/@react-native-community/cli-tools/node_modules/chalk',
  filename: '/home/ludkl571/Documents/TDDC73/test/node_modules/@react-native-community/cli-tools/node_modules/chalk'
}

从报错路径可以看出，监听器正在遍历node_modules下的深层依赖文件，这是小型项目触发限额的核心原因——正常情况构建工具不会监听依赖目录，配置异常时才会遍历依赖目录下的上万个文件，直接占满监视器配额。

无管理员权限可生效的修复方案 #

按优先级从高到低尝试即可：

• 方案1：配置Metro打包器强制忽略node_modules目录
  项目根目录找到或新建metro.config.js文件，写入以下配置，从根源上避免监听不必要的依赖文件：

const { getDefaultConfig } = require('metro-config');
module.exports = (async () => {
  const defaultConfig = await getDefaultConfig();
  return {
    ...defaultConfig,
    watcher: {
      ignorePatterns: [
        /node_modules/,
        ...(defaultConfig.watcher?.ignorePatterns || [])
      ]
    },
    resolver: {
      ...defaultConfig.resolver,
      blockList: [/node_modules\/.*\/node_modules/]
    }
  };
})();

配置完成后先执行pkill -f node杀掉所有残留的Node进程，再重新启动项目即可。

• 方案2：释放当前用户下被占用的监视器配额
  很多时候限额不是当前项目占满的，是之前运行未关闭的其他项目服务、编辑器文件索引、同步盘类工具占用了大量监视器资源。执行以下命令可以列出当前用户下占用监视器最多的前10个进程：

find /proc/*/fd -user "$USER" -lname anon_inode:inotify -printf '%hinfo/%f\n' 2>/dev/null | xargs cat | grep -c 'inotify' | paste - <(ps -p $(find /proc/*/fd -user "$USER" -lname anon_inode:inotify -printf '%hinfo/%f\n' 2>/dev/null | cut -d/ -f3) -o comm= 2>/dev/null) | sort -rn | head -10

找到列表里不需要的残留进程，执行kill 进程PID释放资源即可。

• 方案3：临时设置当前会话的Node监视器上限
  该方案仅对当前终端会话生效，重启终端后失效，无需管理员权限。启动项目前先在当前终端执行：

export NODE_OPTIONS="--max-inotify-watches=8192"

执行完成后直接在同一个终端启动项目即可，Node会优先使用该参数设置的配额，不读取系统级限制。

• 方案4：使用轮询模式绕过系统监视器限制（兜底方案）
  以上方案都无效时，可以让文件监听改用轮询模式，完全不占用系统inotify配额。启动项目时带上环境变量即可：

CHOKIDAR_USEPOLLING=true WATCHPACK_POLLING=true npm start

该模式的缺点是文件变更识别会有几百毫秒延迟，对小型项目来说几乎无感知。

注：报错路径明确指向node_modules下的依赖文件，优先尝试第一个方案，90%以上的同类场景都能通过排除依赖目录监听解决。

内容的提问来源于stack exchange，提问作者Ludvig Klein