Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cli): custom ws headers support #1729

Merged
merged 1 commit into from
Jul 31, 2024
Merged

feat(cli): custom ws headers support #1729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 55 additions & 48 deletions cli/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
parseNumber,
parseProtocol,
parseMQTTVersion,
parseUserProperties,
parseKeyValues,
parseQoS,
parseVariadicOfBooleanType,
parsePubTopic,
Expand Down Expand Up @@ -71,6 +71,11 @@ export class Commander {
state.getConfig('protocol'),
)
.option('--path <PATH>', 'the path of websocket', '/mqtt')
.option(
'-wh, --ws-headers <WSHEADERS...>',
'headers for WebSocket options (only works with MQTT over WebSocket connections, e.g. -wh "Authorization: Bearer token")',
parseKeyValues,
)
.option('--key <PATH>', 'path to the key file')
.option('--cert <PATH>', 'path to the cert file')
.option('--ca <PATH>', 'path to the ca certificate')
Expand Down Expand Up @@ -98,7 +103,7 @@ export class Commander {
.option(
'-up, --user-properties <USERPROPERTIES...>',
'the user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
// will message options
.option('-Wt, --will-topic <TOPIC>', 'the will topic')
Expand All @@ -112,11 +117,7 @@ export class Commander {
.option('-Wct, --will-content-type <CONTENTTYPE>', 'description of the will message’s content')
.option('-Wrt, --will-response-topic <TOPIC>', 'topic name for a response message')
.option('-Wcd, --will-correlation-data <DATA>', 'correlation data for the response message')
.option(
'-Wup, --will-user-properties <USERPROPERTIES...>',
'the user properties of will message',
parseUserProperties,
)
.option('-Wup, --will-user-properties <USERPROPERTIES...>', 'the user properties of will message', parseKeyValues)
.option(
'-so, --save-options [PATH]',
'save the parameters to the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-options.json',
Expand Down Expand Up @@ -155,7 +156,7 @@ export class Commander {
.option(
'-up, --user-properties <USERPROPERTIES...>',
'the user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
.option('-si, --subscription-identifier <NUMBER>', 'the identifier of the subscription', parseNumber)
.option('-ct, --content-type <TYPE>', 'a description of the content of the publish message')
Expand All @@ -180,6 +181,11 @@ export class Commander {
state.getConfig('protocol'),
)
.option('--path <PATH>', 'the path of websocket', '/mqtt')
.option(
'-wh, --ws-headers <WSHEADERS...>',
'headers for WebSocket options (only works with MQTT over WebSocket connections, e.g. -wh "Authorization: Bearer token")',
parseKeyValues,
)
.option('--key <PATH>', 'path to the key file')
.option('--cert <PATH>', 'path to the cert file')
.option('--ca <PATH>', 'path to the ca certificate')
Expand Down Expand Up @@ -207,7 +213,7 @@ export class Commander {
.option(
'-Cup, --conn-user-properties <USERPROPERTIES...>',
'the connect user properties of MQTT 5.0 (e.g. -Cup "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
// will message options
.option('-Wt, --will-topic <TOPIC>', 'the will topic')
Expand All @@ -221,11 +227,7 @@ export class Commander {
.option('-Wct, --will-content-type <CONTENTTYPE>', 'description of the will message’s content')
.option('-Wrt, --will-response-topic <TOPIC>', 'topic name for a response message')
.option('-Wcd, --will-correlation-data <DATA>', 'correlation data for the response message')
.option(
'-Wup, --will-user-properties <USERPROPERTIES...>',
'the user properties of will message',
parseUserProperties,
)
.option('-Wup, --will-user-properties <USERPROPERTIES...>', 'the user properties of will message', parseKeyValues)
.option(
'-so, --save-options [PATH]',
'save the parameters to the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-options.json',
Expand Down Expand Up @@ -264,7 +266,7 @@ export class Commander {
.option(
'-up, --user-properties <USERPROPERTIES...>',
'the user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
.option('-f, --format <TYPE>', 'format the message body, support base64, json, hex, binary and cbor', parseFormat)
.option('-v, --verbose', 'turn on verbose mode to display incoming MQTT packets')
Expand All @@ -290,6 +292,11 @@ export class Commander {
state.getConfig('protocol'),
)
.option('--path <PATH>', 'the path of websocket', '/mqtt')
.option(
'-wh, --ws-headers <WSHEADERS...>',
'headers for WebSocket options (only works with MQTT over WebSocket connections, e.g. -wh "Authorization: Bearer token")',
parseKeyValues,
)
.option('--key <PATH>', 'path to the key file')
.option('--cert <PATH>', 'path to the cert file')
.option('--ca <PATH>', 'path to the ca certificate')
Expand Down Expand Up @@ -317,7 +324,7 @@ export class Commander {
.option(
'-Cup, --conn-user-properties <USERPROPERTIES...>',
'the connect user properties of MQTT 5.0 (e.g. -Cup "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
// will message options
.option('-Wt, --will-topic <TOPIC>', 'the will topic')
Expand All @@ -331,11 +338,7 @@ export class Commander {
.option('-Wct, --will-content-type <CONTENTTYPE>', 'description of the will message’s content')
.option('-Wrt, --will-response-topic <TOPIC>', 'topic name for a response message')
.option('-Wcd, --will-correlation-data <DATA>', 'correlation data for the response message')
.option(
'-Wup, --will-user-properties <USERPROPERTIES...>',
'the user properties of will message',
parseUserProperties,
)
.option('-Wup, --will-user-properties <USERPROPERTIES...>', 'the user properties of will message', parseKeyValues)
.option(
'-so, --save-options [PATH]',
'save the parameters to the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-options.json',
Expand Down Expand Up @@ -390,6 +393,11 @@ export class Commander {
state.getConfig('protocol'),
)
.option('--path <PATH>', 'the path of websocket', '/mqtt')
.option(
'-wh, --ws-headers <WSHEADERS...>',
'headers for WebSocket options (only works with MQTT over WebSocket connections, e.g. -wh "Authorization: Bearer token")',
parseKeyValues,
)
.option('--key <PATH>', 'path to the key file')
.option('--cert <PATH>', 'path to the cert file')
.option('--ca <PATH>', 'path to the ca certificate')
Expand Down Expand Up @@ -417,7 +425,7 @@ export class Commander {
.option(
'-up, --user-properties <USERPROPERTIES...>',
'the user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
// will message options
.option('-Wt, --will-topic <TOPIC>', 'the will topic')
Expand All @@ -431,11 +439,7 @@ export class Commander {
.option('-Wct, --will-content-type <CONTENTTYPE>', 'description of the will message’s content')
.option('-Wrt, --will-response-topic <TOPIC>', 'topic name for a response message')
.option('-Wcd, --will-correlation-data <DATA>', 'correlation data for the response message')
.option(
'-Wup, --will-user-properties <USERPROPERTIES...>',
'the user properties of will message',
parseUserProperties,
)
.option('-Wup, --will-user-properties <USERPROPERTIES...>', 'the user properties of will message', parseKeyValues)
.option(
'-so, --save-options [PATH]',
'save the parameters to the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-options.json',
Expand Down Expand Up @@ -484,7 +488,7 @@ export class Commander {
.option(
'-up, --user-properties <USERPROPERTIES...>',
'the user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
.option('-si, --subscription-identifier <NUMBER>', 'the identifier of the subscription', parseNumber)
.option('-ct, --content-type <TYPE>', 'a description of the content of the publish message')
Expand All @@ -505,6 +509,11 @@ export class Commander {
state.getConfig('protocol'),
)
.option('--path <PATH>', 'the path of websocket', '/mqtt')
.option(
'-wh, --ws-headers <WSHEADERS...>',
'headers for WebSocket options (only works with MQTT over WebSocket connections, e.g. -wh "Authorization: Bearer token")',
parseKeyValues,
)
.option('--key <PATH>', 'path to the key file')
.option('--cert <PATH>', 'path to the cert file')
.option('--ca <PATH>', 'path to the ca certificate')
Expand Down Expand Up @@ -532,7 +541,7 @@ export class Commander {
.option(
'-Cup, --conn-user-properties <USERPROPERTIES...>',
'the connect user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
// will message options
.option('-Wt, --will-topic <TOPIC>', 'the will topic')
Expand All @@ -546,11 +555,7 @@ export class Commander {
.option('-Wct, --will-content-type <CONTENTTYPE>', 'description of the will message’s content')
.option('-Wrt, --will-response-topic <TOPIC>', 'topic name for a response message')
.option('-Wcd, --will-correlation-data <DATA>', 'correlation data for the response message')
.option(
'-Wup, --will-user-properties <USERPROPERTIES...>',
'the user properties of will message',
parseUserProperties,
)
.option('-Wup, --will-user-properties <USERPROPERTIES...>', 'the user properties of will message', parseKeyValues)
.option(
'-so, --save-options [PATH]',
'save the parameters to the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-options.json',
Expand Down Expand Up @@ -589,7 +594,7 @@ export class Commander {
.option(
'-up, --user-properties <USERPROPERTIES...>',
'the user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
.option('-v, --verbose', 'print history received messages and rate')
// connect options
Expand All @@ -608,6 +613,11 @@ export class Commander {
state.getConfig('protocol'),
)
.option('--path <PATH>', 'the path of websocket', '/mqtt')
.option(
'-wh, --ws-headers <WSHEADERS...>',
'headers for WebSocket options (only works with MQTT over WebSocket connections, e.g. -wh "Authorization: Bearer token")',
parseKeyValues,
)
.option('--key <PATH>', 'path to the key file')
.option('--cert <PATH>', 'path to the cert file')
.option('--ca <PATH>', 'path to the ca certificate')
Expand Down Expand Up @@ -635,7 +645,7 @@ export class Commander {
.option(
'-Cup, --conn-user-properties <USERPROPERTIES...>',
'the connect user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
// will message options
.option('-Wt, --will-topic <TOPIC>', 'the will topic')
Expand All @@ -649,11 +659,7 @@ export class Commander {
.option('-Wct, --will-content-type <CONTENTTYPE>', 'description of the will message’s content')
.option('-Wrt, --will-response-topic <TOPIC>', 'topic name for a response message')
.option('-Wcd, --will-correlation-data <DATA>', 'correlation data for the response message')
.option(
'-Wup, --will-user-properties <USERPROPERTIES...>',
'the user properties of will message',
parseUserProperties,
)
.option('-Wup, --will-user-properties <USERPROPERTIES...>', 'the user properties of will message', parseKeyValues)
.option(
'-so, --save-options [PATH]',
'save the parameters to the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-options.json',
Expand Down Expand Up @@ -704,7 +710,7 @@ export class Commander {
.option(
'-up, --user-properties <USERPROPERTIES...>',
'the user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
.option('-si, --subscription-identifier <NUMBER>', 'the identifier of the subscription', parseNumber)
.option('-ct, --content-type <TYPE>', 'a description of the content of the publish message')
Expand All @@ -725,6 +731,11 @@ export class Commander {
state.getConfig('protocol'),
)
.option('--path <PATH>', 'the path of websocket', '/mqtt')
.option(
'-wh, --ws-headers <WSHEADERS...>',
'headers for WebSocket options (only works with MQTT over WebSocket connections, e.g. -wh "Authorization: Bearer token")',
parseKeyValues,
)
.option('--key <PATH>', 'path to the key file')
.option('--cert <PATH>', 'path to the cert file')
.option('--ca <PATH>', 'path to the ca certificate')
Expand All @@ -747,7 +758,7 @@ export class Commander {
.option(
'-Cup, --conn-user-properties <USERPROPERTIES...>',
'the connect user properties of MQTT 5.0 (e.g. -up "name: mqttx cli")',
parseUserProperties,
parseKeyValues,
)
// will message options
.option('-Wt, --will-topic <TOPIC>', 'the will topic')
Expand All @@ -761,11 +772,7 @@ export class Commander {
.option('-Wct, --will-content-type <CONTENTTYPE>', 'description of the will message’s content')
.option('-Wrt, --will-response-topic <TOPIC>', 'topic name for a response message')
.option('-Wcd, --will-correlation-data <DATA>', 'correlation data for the response message')
.option(
'-Wup, --will-user-properties <USERPROPERTIES...>',
'the user properties of will message',
parseUserProperties,
)
.option('-Wup, --will-user-properties <USERPROPERTIES...>', 'the user properties of will message', parseKeyValues)
.option(
'-so, --save-options [PATH]',
'save the parameters to the local configuration file, which supports json and yaml format, default path is ./mqttx-cli-options.json',
Expand Down
1 change: 1 addition & 0 deletions cli/src/types/global.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ declare global {
password?: string
protocol?: Protocol
path?: string
wsHeaders?: Record<string, string>
key?: string
cert?: string
ca?: string
Expand Down
21 changes: 18 additions & 3 deletions cli/src/utils/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const parseMQTTVersion = (value: string) => {
return dict[value as '3.1' | '3.1.1' | '5']
}

const parseUserProperties = (value: string, previous?: Record<string, string | string[]>) => {
const parseKeyValues = (value: string, previous?: Record<string, string | string[]>) => {
const [key, val] = value.split(': ')
if (key && val) {
if (!previous) {
Expand All @@ -56,7 +56,7 @@ const parseUserProperties = (value: string, previous?: Record<string, string | s
}
}
} else {
logWrapper.fail('Not a valid user properties.')
logWrapper.fail(`Invalid key-value pair: "${value}". Expected format is "key: value".`)
process.exit(1)
}
}
Expand Down Expand Up @@ -178,6 +178,16 @@ const checkScenarioExists = (name?: string, file?: string) => {
}
}

const parseWsHeaders = (wsHeaders: Record<string, string>, protocol: Protocol) => {
if (!['ws', 'wss'].includes(protocol)) {
logWrapper.fail('WebSocket headers are only supported with WebSocket connections (ws or wss).')
process.exit(1)
}
return {
headers: wsHeaders,
}
}

const parseConnectOptions = (
options: ConnectOptions | PublishOptions | SubscribeOptions,
commandType?: CommandType,
Expand All @@ -193,6 +203,7 @@ const parseConnectOptions = (
password,
protocol,
path,
wsHeaders,
key,
cert,
ca,
Expand Down Expand Up @@ -252,6 +263,10 @@ const parseConnectOptions = (
connectOptions.ALPNProtocols = alpn
}

if (wsHeaders && protocol) {
connectOptions.wsOptions = parseWsHeaders(wsHeaders, protocol)
}

if (willTopic) {
const will = {
topic: willTopic,
Expand Down Expand Up @@ -406,7 +421,7 @@ export {
parseNumber,
parseProtocol,
parseMQTTVersion,
parseUserProperties,
parseKeyValues,
parseQoS,
parseVariadicOfBooleanType,
checkTopicExists,
Expand Down
Loading