File Explorer

1const util = require('util')2 3const test = require('tape')4const mqtt = require('./')5const WS = require('readable-stream').Writable6 7function normalExpectedObject (object) {8  if (object.username != null) object.username = object.username.toString()9  if (object.password != null) object.password = Buffer.from(object.password)10  return object11}12 13function testParseGenerate (name, object, buffer, opts) {14  test(`${name} parse`, t => {15    t.plan(2)16 17    const parser = mqtt.parser(opts)18    const expected = object19    const fixture = buffer20 21    parser.on('packet', packet => {22      if (packet.cmd !== 'publish') {23        delete packet.topic24        delete packet.payload25      }26      t.deepLooseEqual(packet, normalExpectedObject(expected), 'expected packet')27    })28 29    parser.on('error', err => {30      t.fail(err)31    })32 33    t.equal(parser.parse(fixture), 0, 'remaining bytes')34  })35 36  test(`${name} generate`, t => {37    // For really large buffers, the expanded hex string can be so long as to38    // generate an error in nodejs 14.x, so only do the test with extra output39    // for relatively small buffers.40    const bigLength = 1000041    const generatedBuffer = mqtt.generate(object, opts)42    if (generatedBuffer.length < bigLength && buffer.length < bigLength) {43      t.equal(generatedBuffer.toString('hex'), buffer.toString('hex'))44    } else {45      const bufferOkay = generatedBuffer.equals(buffer)46      if (bufferOkay) {47        t.pass()48      } else {49        // Output abbreviated representations of the buffers.50        t.comment('Expected:\n' + util.inspect(buffer))51        t.comment('Got:\n' + util.inspect(generatedBuffer))52        t.fail('Large buffers not equal')53      }54    }55    t.end()56  })57 58  test(`${name} mirror`, t => {59    t.plan(2)60 61    const parser = mqtt.parser(opts)62    const expected = object63    const fixture = mqtt.generate(object, opts)64 65    parser.on('packet', packet => {66      if (packet.cmd !== 'publish') {67        delete packet.topic68        delete packet.payload69      }70      t.deepLooseEqual(packet, normalExpectedObject(expected), 'expected packet')71    })72 73    parser.on('error', err => {74      t.fail(err)75    })76 77    t.equal(parser.parse(fixture), 0, 'remaining bytes')78  })79 80  test(`${name} writeToStream`, t => {81    const stream = WS()82    stream.write = () => true83    stream.on('error', (err) => t.fail(err))84 85    const result = mqtt.writeToStream(object, stream, opts)86    t.equal(result, true, 'should return true')87    t.end()88  })89}90 91// the API allows to pass strings as buffers to writeToStream and generate92// parsing them back will result in a string so only generate and compare to buffer93function testGenerateOnly (name, object, buffer, opts) {94  test(name, t => {95    t.equal(mqtt.generate(object, opts).toString('hex'), buffer.toString('hex'))96    t.end()97  })98}99 100function testParseOnly (name, object, buffer, opts) {101  test(name, t => {102    const parser = mqtt.parser(opts)103    // const expected = object104    // const fixture = buffer105 106    t.plan(2 + Object.keys(object).length)107 108    parser.on('packet', packet => {109      t.equal(Object.keys(object).length, Object.keys(packet).length, 'key count')110      Object.keys(object).forEach(key => {111        t.deepEqual(packet[key], object[key], `expected packet property ${key}`)112      })113    })114 115    t.equal(parser.parse(buffer), 0, 'remaining bytes')116    t.end()117  })118}119 120function testParseError (expected, fixture, opts) {121  test(expected, t => {122    t.plan(1)123 124    const parser = mqtt.parser(opts)125 126    parser.on('error', err => {127      t.equal(err.message, expected, 'expected error message')128    })129 130    parser.on('packet', () => {131      t.fail('parse errors should not be followed by packet events')132    })133 134    parser.parse(fixture)135    t.end()136  })137}138 139function testGenerateError (expected, fixture, opts, name) {140  test(name || expected, t => {141    t.plan(1)142 143    try {144      mqtt.generate(fixture, opts)145    } catch (err) {146      t.equal(expected, err.message)147    }148    t.end()149  })150}151 152function testGenerateErrorMultipleCmds (cmds, expected, fixture, opts) {153  cmds.forEach(cmd => {154    const obj = Object.assign({}, fixture)155    obj.cmd = cmd156    testGenerateError(expected, obj, opts, `${expected} on ${cmd}`)157  }158  )159}160 161function testParseGenerateDefaults (name, object, buffer, generated, opts) {162  testParseOnly(`${name} parse`, generated, buffer, opts)163  testGenerateOnly(`${name} generate`, object, buffer, opts)164}165 166function testParseAndGenerate (name, object, buffer, opts) {167  testParseOnly(`${name} parse`, object, buffer, opts)168  testGenerateOnly(`${name} generate`, object, buffer, opts)169}170 171function testWriteToStreamError (expected, fixture) {172  test(`writeToStream ${expected} error`, t => {173    t.plan(2)174 175    const stream = WS()176 177    stream.write = () => t.fail('should not have called write')178    stream.on('error', () => t.pass('error emitted'))179 180    const result = mqtt.writeToStream(fixture, stream)181 182    t.false(result, 'result should be false')183    t.end()184  })185}186 187test('cacheNumbers get/set/unset', t => {188  t.true(mqtt.writeToStream.cacheNumbers, 'initial state of cacheNumbers is enabled')189  mqtt.writeToStream.cacheNumbers = false190  t.false(mqtt.writeToStream.cacheNumbers, 'cacheNumbers can be disabled')191  mqtt.writeToStream.cacheNumbers = true192  t.true(mqtt.writeToStream.cacheNumbers, 'cacheNumbers can be enabled')193  t.end()194})195 196test('disabled numbers cache', t => {197  const stream = WS()198  const message = {199    cmd: 'publish',200    retain: false,201    qos: 0,202    dup: false,203    length: 10,204    topic: Buffer.from('test'),205    payload: Buffer.from('test')206  }207  const expected = Buffer.from([208    48, 10, // Header209    0, 4, // Topic length210    116, 101, 115, 116, // Topic (test)211    116, 101, 115, 116 // Payload (test)212  ])213  let written = Buffer.alloc(0)214 215  stream.write = (chunk) => {216    written = Buffer.concat([written, chunk])217  }218  mqtt.writeToStream.cacheNumbers = false219 220  mqtt.writeToStream(message, stream)221 222  t.deepEqual(written, expected, 'written buffer is expected')223 224  mqtt.writeToStream.cacheNumbers = true225 226  stream.end()227  t.end()228})229 230testGenerateError('Unknown command', {})231 232testParseError('Not supported', Buffer.from([0, 1, 0]), {})233 234// Length header field235testParseError('Invalid variable byte integer', Buffer.from(236  [16, 255, 255, 255, 255]237), {})238testParseError('Invalid variable byte integer', Buffer.from(239  [16, 255, 255, 255, 128]240), {})241testParseError('Invalid variable byte integer', Buffer.from(242  [16, 255, 255, 255, 255, 1]243), {})244testParseError('Invalid variable byte integer', Buffer.from(245  [16, 255, 255, 255, 255, 127]246), {})247testParseError('Invalid variable byte integer', Buffer.from(248  [16, 255, 255, 255, 255, 128]249), {})250testParseError('Invalid variable byte integer', Buffer.from(251  [16, 255, 255, 255, 255, 255, 1]252), {})253 254testParseGenerate('minimal connect', {255  cmd: 'connect',256  retain: false,257  qos: 0,258  dup: false,259  length: 18,260  protocolId: 'MQIsdp',261  protocolVersion: 3,262  clean: false,263  keepalive: 30,264  clientId: 'test'265}, Buffer.from([266  16, 18, // Header267  0, 6, // Protocol ID length268  77, 81, 73, 115, 100, 112, // Protocol ID269  3, // Protocol version270  0, // Connect flags271  0, 30, // Keepalive272  0, 4, // Client ID length273  116, 101, 115, 116 // Client ID274]))275 276testGenerateOnly('minimal connect with clientId as Buffer', {277  cmd: 'connect',278  retain: false,279  qos: 0,280  dup: false,281  length: 18,282  protocolId: 'MQIsdp',283  protocolVersion: 3,284  clean: false,285  keepalive: 30,286  clientId: Buffer.from('test')287}, Buffer.from([288  16, 18, // Header289  0, 6, // Protocol ID length290  77, 81, 73, 115, 100, 112, // Protocol ID291  3, // Protocol version292  0, // Connect flags293  0, 30, // Keepalive294  0, 4, // Client ID length295  116, 101, 115, 116 // Client ID296]))297 298testParseGenerate('connect MQTT bridge 131', {299  cmd: 'connect',300  retain: false,301  qos: 0,302  dup: false,303  length: 18,304  protocolId: 'MQIsdp',305  protocolVersion: 3,306  bridgeMode: true,307  clean: false,308  keepalive: 30,309  clientId: 'test'310}, Buffer.from([311  16, 18, // Header312  0, 6, // Protocol ID length313  77, 81, 73, 115, 100, 112, // Protocol ID314  131, // Protocol version315  0, // Connect flags316  0, 30, // Keepalive317  0, 4, // Client ID length318  116, 101, 115, 116 // Client ID319]))320 321testParseGenerate('connect MQTT bridge 132', {322  cmd: 'connect',323  retain: false,324  qos: 0,325  dup: false,326  length: 18,327  protocolId: 'MQIsdp',328  protocolVersion: 4,329  bridgeMode: true,330  clean: false,331  keepalive: 30,332  clientId: 'test'333}, Buffer.from([334  16, 18, // Header335  0, 6, // Protocol ID length336  77, 81, 73, 115, 100, 112, // Protocol ID337  132, // Protocol version338  0, // Connect flags339  0, 30, // Keepalive340  0, 4, // Client ID length341  116, 101, 115, 116 // Client ID342]))343 344testParseGenerate('connect MQTT 5', {345  cmd: 'connect',346  retain: false,347  qos: 0,348  dup: false,349  length: 125,350  protocolId: 'MQTT',351  protocolVersion: 5,352  will: {353    retain: true,354    qos: 2,355    properties: {356      willDelayInterval: 1234,357      payloadFormatIndicator: false,358      messageExpiryInterval: 4321,359      contentType: 'test',360      responseTopic: 'topic',361      correlationData: Buffer.from([1, 2, 3, 4]),362      userProperties: {363        test: 'test'364      }365    },366    topic: 'topic',367    payload: Buffer.from([4, 3, 2, 1])368  },369  clean: true,370  keepalive: 30,371  properties: {372    sessionExpiryInterval: 1234,373    receiveMaximum: 432,374    maximumPacketSize: 100,375    topicAliasMaximum: 456,376    requestResponseInformation: true,377    requestProblemInformation: true,378    userProperties: {379      test: 'test'380    },381    authenticationMethod: 'test',382    authenticationData: Buffer.from([1, 2, 3, 4])383  },384  clientId: 'test'385}, Buffer.from([386  16, 125, // Header387  0, 4, // Protocol ID length388  77, 81, 84, 84, // Protocol ID389  5, // Protocol version390  54, // Connect flags391  0, 30, // Keepalive392  47, // properties length393  17, 0, 0, 4, 210, // sessionExpiryInterval394  33, 1, 176, // receiveMaximum395  39, 0, 0, 0, 100, // maximumPacketSize396  34, 1, 200, // topicAliasMaximum397  25, 1, // requestResponseInformation398  23, 1, // requestProblemInformation,399  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties,400  21, 0, 4, 116, 101, 115, 116, // authenticationMethod401  22, 0, 4, 1, 2, 3, 4, // authenticationData402  0, 4, // Client ID length403  116, 101, 115, 116, // Client ID404  47, // will properties405  24, 0, 0, 4, 210, // will delay interval406  1, 0, // payload format indicator407  2, 0, 0, 16, 225, // message expiry interval408  3, 0, 4, 116, 101, 115, 116, // content type409  8, 0, 5, 116, 111, 112, 105, 99, // response topic410  9, 0, 4, 1, 2, 3, 4, // corelation data411  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // user properties412  0, 5, // Will topic length413  116, 111, 112, 105, 99, // Will topic414  0, 4, // Will payload length415  4, 3, 2, 1// Will payload416]))417 418testParseGenerate('connect MQTT 5 with will properties but with empty will payload', {419  cmd: 'connect',420  retain: false,421  qos: 0,422  dup: false,423  length: 121,424  protocolId: 'MQTT',425  protocolVersion: 5,426  will: {427    retain: true,428    qos: 2,429    properties: {430      willDelayInterval: 1234,431      payloadFormatIndicator: false,432      messageExpiryInterval: 4321,433      contentType: 'test',434      responseTopic: 'topic',435      correlationData: Buffer.from([1, 2, 3, 4]),436      userProperties: {437        test: 'test'438      }439    },440    topic: 'topic',441    payload: Buffer.from([])442  },443  clean: true,444  keepalive: 30,445  properties: {446    sessionExpiryInterval: 1234,447    receiveMaximum: 432,448    maximumPacketSize: 100,449    topicAliasMaximum: 456,450    requestResponseInformation: true,451    requestProblemInformation: true,452    userProperties: {453      test: 'test'454    },455    authenticationMethod: 'test',456    authenticationData: Buffer.from([1, 2, 3, 4])457  },458  clientId: 'test'459}, Buffer.from([460  16, 121, // Header461  0, 4, // Protocol ID length462  77, 81, 84, 84, // Protocol ID463  5, // Protocol version464  54, // Connect flags465  0, 30, // Keepalive466  47, // properties length467  17, 0, 0, 4, 210, // sessionExpiryInterval468  33, 1, 176, // receiveMaximum469  39, 0, 0, 0, 100, // maximumPacketSize470  34, 1, 200, // topicAliasMaximum471  25, 1, // requestResponseInformation472  23, 1, // requestProblemInformation,473  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties,474  21, 0, 4, 116, 101, 115, 116, // authenticationMethod475  22, 0, 4, 1, 2, 3, 4, // authenticationData476  0, 4, // Client ID length477  116, 101, 115, 116, // Client ID478  47, // will properties479  24, 0, 0, 4, 210, // will delay interval480  1, 0, // payload format indicator481  2, 0, 0, 16, 225, // message expiry interval482  3, 0, 4, 116, 101, 115, 116, // content type483  8, 0, 5, 116, 111, 112, 105, 99, // response topic484  9, 0, 4, 1, 2, 3, 4, // corelation data485  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // user properties486  0, 5, // Will topic length487  116, 111, 112, 105, 99, // Will topic488  0, 0 // Will payload length489]))490 491testParseGenerate('connect MQTT 5 w/o will properties', {492  cmd: 'connect',493  retain: false,494  qos: 0,495  dup: false,496  length: 78,497  protocolId: 'MQTT',498  protocolVersion: 5,499  will: {500    retain: true,501    qos: 2,502    topic: 'topic',503    payload: Buffer.from([4, 3, 2, 1])504  },505  clean: true,506  keepalive: 30,507  properties: {508    sessionExpiryInterval: 1234,509    receiveMaximum: 432,510    maximumPacketSize: 100,511    topicAliasMaximum: 456,512    requestResponseInformation: true,513    requestProblemInformation: true,514    userProperties: {515      test: 'test'516    },517    authenticationMethod: 'test',518    authenticationData: Buffer.from([1, 2, 3, 4])519  },520  clientId: 'test'521}, Buffer.from([522  16, 78, // Header523  0, 4, // Protocol ID length524  77, 81, 84, 84, // Protocol ID525  5, // Protocol version526  54, // Connect flags527  0, 30, // Keepalive528  47, // properties length529  17, 0, 0, 4, 210, // sessionExpiryInterval530  33, 1, 176, // receiveMaximum531  39, 0, 0, 0, 100, // maximumPacketSize532  34, 1, 200, // topicAliasMaximum533  25, 1, // requestResponseInformation534  23, 1, // requestProblemInformation,535  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties,536  21, 0, 4, 116, 101, 115, 116, // authenticationMethod537  22, 0, 4, 1, 2, 3, 4, // authenticationData538  0, 4, // Client ID length539  116, 101, 115, 116, // Client ID540  0, // will properties541  0, 5, // Will topic length542  116, 111, 112, 105, 99, // Will topic543  0, 4, // Will payload length544  4, 3, 2, 1// Will payload545]))546 547testParseGenerate('no clientId with 3.1.1', {548  cmd: 'connect',549  retain: false,550  qos: 0,551  dup: false,552  length: 12,553  protocolId: 'MQTT',554  protocolVersion: 4,555  clean: true,556  keepalive: 30,557  clientId: ''558}, Buffer.from([559  16, 12, // Header560  0, 4, // Protocol ID length561  77, 81, 84, 84, // Protocol ID562  4, // Protocol version563  2, // Connect flags564  0, 30, // Keepalive565  0, 0 // Client ID length566]))567 568testParseGenerateDefaults('no clientId with 5.0', {569  cmd: 'connect',570  protocolId: 'MQTT',571  protocolVersion: 5,572  clean: true,573  keepalive: 60,574  properties:575  {576    receiveMaximum: 20577  },578  clientId: ''579}, Buffer.from(580  [16, 16, 0, 4, 77, 81, 84, 84, 5, 2, 0, 60, 3, 33, 0, 20, 0, 0]581), {582  cmd: 'connect',583  retain: false,584  qos: 0,585  dup: false,586  length: 16,587  topic: null,588  payload: null,589  protocolId: 'MQTT',590  protocolVersion: 5,591  clean: true,592  keepalive: 60,593  properties: {594    receiveMaximum: 20595  },596  clientId: ''597}, { protocolVersion: 5 })598 599testParseGenerateDefaults('utf-8 clientId with 5.0', {600  cmd: 'connect',601  retain: false,602  qos: 0,603  dup: false,604  length: 23,605  protocolId: 'MQTT',606  protocolVersion: 4,607  clean: true,608  keepalive: 30,609  clientId: 'Ŧėśt🜄'610}, Buffer.from([611  16, 23, // Header612  0, 4, // Protocol ID length613  77, 81, 84, 84, // Protocol ID614  4, // Protocol version615  2, // Connect flags616  0, 30, // Keepalive617  0, 11, // Client ID length618  197, 166, // Ŧ (UTF-8: 0xc5a6)619  196, 151, // ė (UTF-8: 0xc497)620  197, 155, // ś (utf-8: 0xc59b)621  116, // t (utf-8: 0x74)622  240, 159, 156, 132 // 🜄 (utf-8: 0xf09f9c84)623]), {624  cmd: 'connect',625  retain: false,626  qos: 0,627  dup: false,628  length: 23,629  topic: null,630  payload: null,631  protocolId: 'MQTT',632  protocolVersion: 4,633  clean: true,634  keepalive: 30,635  clientId: 'Ŧėśt🜄'636}, { protocol: 5 })637 638testParseGenerateDefaults('default connect', {639  cmd: 'connect',640  clientId: 'test'641}, Buffer.from([642  16, 16, 0, 4, 77, 81, 84,643  84, 4, 2, 0, 0,644  0, 4, 116, 101, 115, 116645]), {646  cmd: 'connect',647  retain: false,648  qos: 0,649  dup: false,650  length: 16,651  topic: null,652  payload: null,653  protocolId: 'MQTT',654  protocolVersion: 4,655  clean: true,656  keepalive: 0,657  clientId: 'test'658})659 660testParseAndGenerate('Version 4 CONACK', {661  cmd: 'connack',662  retain: false,663  qos: 0,664  dup: false,665  length: 2,666  topic: null,667  payload: null,668  sessionPresent: false,669  returnCode: 1670}, Buffer.from([671  32, 2, // Fixed Header (CONNACK, Remaining Length)672  0, 1 // Variable Header (Session not present, Connection Refused - unacceptable protocol version)673]), {}) // Default protocolVersion (4)674 675testParseAndGenerate('Version 5 CONACK', {676  cmd: 'connack',677  retain: false,678  qos: 0,679  dup: false,680  length: 3,681  topic: null,682  payload: null,683  sessionPresent: false,684  reasonCode: 140685}, Buffer.from([686  32, 3, // Fixed Header (CONNACK, Remaining Length)687  0, 140, // Variable Header (Session not present, Bad authentication method)688  0 // Property Length Zero689]), { protocolVersion: 5 })690 691testParseOnly('Version 4 CONACK in Version 5 mode', {692  cmd: 'connack',693  retain: false,694  qos: 0,695  dup: false,696  length: 2,697  topic: null,698  payload: null,699  sessionPresent: false,700  reasonCode: 1 // a version 4 return code stored in the version 5 reasonCode because this client is in version 5701}, Buffer.from([702  32, 2, // Fixed Header (CONNACK, Remaining Length)703  0, 1 // Variable Header (Session not present, Connection Refused - unacceptable protocol version)704]), { protocolVersion: 5 }) // message is in version 4 format, but this client is in version 5 mode705 706testParseOnly('Version 5 PUBACK test 1', {707  cmd: 'puback',708  messageId: 42,709  retain: false,710  qos: 0,711  dup: false,712  length: 2,713  topic: null,714  payload: null,715  reasonCode: 0716}, Buffer.from([717  64, 2, // Fixed Header (PUBACK, Remaining Length)718  0, 42 // Variable Header (2 Bytes: Packet Identifier 42, Implied Reason code: Success, Implied no properties)719]), { protocolVersion: 5 }720)721 722testParseAndGenerate('Version 5 PUBACK test 2', {723  cmd: 'puback',724  messageId: 42,725  retain: false,726  qos: 0,727  dup: false,728  length: 3,729  topic: null,730  payload: null,731  reasonCode: 0732}, Buffer.from([733  64, 3, // Fixed Header (PUBACK, Remaining Length)734  0, 42, 0 // Variable Header (2 Bytes: Packet Identifier 42, Reason code: 0 Success, Implied no properties)735]), { protocolVersion: 5 }736)737 738testParseOnly('Version 5 PUBACK test 3', {739  cmd: 'puback',740  messageId: 42,741  retain: false,742  qos: 0,743  dup: false,744  length: 4,745  topic: null,746  payload: null,747  reasonCode: 0748}, Buffer.from([749  64, 4, // Fixed Header (PUBACK, Remaining Length)750  0, 42, 0, // Variable Header (2 Bytes: Packet Identifier 42, Reason code: 0 Success)751  0 // no properties752]), { protocolVersion: 5 }753)754 755testParseOnly('Version 5 CONNACK test 1', {756  cmd: 'connack',757  retain: false,758  qos: 0,759  dup: false,760  length: 1,761  topic: null,762  payload: null,763  sessionPresent: true,764  reasonCode: 0765}, Buffer.from([766  32, 1, // Fixed Header (CONNACK, Remaining Length)767  1 // Variable Header (Session Present: 1 => true, Implied Reason code: Success, Implied no properties)768]), { protocolVersion: 5 }769)770 771testParseOnly('Version 5 CONNACK test 2', {772  cmd: 'connack',773  retain: false,774  qos: 0,775  dup: false,776  length: 2,777  topic: null,778  payload: null,779  sessionPresent: true,780  reasonCode: 0781}, Buffer.from([782  32, 2, // Fixed Header (CONNACK, Remaining Length)783  1, 0 // Variable Header (Session Present: 1 => true, Connect Reason code: Success, Implied no properties)784]), { protocolVersion: 5 }785)786 787testParseAndGenerate('Version 5 CONNACK test 3', {788  cmd: 'connack',789  retain: false,790  qos: 0,791  dup: false,792  length: 3,793  topic: null,794  payload: null,795  sessionPresent: true,796  reasonCode: 0797}, Buffer.from([798  32, 3, // Fixed Header (CONNACK, Remaining Length)799  1, 0, // Variable Header (Session Present: 1 => true, Connect Reason code: Success)800  0 // no properties801]), { protocolVersion: 5 }802)803 804testParseOnly('Version 5 DISCONNECT test 1', {805  cmd: 'disconnect',806  retain: false,807  qos: 0,808  dup: false,809  length: 0,810  topic: null,811  payload: null,812  reasonCode: 0813}, Buffer.from([814  224, 0 // Fixed Header (DISCONNECT, Remaining Length), Implied Reason code: Normal Disconnection815]), { protocolVersion: 5 }816)817 818testParseOnly('Version 5 DISCONNECT test 2', {819  cmd: 'disconnect',820  retain: false,821  qos: 0,822  dup: false,823  length: 1,824  topic: null,825  payload: null,826  reasonCode: 0827}, Buffer.from([828  224, 1, // Fixed Header (DISCONNECT, Remaining Length)829  0 // reason Code (Normal disconnection)830]), { protocolVersion: 5 }831)832 833testParseAndGenerate('Version 5 DISCONNECT test 3', {834  cmd: 'disconnect',835  retain: false,836  qos: 0,837  dup: false,838  length: 2,839  topic: null,840  payload: null,841  reasonCode: 0842}, Buffer.from([843  224, 2, // Fixed Header (DISCONNECT, Remaining Length)844  0, // reason Code (Normal disconnection)845  0 // no properties846]), { protocolVersion: 5 }847)848 849testParseGenerate('empty will payload', {850  cmd: 'connect',851  retain: false,852  qos: 0,853  dup: false,854  length: 47,855  protocolId: 'MQIsdp',856  protocolVersion: 3,857  will: {858    retain: true,859    qos: 2,860    topic: 'topic',861    payload: Buffer.alloc(0)862  },863  clean: true,864  keepalive: 30,865  clientId: 'test',866  username: 'username',867  password: Buffer.from('password')868}, Buffer.from([869  16, 47, // Header870  0, 6, // Protocol ID length871  77, 81, 73, 115, 100, 112, // Protocol ID872  3, // Protocol version873  246, // Connect flags874  0, 30, // Keepalive875  0, 4, // Client ID length876  116, 101, 115, 116, // Client ID877  0, 5, // Will topic length878  116, 111, 112, 105, 99, // Will topic879  0, 0, // Will payload length880  // Will payload881  0, 8, // Username length882  117, 115, 101, 114, 110, 97, 109, 101, // Username883  0, 8, // Password length884  112, 97, 115, 115, 119, 111, 114, 100 // Password885]))886 887testParseGenerate('empty buffer username payload', {888  cmd: 'connect',889  retain: false,890  qos: 0,891  dup: false,892  length: 20,893  protocolId: 'MQIsdp',894  protocolVersion: 3,895  clean: true,896  keepalive: 30,897  clientId: 'test',898  username: Buffer.from('')899}, Buffer.from([900  16, 20, // Header901  0, 6, // Protocol ID length902  77, 81, 73, 115, 100, 112, // Protocol ID903  3, // Protocol version904  130, // Connect flags905  0, 30, // Keepalive906  0, 4, // Client ID length907  116, 101, 115, 116, // Client ID908  0, 0 // Username length909  // Empty Username payload910]))911 912testParseGenerate('empty string username payload', {913  cmd: 'connect',914  retain: false,915  qos: 0,916  dup: false,917  length: 20,918  protocolId: 'MQIsdp',919  protocolVersion: 3,920  clean: true,921  keepalive: 30,922  clientId: 'test',923  username: ''924}, Buffer.from([925  16, 20, // Header926  0, 6, // Protocol ID length927  77, 81, 73, 115, 100, 112, // Protocol ID928  3, // Protocol version929  130, // Connect flags930  0, 30, // Keepalive931  0, 4, // Client ID length932  116, 101, 115, 116, // Client ID933  0, 0 // Username length934  // Empty Username payload935]))936 937testParseGenerate('empty buffer password payload', {938  cmd: 'connect',939  retain: false,940  qos: 0,941  dup: false,942  length: 30,943  protocolId: 'MQIsdp',944  protocolVersion: 3,945  clean: true,946  keepalive: 30,947  clientId: 'test',948  username: 'username',949  password: Buffer.from('')950}, Buffer.from([951  16, 30, // Header952  0, 6, // Protocol ID length953  77, 81, 73, 115, 100, 112, // Protocol ID954  3, // Protocol version955  194, // Connect flags956  0, 30, // Keepalive957  0, 4, // Client ID length958  116, 101, 115, 116, // Client ID959  0, 8, // Username length960  117, 115, 101, 114, 110, 97, 109, 101, // Username payload961  0, 0 // Password length962  // Empty password payload963]))964 965testParseGenerate('empty string password payload', {966  cmd: 'connect',967  retain: false,968  qos: 0,969  dup: false,970  length: 30,971  protocolId: 'MQIsdp',972  protocolVersion: 3,973  clean: true,974  keepalive: 30,975  clientId: 'test',976  username: 'username',977  password: ''978}, Buffer.from([979  16, 30, // Header980  0, 6, // Protocol ID length981  77, 81, 73, 115, 100, 112, // Protocol ID982  3, // Protocol version983  194, // Connect flags984  0, 30, // Keepalive985  0, 4, // Client ID length986  116, 101, 115, 116, // Client ID987  0, 8, // Username length988  117, 115, 101, 114, 110, 97, 109, 101, // Username payload989  0, 0 // Password length990  // Empty password payload991]))992 993testParseGenerate('empty string username and password payload', {994  cmd: 'connect',995  retain: false,996  qos: 0,997  dup: false,998  length: 22,999  protocolId: 'MQIsdp',1000  protocolVersion: 3,1001  clean: true,1002  keepalive: 30,1003  clientId: 'test',1004  username: '',1005  password: Buffer.from('')1006}, Buffer.from([1007  16, 22, // Header1008  0, 6, // Protocol ID length1009  77, 81, 73, 115, 100, 112, // Protocol ID1010  3, // Protocol version1011  194, // Connect flags1012  0, 30, // Keepalive1013  0, 4, // Client ID length1014  116, 101, 115, 116, // Client ID1015  0, 0, // Username length1016  // Empty Username payload1017  0, 0 // Password length1018  // Empty password payload1019]))1020 1021testParseGenerate('maximal connect', {1022  cmd: 'connect',1023  retain: false,1024  qos: 0,1025  dup: false,1026  length: 54,1027  protocolId: 'MQIsdp',1028  protocolVersion: 3,1029  will: {1030    retain: true,1031    qos: 2,1032    topic: 'topic',1033    payload: Buffer.from('payload')1034  },1035  clean: true,1036  keepalive: 30,1037  clientId: 'test',1038  username: 'username',1039  password: Buffer.from('password')1040}, Buffer.from([1041  16, 54, // Header1042  0, 6, // Protocol ID length1043  77, 81, 73, 115, 100, 112, // Protocol ID1044  3, // Protocol version1045  246, // Connect flags1046  0, 30, // Keepalive1047  0, 4, // Client ID length1048  116, 101, 115, 116, // Client ID1049  0, 5, // Will topic length1050  116, 111, 112, 105, 99, // Will topic1051  0, 7, // Will payload length1052  112, 97, 121, 108, 111, 97, 100, // Will payload1053  0, 8, // Username length1054  117, 115, 101, 114, 110, 97, 109, 101, // Username1055  0, 8, // Password length1056  112, 97, 115, 115, 119, 111, 114, 100 // Password1057]))1058 1059testParseGenerate('max connect with special chars', {1060  cmd: 'connect',1061  retain: false,1062  qos: 0,1063  dup: false,1064  length: 57,1065  protocolId: 'MQIsdp',1066  protocolVersion: 3,1067  will: {1068    retain: true,1069    qos: 2,1070    topic: 'tòpic',1071    payload: Buffer.from('pay£oad')1072  },1073  clean: true,1074  keepalive: 30,1075  clientId: 'te$t',1076  username: 'u$ern4me',1077  password: Buffer.from('p4$$w0£d')1078}, Buffer.from([1079  16, 57, // Header1080  0, 6, // Protocol ID length1081  77, 81, 73, 115, 100, 112, // Protocol ID1082  3, // Protocol version1083  246, // Connect flags1084  0, 30, // Keepalive1085  0, 4, // Client ID length1086  116, 101, 36, 116, // Client ID1087  0, 6, // Will topic length1088  116, 195, 178, 112, 105, 99, // Will topic1089  0, 8, // Will payload length1090  112, 97, 121, 194, 163, 111, 97, 100, // Will payload1091  0, 8, // Username length1092  117, 36, 101, 114, 110, 52, 109, 101, // Username1093  0, 9, // Password length1094  112, 52, 36, 36, 119, 48, 194, 163, 100 // Password1095]))1096 1097testGenerateOnly('connect all strings generate', {1098  cmd: 'connect',1099  retain: false,1100  qos: 0,1101  dup: false,1102  length: 54,1103  protocolId: 'MQIsdp',1104  protocolVersion: 3,1105  will: {1106    retain: true,1107    qos: 2,1108    topic: 'topic',1109    payload: 'payload'1110  },1111  clean: true,1112  keepalive: 30,1113  clientId: 'test',1114  username: 'username',1115  password: 'password'1116}, Buffer.from([1117  16, 54, // Header1118  0, 6, // Protocol ID length1119  77, 81, 73, 115, 100, 112, // Protocol ID1120  3, // Protocol version1121  246, // Connect flags1122  0, 30, // Keepalive1123  0, 4, // Client ID length1124  116, 101, 115, 116, // Client ID1125  0, 5, // Will topic length1126  116, 111, 112, 105, 99, // Will topic1127  0, 7, // Will payload length1128  112, 97, 121, 108, 111, 97, 100, // Will payload1129  0, 8, // Username length1130  117, 115, 101, 114, 110, 97, 109, 101, // Username1131  0, 8, // Password length1132  112, 97, 115, 115, 119, 111, 114, 100 // Password1133]))1134 1135testParseError('Cannot parse protocolId', Buffer.from([1136  16, 4,1137  0, 6,1138  77, 811139]))1140 1141// missing protocol version on connect1142testParseError('Packet too short', Buffer.from([1143  16, 8, // Header1144  0, 6, // Protocol ID length1145  77, 81, 73, 115, 100, 112 // Protocol ID1146]))1147 1148// missing keepalive on connect1149testParseError('Packet too short', Buffer.from([1150  16, 10, // Header1151  0, 6, // Protocol ID length1152  77, 81, 73, 115, 100, 112, // Protocol ID1153  3, // Protocol version1154  246 // Connect flags1155]))1156 1157// missing clientid on connect1158testParseError('Packet too short', Buffer.from([1159  16, 10, // Header1160  0, 6, // Protocol ID length1161  77, 81, 73, 115, 100, 112, // Protocol ID1162  3, // Protocol version1163  246, // Connect flags1164  0, 30 // Keepalive1165]))1166 1167// missing will topic on connect1168testParseError('Cannot parse will topic', Buffer.from([1169  16, 16, // Header1170  0, 6, // Protocol ID length1171  77, 81, 73, 115, 100, 112, // Protocol ID1172  3, // Protocol version1173  246, // Connect flags1174  0, 30, // Keepalive1175  0, 2, // Will topic length1176  0, 0 // Will topic1177]))1178 1179// missing will payload on connect1180testParseError('Cannot parse will payload', Buffer.from([1181  16, 23, // Header1182  0, 6, // Protocol ID length1183  77, 81, 73, 115, 100, 112, // Protocol ID1184  3, // Protocol version1185  246, // Connect flags1186  0, 30, // Keepalive1187  0, 5, // Will topic length1188  116, 111, 112, 105, 99, // Will topic1189  0, 2, // Will payload length1190  0, 0 // Will payload1191]))1192 1193// missing username on connect1194testParseError('Cannot parse username', Buffer.from([1195  16, 32, // Header1196  0, 6, // Protocol ID length1197  77, 81, 73, 115, 100, 112, // Protocol ID1198  3, // Protocol version1199  246, // Connect flags1200  0, 30, // Keepalive1201  0, 5, // Will topic length1202  116, 111, 112, 105, 99, // Will topic1203  0, 7, // Will payload length1204  112, 97, 121, 108, 111, 97, 100, // Will payload1205  0, 2, // Username length1206  0, 0 // Username1207]))1208 1209// missing password on connect1210testParseError('Cannot parse password', Buffer.from([1211  16, 42, // Header1212  0, 6, // Protocol ID length1213  77, 81, 73, 115, 100, 112, // Protocol ID1214  3, // Protocol version1215  246, // Connect flags1216  0, 30, // Keepalive1217  0, 5, // Will topic length1218  116, 111, 112, 105, 99, // Will topic1219  0, 7, // Will payload length1220  112, 97, 121, 108, 111, 97, 100, // Will payload1221  0, 8, // Username length1222  117, 115, 101, 114, 110, 97, 109, 101, // Username1223  0, 2, // Password length1224  0, 0 // Password1225]))1226 1227testParseGenerate('connack with return code 0', {1228  cmd: 'connack',1229  retain: false,1230  qos: 0,1231  dup: false,1232  length: 2,1233  sessionPresent: false,1234  returnCode: 01235}, Buffer.from([1236  32, 2, 0, 01237]))1238 1239testParseGenerate('connack MQTT 5 with properties', {1240  cmd: 'connack',1241  retain: false,1242  qos: 0,1243  dup: false,1244  length: 87,1245  sessionPresent: false,1246  reasonCode: 0,1247  properties: {1248    sessionExpiryInterval: 1234,1249    receiveMaximum: 432,1250    maximumQoS: 2,1251    retainAvailable: true,1252    maximumPacketSize: 100,1253    assignedClientIdentifier: 'test',1254    topicAliasMaximum: 456,1255    reasonString: 'test',1256    userProperties: {1257      test: 'test'1258    },1259    wildcardSubscriptionAvailable: true,1260    subscriptionIdentifiersAvailable: true,1261    sharedSubscriptionAvailable: false,1262    serverKeepAlive: 1234,1263    responseInformation: 'test',1264    serverReference: 'test',1265    authenticationMethod: 'test',1266    authenticationData: Buffer.from([1, 2, 3, 4])1267  }1268}, Buffer.from([1269  32, 87, 0, 0,1270  84, // properties length1271  17, 0, 0, 4, 210, // sessionExpiryInterval1272  33, 1, 176, // receiveMaximum1273  36, 2, // Maximum qos1274  37, 1, // retainAvailable1275  39, 0, 0, 0, 100, // maximumPacketSize1276  18, 0, 4, 116, 101, 115, 116, // assignedClientIdentifier1277  34, 1, 200, // topicAliasMaximum1278  31, 0, 4, 116, 101, 115, 116, // reasonString1279  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties1280  40, 1, // wildcardSubscriptionAvailable1281  41, 1, // subscriptionIdentifiersAvailable1282  42, 0, // sharedSubscriptionAvailable1283  19, 4, 210, // serverKeepAlive1284  26, 0, 4, 116, 101, 115, 116, // responseInformation1285  28, 0, 4, 116, 101, 115, 116, // serverReference1286  21, 0, 4, 116, 101, 115, 116, // authenticationMethod1287  22, 0, 4, 1, 2, 3, 4 // authenticationData1288]), { protocolVersion: 5 })1289 1290testParseGenerate('connack MQTT 5 with properties and doubled user properties', {1291  cmd: 'connack',1292  retain: false,1293  qos: 0,1294  dup: false,1295  length: 100,1296  sessionPresent: false,1297  reasonCode: 0,1298  properties: {1299    sessionExpiryInterval: 1234,1300    receiveMaximum: 432,1301    maximumQoS: 2,1302    retainAvailable: true,1303    maximumPacketSize: 100,1304    assignedClientIdentifier: 'test',1305    topicAliasMaximum: 456,1306    reasonString: 'test',1307    userProperties: {1308      test: ['test', 'test']1309    },1310    wildcardSubscriptionAvailable: true,1311    subscriptionIdentifiersAvailable: true,1312    sharedSubscriptionAvailable: false,1313    serverKeepAlive: 1234,1314    responseInformation: 'test',1315    serverReference: 'test',1316    authenticationMethod: 'test',1317    authenticationData: Buffer.from([1, 2, 3, 4])1318  }1319}, Buffer.from([1320  32, 100, 0, 0,1321  97, // properties length1322  17, 0, 0, 4, 210, // sessionExpiryInterval1323  33, 1, 176, // receiveMaximum1324  36, 2, // Maximum qos1325  37, 1, // retainAvailable1326  39, 0, 0, 0, 100, // maximumPacketSize1327  18, 0, 4, 116, 101, 115, 116, // assignedClientIdentifier1328  34, 1, 200, // topicAliasMaximum1329  31, 0, 4, 116, 101, 115, 116, // reasonString1330  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116,1331  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties1332  40, 1, // wildcardSubscriptionAvailable1333  41, 1, // subscriptionIdentifiersAvailable1334  42, 0, // sharedSubscriptionAvailable1335  19, 4, 210, // serverKeepAlive1336  26, 0, 4, 116, 101, 115, 116, // responseInformation1337  28, 0, 4, 116, 101, 115, 116, // serverReference1338  21, 0, 4, 116, 101, 115, 116, // authenticationMethod1339  22, 0, 4, 1, 2, 3, 4 // authenticationData1340]), { protocolVersion: 5 })1341 1342testParseGenerate('connack with return code 0 session present bit set', {1343  cmd: 'connack',1344  retain: false,1345  qos: 0,1346  dup: false,1347  length: 2,1348  sessionPresent: true,1349  returnCode: 01350}, Buffer.from([1351  32, 2, 1, 01352]))1353 1354testParseGenerate('connack with return code 5', {1355  cmd: 'connack',1356  retain: false,1357  qos: 0,1358  dup: false,1359  length: 2,1360  sessionPresent: false,1361  returnCode: 51362}, Buffer.from([1363  32, 2, 0, 51364]))1365 1366testGenerateError('Invalid return code', {1367  cmd: 'connack',1368  retain: false,1369  qos: 0,1370  dup: false,1371  length: 2,1372  sessionPresent: false,1373  returnCode: '5' // returncode must be a number1374})1375 1376testParseGenerate('minimal publish', {1377  cmd: 'publish',1378  retain: false,1379  qos: 0,1380  dup: false,1381  length: 10,1382  topic: 'test',1383  payload: Buffer.from('test')1384}, Buffer.from([1385  48, 10, // Header1386  0, 4, // Topic length1387  116, 101, 115, 116, // Topic (test)1388  116, 101, 115, 116 // Payload (test)1389]))1390 1391testParseGenerate('publish MQTT 5 properties', {1392  cmd: 'publish',1393  retain: true,1394  qos: 2,1395  dup: true,1396  length: 86,1397  topic: 'test',1398  payload: Buffer.from('test'),1399  messageId: 10,1400  properties: {1401    payloadFormatIndicator: true,1402    messageExpiryInterval: 4321,1403    topicAlias: 100,1404    responseTopic: 'topic',1405    correlationData: Buffer.from([1, 2, 3, 4]),1406    userProperties: {1407      test: ['test', 'test', 'test']1408    },1409    subscriptionIdentifier: 120,1410    contentType: 'test'1411  }1412}, Buffer.from([1413  61, 86, // Header1414  0, 4, // Topic length1415  116, 101, 115, 116, // Topic (test)1416  0, 10, // Message ID1417  73, // properties length1418  1, 1, // payloadFormatIndicator1419  2, 0, 0, 16, 225, // message expiry interval1420  35, 0, 100, // topicAlias1421  8, 0, 5, 116, 111, 112, 105, 99, // response topic1422  9, 0, 4, 1, 2, 3, 4, // correlationData1423  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties1424  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties1425  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties1426  11, 120, // subscriptionIdentifier1427  3, 0, 4, 116, 101, 115, 116, // content type1428  116, 101, 115, 116 // Payload (test)1429]), { protocolVersion: 5 })1430 1431testParseGenerate('publish MQTT 5 with multiple same properties', {1432  cmd: 'publish',1433  retain: true,1434  qos: 2,1435  dup: true,1436  length: 64,1437  topic: 'test',1438  payload: Buffer.from('test'),1439  messageId: 10,1440  properties: {1441    payloadFormatIndicator: true,1442    messageExpiryInterval: 4321,1443    topicAlias: 100,1444    responseTopic: 'topic',1445    correlationData: Buffer.from([1, 2, 3, 4]),1446    userProperties: {1447      test: 'test'1448    },1449    subscriptionIdentifier: [120, 121, 122],1450    contentType: 'test'1451  }1452}, Buffer.from([1453  61, 64, // Header1454  0, 4, // Topic length1455  116, 101, 115, 116, // Topic (test)1456  0, 10, // Message ID1457  51, // properties length1458  1, 1, // payloadFormatIndicator1459  2, 0, 0, 16, 225, // message expiry interval1460  35, 0, 100, // topicAlias1461  8, 0, 5, 116, 111, 112, 105, 99, // response topic1462  9, 0, 4, 1, 2, 3, 4, // correlationData1463  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties1464  11, 120, // subscriptionIdentifier1465  11, 121, // subscriptionIdentifier1466  11, 122, // subscriptionIdentifier1467  3, 0, 4, 116, 101, 115, 116, // content type1468  116, 101, 115, 116 // Payload (test)1469]), { protocolVersion: 5 })1470 1471testParseGenerate('publish MQTT 5 properties with 0-4 byte varbyte', {1472  cmd: 'publish',1473  retain: true,1474  qos: 2,1475  dup: true,1476  length: 27,1477  topic: 'test',1478  payload: Buffer.from('test'),1479  messageId: 10,1480  properties: {1481    payloadFormatIndicator: false,1482    subscriptionIdentifier: [128, 16384, 2097152] // this tests the varbyte handling1483  }1484}, Buffer.from([1485  61, 27, // Header1486  0, 4, // Topic length1487  116, 101, 115, 116, // Topic (test)1488  0, 10, // Message ID1489  14, // properties length1490  1, 0, // payloadFormatIndicator1491  11, 128, 1, // subscriptionIdentifier1492  11, 128, 128, 1, // subscriptionIdentifier1493  11, 128, 128, 128, 1, // subscriptionIdentifier1494  116, 101, 115, 116 // Payload (test)1495]), { protocolVersion: 5 })1496 1497testParseGenerate('publish MQTT 5 properties with max value varbyte', {1498  cmd: 'publish',1499  retain: true,1500  qos: 2,1501  dup: true,1502  length: 22,1503  topic: 'test',1504  payload: Buffer.from('test'),1505  messageId: 10,1506  properties: {1507    payloadFormatIndicator: false,1508    subscriptionIdentifier: [1, 268435455]1509  }1510}, Buffer.from([1511  61, 22, // Header1512  0, 4, // Topic length1513  116, 101, 115, 116, // Topic (test)1514  0, 10, // Message ID1515  9, // properties length1516  1, 0, // payloadFormatIndicator1517  11, 1, // subscriptionIdentifier1518  11, 255, 255, 255, 127, // subscriptionIdentifier (max value)1519  116, 101, 115, 116 // Payload (test)1520]), { protocolVersion: 5 })1521 1522; (() => {1523  const buffer = Buffer.alloc(2048)1524  testParseGenerate('2KB publish packet', {1525    cmd: 'publish',1526    retain: false,1527    qos: 0,1528    dup: false,1529    length: 2054,1530    topic: 'test',1531    payload: buffer1532  }, Buffer.concat([Buffer.from([1533    48, 134, 16, // Header1534    0, 4, // Topic length1535    116, 101, 115, 116 // Topic (test)1536  ]), buffer]))1537})()1538 1539; (() => {1540  const maxLength = 2684354551541  const buffer = Buffer.alloc(maxLength - 6)1542  testParseGenerate('Max payload publish packet', {1543    cmd: 'publish',1544    retain: false,1545    qos: 0,1546    dup: false,1547    length: maxLength,1548    topic: 'test',1549    payload: buffer1550  }, Buffer.concat([Buffer.from([1551    48, 255, 255, 255, 127, // Header1552    0, 4, // Topic length1553    116, 101, 115, 116 // Topic (test)1554  ]), buffer]))1555})()1556 1557testParseGenerate('maximal publish', {1558  cmd: 'publish',1559  retain: true,1560  qos: 2,1561  length: 12,1562  dup: true,1563  topic: 'test',1564  messageId: 10,1565  payload: Buffer.from('test')1566}, Buffer.from([1567  61, 12, // Header1568  0, 4, // Topic length1569  116, 101, 115, 116, // Topic1570  0, 10, // Message ID1571  116, 101, 115, 116 // Payload1572]))1573 1574test('publish all strings generate', t => {1575  const message = {1576    cmd: 'publish',1577    retain: true,1578    qos: 2,1579    length: 12,1580    dup: true,1581    topic: 'test',1582    messageId: 10,1583    payload: Buffer.from('test')1584  }1585  const expected = Buffer.from([1586    61, 12, // Header1587    0, 4, // Topic length1588    116, 101, 115, 116, // Topic1589    0, 10, // Message ID1590    116, 101, 115, 116 // Payload1591  ])1592 1593  t.equal(mqtt.generate(message).toString('hex'), expected.toString('hex'))1594  t.end()1595})1596 1597testParseGenerate('empty publish', {1598  cmd: 'publish',1599  retain: false,1600  qos: 0,1601  dup: false,1602  length: 6,1603  topic: 'test',1604  payload: Buffer.alloc(0)1605}, Buffer.from([1606  48, 6, // Header1607  0, 4, // Topic length1608  116, 101, 115, 116 // Topic1609  // Empty payload1610]))1611 1612test('splitted publish parse', t => {1613  t.plan(3)1614 1615  const parser = mqtt.parser()1616  const expected = {1617    cmd: 'publish',1618    retain: false,1619    qos: 0,1620    dup: false,1621    length: 10,1622    topic: 'test',1623    payload: Buffer.from('test')1624  }1625 1626  parser.on('packet', packet => {1627    t.deepLooseEqual(packet, expected, 'expected packet')1628  })1629 1630  t.equal(parser.parse(Buffer.from([1631    48, 10, // Header1632    0, 4, // Topic length1633    116, 101, 115, 116 // Topic (test)1634  ])), 6, 'remaining bytes')1635 1636  t.equal(parser.parse(Buffer.from([1637    116, 101, 115, 116 // Payload (test)1638  ])), 0, 'remaining bytes')1639})1640 1641test('split publish longer', t => {1642  t.plan(3)1643 1644  const length = 2551645  const topic = 'test'1646  // Minus two bytes for the topic length specifier1647  const payloadLength = length - topic.length - 21648 1649  const parser = mqtt.parser()1650  const expected = {1651    cmd: 'publish',1652    retain: false,1653    qos: 0,1654    dup: false,1655    length: length,1656    topic: topic,1657    payload: Buffer.from('a'.repeat(payloadLength))1658  }1659 1660  parser.on('packet', packet => {1661    t.deepLooseEqual(packet, expected, 'expected packet')1662  })1663 1664  t.equal(parser.parse(Buffer.from([1665    48, 255, 1, // Header1666    0, topic.length, // Topic length1667    116, 101, 115, 116 // Topic (test)1668  ])), 6, 'remaining bytes')1669 1670  t.equal(parser.parse(Buffer.from(Array(payloadLength).fill(97))),1671    0, 'remaining bytes')1672})1673 1674test('split length parse', t => {1675  t.plan(4)1676 1677  const length = 2551678  const topic = 'test'1679  const payloadLength = length - topic.length - 21680 1681  const parser = mqtt.parser()1682  const expected = {1683    cmd: 'publish',1684    retain: false,1685    qos: 0,1686    dup: false,1687    length: length,1688    topic: topic,1689    payload: Buffer.from('a'.repeat(payloadLength))1690  }1691 1692  parser.on('packet', packet => {1693    t.deepLooseEqual(packet, expected, 'expected packet')1694  })1695 1696  t.equal(parser.parse(Buffer.from([1697    48, 255 // Header (partial length)1698  ])), 1, 'remaining bytes')1699 1700  t.equal(parser.parse(Buffer.from([1701    1, // Rest of header length1702    0, topic.length, // Topic length1703    116, 101, 115, 116 // Topic (test)1704  ])), 6, 'remaining bytes')1705 1706  t.equal(parser.parse(Buffer.from(Array(payloadLength).fill(97))),1707    0, 'remaining bytes')1708})1709 1710testGenerateError('Invalid variable byte integer: 268435456', {1711  cmd: 'publish',1712  retain: false,1713  qos: 0,1714  dup: false,1715  length: (268435455 + 1),1716  topic: 'test',1717  payload: Buffer.alloc(268435455 + 1 - 6)1718}, {}, 'Length var byte integer over max allowed value throws error')1719 1720testGenerateError('Invalid subscriptionIdentifier: 268435456', {1721  cmd: 'publish',1722  retain: true,1723  qos: 2,1724  dup: true,1725  length: 27,1726  topic: 'test',1727  payload: Buffer.from('test'),1728  messageId: 10,1729  properties: {1730    payloadFormatIndicator: false,1731    subscriptionIdentifier: 2684354561732  }1733}, { protocolVersion: 5 }, 'MQTT 5.0 var byte integer >24 bits throws error')1734 1735testParseGenerate('puback', {1736  cmd: 'puback',1737  retain: false,1738  qos: 0,1739  dup: false,1740  length: 2,1741  messageId: 21742}, Buffer.from([1743  64, 2, // Header1744  0, 2 // Message ID1745]))1746 1747testParseGenerate('puback with reason and no MQTT 5 properties', {1748  cmd: 'puback',1749  retain: false,1750  qos: 0,1751  dup: false,1752  length: 3,1753  messageId: 2,1754  reasonCode: 161755}, Buffer.from([1756  64, 3, // Header1757  0, 2, // Message ID1758  16 // reason code1759]), { protocolVersion: 5 })1760 1761testParseGenerate('puback MQTT 5 properties', {1762  cmd: 'puback',1763  retain: false,1764  qos: 0,1765  dup: false,1766  length: 24,1767  messageId: 2,1768  reasonCode: 16,1769  properties: {1770    reasonString: 'test',1771    userProperties: {1772      test: 'test'1773    }1774  }1775}, Buffer.from([1776  64, 24, // Header1777  0, 2, // Message ID1778  16, // reason code1779  20, // properties length1780  31, 0, 4, 116, 101, 115, 116, // reasonString1781  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116 // userProperties1782]), { protocolVersion: 5 })1783 1784testParseGenerate('pubrec', {1785  cmd: 'pubrec',1786  retain: false,1787  qos: 0,1788  dup: false,1789  length: 2,1790  messageId: 21791}, Buffer.from([1792  80, 2, // Header1793  0, 2 // Message ID1794]))1795 1796testParseGenerate('pubrec MQTT 5 properties', {1797  cmd: 'pubrec',1798  retain: false,1799  qos: 0,1800  dup: false,1801  length: 24,1802  messageId: 2,1803  reasonCode: 16,1804  properties: {1805    reasonString: 'test',1806    userProperties: {1807      test: 'test'1808    }1809  }1810}, Buffer.from([1811  80, 24, // Header1812  0, 2, // Message ID1813  16, // reason code1814  20, // properties length1815  31, 0, 4, 116, 101, 115, 116, // reasonString1816  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116 // userProperties1817]), { protocolVersion: 5 })1818 1819testParseGenerate('pubrel', {1820  cmd: 'pubrel',1821  retain: false,1822  qos: 1,1823  dup: false,1824  length: 2,1825  messageId: 21826}, Buffer.from([1827  98, 2, // Header1828  0, 2 // Message ID1829]))1830 1831testParseGenerate('pubrel MQTT5 properties', {1832  cmd: 'pubrel',1833  retain: false,1834  qos: 1,1835  dup: false,1836  length: 24,1837  messageId: 2,1838  reasonCode: 16,1839  properties: {1840    reasonString: 'test',1841    userProperties: {1842      test: 'test'1843    }1844  }1845}, Buffer.from([1846  98, 24, // Header1847  0, 2, // Message ID1848  16, // reason code1849  20, // properties length1850  31, 0, 4, 116, 101, 115, 116, // reasonString1851  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116 // userProperties1852]), { protocolVersion: 5 })1853 1854testParseGenerate('pubcomp', {1855  cmd: 'pubcomp',1856  retain: false,1857  qos: 0,1858  dup: false,1859  length: 2,1860  messageId: 21861}, Buffer.from([1862  112, 2, // Header1863  0, 2 // Message ID1864]))1865 1866testParseGenerate('pubcomp MQTT 5 properties', {1867  cmd: 'pubcomp',1868  retain: false,1869  qos: 0,1870  dup: false,1871  length: 24,1872  messageId: 2,1873  reasonCode: 16,1874  properties: {1875    reasonString: 'test',1876    userProperties: {1877      test: 'test'1878    }1879  }1880}, Buffer.from([1881  112, 24, // Header1882  0, 2, // Message ID1883  16, // reason code1884  20, // properties length1885  31, 0, 4, 116, 101, 115, 116, // reasonString1886  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116 // userProperties1887]), { protocolVersion: 5 })1888 1889testParseError('Wrong subscribe header', Buffer.from([1890  128, 9, // Header (subscribeqos=0length=9)1891  0, 6, // Message ID (6)1892  0, 4, // Topic length,1893  116, 101, 115, 116, // Topic (test)1894  0 // Qos (0)1895]))1896 1897testParseGenerate('subscribe to one topic', {1898  cmd: 'subscribe',1899  retain: false,1900  qos: 1,1901  dup: false,1902  length: 9,1903  subscriptions: [1904    {1905      topic: 'test',1906      qos: 01907    }1908  ],1909  messageId: 61910}, Buffer.from([1911  130, 9, // Header (subscribeqos=1length=9)1912  0, 6, // Message ID (6)1913  0, 4, // Topic length,1914  116, 101, 115, 116, // Topic (test)1915  0 // Qos (0)1916]))1917 1918testParseGenerate('subscribe to one topic by MQTT 5', {1919  cmd: 'subscribe',1920  retain: false,1921  qos: 1,1922  dup: false,1923  length: 26,1924  subscriptions: [1925    {1926      topic: 'test',1927      qos: 0,1928      nl: false,1929      rap: true,1930      rh: 11931    }1932  ],1933  messageId: 6,1934  properties: {1935    subscriptionIdentifier: 145,1936    userProperties: {1937      test: 'test'1938    }1939  }1940}, Buffer.from([1941  130, 26, // Header (subscribeqos=1length=9)1942  0, 6, // Message ID (6)1943  16, // properties length1944  11, 145, 1, // subscriptionIdentifier1945  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties1946  0, 4, // Topic length,1947  116, 101, 115, 116, // Topic (test)1948  24 // settings(qos: 0, noLocal: false, Retain as Published: true, retain handling: 1)1949]), { protocolVersion: 5 })1950 1951testParseGenerate('subscribe to three topics', {1952  cmd: 'subscribe',1953  retain: false,1954  qos: 1,1955  dup: false,1956  length: 23,1957  subscriptions: [1958    {1959      topic: 'test',1960      qos: 01961    }, {1962      topic: 'uest',1963      qos: 11964    }, {1965      topic: 'tfst',1966      qos: 21967    }1968  ],1969  messageId: 61970}, Buffer.from([1971  130, 23, // Header (publishqos=1length=9)1972  0, 6, // Message ID (6)1973  0, 4, // Topic length,1974  116, 101, 115, 116, // Topic (test)1975  0, // Qos (0)1976  0, 4, // Topic length1977  117, 101, 115, 116, // Topic (uest)1978  1, // Qos (1)1979  0, 4, // Topic length1980  116, 102, 115, 116, // Topic (tfst)1981  2 // Qos (2)1982]))1983 1984testParseGenerate('subscribe to 3 topics by MQTT 5', {1985  cmd: 'subscribe',1986  retain: false,1987  qos: 1,1988  dup: false,1989  length: 40,1990  subscriptions: [1991    {1992      topic: 'test',1993      qos: 0,1994      nl: false,1995      rap: true,1996      rh: 11997    },1998    {1999      topic: 'uest',2000      qos: 1,2001      nl: false,2002      rap: false,2003      rh: 02004    }, {2005      topic: 'tfst',2006      qos: 2,2007      nl: true,2008      rap: false,2009      rh: 02010    }2011  ],2012  messageId: 6,2013  properties: {2014    subscriptionIdentifier: 145,2015    userProperties: {2016      test: 'test'2017    }2018  }2019}, Buffer.from([2020  130, 40, // Header (subscribeqos=1length=9)2021  0, 6, // Message ID (6)2022  16, // properties length2023  11, 145, 1, // subscriptionIdentifier2024  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties2025  0, 4, // Topic length,2026  116, 101, 115, 116, // Topic (test)2027  24, // settings(qos: 0, noLocal: false, Retain as Published: true, retain handling: 1)2028  0, 4, // Topic length2029  117, 101, 115, 116, // Topic (uest)2030  1, // Qos (1)2031  0, 4, // Topic length2032  116, 102, 115, 116, // Topic (tfst)2033  6 // Qos (2), No Local: true2034]), { protocolVersion: 5 })2035 2036testParseGenerate('suback', {2037  cmd: 'suback',2038  retain: false,2039  qos: 0,2040  dup: false,2041  length: 6,2042  granted: [0, 1, 2, 128],2043  messageId: 62044}, Buffer.from([2045  144, 6, // Header2046  0, 6, // Message ID2047  0, 1, 2, 128 // Granted qos (0, 1, 2) and a rejected being 0x802048]))2049 2050testParseGenerate('suback MQTT 5', {2051  cmd: 'suback',2052  retain: false,2053  qos: 0,2054  dup: false,2055  length: 27,2056  granted: [0, 1, 2, 128],2057  messageId: 6,2058  properties: {2059    reasonString: 'test',2060    userProperties: {2061      test: 'test'2062    }2063  }2064}, Buffer.from([2065  144, 27, // Header2066  0, 6, // Message ID2067  20, // properties length2068  31, 0, 4, 116, 101, 115, 116, // reasonString2069  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties2070  0, 1, 2, 128 // Granted qos (0, 1, 2) and a rejected being 0x802071]), { protocolVersion: 5 })2072 2073testParseGenerate('unsubscribe', {2074  cmd: 'unsubscribe',2075  retain: false,2076  qos: 1,2077  dup: false,2078  length: 14,2079  unsubscriptions: [2080    'tfst',2081    'test'2082  ],2083  messageId: 72084}, Buffer.from([2085  162, 14,2086  0, 7, // Message ID (7)2087  0, 4, // Topic length2088  116, 102, 115, 116, // Topic (tfst)2089  0, 4, // Topic length,2090  116, 101, 115, 116 // Topic (test)2091]))2092 2093testGenerateError('Invalid unsubscriptions', {2094  cmd: 'unsubscribe',2095  retain: false,2096  qos: 1,2097  dup: true,2098  length: 5,2099  unsubscriptions: 5,2100  messageId: 72101}, {}, 'unsubscribe with unsubscriptions not an array')2102 2103testGenerateError('Invalid unsubscriptions', {2104  cmd: 'unsubscribe',2105  retain: false,2106  qos: 1,2107  dup: true,2108  length: 5,2109  unsubscriptions: [1, 2],2110  messageId: 72111}, {}, 'unsubscribe with unsubscriptions as an object')2112 2113testParseGenerate('unsubscribe MQTT 5', {2114  cmd: 'unsubscribe',2115  retain: false,2116  qos: 1,2117  dup: false,2118  length: 28,2119  unsubscriptions: [2120    'tfst',2121    'test'2122  ],2123  messageId: 7,2124  properties: {2125    userProperties: {2126      test: 'test'2127    }2128  }2129}, Buffer.from([2130  162, 28,2131  0, 7, // Message ID (7)2132  13, // properties length2133  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties2134  0, 4, // Topic length2135  116, 102, 115, 116, // Topic (tfst)2136  0, 4, // Topic length,2137  116, 101, 115, 116 // Topic (test)2138]), { protocolVersion: 5 })2139 2140testParseGenerate('unsuback', {2141  cmd: 'unsuback',2142  retain: false,2143  qos: 0,2144  dup: false,2145  length: 2,2146  messageId: 82147}, Buffer.from([2148  176, 2, // Header2149  0, 8 // Message ID2150]))2151 2152testParseGenerate('unsuback MQTT 5', {2153  cmd: 'unsuback',2154  retain: false,2155  qos: 0,2156  dup: false,2157  length: 25,2158  messageId: 8,2159  properties: {2160    reasonString: 'test',2161    userProperties: {2162      test: 'test'2163    }2164  },2165  granted: [0, 128]2166}, Buffer.from([2167  176, 25, // Header2168  0, 8, // Message ID2169  20, // properties length2170  31, 0, 4, 116, 101, 115, 116, // reasonString2171  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties2172  0, 128 // success and error2173]), { protocolVersion: 5 })2174 2175testParseGenerate('pingreq', {2176  cmd: 'pingreq',2177  retain: false,2178  qos: 0,2179  dup: false,2180  length: 02181}, Buffer.from([2182  192, 0 // Header2183]))2184 2185testParseGenerate('pingresp', {2186  cmd: 'pingresp',2187  retain: false,2188  qos: 0,2189  dup: false,2190  length: 02191}, Buffer.from([2192  208, 0 // Header2193]))2194 2195testParseGenerate('disconnect', {2196  cmd: 'disconnect',2197  retain: false,2198  qos: 0,2199  dup: false,2200  length: 02201}, Buffer.from([2202  224, 0 // Header2203]))2204 2205testParseGenerate('disconnect MQTT 5', {2206  cmd: 'disconnect',2207  retain: false,2208  qos: 0,2209  dup: false,2210  length: 34,2211  reasonCode: 0,2212  properties: {2213    sessionExpiryInterval: 145,2214    reasonString: 'test',2215    userProperties: {2216      test: 'test'2217    },2218    serverReference: 'test'2219  }2220}, Buffer.from([2221  224, 34, // Header2222  0, // reason code2223  32, // properties length2224  17, 0, 0, 0, 145, // sessionExpiryInterval2225  31, 0, 4, 116, 101, 115, 116, // reasonString2226  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties2227  28, 0, 4, 116, 101, 115, 116// serverReference2228]), { protocolVersion: 5 })2229 2230testParseGenerate('disconnect MQTT 5 with no properties', {2231  cmd: 'disconnect',2232  retain: false,2233  qos: 0,2234  dup: false,2235  length: 2,2236  reasonCode: 02237}, Buffer.from([2238  224, 2, // Fixed Header (DISCONNECT, Remaining Length)2239  0, // Reason Code (Normal Disconnection)2240  0 // Property Length (0 => No Properties)2241]), { protocolVersion: 5 })2242 2243testParseGenerate('auth MQTT 5', {2244  cmd: 'auth',2245  retain: false,2246  qos: 0,2247  dup: false,2248  length: 36,2249  reasonCode: 0,2250  properties: {2251    authenticationMethod: 'test',2252    authenticationData: Buffer.from([0, 1, 2, 3]),2253    reasonString: 'test',2254    userProperties: {2255      test: 'test'2256    }2257  }2258}, Buffer.from([2259  240, 36, // Header2260  0, // reason code2261  34, // properties length2262  21, 0, 4, 116, 101, 115, 116, // auth method2263  22, 0, 4, 0, 1, 2, 3, // auth data2264  31, 0, 4, 116, 101, 115, 116, // reasonString2265  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116 // userProperties2266]), { protocolVersion: 5 })2267 2268testGenerateError('Invalid protocolId', {2269  cmd: 'connect',2270  retain: false,2271  qos: 0,2272  dup: false,2273  length: 54,2274  protocolId: 42,2275  protocolVersion: 3,2276  will: {2277    retain: true,2278    qos: 2,2279    topic: 'topic',2280    payload: 'payload'2281  },2282  clean: true,2283  keepalive: 30,2284  clientId: 'test',2285  username: 'username',2286  password: 'password'2287})2288 2289testGenerateError('Invalid protocol version', {2290  cmd: 'connect',2291  retain: false,2292  qos: 0,2293  dup: false,2294  length: 54,2295  protocolId: 'MQIsdp',2296  protocolVersion: 1,2297  will: {2298    retain: true,2299    qos: 2,2300    topic: 'topic',2301    payload: 'payload'2302  },2303  clean: true,2304  keepalive: 30,2305  clientId: 'test',2306  username: 'username',2307  password: 'password'2308})2309 2310testGenerateError('clientId must be supplied before 3.1.1', {2311  cmd: 'connect',2312  retain: false,2313  qos: 0,2314  dup: false,2315  length: 54,2316  protocolId: 'MQIsdp',2317  protocolVersion: 3,2318  will: {2319    retain: true,2320    qos: 2,2321    topic: 'topic',2322    payload: 'payload'2323  },2324  clean: true,2325  keepalive: 30,2326  username: 'username',2327  password: 'password'2328})2329 2330testGenerateError('clientId must be given if cleanSession set to 0', {2331  cmd: 'connect',2332  retain: false,2333  qos: 0,2334  dup: false,2335  length: 54,2336  protocolId: 'MQTT',2337  protocolVersion: 4,2338  will: {2339    retain: true,2340    qos: 2,2341    topic: 'topic',2342    payload: 'payload'2343  },2344  clean: false,2345  keepalive: 30,2346  username: 'username',2347  password: 'password'2348})2349 2350testGenerateError('Invalid keepalive', {2351  cmd: 'connect',2352  retain: false,2353  qos: 0,2354  dup: false,2355  length: 54,2356  protocolId: 'MQIsdp',2357  protocolVersion: 3,2358  will: {2359    retain: true,2360    qos: 2,2361    topic: 'topic',2362    payload: 'payload'2363  },2364  clean: true,2365  keepalive: 'hello',2366  clientId: 'test',2367  username: 'username',2368  password: 'password'2369})2370 2371testGenerateError('Invalid keepalive', {2372  cmd: 'connect',2373  keepalive: 3.14162374})2375 2376testGenerateError('Invalid will', {2377  cmd: 'connect',2378  retain: false,2379  qos: 0,2380  dup: false,2381  length: 54,2382  protocolId: 'MQIsdp',2383  protocolVersion: 3,2384  will: 42,2385  clean: true,2386  keepalive: 30,2387  clientId: 'test',2388  username: 'username',2389  password: 'password'2390})2391 2392testGenerateError('Invalid will topic', {2393  cmd: 'connect',2394  retain: false,2395  qos: 0,2396  dup: false,2397  length: 54,2398  protocolId: 'MQIsdp',2399  protocolVersion: 3,2400  will: {2401    retain: true,2402    qos: 2,2403    payload: 'payload'2404  },2405  clean: true,2406  keepalive: 30,2407  clientId: 'test',2408  username: 'username',2409  password: 'password'2410})2411 2412testGenerateError('Invalid will payload', {2413  cmd: 'connect',2414  retain: false,2415  qos: 0,2416  dup: false,2417  length: 54,2418  protocolId: 'MQIsdp',2419  protocolVersion: 3,2420  will: {2421    retain: true,2422    qos: 2,2423    topic: 'topic',2424    payload: 422425  },2426  clean: true,2427  keepalive: 30,2428  clientId: 'test',2429  username: 'username',2430  password: 'password'2431})2432 2433testGenerateError('Invalid username', {2434  cmd: 'connect',2435  retain: false,2436  qos: 0,2437  dup: false,2438  length: 54,2439  protocolId: 'MQIsdp',2440  protocolVersion: 3,2441  will: {2442    retain: true,2443    qos: 2,2444    topic: 'topic',2445    payload: 'payload'2446  },2447  clean: true,2448  keepalive: 30,2449  clientId: 'test',2450  username: 42,2451  password: 'password'2452})2453 2454testGenerateError('Invalid password', {2455  cmd: 'connect',2456  retain: false,2457  qos: 0,2458  dup: false,2459  length: 54,2460  protocolId: 'MQIsdp',2461  protocolVersion: 3,2462  will: {2463    retain: true,2464    qos: 2,2465    topic: 'topic',2466    payload: 'payload'2467  },2468  clean: true,2469  keepalive: 30,2470  clientId: 'test',2471  username: 'username',2472  password: 422473})2474 2475testGenerateError('Username is required to use password', {2476  cmd: 'connect',2477  retain: false,2478  qos: 0,2479  dup: false,2480  length: 54,2481  protocolId: 'MQIsdp',2482  protocolVersion: 3,2483  will: {2484    retain: true,2485    qos: 2,2486    topic: 'topic',2487    payload: 'payload'2488  },2489  clean: true,2490  keepalive: 30,2491  clientId: 'test',2492  password: 'password'2493})2494 2495testGenerateError('Invalid messageExpiryInterval: -4321', {2496  cmd: 'publish',2497  retain: true,2498  qos: 2,2499  dup: true,2500  length: 60,2501  topic: 'test',2502  payload: Buffer.from('test'),2503  messageId: 10,2504  properties: {2505    payloadFormatIndicator: true,2506    messageExpiryInterval: -4321,2507    topicAlias: 100,2508    responseTopic: 'topic',2509    correlationData: Buffer.from([1, 2, 3, 4]),2510    userProperties: {2511      test: 'test'2512    },2513    subscriptionIdentifier: 120,2514    contentType: 'test'2515  }2516}, { protocolVersion: 5 })2517 2518testGenerateError('Invalid topicAlias: -100', {2519  cmd: 'publish',2520  retain: true,2521  qos: 2,2522  dup: true,2523  length: 60,2524  topic: 'test',2525  payload: Buffer.from('test'),2526  messageId: 10,2527  properties: {2528    payloadFormatIndicator: true,2529    messageExpiryInterval: 4321,2530    topicAlias: -100,2531    responseTopic: 'topic',2532    correlationData: Buffer.from([1, 2, 3, 4]),2533    userProperties: {2534      test: 'test'2535    },2536    subscriptionIdentifier: 120,2537    contentType: 'test'2538  }2539}, { protocolVersion: 5 })2540 2541testGenerateError('Invalid subscriptionIdentifier: -120', {2542  cmd: 'publish',2543  retain: true,2544  qos: 2,2545  dup: true,2546  length: 60,2547  topic: 'test',2548  payload: Buffer.from('test'),2549  messageId: 10,2550  properties: {2551    payloadFormatIndicator: true,2552    messageExpiryInterval: 4321,2553    topicAlias: 100,2554    responseTopic: 'topic',2555    correlationData: Buffer.from([1, 2, 3, 4]),2556    userProperties: {2557      test: 'test'2558    },2559    subscriptionIdentifier: -120,2560    contentType: 'test'2561  }2562}, { protocolVersion: 5 })2563 2564test('support cork', t => {2565  t.plan(9)2566 2567  const dest = WS()2568 2569  dest._write = (chunk, enc, cb) => {2570    t.pass('_write called')2571    cb()2572  }2573 2574  mqtt.writeToStream({2575    cmd: 'connect',2576    retain: false,2577    qos: 0,2578    dup: false,2579    length: 18,2580    protocolId: 'MQIsdp',2581    protocolVersion: 3,2582    clean: false,2583    keepalive: 30,2584    clientId: 'test'2585  }, dest)2586 2587  dest.end()2588})2589 2590// The following test case was designed after experiencing errors2591// when trying to connect with tls on a non tls mqtt port2592// the specific behaviour is:2593// - first byte suggests this is a connect message2594// - second byte suggests message length to be smaller than buffer length2595//   thus payload processing starts2596// - the first two bytes suggest a protocol identifier string length2597//   that leads the parser pointer close to the end of the buffer2598// - when trying to read further connect flags the buffer produces2599//   a "out of range" Error2600//2601testParseError('Packet too short', Buffer.from([2602  16, 9,2603  0, 6,2604  77, 81, 73, 115, 100, 112,2605  32606]))2607 2608// CONNECT Packets that show other protocol IDs than2609// the valid values MQTT and MQIsdp should cause an error2610// those packets are a hint that this is not a mqtt connection2611testParseError('Invalid protocolId', Buffer.from([2612  16, 18,2613  0, 6,2614  65, 65, 65, 65, 65, 65, // AAAAAA2615  3, // Protocol version2616  0, // Connect flags2617  0, 10, // Keepalive2618  0, 4, // Client ID length2619  116, 101, 115, 116 // Client ID2620]))2621 2622// CONNECT Packets that contain an unsupported protocol version2623// Flag (i.e. not `3` or `4` or '5') should cause an error2624testParseError('Invalid protocol version', Buffer.from([2625  16, 18,2626  0, 6,2627  77, 81, 73, 115, 100, 112, // Protocol ID2628  1, // Protocol version2629  0, // Connect flags2630  0, 10, // Keepalive2631  0, 4, // Client ID length2632  116, 101, 115, 116 // Client ID2633]))2634 2635// When a packet contains a string in the variable header and the2636// given string length of this exceeds the overall length of the packet that2637// was specified in the fixed header, parsing must fail.2638// this case simulates this behavior with the protocol ID string of the2639// CONNECT packet. The fixed header suggests a remaining length of 8 bytes2640// which would be exceeded by the string length of 152641// in this case, a protocol ID parse error is expected2642testParseError('Cannot parse protocolId', Buffer.from([2643  16, 8, // Fixed header2644  0, 15, // string length 15 --> 15 > 8 --> error!2645  77, 81, 73, 115, 100, 112,2646  77, 81, 73, 115, 100, 112,2647  77, 81, 73, 115, 100, 112,2648  77, 81, 73, 115, 100, 112,2649  77, 81, 73, 115, 100, 112,2650  77, 81, 73, 115, 100, 112,2651  77, 81, 73, 115, 100, 112,2652  77, 81, 73, 115, 100, 1122653]))2654 2655testParseError('Unknown property', Buffer.from([2656  61, 60, // Header2657  0, 4, // Topic length2658  116, 101, 115, 116, // Topic (test)2659  0, 10, // Message ID2660  47, // properties length2661  126, 1, // unknown property2662  2, 0, 0, 16, 225, // message expiry interval2663  35, 0, 100, // topicAlias2664  8, 0, 5, 116, 111, 112, 105, 99, // response topic2665  9, 0, 4, 1, 2, 3, 4, // correlationData2666  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116, // userProperties2667  11, 120, // subscriptionIdentifier2668  3, 0, 4, 116, 101, 115, 116, // content type2669  116, 101, 115, 116 // Payload (test)2670]), { protocolVersion: 5 })2671 2672testParseError('Not supported auth packet for this version MQTT', Buffer.from([2673  240, 36, // Header2674  0, // reason code2675  34, // properties length2676  21, 0, 4, 116, 101, 115, 116, // auth method2677  22, 0, 4, 0, 1, 2, 3, // auth data2678  31, 0, 4, 116, 101, 115, 116, // reasonString2679  38, 0, 4, 116, 101, 115, 116, 0, 4, 116, 101, 115, 116 // userProperties2680]))2681 2682// When a Subscribe packet contains a topic_filter and the given2683// length is topic_filter.length + 1 then the last byte (requested QoS) is interpreted as topic_filter2684// reading the requested_qos at the end causes 'Index out of range' read2685testParseError('Malformed Subscribe Payload', Buffer.from([2686  130, 14, // subscribe header and remaining length2687  0, 123, // packet ID2688  0, 10, // topic filter length2689  104, 105, 106, 107, 108, 47, 109, 110, 111, // topic filter with length of 9 bytes2690  0 // requested QoS2691]))2692 2693test('Cannot parse property code type', t => {2694  const packets = Buffer.from([2695    16, 16, 0, 4, 77, 81, 84, 84, 5, 2, 0, 60, 3, 33, 0, 20, 0, 0, 98, 2, 211, 1, 224, 2, 0, 322696  ])2697 2698  t.plan(3)2699 2700  const parser = mqtt.parser()2701 2702  parser.on('error', err => {2703    t.equal(err.message, 'Cannot parse property code type', 'expected error message')2704    t.end()2705  })2706 2707  parser.on('packet', (packet) => {2708    t.pass('Packet parsed')2709  })2710 2711  parser.parse(packets)2712})2713 2714testWriteToStreamError('Invalid command', {2715  cmd: 'invalid'2716})2717 2718testWriteToStreamError('Invalid protocolId', {2719  cmd: 'connect',2720  protocolId: {}2721})2722 2723test('userProperties null prototype', t => {2724  t.plan(3)2725 2726  const packet = mqtt.generate({2727    cmd: 'connect',2728    retain: false,2729    qos: 0,2730    dup: false,2731    length: 125,2732    protocolId: 'MQTT',2733    protocolVersion: 5,2734    will: {2735      retain: true,2736      qos: 2,2737      properties: {2738        willDelayInterval: 1234,2739        payloadFormatIndicator: false,2740        messageExpiryInterval: 4321,2741        contentType: 'test',2742        responseTopic: 'topic',2743        correlationData: Buffer.from([1, 2, 3, 4]),2744        userProperties: {2745          test: 'test'2746        }2747      },2748      topic: 'topic',2749      payload: Buffer.from([4, 3, 2, 1])2750    },2751    clean: true,2752    keepalive: 30,2753    properties: {2754      sessionExpiryInterval: 1234,2755      receiveMaximum: 432,2756      maximumPacketSize: 100,2757      topicAliasMaximum: 456,2758      requestResponseInformation: true,2759      requestProblemInformation: true,2760      userProperties: {2761        test: 'test'2762      },2763      authenticationMethod: 'test',2764      authenticationData: Buffer.from([1, 2, 3, 4])2765    },2766    clientId: 'test'2767  })2768 2769  const parser = mqtt.parser()2770 2771  parser.on('packet', packet => {2772    t.equal(packet.cmd, 'connect')2773    t.equal(Object.getPrototypeOf(packet.properties.userProperties), null)2774    t.equal(Object.getPrototypeOf(packet.will.properties.userProperties), null)2775  })2776 2777  parser.parse(packet)2778})2779 2780test('stops parsing after first error', t => {2781  t.plan(4)2782 2783  const parser = mqtt.parser()2784 2785  let packetCount = 02786  let errorCount = 02787  let expectedPackets = 12788  let expectedErrors = 12789 2790  parser.on('packet', packet => {2791    t.ok(++packetCount <= expectedPackets, `expected <= ${expectedPackets} packets`)2792  })2793 2794  parser.on('error', erroneous => {2795    t.ok(++errorCount <= expectedErrors, `expected <= ${expectedErrors} errors`)2796  })2797 2798  parser.parse(Buffer.from([2799    // First, a valid connect packet:2800 2801    16, 12, // Header2802    0, 4, // Protocol ID length2803    77, 81, 84, 84, // Protocol ID2804    4, // Protocol version2805    2, // Connect flags2806    0, 30, // Keepalive2807    0, 0, // Client ID length2808 2809    // Then an invalid subscribe packet:2810 2811    128, 9, // Header (subscribeqos=0length=9)2812    0, 6, // Message ID (6)2813    0, 4, // Topic length,2814    116, 101, 115, 116, // Topic (test)2815    0, // Qos (0)2816 2817    // And another invalid subscribe packet:2818 2819    128, 9, // Header (subscribeqos=0length=9)2820    0, 6, // Message ID (6)2821    0, 4, // Topic length,2822    116, 101, 115, 116, // Topic (test)2823    0, // Qos (0)2824 2825    // Finally, a valid disconnect packet:2826 2827    224, 0 // Header2828  ]))2829 2830  // Calling parse again clears the error and continues parsing2831  packetCount = 02832  errorCount = 02833  expectedPackets = 22834  expectedErrors = 02835 2836  parser.parse(Buffer.from([2837    // Connect:2838 2839    16, 12, // Header2840    0, 4, // Protocol ID length2841    77, 81, 84, 84, // Protocol ID2842    4, // Protocol version2843    2, // Connect flags2844    0, 30, // Keepalive2845    0, 0, // Client ID length2846 2847    // Disconnect:2848 2849    224, 0 // Header2850  ]))2851})2852 2853testGenerateErrorMultipleCmds([2854  'publish',2855  'puback',2856  'pubrec',2857  'pubrel',2858  'subscribe',2859  'suback',2860  'unsubscribe',2861  'unsuback'2862], 'Invalid messageId', {2863  qos: 1, // required for publish2864  topic: 'test', // required for publish2865  messageId: 'a'2866}, {})2867