replace nodejs once() usage with mineflayer once() with a default 20s timeout

extremeheat · extremeheat · commit 2ad413e65b2e · 2024-02-22T03:54:04.000Z
diff --git a/lib/plugins/anvil.js b/lib/plugins/anvil.js
@@ -1,6 +1,6 @@
 const assert = require('assert')
 const { sleep } = require('../promise_utils')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
diff --git a/lib/plugins/book.js b/lib/plugins/book.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
diff --git a/lib/plugins/craft.js b/lib/plugins/craft.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
diff --git a/lib/plugins/creative.js b/lib/plugins/creative.js
@@ -1,7 +1,7 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
 const { sleep, onceWithCleanup } = require('../promise_utils')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
@@ -70,7 +70,7 @@ function inject (bot) {
 
     // last step
     bot.entity.position = destination
-    await once(bot, 'move')
+    await once(bot, 'move', /* no timeout */ 0)
   }
 
   function startFlying () {
diff --git a/lib/plugins/enchantment_table.js b/lib/plugins/enchantment_table.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
diff --git a/lib/plugins/inventory.js b/lib/plugins/inventory.js
@@ -1,7 +1,6 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
-const { once } = require('events')
-const { sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
+const { once, sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
 
 module.exports = inject
 
diff --git a/lib/plugins/villager.js b/lib/plugins/villager.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
diff --git a/lib/promise_utils.js b/lib/promise_utils.js
@@ -72,6 +72,10 @@ function onceWithCleanup (emitter, event, { timeout = 0, checkCondition = undefi
   return task.promise
 }
 
+function once (emitter, event, timeout = 20000) {
+  return onceWithCleanup(emitter, event, { timeout })
+}
+
 function withTimeout (promise, timeout) {
   return Promise.race([
     promise,
@@ -82,6 +86,7 @@ function withTimeout (promise, timeout) {
 }
 
 module.exports = {
+  once,
   sleep,
   createTask,
   createDoneTask,
diff --git a/test/externalTests/anvil.js b/test/externalTests/anvil.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => {
   async function runTest (bot, testFunction) {
diff --git a/test/externalTests/bed.js b/test/externalTests/bed.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   const midnight = 18000
diff --git a/test/externalTests/chat.js b/test/externalTests/chat.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => {
   async function runTest (bot, testFunction) {
diff --git a/test/externalTests/commandBlock.js b/test/externalTests/commandBlock.js
@@ -1,7 +1,6 @@
 const assert = require('assert')
-const { once } = require('events')
 const { Vec3 } = require('vec3')
-const { onceWithCleanup } = require('../../lib/promise_utils')
+const { once, onceWithCleanup } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   const command = `/say ${Math.floor(Math.random() * 1000)}`
diff --git a/test/externalTests/crafting.js b/test/externalTests/crafting.js
@@ -1,4 +1,4 @@
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 const { Vec3 } = require('vec3')
 
 module.exports = () => async (bot) => {
diff --git a/test/externalTests/nether.js b/test/externalTests/nether.js
@@ -1,6 +1,6 @@
 const assert = require('assert')
 const Vec3 = require('vec3')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   // Test spawn event on death
diff --git a/test/externalTests/placeEntity.js b/test/externalTests/placeEntity.js
@@ -1,6 +1,6 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = (version) => {
   async function runTest (bot, testFunction) {
diff --git a/test/externalTests/plugins/testCommon.js b/test/externalTests/plugins/testCommon.js
@@ -1,7 +1,7 @@
 const { Vec3 } = require('vec3')
 
 const { spawn } = require('child_process')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 const process = require('process')
 const assert = require('assert')
 const { sleep, onceWithCleanup, withTimeout } = require('../../../lib/promise_utils')
diff --git a/test/externalTests/rain.js b/test/externalTests/rain.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   bot.test.sayEverywhere('/weather clear')
diff --git a/test/externalTests/scoreboard.js b/test/externalTests/scoreboard.js
@@ -1,5 +1,5 @@
 // const assert = require('assert')
-// const { once } = require('events')
+// const { once } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   // TODO: This is failing randomly, investigate and fix
diff --git a/test/externalTests/spawnEvent.js b/test/externalTests/spawnEvent.js
@@ -1,5 +1,5 @@
 const mineflayer = require('mineflayer')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   // Test spawn event on login
diff --git a/test/externalTests/team.js b/test/externalTests/team.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   const p = once(bot, 'teamMemberAdded')
diff --git a/test/externalTests/trade.js b/test/externalTests/trade.js
@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   const Item = require('prismarine-item')(bot.registry)
diff --git a/test/externalTests/useChests.js b/test/externalTests/useChests.js
@@ -1,7 +1,6 @@
 const { Vec3 } = require('vec3')
 const assert = require('assert')
-const { once } = require('events')
-const { onceWithCleanup } = require('../../lib/promise_utils')
+const { once, onceWithCleanup } = require('../../lib/promise_utils')
 
 module.exports = () => async (bot) => {
   const Item = require('prismarine-item')(bot.registry)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-const { once } = require('events')`
	`1`	`+const { once } = require('../../lib/promise_utils')`
`2`	`2`	`const { Vec3 } = require('vec3')`
`3`	`3`
`4`	`4`	`module.exports = () => async (bot) => {`