fix(cli):optimized parameter checks and error handling

cli/src/index.ts

@@ -31,11 +31,13 @@ export class Commander {
       .name('mqttx')
       .description('An MQTT client for the command line')
       .enablePositionalOptions()
+      .allowUnknownOption(false)
       .version(`${version}\nhttps://mqttx.app/changelogs/v${version}`, '-v, --version')
 
     this.program
       .command('check')
       .description('Check for updates.')
+      .allowUnknownOption(false)
       .action(async () => {
         await checkUpdate()
       })
@@ -101,6 +103,7 @@ export class Commander {
         '--config [PATH]',
         'load the parameters from the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-config.json',
       )
+      .allowUnknownOption(false)
       .action(conn)
 
     this.program
@@ -195,10 +198,11 @@ export class Commander {
       .option('-Pp, --protobuf-path <PATH>', 'the .proto file that defines the message format of protobuf')
       .option('-Pmn, --protobuf-message-name <NAME>', 'the name of the protobuf message type')
       .option(
-        '-Pf, --protobuf-format <TYPE>',
+        '-Pft, --protobuf-format-type <TYPE>',
         'the format type of message body, support base64, json, hex',
         parseFormat,
       )
+      .allowUnknownOption(false)
       .action(pub)
 
     this.program
@@ -289,6 +293,7 @@ export class Commander {
       )
       .option('-Pp, --protobuf-path <PATH>', 'the .proto file that defines the message format of protobuf')
       .option('-Pmn, --protobuf-message-name <NAME>', 'the name of the protobuf message type')
+      .allowUnknownOption(false)
       .action(sub)
 
     const benchCmd = this.program.command('bench').description('MQTT Benchmark in performance testing.')
@@ -356,6 +361,7 @@ export class Commander {
         '--config [PATH]',
         'load the parameters from the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-config.json',
       )
+      .allowUnknownOption(false)
       .action(benchConn)
 
     benchCmd
@@ -453,6 +459,7 @@ export class Commander {
         '--config [PATH]',
         'load the parameters from the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-config.json',
       )
+      .allowUnknownOption(false)
       .action(benchPub)
 
     benchCmd
@@ -539,6 +546,7 @@ export class Commander {
         '--config [PATH]',
         'load the parameters from the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-config.json',
       )
+      .allowUnknownOption(false)
       .action(benchSub)
 
     this.program
@@ -638,12 +646,14 @@ export class Commander {
         '--config [PATH]',
         'load the parameters from the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-config.json',
       )
+      .allowUnknownOption(false)
       .action(simulatePub)
 
     this.program
       .command('ls')
       .description('List information based on the provided options.')
       .option('-sc, --scenarios', 'List all built-in scenarios')
+      .allowUnknownOption(false)
       .action(ls)
   }
 }

cli/src/lib/pub.ts

@@ -18,17 +18,17 @@ const send = (
     message: string | Buffer
     protobufPath: string | undefined
     protobufMessageName: string | undefined
-    protobufFormat: FormatType | undefined
+    protobufFormatType: FormatType | undefined
     opts: IClientPublishOptions
   },
 ) => {
   const client = mqtt.connect(connOpts)
   basicLog.connecting(config, connOpts.hostname!, connOpts.port, pubOpts.topic, pubOpts.message.toString())
   client.on('connect', () => {
     basicLog.connected()
-    const { topic, message, protobufPath, protobufMessageName, protobufFormat } = pubOpts
+    const { topic, message, protobufPath, protobufMessageName, protobufFormatType } = pubOpts
     basicLog.publishing()
-    let bufferMessage = serializeProtobufToBuffer(message, protobufPath, protobufMessageName, protobufFormat)
+    let bufferMessage = serializeProtobufToBuffer(message, protobufPath, protobufMessageName, protobufFormatType)
     client.publish(topic, bufferMessage, pubOpts.opts, (err) => {
       if (err) {
         signale.warn(err)
@@ -59,7 +59,7 @@ const multisend = (
     message: string | Buffer
     protobufPath: string | undefined
     protobufMessageName: string | undefined
-    protobufFormat: FormatType | undefined
+    protobufFormatType: FormatType | undefined
     opts: IClientPublishOptions
   },
   maximumReconnectTimes: number,
@@ -72,9 +72,9 @@ const multisend = (
     objectMode: true,
   })
   sender._write = (line, _enc, cb) => {
-    const { topic, opts, protobufPath, protobufMessageName, protobufFormat } = pubOpts
+    const { topic, opts, protobufPath, protobufMessageName, protobufFormatType } = pubOpts
 
-    let bufferMessage = serializeProtobufToBuffer(line.trim(), protobufPath, protobufMessageName, protobufFormat)
+    let bufferMessage = serializeProtobufToBuffer(line.trim(), protobufPath, protobufMessageName, protobufFormatType)
     client.publish(topic, bufferMessage, opts, cb)
   }
 

cli/src/types/global.d.ts

@@ -74,7 +74,7 @@ declare global {
     connUserProperties?: Record<string, string | string[]>
     protobufPath?: string
     protobufMessageName?: string
-    protobufFormat?: FormatType
+    protobufFormatType?: FormatType
   }
 
   interface SubscribeOptions extends ConnectOptions {
@@ -100,7 +100,7 @@ declare global {
 
   type OmitPublishOptions = Omit<
     PublishOptions,
-    'stdin' | 'multiline' | 'protobufPath' | 'protobufMessageName' | 'protobufFormat'
+    'stdin' | 'multiline' | 'protobufPath' | 'protobufMessageName' | 'protobufFormatType'
   >
 
   interface BenchPublishOptions extends OmitPublishOptions {

cli/src/utils/parse.ts

@@ -291,7 +291,7 @@ const parsePublishOptions = (options: PublishOptions) => {
     contentType,
     protobufPath,
     protobufMessageName,
-    protobufFormat,
+    protobufFormatType,
   } = options
 
   const publishOptions: IClientPublishOptions = {
@@ -317,7 +317,7 @@ const parsePublishOptions = (options: PublishOptions) => {
     )
   }
 
-  return { topic, message, protobufPath, protobufMessageName, protobufFormat, opts: publishOptions }
+  return { topic, message, protobufPath, protobufMessageName, protobufFormatType, opts: publishOptions }
 }
 
 const parseSubscribeOptions = (options: SubscribeOptions) => {

cli/src/utils/protobuf.ts

@@ -1,5 +1,6 @@
 import protobuf from 'protobufjs'
 import signale from './signale'
+import { transformPBJSError } from './protobufErrors'
 
 const convertObject = (raw: string | Buffer, format?: FormatType | undefined) => {
   switch (format) {
@@ -26,13 +27,15 @@ export const serializeProtobufToBuffer = (
       const rawData = convertObject(raw, format)
       const err = Message.verify(rawData)
       if (err) {
-        signale.warn(err)
+        signale.error(`Message serialization error: ${err}`)
+        process.exit(1)
       }
       const data = Message.create(rawData)
       const serializedMessage = Message.encode(data).finish()
       bufferMessage = Buffer.from(serializedMessage)
-    } catch (err: unknown) {
-      signale.warn((err as Error).message.split('\n')[0])
+    } catch (error: unknown) {
+      signale.error(`Message format type error : ${(error as Error).message.split('\n')[0]}`)
+      process.exit(1)
     }
   }
   return bufferMessage
@@ -49,12 +52,19 @@ export const deserializeBufferToProtobuf = (
       const root = protobuf.loadSync(protobufPath)
       const Message = root.lookupType(protobufMessageName)
       const MessageData = Message.decode(payload)
+      const err = Message.verify(MessageData)
+      if (err) {
+        signale.error(`Message deserialization error: ${err}`)
+        process.exit(1)
+      }
       if (to) {
         return Buffer.from(JSON.stringify(MessageData.toJSON()))
       }
       return MessageData
-    } catch (err: unknown) {
-      signale.warn((err as Error).message.split('\n')[0])
+    } catch (error: unknown) {
+      let err = transformPBJSError(error as Error)
+      signale.error(err.message.split('\n')[0])
+      process.exit(1)
     }
   }
 }

cli/src/utils/protobufErrors.ts

@@ -0,0 +1,28 @@
+function prepend(msg: string): string {
+  return `Message deserialization error: ${msg}`
+}
+
+function indexOutOfRange(msg: string): string {
+  function errMsg(pos: string, read: string, len: string): string {
+    return `Index out of range: the reader was at position ${pos} and tried to read ${read} more (bytes), but the given buffer was ${len} bytes`
+  }
+
+  const regex = /index out of range: ([0-9]+) \+ ([0-9]+) > ([0-9]+)/
+
+  const res = msg.match(regex)
+
+  if (res) {
+    const [matched, pos, read, len] = res
+    return msg.replace(matched, errMsg(pos, read, len))
+  }
+
+  return msg
+}
+
+export function transformPBJSError(e: Error): Error {
+  const transformers = [prepend, indexOutOfRange]
+
+  const message = transformers.reduce((msg, transform) => transform(msg), e.message)
+
+  return new Error(message)
+}