Merge branch 'PrismarineJS:master' into master

Author: Scarsz

.github/workflows/ci.yml

@@ -24,8 +24,8 @@ jobs:
     - name: Setup Java JDK
       uses: actions/[email protected]
       with:
-        java-version: 1.8
-        java-package: jre
+        java-version: '16'
+        distribution: 'adopt'
     - name: Install dependencies
       run: npm install
     - name: Run tests
@@ -42,6 +42,6 @@ jobs:
     - name: Setup Java JDK
       uses: actions/[email protected]
       with:
-        java-version: 1.8
-        java-package: jre
+        java-version: '16'
+        distribution: 'adopt'
     - run: npm install && npm run test-non-par

docs/API.md

@@ -15,6 +15,8 @@ automatically logged in and validated against mojang's auth.
  * beforePing : allow customisation of the answer to ping the server does. 
  It takes a function with argument response and client, response is the default json response, and client is client who sent a ping.
  It can take as third argument a callback. If the callback is passed, the function should pass its result to the callback, if not it should return.
+ * beforeLogin : allow customisation of client before the `success` packet is sent.
+ It takes a function with argument client and should be synchronous for the server to wait for completion before continuing execution.
  * motd : default to "A Minecraft server"
  * maxPlayers : default to 20
  * keepAlive : send keep alive packets : default to true

package.json

@@ -34,7 +34,7 @@
   },
   "browser": "src/browser.js",
   "devDependencies": {
-    "@types/node": "^15.0.1",
+    "@types/node": "^16.0.0",
     "espower-loader": "^1.0.0",
     "intelli-espower-loader": "^1.1.0",
     "minecraft-packets": "^1.1.5",

src/client/authFlow.js

@@ -41,7 +41,7 @@ class MsAuthFlow {
     let cachePath = cacheDir || mcDefaultFolderPath
     try {
       if (!fs.existsSync(cachePath + '/nmp-cache')) {
-        fs.mkdirSync(cachePath + '/nmp-cache')
+        fs.mkdirSync(cachePath + '/nmp-cache', { recursive: true })
       }
       cachePath += '/nmp-cache'
     } catch (e) {

src/index.d.ts

@@ -82,6 +82,7 @@ declare module 'minecraft-protocol' {
 		port?: number
 		version?: string
 		beforePing?: (response: any, client: Client, callback?: (result: any) => any) => any
+		beforeLogin?: (client: Client) => void
 		errorHandler?: (client: Client, error: Error) => void
 		agent?: Agent
 	}

src/server/login.js

@@ -109,6 +109,7 @@ module.exports = function (client, server, options) {
     if (onlineMode === false || isException) {
       client.uuid = nameToMcOfflineUUID(client.username)
     }
+    options.beforeLogin?.(client)
     if (client.protocolVersion >= 27) { // 14w28a (27) added whole-protocol compression (http://wiki.vg/Protocol_History#14w28a), earlier versions per-packet compressed TODO: refactor into minecraft-data
       client.write('compress', { threshold: 256 }) // Default threshold is 256
       client.compressionThreshold = 256

test/clientTest.js

@@ -5,14 +5,17 @@ const os = require('os')
 const path = require('path')
 const assert = require('power-assert')
 const SURVIVE_TIME = 10000
+const util = require('util')
 const MC_SERVER_PATH = path.join(__dirname, 'server')
 
 const Wrap = require('minecraft-wrap').Wrap
 
-const download = require('minecraft-wrap').download
+const download = util.promisify(require('minecraft-wrap').download)
+
+const { getPort } = require('./common/util')
 
 for (const supportedVersion of mc.supportedVersions) {
-  const PORT = Math.round(30000 + Math.random() * 20000)
+  let PORT = null
   const mcData = require('minecraft-data')(supportedVersion)
   const version = mcData.version
   const MC_SERVER_JAR_DIR = process.env.MC_SERVER_JAR_DIR || os.tmpdir()
@@ -28,28 +31,39 @@ for (const supportedVersion of mc.supportedVersions) {
   describe('client ' + version.minecraftVersion, function () {
     this.timeout(10 * 60 * 1000)
 
-    before(download.bind(null, version.minecraftVersion, MC_SERVER_JAR))
+    before(async function () {
+      this.timeout(30 * 1000)
+      await download(version.minecraftVersion, MC_SERVER_JAR)
+      PORT = await getPort()
+      console.log(`Port chosen: ${PORT}`)
+    })
 
-    after(function (done) {
-      wrap.deleteServerData(function (err) {
-        if (err) { console.log(err) }
-        done(err)
+    after(async () => {
+      await new Promise((resolve, reject) => {
+        wrap.deleteServerData(err => {
+          if (err) reject(err)
+          resolve()
+        })
       })
     })
 
     describe('offline', function () {
-      before(function (done) {
+      this.timeout(90 * 1000)
+      before(async () => {
         console.log(new Date() + 'starting server ' + version.minecraftVersion)
-        wrap.startServer({
-          'online-mode': 'false',
-          'server-port': PORT,
-          motd: 'test1234',
-          'max-players': 120
-        }, function (err) {
-          if (err) { console.log(err) }
-          console.log(new Date() + 'started server ' + version.minecraftVersion)
-          done(err)
+        await new Promise((resolve, reject) => {
+          wrap.startServer({
+            'online-mode': 'false',
+            'server-port': PORT,
+            motd: 'test1234',
+            'max-players': 120,
+            'use-native-transport': 'false' // java 16 throws errors without this, https://www.spigotmc.org/threads/unable-to-access-address-of-buffer.311602
+          }, (err) => {
+            if (err) reject(err)
+            resolve()
+          })
         })
+        console.log(new Date() + 'started server ' + version.minecraftVersion)
       })
 
       after(function (done) {
@@ -173,12 +187,13 @@ for (const supportedVersion of mc.supportedVersions) {
       })
     })
 
-    describe('online', function () {
+    describe.skip('online', function () {
       before(function (done) {
         console.log(new Date() + 'starting server ' + version.minecraftVersion)
         wrap.startServer({
           'online-mode': 'true',
-          'server-port': PORT
+          'server-port': PORT,
+          'use-native-transport': 'false' // java 16 throws errors without this, https://www.spigotmc.org/threads/unable-to-access-address-of-buffer.311602
         }, function (err) {
           if (err) { console.log(err) }
           console.log(new Date() + 'started server ' + version.minecraftVersion)
@@ -195,7 +210,7 @@ for (const supportedVersion of mc.supportedVersions) {
         })
       })
 
-      it.skip('connects successfully - online mode', function (done) {
+      it('connects successfully - online mode', function (done) {
         const client = mc.createClient({
           username: process.env.MC_USERNAME,
           password: process.env.MC_PASSWORD,

test/common/util.js

@@ -0,0 +1,12 @@
+const net = require('net')
+
+const getPort = () => new Promise(resolve => {
+  const server = net.createServer()
+  server.listen(0, '127.0.0.1')
+  server.on('listening', () => {
+    const { port } = server.address()
+    server.close(() => resolve(port))
+  })
+})
+
+module.exports = { getPort }

test/packetTest.js

@@ -8,6 +8,8 @@ const assert = require('power-assert')
 const getFieldInfo = require('protodef').utils.getFieldInfo
 const getField = require('protodef').utils.getField
 
+const { getPort } = require('./common/util')
+
 function evalCount (count, fields) {
   if (fields[count.field] in count.map) { return count.map[fields[count.field]] }
   return count.default
@@ -188,24 +190,29 @@ function getValue (_type, packet) {
 }
 
 for (const supportedVersion of mc.supportedVersions) {
-  const PORT = Math.round(30000 + Math.random() * 20000)
+  let PORT
+
   const mcData = require('minecraft-data')(supportedVersion)
   const version = mcData.version
   const packets = mcData.protocol
 
   describe('packets ' + version.minecraftVersion, function () {
     let client, server, serverClient
-    before(function (done) {
+    before(async function () {
+      PORT = await getPort()
       server = new Server(version.minecraftVersion)
-      server.once('listening', function () {
-        server.once('connection', function (c) {
-          serverClient = c
-          done()
+      return new Promise((resolve) => {
+        console.log(`Using port for tests: ${PORT}`)
+        server.once('listening', function () {
+          server.once('connection', function (c) {
+            serverClient = c
+            resolve()
+          })
+          client = new Client(false, version.minecraftVersion)
+          client.setSocket(net.connect(PORT, 'localhost'))
         })
-        client = new Client(false, version.minecraftVersion)
-        client.setSocket(net.connect(PORT, 'localhost'))
+        server.listen(PORT, 'localhost')
       })
-      server.listen(PORT, 'localhost')
     })
     after(function (done) {
       client.on('end', function () {

test/serverTest.js

@@ -4,6 +4,8 @@ const mc = require('../')
 const assert = require('power-assert')
 const { once } = require('events')
 
+const { getPort } = require('./common/util')
+
 const w = {
   piglin_safe: {
     type: 'byte',
@@ -60,11 +62,17 @@ const w = {
 }
 
 for (const supportedVersion of mc.supportedVersions) {
-  const PORT = Math.round(30000 + Math.random() * 20000)
+  let PORT
   const mcData = require('minecraft-data')(supportedVersion)
   const version = mcData.version
 
   describe('mc-server ' + version.minecraftVersion, function () {
+
+    this.beforeAll(async function() {
+      PORT = await getPort()
+      console.log(`Using port for tests: ${PORT}`)
+    })
+
     this.timeout(5000)
     it('starts listening and shuts down cleanly', function (done) {
       const server = mc.createServer({
@@ -183,6 +191,32 @@ for (const supportedVersion of mc.supportedVersions) {
       })
       server.on('close', done)
     })
+    it('clients can be changed by beforeLogin', function (done) {
+      const notchUUID = '069a79f4-44e9-4726-a5be-fca90e38aaf5'
+      const server = mc.createServer({
+        'online-mode': false,
+        version: version.minecraftVersion,
+        port: PORT,
+        beforeLogin: (client) => {
+          client.uuid = notchUUID
+        }
+      })
+      server.on('listening', function () {
+        const client = mc.createClient({
+          username: 'notNotch',
+          host: '127.0.0.1',
+          version: version.minecraftVersion,
+          port: PORT
+        })
+        client.on('packet', (data, {name})=>{
+          if (name === 'success') {
+            assert.strictEqual(data.uuid, notchUUID, 'UUID')
+            server.close()
+          }
+        })
+      })
+      server.on('close', done)
+    })
     it('clients can log in and chat', function (done) {
       const server = mc.createServer({
         'online-mode': false,
@@ -203,9 +237,9 @@ for (const supportedVersion of mc.supportedVersions) {
           entityId: client.id,
           levelType: 'default',
           gameMode: 1,
-          previousGameMode: 255,
+          previousGameMode: version.version >= 755 ? 0 : 255,
           worldNames: ['minecraft:overworld'],
-          dimensionCodec: (version.version >= 735 ? mcData.loginPacket.dimension : { name: '', type: 'compound', value: { dimension: { type: 'list', value: { type: 'compound', value: [w] } } } }),
+          dimensionCodec: version.version >= 755 ? mcData.loginPacket.dimensionCodec : (version.version >= 735 ? mcData.loginPacket.dimension : { name: '', type: 'compound', value: { dimension: { type: 'list', value: { type: 'compound', value: [w] } } } }),
           dimension: (version.version >= 735 ? mcData.loginPacket.dimension : 0),
           worldName: 'minecraft:overworld',
           hashedSeed: [0, 0],
@@ -328,9 +362,9 @@ for (const supportedVersion of mc.supportedVersions) {
           entityId: client.id,
           levelType: 'default',
           gameMode: 1,
-          previousGameMode: 255,
+          previousGameMode: version.version >= 755 ? 0 : 255,
           worldNames: ['minecraft:overworld'],
-          dimensionCodec: (version.version >= 735 ? mcData.loginPacket.dimension : { name: '', type: 'compound', value: { dimension: { type: 'list', value: { type: 'compound', value: [w] } } } }),
+          dimensionCodec: version.version >= 755 ? mcData.loginPacket.dimensionCodec : (version.version >= 735 ? mcData.loginPacket.dimension : { name: '', type: 'compound', value: { dimension: { type: 'list', value: { type: 'compound', value: [w] } } } }),
           dimension: (version.version >= 735 ? mcData.loginPacket.dimension : 0),
           worldName: 'minecraft:overworld',
           hashedSeed: [0, 0],
@@ -379,9 +413,9 @@ for (const supportedVersion of mc.supportedVersions) {
           entityId: client.id,
           levelType: 'default',
           gameMode: 1,
-          previousGameMode: 255,
+          previousGameMode: version.version >= 755 ? 0 : 255,
           worldNames: ['minecraft:overworld'],
-          dimensionCodec: (version.version >= 735 ? mcData.loginPacket.dimension : { name: '', type: 'compound', value: { dimension: { type: 'list', value: { type: 'compound', value: [w] } } } }),
+          dimensionCodec: version.version >= 755 ? mcData.loginPacket.dimensionCodec : (version.version >= 735 ? mcData.loginPacket.dimension : { name: '', type: 'compound', value: { dimension: { type: 'list', value: { type: 'compound', value: [w] } } } }),
           dimension: (version.version >= 735 ? mcData.loginPacket.dimension : 0),
           worldName: 'minecraft:overworld',
           hashedSeed: [0, 0],