feat(cli): add support debug mode with

emqx · Dec 27, 2023 · 4f27cfa · 4f27cfa
1 parent 72fe43c
commit 4f27cfa
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 3 deletions.
diff --git a/cli/src/index.ts b/cli/src/index.ts
@@ -104,6 +104,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',
       )
+      .option('--debug', 'Enable debug mode for MQTT.js', false)
       .allowUnknownOption(false)
       .action(conn)
 
@@ -206,6 +207,7 @@ export class Commander {
         '-Pmn, --protobuf-message-name <NAME>',
         'the name of the protobuf message type (must exist in the .proto file)',
       )
+      .option('--debug', 'Enable debug mode for MQTT.js', false)
       .allowUnknownOption(false)
       .action(pub)
 
@@ -304,6 +306,7 @@ export class Commander {
         '-Pmn, --protobuf-message-name <NAME>',
         'the name of the protobuf message type (must exist in the .proto file)',
       )
+      .option('--debug', 'Enable debug mode for MQTT.js', false)
       .allowUnknownOption(false)
       .action(sub)
 

diff --git a/cli/src/lib/conn.ts b/cli/src/lib/conn.ts
@@ -3,14 +3,17 @@ import { Signale, signale, basicLog, benchLog } from '../utils/signale'
 import { parseConnectOptions } from '../utils/parse'
 import delay from '../utils/delay'
 import { saveConfig, loadConfig } from '../utils/config'
+import * as Debug from 'debug'
 
 const conn = (options: ConnectOptions) => {
-  const { save, config } = options
+  const { debug, save, config } = options
 
   config && (options = loadConfig('conn', config))
 
   save && saveConfig('conn', options)
 
+  debug && Debug.enable('mqttjs*')
+
   const { maximumReconnectTimes } = options
 
   const connOpts = parseConnectOptions(options, 'conn')

diff --git a/cli/src/lib/pub.ts b/cli/src/lib/pub.ts
@@ -11,6 +11,7 @@ import { saveConfig, loadConfig } from '../utils/config'
 import { loadSimulator } from '../utils/simulate'
 import { serializeProtobufToBuffer } from '../utils/protobuf'
 import convertPayload from '../utils/convertPayload'
+import * as Debug from 'debug'
 
 const processPublishMessage = (
   message: string | Buffer,
@@ -143,12 +144,14 @@ const multisend = (
 }
 
 const pub = (options: PublishOptions) => {
-  const { save, config } = options
+  const { debug, save, config } = options
 
   config && (options = loadConfig('pub', config))
 
   save && saveConfig('pub', options)
 
+  debug && Debug.enable('mqttjs*')
+
   checkTopicExists(options.topic, 'pub')
 
   const connOpts = parseConnectOptions(options, 'pub')

diff --git a/cli/src/lib/sub.ts b/cli/src/lib/sub.ts
@@ -5,6 +5,7 @@ import delay from '../utils/delay'
 import convertPayload from '../utils/convertPayload'
 import { saveConfig, loadConfig } from '../utils/config'
 import { deserializeBufferToProtobuf } from '../utils/protobuf'
+import * as Debug from 'debug'
 
 const processReceivedMessage = (
   payload: Buffer,
@@ -36,12 +37,14 @@ const processReceivedMessage = (
 }
 
 const sub = (options: SubscribeOptions) => {
-  const { save, config } = options
+  const { debug, save, config } = options
 
   config && (options = loadConfig('sub', config))
 
   save && saveConfig('sub', options)
 
+  debug && Debug.enable('mqttjs*')
+
   checkTopicExists(options.topic, 'sub')
 
   const connOpts = parseConnectOptions(options, 'sub')

diff --git a/cli/src/types/global.d.ts b/cli/src/types/global.d.ts
@@ -54,6 +54,7 @@ declare global {
     willUserProperties?: Record<string, string | string[]>
     save?: boolean | string
     config?: boolean | string
+    debug?: boolean
   }
 
   interface PublishOptions extends ConnectOptions {