Refactoring for 1.20.4 enablement

Author: retrixe

src/components/servers/EditServerDialog.tsx

@@ -106,11 +106,13 @@ const EditServerDialog = ({
         dropdownIconColor={darkMode ? '#ffffff' : '#000000'}
       >
         <Picker.Item label='Auto' value='auto' />
+        {/* FIXME: Update README after enablement. */}
+        <Picker.Item label='1.20.3/1.20.4 (DOES NOT WORK!)' value='1.20.3' />
         <Picker.Item label='1.20.2 (WIP)' value='1.20.2' />
-        <Picker.Item label='1.20/1.20.1 (WIP)' value='1.20.1' />
+        <Picker.Item label='1.20/1.20.1 (WIP)' value='1.20' />
         <Picker.Item label='1.19.4 (WIP)' value='1.19.4' />
         <Picker.Item label='1.19.3 (WIP)' value='1.19.3' />
-        <Picker.Item label='1.19.1/1.19.2 (WIP)' value='1.19.2' />
+        <Picker.Item label='1.19.1/1.19.2 (WIP)' value='1.19.1' />
         <Picker.Item label='1.19 (WIP)' value='1.19' />
         <Picker.Item label='1.18.2' value='1.18.2' />
         <Picker.Item label='1.18/1.18.1' value='1.18' />

src/minecraft/chatToJsx.tsx

@@ -1,6 +1,8 @@
 import React from 'react'
 import { type StyleProp, type TextProps, type TextStyle } from 'react-native'
+// import nbt from 'prismarine-nbt'
 import translationsJson from './translations.json'
+import { protocolMap } from './utils'
 
 const translations: Record<string, string> = translationsJson
 
@@ -309,11 +311,26 @@ export const ChatToJsx = (props: {
     props.trim
   )
 
-export const parseValidJson = (text: string): any => {
+export const parseChat = (
+  chat: string | Buffer,
+  version: number
+): BaseChat | string => {
+  if (typeof chat === 'string') return parseJsonChat(chat)
+  if (version < protocolMap['1.20.3'])
+    return parseJsonChat(chat.toString('utf8'))
   try {
-    return JSON.parse(text)
+    throw new Error('NBT parsing is disabled.')
+    // return nbt.simplify(nbt.parseUncompressed(chat))
   } catch (e) {
-    return text
+    return parseJsonChat(chat.toString('utf8'))
+  }
+}
+
+export const parseJsonChat = (chat: string): MinecraftChat => {
+  try {
+    return JSON.parse(chat)
+  } catch (e) {
+    return chat
   }
 }
 

src/minecraft/connection/index.ts

@@ -26,7 +26,7 @@ export interface ServerConnection extends events.EventEmitter {
   state: ConnectionState
   closed: boolean
   msgSalt?: Buffer
-  disconnectReason?: string
+  disconnectReason?: string // FIXME: This is no longer just a string, it may be NBT too...
 
   writePacket: (packetId: number, data: Buffer) => Promise<boolean>
 

src/minecraft/pingServer.ts

@@ -15,7 +15,7 @@ import {
   parsePacket,
   type Packet
 } from './packet'
-import { parseValidJson, type PlainTextChat } from './chatToJsx'
+import { type PlainTextChat } from './chatToJsx'
 
 export interface LegacyPing {
   ff: number
@@ -158,7 +158,7 @@ export const modernPing = async (opts: {
         const json = responsePacket.data
           .slice(varIntLength, varIntLength + jsonLength)
           .toString('utf8')
-        const response = parseValidJson(json)
+        const response = JSON.parse(json)
 
         resolve({
           ping: timeReceived - timeSent,

src/minecraft/utils.ts

@@ -20,7 +20,7 @@ export const protocolMap = {
   '1.20.2': 764,
   '1.20.3': 765,
   '1.20.4': 765,
-  latest: 764,
+  latest: 764, // FIXME: Set to 765 when 1.20.4 is supported.
   auto: -1
 }
 

src/utilities/connection/connectionBuilder.ts

@@ -15,7 +15,7 @@ import {
 } from '../../minecraft/api/microsoft'
 import { getPlayerCertificates } from '../../minecraft/api/mojang'
 import { refresh } from '../../minecraft/api/yggdrasil'
-import { parseValidJson } from '../../minecraft/chatToJsx'
+import { parseJsonChat } from '../../minecraft/chatToJsx'
 import initiateConnection, {
   type ServerConnection
 } from '../../minecraft/connection'
@@ -131,7 +131,7 @@ export const createConnection = async (
     const onCloseOrError = (): void => {
       closeChatScreen(
         newConn.disconnectReason
-          ? { server, reason: parseValidJson(newConn.disconnectReason) }
+          ? { server, reason: parseJsonChat(newConn.disconnectReason) }
           : undefined
       )
       setConnection(undefined)

src/utilities/connection/packetHandler.ts

@@ -1,5 +1,10 @@
 import type React from 'react'
-import { type MinecraftChat, parseValidJson } from '../../minecraft/chatToJsx'
+// import nbt from 'prismarine-nbt'
+import {
+  type MinecraftChat,
+  parseChat,
+  parseJsonChat
+} from '../../minecraft/chatToJsx'
 import {
   ConnectionState,
   type ServerConnection
@@ -33,53 +38,92 @@ type HandleError = (
 ) => (error: unknown) => any
 
 interface PlayerChatMessage {
-  signedChat: string
-  unsignedChat?: string
+  signedChat: MinecraftChat
+  unsignedChat?: MinecraftChat
   type: number
-  displayName: string
+  displayName: MinecraftChat
 }
 
-const parsePlayerChatMessage = (data: Buffer): PlayerChatMessage => {
-  const [signedChatLength, signedChatVarIntLength] = readVarInt(data)
-  data = data.slice(signedChatVarIntLength)
-  const signedChat = data.slice(0, signedChatLength).toString('utf8')
-  data = data.slice(signedChatLength)
+const parsePlayerChatMessage = (
+  data: Buffer,
+  version: number
+): PlayerChatMessage => {
+  let signedChat: MinecraftChat
+  if (version < protocolMap['1.20.3']) {
+    const [signedChatLength, signedChatVarIntLength] = readVarInt(data)
+    data = data.slice(signedChatVarIntLength)
+    signedChat = parseJsonChat(data.slice(0, signedChatLength).toString('utf8'))
+    data = data.slice(signedChatLength)
+  } else {
+    signedChat = 'FIXME: NBT Chat'
+    // const signedChatNbt = nbt.parseUncompressed(data)
+    // signedChat = nbt.simplify(signedChatNbt)
+    // data = data.slice(nbt.writeUncompressed(signedChatNbt).length)
+  }
   const hasUnsignedChat = data.readInt8()
   data = data.slice(1)
-  let unsignedChat
-  if (hasUnsignedChat) {
+  let unsignedChat: MinecraftChat | undefined
+  if (hasUnsignedChat && version < protocolMap['1.20.3']) {
     const [unsignedChatLength, unsignedChatVarIntLength] = readVarInt(data)
     data = data.slice(unsignedChatVarIntLength)
-    unsignedChat = data.slice(0, unsignedChatLength).toString('utf8')
+    unsignedChat = parseJsonChat(
+      data.slice(0, unsignedChatLength).toString('utf8')
+    )
     data = data.slice(unsignedChatLength)
+  } else if (hasUnsignedChat) {
+    unsignedChat = undefined // FIXME
+    // const unsignedChatNbt = nbt.parseUncompressed(data)
+    // unsignedChat = nbt.simplify(unsignedChatNbt)
+    // data = data.slice(nbt.writeUncompressed(unsignedChatNbt).length)
   }
   const [type, typeLength] = readVarInt(data)
   data = data.slice(typeLength)
   data = data.slice(16) // Skip sender UUID
-  const [displayNameLength, displayNameVarIntLength] = readVarInt(data)
-  data = data.slice(displayNameVarIntLength)
-  const displayName = data.slice(0, displayNameLength).toString('utf8')
+  let displayName: MinecraftChat
+  if (version < protocolMap['1.20.3']) {
+    const [displayNameLength, displayNameVarIntLength] = readVarInt(data)
+    data = data.slice(displayNameVarIntLength)
+    displayName = parseJsonChat(
+      data.slice(0, displayNameLength).toString('utf8')
+    )
+    data = data.slice(displayNameLength)
+  } else {
+    displayName = 'FIXME: NBT Chat'
+    // const displayNameNbt = nbt.parseUncompressed(data)
+    // displayName = nbt.simplify(displayNameNbt)
+    // data = data.slice(nbt.writeUncompressed(displayNameNbt).length)
+  }
   return { signedChat, unsignedChat, type, displayName }
 }
 
 const handleSystemMessage = (
   packet: Packet,
   addMessage: (text: MinecraftChat) => void,
   handleError: HandleError,
-  is1191: boolean
+  version: number
 ): void => {
   try {
-    const [chatLength, chatVarIntLength] = readVarInt(packet.data)
-    const chatJson = packet.data
-      .slice(chatVarIntLength, chatVarIntLength + chatLength)
-      .toString('utf8')
+    let parsedChat: MinecraftChat
+    let offset
+    if (version < protocolMap['1.20.3']) {
+      const [chatLength, chatViLength] = readVarInt(packet.data)
+      const chat = packet.data.slice(chatViLength, chatViLength + chatLength)
+      parsedChat = parseJsonChat(chat.toString('utf8'))
+      offset = chatViLength + chatLength
+    } else {
+      parsedChat = 'FIXME: NBT Chat'
+      offset = packet.data.length - 1
+      // const chatNbt = nbt.parseUncompressed(packet.data)
+      // parsedChat = nbt.simplify(chatNbt)
+      // offset = nbt.writeUncompressed(chatNbt).length
+    }
     // TODO: Support position 2 (action bar), true (action bar) and sender for disableChat/blocked players.
     // TODO-1.19: 3 say command, 4 msg command, 5 team msg command, 6 emote command, 7 tellraw command, also in Player Chat Message.
-    const position = packet.data.readInt8(chatVarIntLength + chatLength)
-    if (!is1191 && (position === 0 || position === 1)) {
-      addMessage(parseValidJson(chatJson))
-    } else if (is1191 && !position) {
-      addMessage(parseValidJson(chatJson))
+    const position = packet.data.readInt8(offset)
+    if (version < protocolMap['1.19.1'] && (position === 0 || position === 1)) {
+      addMessage(parsedChat)
+    } else if (version >= protocolMap['1.19.1'] && !position) {
+      addMessage(parsedChat)
     }
   } catch (e) {
     handleError(addMessage, parseMessageError)(e)
@@ -138,7 +182,6 @@ export const packetHandler =
     const { protocolVersion: version } = connection.options
     const is117 = version >= protocolMap[1.17]
     const is118 = version >= protocolMap[1.18]
-    const is1191 = version >= protocolMap['1.19.1']
 
     // LOW-TODO: 1.20.2 also has a second Client Information in configuration state, do we send it?
     if (connection.state === ConnectionState.PLAY) {
@@ -194,25 +237,22 @@ export const packetHandler =
             .catch(handleError(addMessage, sendMessageError))
         }
       } else if (packet.id === packetIds.CLIENTBOUND_CHAT_MESSAGE(version)) {
-        handleSystemMessage(packet, addMessage, handleError, is1191)
+        handleSystemMessage(packet, addMessage, handleError, version)
       } else if (
         packet.id === packetIds.CLIENTBOUND_SYSTEM_CHAT_MESSAGE(version)
       ) {
-        handleSystemMessage(packet, addMessage, handleError, is1191)
+        handleSystemMessage(packet, addMessage, handleError, version)
       } else if (
         packet.id === packetIds.CLIENTBOUND_PLAYER_CHAT_MESSAGE(version)
       ) {
         try {
           const { type, displayName, signedChat, unsignedChat } =
-            parsePlayerChatMessage(packet.data)
+            parsePlayerChatMessage(packet.data, version)
           // TODO-1.19: Support sender team name
           if (type === 0 || type === 1) {
             addMessage({
               translate: 'chat.type.text',
-              with: [
-                parseValidJson(displayName),
-                parseValidJson(unsignedChat ?? signedChat)
-              ]
+              with: [displayName, unsignedChat ?? signedChat]
             })
           }
         } catch (e) {
@@ -238,9 +278,8 @@ export const packetHandler =
         data = data.slice(readVarInt(data)[1]) // Remove Player ID
         if (version <= protocolMap['1.19.4']) data = data.slice(4) // Remove Killer ID
         const [chatLen, chatViLength] = readVarInt(data)
-        const deathMessage = parseValidJson(
-          data.slice(chatViLength, chatViLength + chatLen).toString('utf8')
-        )
+        const chat = data.slice(chatViLength, chatViLength + chatLen)
+        const deathMessage = parseChat(chat, version)
         if (
           (typeof deathMessage === 'string' && deathMessage.trim()) ||
           Object.keys(deathMessage).length !== 0