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.

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

Already on GitHub? Sign in to your account

fix: alias listeners.Type.Name.enabled as listeners.Type.Name.enable #11226

Merged
merged 4 commits into from Jul 10, 2023

Conversation

zhongwencool
Copy link
Member

@zhongwencool zhongwencool commented Jul 7, 2023

Fixes https://emqx.atlassian.net/browse/EMQX-10501

  • Most listeners use "enable" for configuration and HTTP API
  • Only listeners.tcp.x uses "enabled" as primary key(enable as alias) for backwards compatibility
  • The Listeners HTTP API still uses "enable"
  • We want to standardize on "enable" going forward, but remain compatible with existing "enabled" configurations

Summary

馃 Generated by Copilot at 5c07980

This pull request standardizes the enable key name in the listener configuration map across different API endpoints and files. It also fixes some typos and renames the schema file to match the module name.

PR Checklist

Please convert it to a draft if any of the following conditions are not met. Reviewers may skip over until all the items are checked:

  • Added tests for the changes
  • Changed lines covered in coverage report
  • Change log has been added to changes/{ce,ee}/(feat|perf|fix)-<PR-id>.en.md files
  • For internal contributor: there is a jira ticket to track this change
  • If there should be document changes, a PR to emqx-docs.git is sent, or a jira ticket is created to follow up
  • Schema changes are backward compatible

Checklist for CI (.github/workflows) changes

  • If changed package build workflow, pass this action (manual trigger)
  • Change log has been added to changes/ dir for user-facing artifacts update

@zhongwencool zhongwencool requested review from a team, lafirest and sstrigler as code owners July 7, 2023 12:26
thalesmg
thalesmg previously approved these changes Jul 7, 2023
Copy link
Contributor

@thalesmg thalesmg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a changelog?

@zhongwencool
Copy link
Member Author

Should we add a changelog?

Done

@zhongwencool zhongwencool force-pushed the listener-conf-enabled-to-enable branch 2 times, most recently from c2e9a77 to d7ce077 Compare July 7, 2023 22:52
@zhongwencool zhongwencool force-pushed the listener-conf-enabled-to-enable branch from d7ce077 to d661b10 Compare July 10, 2023 02:34
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 5503397754

  • 5 of 6 (83.33%) changed or added relevant lines in 2 files are covered.
  • 21 unchanged lines in 9 files lost coverage.
  • Overall coverage decreased (-0.02%) to 82.286%

Changes Missing Coverage Covered Lines Changed/Added Lines %
apps/emqx/src/emqx_listeners.erl 2 3 66.67%
Files with Coverage Reduction New Missed Lines %
apps/emqx_ft/src/emqx_ft_assembler.erl 1 85.11%
apps/emqx_ft/src/emqx_ft_responder.erl 1 88.24%
apps/emqx_ft/src/emqx_ft_storage_exporter.erl 1 88.24%
apps/emqx_gateway_mqttsn/src/emqx_mqttsn_frame.erl 1 63.48%
apps/emqx/src/emqx_connection.erl 1 83.7%
apps/emqx/src/emqx_quic_data_stream.erl 1 75.21%
apps/emqx_resource/src/emqx_resource_buffer_worker.erl 2 93.12%
apps/emqx_ft/src/emqx_ft_storage_fs.erl 3 82.84%
apps/emqx/src/emqx_reason_codes.erl 10 91.91%
Totals Coverage Status
Change from base Build 5503102326: -0.02%
Covered Lines: 30937
Relevant Lines: 37597

馃挍 - Coveralls

@HJianBo HJianBo merged commit f144bb0 into emqx:master Jul 10, 2023
138 checks passed
@zhongwencool zhongwencool deleted the listener-conf-enabled-to-enable branch July 10, 2023 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants