NodeJS中process模块跨模块修改不生效问题求助

问题现象 #

在ESM模块规范下（强制使用import而非require），在server.js中绑定process.uncaughtException事件后，无法捕获app.js模块加载时抛出的未捕获异常：

• 当app.js中存在未定义变量的代码（如console.log(y)），运行node server.js时，异常直接抛出，未触发uncaughtException事件
• 若将该异常代码移至server.js中，则能正常触发uncaughtException事件

测试代码 #

server.js

import app from "./app.js";

process.on("uncaughtException", (err) => {
  console.log("UNCAUGHT EXCEPTION: shutting down ...");
  console.log(err.name, err.message);
  process.exit(1);
});

// Server
const port = process.env.PORT || 3000;
const server = app.listen(port, () => {
  console.log(`App running on port ${port}...`);
});

app.js

import express from 'express'

const app = express();

console.log(y)    

export default app;

运行报错信息 #

直接运行server.js时的报错：

file:///tmp/node-test/app.js:5
console.log(y);
            ^

ReferenceError: y is not defined
    at file:///tmp/node-test/app.js:5:13
    at ModuleJob.run (node:internal/modules/esm/module_job:193:25)

将异常代码移至server.js后的输出：

UNCAUGHT EXCEPTION: shutting down ...
ReferenceError y is not defined

原因分析 #

这是ESM模块的加载机制导致的：

1. 在ESM中，模块的加载和执行是在当前模块代码执行之前完成的。当server.js执行到import app from "./app.js"时，Node.js会立即加载并执行app.js的全部代码，此时server.js中后续的process.on("uncaughtException")代码还未执行，事件绑定根本没完成。
2. 而当异常代码放在server.js中时，代码是在uncaughtException事件绑定之后执行的，所以异常能被正常捕获。

解决方法 #

要解决这个问题，需要在任何模块加载之前就完成uncaughtException事件的绑定，具体可以通过新增一个入口文件实现：

步骤1：创建入口文件start.js #

// 先绑定uncaughtException事件，这是执行顺序最靠前的代码
process.on("uncaughtException", (err) => {
  console.log("UNCAUGHT EXCEPTION: shutting down ...");
  console.log(err.name, err.message);
  process.exit(1);
});

// 再导入原入口文件server.js
import './server.js';

步骤2：修改server.js，移除原有的uncaughtException绑定 #

import app from "./app.js";

// Server
const port = process.env.PORT || 3000;
const server = app.listen(port, () => {
  console.log(`App running on port ${port}...`);
});

步骤3：运行入口文件 #

执行node start.js，此时app.js中模块加载时的异常会被start.js中提前绑定的uncaughtException事件捕获，输出预期的提示信息。

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