fix: make protocol_name optional in mqtt-proxy plugin #12720
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The protocol_name parameter is now optional with a default value of 'MQTT'. Previously it was required which was unnecessarily restrictive since MQTT is the standard protocol and should be the default. Changes: - Set protocol_name as optional in schema with default value 'MQTT' - Updated validation logic to use default when not specified - Updated English documentation to reflect optional status - Updated Chinese documentation to reflect optional status Fixes apache#11589
dosubot
bot
added
size:S
Baoyuantop
reviewed
Nov 7, 2025
Contributor
Baoyuantop
left a comment
Baoyuantop
left a comment
There was a problem hiding this comment.
We also need to add tests to verify that it works when the protocol_name configuration is not filled in.
|
|
||
| if res.protocol and res.protocol ~= conf.protocol_name then | ||
| core.log.error("expect protocol name: ", conf.protocol_name, | ||
| local protocol_name = conf.protocol_name or "MQTT" |
Contributor
There was a problem hiding this comment.
No default value is needed here since we've already defined the default value in the schema.
Baoyuantop
added
the
wait for update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR makes the
protocol_nameparameter optional in the mqtt-proxy plugin, as requested in #11589.Currently,
protocol_nameis required even though it's almost always set toMQTT. This creates unnecessary configuration overhead for users.Changes:
protocol_nameoptional in the plugin schema with default valueMQTTPre-submission checklist:
Backward Compatibility:
✅ This change is fully backward compatible. Existing configurations that specify
protocol_namewill continue to work exactly as before.Fixes #11589