mc.listen()回调函数使用异步无法正常运行

[Hesitate-P]

异常模块

ScriptEngine（脚本引擎）

操作系统

Windows 11

LiteLoader版本

2.5.1

BDS版本

1.19.20

发生了什么?

RT，这是个编写nodejs插件时发现的问题。
此问题在quickjs中没有发现。

复现此问题的步骤

将这串代码输入到您的nodejs插件中，您会发现mc.listen中的回调函数不会执行：
async function abc(a) {
if (a == 0) {
a = 1
}
else {
a = 0
}
return a
}
mc.listen("onServerStarted", async function () {
let d = await abc(1)
log(d)
})

有关的日志/输出

（无）

插件列表

17:22:20 INFO [Server] 插件列表 [5]
17:22:20 INFO [Server] - LLMoney [v2.5.0] (LLMoney.dll)
17:22:20 INFO [Server]   EconomyCore for LiteLoaderBDS
17:22:20 INFO [Server] - ScriptEngine-Lua [v2.5.0] (LiteLoader.Lua.dll)
17:22:20 INFO [Server]   Lua ScriptEngine for LiteLoaderBDS
17:22:20 INFO [Server] - ScriptEngine-QuickJs [v2.5.0] (LiteLoader.Js.dll)
17:22:20 INFO [Server]   Javascript ScriptEngine for LiteLoaderBDS
17:22:20 INFO [Server] - ScriptEngine-NodeJs [v2.5.0] (LiteLoader.NodeJs.dll)
17:22:20 INFO [Server]   Node.js ScriptEngine for LiteLoaderBDS
17:22:20 INFO [Server] - TEST [v1.0.0] (TEST)
17:22:20 INFO [Server]   TEST plugin
17:22:20 INFO [Server]

[Timiya-re]

可以用Promise来代替吧，反正这也不阻塞

function onStart() {
abc(1).then((res)=>{
log(res);
});
}
mc.listen("onServerStarted", onStart);

[leoweyr]

我的情况是其它地方的异步函数被执行后，mc.listen 里的异步函数会跟着被执行，比如：

index.ts：

PlaceIntroducer 实例里调用 mc.listen：

PlaceIntroducer 功能实现与 /ocite 指令完全无关：

可是玩家 onJoin 并没有执行 PlaceIntroducer，而是需要使用 /ocite 指令后才会执行，有种被“放行”的感觉，我怀疑是底层事件循环阻塞了，mc.listen 正确监听到事件并发起 pending，但是被阻塞了无法 fullfilled。

怀疑 Legacy Script Engine 底层对接 Node.js 的接口过程中存在 while 循环，在普通 Node.js 项目中，while 循环不能用于异步函数中，否则会阻塞事件循环，如果要用，需要额外添加 setTimeout。比如我以下其它 Node.js 项目中曾经遇到并解决的问题：

开发者可参考以上举例类比的机制诱发原因分析 Legacy Script Engine 底层触发 bug 可能的位置。

[leoweyr]

可以用Promise来代替吧，反正这也不阻塞

function onStart() { abc(1).then((res)=>{ log(res); }); } mc.listen("onServerStarted", onStart);

@Timiya-re 不建议这种写法，如果 onStart 是类实例方法，会导致 this 引用丢失。事件监听回调函数建议还是用匿名函数来写。

[leoweyr]

目前临时解决方案是所有需要用到异步函数的地方，外层都包装上 setTimeout。

意思是，假设以下是你的异步函数代码：

async() => { return };

那么包装为：

setTimeout(async() => {return}, 0);

[xiaoqch]

准确的bug是，只要没有计划中的定时器任务，事件循环就不会去处理lse api的回调函数中创建的promise，
以下代码，只会输出1和2，两行注释取消掉任意一行后一切正常，

async function asyncFunc() {
  logger.warn("2");
}
// setInterval(() => {}, 100000000);
mc.listen("onServerStarted", () => {
  // setTimeout(() => {}, 0);
  logger.warn("1");
  asyncFunc().then(() => {
    logger.warn("3");
  });
});

或者

async function asyncFunc() {
  logger.warn("2");
}
// setInterval(() => {}, 100000000);
mc.listen("onServerStarted", async () => {
  // setTimeout(() => {}, 0);
  logger.warn("1");
  await asyncFunc();
  logger.warn("3");
});

另外，就是上面说到的，如果一段时间后再创建定时器任务，前面没处理的promise会被处理，加上下面代码，执行任意控制台指令后输出3

mc.listen("onConsoleCmd", () => {
  setTimeout(() => {}, 0);
});

[xiaoqch]

bug出现的原因是嵌入nodejs默认配置的情况下不会自动处理微任务，已修复。