Merge pull request #10926 from zmstone/0602-add-enable-as-an-alias-fo…

…r-enabled 0602 add enable as an alias for enabled
emqx · Jun 9, 2023 · ee69783 · ee69783
2 parents 9f6beee + abdbf34
commit ee69783
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
@@ -307,6 +307,8 @@ fields("persistent_session_store") ->
                 boolean(),
                 #{
                     default => false,
+                    %% TODO(5.2): change field name to 'enable' and keep 'enabled' as an alias
+                    aliases => [enable],
                     desc => ?DESC(persistent_session_store_enabled)
                 }
             )},
@@ -2003,6 +2005,8 @@ base_listener(Bind) ->
                 boolean(),
                 #{
                     default => true,
+                    %% TODO(5.2): change field name to 'enable' and keep 'enabled' as an alias
+                    aliases => [enable],
                     desc => ?DESC(fields_listener_enabled)
                 }
             )},

diff --git a/apps/emqx_conf/src/emqx_conf_app.erl b/apps/emqx_conf/src/emqx_conf_app.erl
@@ -261,9 +261,13 @@ sync_data_from_node(Node) ->
         {ok, DataBin} ->
             case zip:unzip(DataBin, [{cwd, emqx:data_dir()}]) of
                 {ok, []} ->
-                    ?SLOG(debug, #{node => Node, msg => "sync_data_from_node_ignore"});
+                    ?SLOG(debug, #{node => Node, msg => "sync_data_from_node_empty_response"});
                 {ok, Files} ->
-                    ?SLOG(debug, #{node => Node, msg => "sync_data_from_node_ok", files => Files})
+                    ?SLOG(debug, #{
+                        node => Node,
+                        msg => "sync_data_from_node_non_empty_response",
+                        files => Files
+                    })
             end,
             ok;
         Error ->

diff --git a/changes/ce/feat-10926.en.md b/changes/ce/feat-10926.en.md
@@ -0,0 +1,5 @@
+Allow 'enable' as well as 'enabled' as the state flag for listeners.
+
+Prior to this change, listener can be enable/disabled by setting the 'true' or 'false' on the 'enabled' config.
+This is slightly different naming comparing to other state flags in the system.
+No the 'enable' flag is added as an aliase on listeners.