fix: send a command with no signable argument as chat_command

src/client/chat.js

@@ -389,7 +389,6 @@ module.exports = function (client, options) {
       if (message) {
         acc |= 1 << i
         acknowledgements.push(message.signature)
-        message.pending = false
       }
     }
 
@@ -404,6 +403,15 @@ module.exports = function (client, options) {
     }
   }
 
+  // Call only after writing a packet that carries the acknowledgements from getAcknowledgements.
+  function markAcknowledgementsSent () {
+    for (let i = 0; i < client._lastSeenMessages.capacity; i++) {
+      const message = client._lastSeenMessages[(client._lastSeenMessages.offset + i) % 20]
+      if (message) message.pending = false
+    }
+    client._lastSeenMessages.pending = 0
+  }
+
   client._signedChat = (message, options = {}) => {
     options.timestamp = options.timestamp || BigInt(Date.now())
     options.salt = options.salt || 1n
@@ -413,17 +421,22 @@ module.exports = function (client, options) {
       if (mcData.supportFeature('useChatSessions')) { // 1.19.3+
         const { acknowledged, acknowledgements } = getAcknowledgements()
         const canSign = client.profileKeys && client._session
+        const argumentSignatures = canSign ? signaturesForCommand(command, options.timestamp, options.salt, options.preview, acknowledgements) : []
         const chatPacket = {
           command,
           timestamp: options.timestamp,
           salt: options.salt,
-          argumentSignatures: canSign ? signaturesForCommand(command, options.timestamp, options.salt, options.preview, acknowledgements) : [],
+          argumentSignatures,
           messageCount: client._lastSeenMessages.pending,
           checksum: computeChatChecksum(client._lastSeenMessages), // 1.21.5+
           acknowledged
         }
-        client.write((mcData.supportFeature('seperateSignedChatCommandPacket') && canSign) ? 'chat_command_signed' : 'chat_command', chatPacket)
-        client._lastSeenMessages.pending = 0
+        const separateSignedPacket = mcData.supportFeature('seperateSignedChatCommandPacket')
+        // A command with nothing to sign goes as the unsigned chat_command whether or not the client can sign.
+        const signedPacket = separateSignedPacket && argumentSignatures.length > 0
+        client.write(signedPacket ? 'chat_command_signed' : 'chat_command', chatPacket)
+        // Once the packets are split, chat_command carries only the command, so it acknowledges nothing.
+        if (signedPacket || !separateSignedPacket) markAcknowledgementsSent()
       } else {
         client.write('chat_command', {
           command,
@@ -454,7 +467,7 @@ module.exports = function (client, options) {
         checksum: computeChatChecksum(client._lastSeenMessages), // 1.21.5+
         acknowledged
       })
-      client._lastSeenMessages.pending = 0
+      markAcknowledgementsSent()
 
       return
     }

test/declareCommandsTest.js

@@ -54,4 +54,112 @@ describe('declare_commands handling', () => {
     assert.strictEqual(writes[0].name, 'chat_command_signed')
     assert.deepStrictEqual(writes[0].data.argumentSignatures.map(sig => sig.argumentName), ['message'])
   })
+
+  it('sends a command with no signable argument as the unsigned packet', () => {
+    const client = new EventEmitter()
+    client.version = '26.1'
+    client.verifyMessage = () => true
+    client.profileKeys = true
+    client._session = { uuid: '00000000-0000-0000-0000-000000000000' }
+
+    const writes = []
+    client.write = (name, data) => writes.push({ name, data })
+
+    injectChatPlugin(client, {})
+    client.signMessage = () => Buffer.from([1])
+
+    client.emit('declare_commands', {
+      rootIndex: 0,
+      nodes: [
+        { children: [1] },
+        { children: [2], extraNodeData: { name: 'msg' } },
+        { children: [], extraNodeData: { name: 'message', parser: 'minecraft:message' } }
+      ]
+    })
+
+    client._signedChat('/login hunter2', { timestamp: 1n, salt: 1n })
+
+    assert.strictEqual(writes.length, 1)
+    assert.strictEqual(writes[0].name, 'chat_command')
+    assert.deepStrictEqual(writes[0].data.argumentSignatures, [])
+  })
+
+  it('sends a known command without arguments as the unsigned packet', () => {
+    const client = new EventEmitter()
+    client.version = '26.1'
+    client.verifyMessage = () => true
+    client.profileKeys = true
+    client._session = { uuid: '00000000-0000-0000-0000-000000000000' }
+
+    const writes = []
+    client.write = (name, data) => writes.push({ name, data })
+
+    injectChatPlugin(client, {})
+    client.signMessage = () => Buffer.from([1])
+
+    client.emit('declare_commands', {
+      rootIndex: 0,
+      nodes: [
+        { children: [1] },
+        { children: [2], extraNodeData: { name: 'msg' } },
+        { children: [], extraNodeData: { name: 'message', parser: 'minecraft:message' } }
+      ]
+    })
+
+    client._signedChat('/msg', { timestamp: 1n, salt: 1n })
+
+    assert.strictEqual(writes.length, 1)
+    assert.strictEqual(writes[0].name, 'chat_command')
+  })
+
+  it('leaves acknowledgements pending after an unsigned command', () => {
+    const client = new EventEmitter()
+    client.version = '26.1'
+    client.verifyMessage = () => true
+    client.profileKeys = true
+    client._session = { uuid: '00000000-0000-0000-0000-000000000000' }
+
+    const writes = []
+    client.write = (name, data) => writes.push({ name, data })
+
+    injectChatPlugin(client, {})
+    client.signMessage = () => Buffer.from([1])
+
+    client._lastSeenMessages.push(Buffer.from([2]))
+    client._signedChat('/list', { timestamp: 1n, salt: 1n })
+    client._signedChat('hello', { timestamp: 2n, salt: 1n })
+
+    assert.deepStrictEqual(writes.map(write => write.name), ['chat_command', 'chat_message'])
+    assert.strictEqual(writes[1].data.offset, 1)
+    assert.strictEqual(client._lastSeenMessages.pending, 0)
+    assert.strictEqual(client._lastSeenMessages[0].pending, false)
+  })
+
+  it('acknowledges with chat_command before the signed command packet was split out', () => {
+    require.cache[minecraftDataPath] = {
+      exports: () => ({
+        supportFeature (feature) {
+          return feature === 'useChatSessions'
+        }
+      })
+    }
+
+    const client = new EventEmitter()
+    client.version = '1.20.4'
+    client.verifyMessage = () => true
+
+    const writes = []
+    client.write = (name, data) => writes.push({ name, data })
+
+    injectChatPlugin(client, {})
+
+    client._lastSeenMessages.push(Buffer.from([2]))
+    client._signedChat('/list', { timestamp: 1n, salt: 1n })
+
+    assert.strictEqual(writes.length, 1)
+    assert.strictEqual(writes[0].name, 'chat_command')
+    assert.strictEqual(writes[0].data.messageCount, 1)
+    assert.strictEqual(client._lastSeenMessages.pending, 0)
+    assert.strictEqual(client._lastSeenMessages[0].pending, false)
+  })
 })