以下整理幾個 Node.js 實作中容易遇到的錯誤,以及對應的排查方向。
寫一個小專案時,原本以為可以輕鬆收工,結果跳出了讓人想掀桌的錯誤:
fs.js:77
throw err; // Forgot a callback but don't know where? Use NODE_DEBUG=fs
^
Error: EBADF, write
at Error (native)
fs.js:77 這個堆疊幾乎毫無線索。好在專案不大,逐段拆解之後大致理清了。
EBADF 的意思是 bad file descriptor,也就是「檔案描述符無效」;Error: EBADF, write 就是往一個無效的描述符寫入資料。
引發情境是這樣的:某個 .on('data') 事件持續把資料寫進 fd,此時另一個操作拋出錯誤,你在錯誤處理中關閉了 fd,但 data 事件仍在觸發,繼續嘗試寫入這個已被關閉的描述符:
var fd = fs.openSync(path, 'w');
test.on('data', function(data) {
fs.write(fd, data);
});
test.on('end', function() {
fs.close(fd);
});
// 在 end 之前就 close,就會出現 Error: EBADF, write
setTimeout(function() {
fs.close(fd);
}, 10);
解法:檢查所有呼叫 fs.close 的位置,確保關閉之後不會再有 read/write。
搜尋過程中會看到另一個類似錯誤。如果你為多種情境都寫了 fs.close(fd),而這些情境又被同時觸發,close 就會被呼叫多次,同樣會得到 EBADF:
test.on('end', function() {
fs.close(fd);
fs.close(fd); // 多呼叫一次就會出錯
});
錯誤訊息一樣不友善:
fs.js:77
throw err;
^
Error: EBADF, close
at Error (native)
解法:一樣是檢查 fs.close,這次重點是確保多個分支不會重複關閉;若難以完全避免,可用 try/catch 包住。
最後一種情況:fd 失效後再進行讀取。原本以為會看到 Error: EBADF, read,實際上不是:
fs.closeSync(fd); fs.readSync(fd, new Buffer(1024), 0, 1024);
這個錯誤訊息友善多了,會把呼叫堆疊完整印出來:
fs.js:552
var r = binding.read(fd, buffer, offset, length, position);
^
Error: EBADF, bad file descriptor
at Error (native)
at Object.fs.readSync (fs.js:552:19)
at command.<anonymous> (.../services/TestService.js:40:6)
at command.emit (events.js:110:17)
解法:照著堆疊回頭改程式即可。
使用 child_process 的 exec、execFile、spawnSync、execFileSync、execSync 時,要特別注意 options 中的 maxBuffer。
這些方法執行時會在記憶體中建立一個 buffer 收集所有輸出,maxBuffer 決定其大小;一旦輸出超過上限,就會丟出 maxBuffer exceeded。
解法是在執行前估算資料量,把上限調大:
var exec = require('child_process').exec;
var child = exec('ls -lah', {
encoding: 'utf8',
timeout: 0,
maxBuffer: 5000 * 1024, // 預設 200 * 1024
killSignal: 'SIGTERM'
}, function(err, stdout, stderr) {
console.log(stdout);
});
另一個思路是改用 spawn,在 .on('data') 事件中手動拼接資料,等到 .on('close') 時取得完整結果。
錯誤訊息如下:
[ERROR] pomelo - fail to forward message:
TypeError: Cannot call method 'forwardMessage' of undefined
at doForward (.../lib/server/server.js:334:50)
at dispatch (.../lib/server/server.js:103:7)
at next (.../lib/common/service/filterService.js:50:7)
at Service.beforeFilter (.../lib/common/service/filterService.js:65:3)
at beforeFilter (.../lib/server/server.js:242:8)
at pro.globalHandle (.../lib/server/server.js:112:3)
at handleMessage (.../lib/components/connector.js:295:15)
社群中有兩種說法:一是前端伺服器把訊息轉發到其他伺服器時出了問題、rpc 失敗;二是 handler 名稱拼錯。
實際檢查後發現,問題出在 servers.json:普通 server 若被設成 "frontend": true 就會觸發這個錯誤。把該設定移除或改為 false,即可恢復正常。