Merge pull request #12517 from zmstone/0213-hocon-multiline-string-wi…

…th-indentation

0213 hocon multiline string with indentation

apps/emqx/rebar.config

@@ -30,7 +30,7 @@
     {esockd, {git, "https://github.com/emqx/esockd", {tag, "5.11.1"}}},
     {ekka, {git, "https://github.com/emqx/ekka", {tag, "0.18.4"}}},
     {gen_rpc, {git, "https://github.com/emqx/gen_rpc", {tag, "3.3.1"}}},
-    {hocon, {git, "https://github.com/emqx/hocon.git", {tag, "0.40.4"}}},
+    {hocon, {git, "https://github.com/emqx/hocon.git", {tag, "0.41.0"}}},
     {emqx_http_lib, {git, "https://github.com/emqx/emqx_http_lib.git", {tag, "0.5.3"}}},
     {pbkdf2, {git, "https://github.com/emqx/erlang-pbkdf2.git", {tag, "2.0.4"}}},
     {recon, {git, "https://github.com/ferd/recon", {tag, "2.5.1"}}},

apps/emqx_auth/src/emqx_authn/emqx_authn_api.erl

@@ -42,7 +42,8 @@
 -export([
     api_spec/0,
     paths/0,
-    schema/1
+    schema/1,
+    namespace/0
 ]).
 
 -export([
@@ -95,6 +96,8 @@
 
 -elvis([{elvis_style, god_modules, disable}]).
 
+namespace() -> undefined.
+
 api_spec() ->
     emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}).
 

apps/emqx_auth/src/emqx_authz/emqx_authz_api_sources.erl

@@ -41,7 +41,8 @@
     api_spec/0,
     paths/0,
     schema/1,
-    fields/1
+    fields/1,
+    namespace/0
 ]).
 
 -export([
@@ -56,6 +57,9 @@
 
 -define(TAGS, [<<"Authorization">>]).
 
+namespace() ->
+    undefined.
+
 api_spec() ->
     emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}).
 

apps/emqx_auth/src/emqx_authz/emqx_authz_schema.erl

@@ -22,7 +22,8 @@
 -export([
     roots/0,
     fields/1,
-    desc/1
+    desc/1,
+    namespace/0
 ]).
 
 -export([
@@ -65,6 +66,8 @@
 
 roots() -> [].
 
+namespace() -> undefined.
+
 fields(?CONF_NS) ->
     emqx_schema:authz_fields() ++ authz_fields();
 fields("metrics_status_fields") ->

apps/emqx_auth_mnesia/src/emqx_authz_api_mnesia.erl

@@ -35,7 +35,8 @@
     api_spec/0,
     paths/0,
     schema/1,
-    fields/1
+    fields/1,
+    namespace/0
 ]).
 
 %% operation funs
@@ -69,6 +70,8 @@
 -define(PUT_MAP_EXAMPLE, in_put_requestBody).
 -define(POST_ARRAY_EXAMPLE, in_post_requestBody).
 
+namespace() -> undefined.
+
 api_spec() ->
     emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}).
 

apps/emqx_bridge/src/schema/emqx_bridge_enterprise.erl

@@ -13,7 +13,8 @@
     examples/1,
     resource_type/1,
     bridge_impl_module/1,
-    fields/1
+    fields/1,
+    namespace/0
 ]).
 
 api_schemas(Method) ->
@@ -139,6 +140,8 @@ bridge_impl_module(azure_event_hub_producer) ->
 bridge_impl_module(_BridgeType) ->
     undefined.
 
+namespace() -> undefined.
+
 fields(bridges) ->
     [
         {hstreamdb,

apps/emqx_bridge_cassandra/src/emqx_bridge_cassandra_connector.erl

@@ -14,7 +14,7 @@
 -include_lib("snabbkaffe/include/snabbkaffe.hrl").
 
 %% schema
--export([roots/0, fields/1, desc/1]).
+-export([roots/0, fields/1, desc/1, namespace/0]).
 
 %% callbacks of behaviour emqx_resource
 -export([
@@ -56,6 +56,8 @@
 %%--------------------------------------------------------------------
 %% schema
 
+namespace() -> cassandra.
+
 roots() ->
     [{config, #{type => hoconsc:ref(?MODULE, config)}}].
 

apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse.app.src

@@ -1,6 +1,6 @@
 {application, emqx_bridge_clickhouse, [
     {description, "EMQX Enterprise ClickHouse Bridge"},
-    {vsn, "0.2.4"},
+    {vsn, "0.2.5"},
     {registered, []},
     {applications, [
         kernel,

apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse_connector.erl

@@ -23,7 +23,8 @@
 -export([
     roots/0,
     fields/1,
-    values/1
+    values/1,
+    namespace/0
 ]).
 
 %% callbacks for behaviour emqx_resource
@@ -72,6 +73,8 @@
 %% Configuration and default values
 %%=====================================================================
 
+namespace() -> clickhouse.
+
 roots() ->
     [{config, #{type => hoconsc:ref(?MODULE, config)}}].
 

apps/emqx_bridge_dynamo/src/emqx_bridge_dynamo.app.src

@@ -1,6 +1,6 @@
 {application, emqx_bridge_dynamo, [
     {description, "EMQX Enterprise Dynamo Bridge"},
-    {vsn, "0.1.4"},
+    {vsn, "0.1.5"},
     {registered, []},
     {applications, [
         kernel,

apps/emqx_bridge_dynamo/src/emqx_bridge_dynamo_connector.erl

@@ -12,7 +12,7 @@
 -include_lib("snabbkaffe/include/snabbkaffe.hrl").
 -include_lib("hocon/include/hoconsc.hrl").
 
--export([roots/0, fields/1]).
+-export([roots/0, fields/1, namespace/0]).
 
 %% `emqx_resource' API
 -export([
@@ -32,6 +32,9 @@
 
 %%=====================================================================
 %% Hocon schema
+
+namespace() -> dynamodka.
+
 roots() ->
     [{config, #{type => hoconsc:ref(?MODULE, config)}}].
 

apps/emqx_bridge_rocketmq/src/emqx_bridge_rocketmq.erl

@@ -115,7 +115,8 @@ action_values() ->
 
 %% -------------------------------------------------------------------------------------------------
 %% Hocon Schema Definitions
-namespace() -> "bridge_rocketmq".
+
+namespace() -> "rocketmq".
 
 roots() -> [].
 

apps/emqx_bridge_rocketmq/src/emqx_bridge_rocketmq_connector.erl

@@ -12,7 +12,7 @@
 -include_lib("snabbkaffe/include/snabbkaffe.hrl").
 -include_lib("hocon/include/hoconsc.hrl").
 
--export([roots/0, fields/1]).
+-export([roots/0, fields/1, namespace/0]).
 
 %% `emqx_resource' API
 -export([
@@ -36,6 +36,9 @@
 
 %%=====================================================================
 %% Hocon schema
+
+namespace() -> rocketmq.
+
 roots() ->
     [{config, #{type => hoconsc:ref(?MODULE, config)}}].
 

apps/emqx_bridge_sqlserver/src/emqx_bridge_sqlserver.app.src

@@ -1,6 +1,6 @@
 {application, emqx_bridge_sqlserver, [
     {description, "EMQX Enterprise SQL Server Bridge"},
-    {vsn, "0.1.5"},
+    {vsn, "0.1.6"},
     {registered, []},
     {applications, [kernel, stdlib, emqx_resource, odbc]},
     {env, []},

apps/emqx_bridge_sqlserver/src/emqx_bridge_sqlserver_connector.erl

@@ -24,7 +24,8 @@
 %% Hocon config schema exports
 -export([
     roots/0,
-    fields/1
+    fields/1,
+    namespace/0
 ]).
 
 %% callbacks for behaviour emqx_resource
@@ -132,6 +133,8 @@
 %% Configuration and default values
 %%====================================================================
 
+namespace() -> sqlserver.
+
 roots() ->
     [{config, #{type => hoconsc:ref(?MODULE, config)}}].
 

apps/emqx_conf/src/emqx_conf.erl

@@ -158,7 +158,6 @@ dump_schema(Dir, SchemaModule) ->
     ok = emqx_dashboard_desc_cache:init(),
     lists:foreach(
         fun(Lang) ->
-            ok = gen_config_md(Dir, SchemaModule, Lang),
             ok = gen_schema_json(Dir, SchemaModule, Lang)
         end,
         ["en", "zh"]
@@ -468,14 +467,6 @@ bridge_schema_json() ->
     SchemaInfo = #{title => <<"EMQX Data Bridge API Schema">>, version => Version},
     gen_api_schema_json_iodata(emqx_bridge_api, SchemaInfo).
 
-%% TODO: remove it and also remove hocon_md.erl and friends.
-%% markdown generation from schema is a failure and we are moving to an interactive
-%% viewer like swagger UI.
-gen_config_md(Dir, SchemaModule, Lang) ->
-    SchemaMdFile = filename:join([Dir, "config-" ++ Lang ++ ".md"]),
-    io:format(user, "===< Generating: ~s~n", [SchemaMdFile]),
-    ok = gen_doc(SchemaMdFile, SchemaModule, Lang).
-
 %% @doc return the root schema module.
 -spec schema_module() -> module().
 schema_module() ->
@@ -515,19 +506,6 @@ make_desc_resolver(Lang) ->
             unicode:characters_to_binary(Desc)
     end.
 
--spec gen_doc(file:name_all(), module(), string()) -> ok.
-gen_doc(File, SchemaModule, Lang) ->
-    Version = emqx_release:version(),
-    Title =
-        "# " ++ emqx_release:description() ++ " Configuration\n\n" ++
-            "<!--" ++ Version ++ "-->",
-    BodyFile = filename:join([rel, "emqx_conf.template." ++ Lang ++ ".md"]),
-    {ok, Body} = file:read_file(BodyFile),
-    Resolver = make_desc_resolver(Lang),
-    Opts = #{title => Title, body => Body, desc_resolver => Resolver},
-    Doc = hocon_schema_md:gen(SchemaModule, Opts),
-    file:write_file(File, Doc).
-
 gen_api_schema_json_iodata(SchemaMod, SchemaInfo) ->
     emqx_dashboard_swagger:gen_api_schema_json_iodata(
         SchemaMod,

apps/emqx_connector/src/emqx_connector_schema_lib.erl

@@ -44,12 +44,6 @@
     password/0
 ]).
 
--export([roots/0, fields/1]).
-
-roots() -> [].
-
-fields(_) -> [].
-
 ssl_fields() ->
     [
         {ssl, #{

apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl

@@ -15,8 +15,8 @@
 -export([
     api_schemas/1,
     fields/1,
-    %%examples/1
-    schema_modules/0
+    schema_modules/0,
+    namespace/0
 ]).
 
 resource_type(Type) when is_binary(Type) ->
@@ -93,6 +93,8 @@ connector_impl_module(rabbitmq) ->
 connector_impl_module(_ConnectorType) ->
     undefined.
 
+namespace() -> undefined.
+
 fields(connectors) ->
     connector_structs().
 

apps/emqx_dashboard/src/emqx_dashboard_monitor_api.erl

@@ -27,14 +27,17 @@
 -export([
     paths/0,
     schema/1,
-    fields/1
+    fields/1,
+    namespace/0
 ]).
 
 -export([
     monitor/2,
     monitor_current/2
 ]).
 
+namespace() -> undefined.
+
 api_spec() ->
     emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true, translate_body => true}).
 

apps/emqx_dashboard/test/emqx_swagger_parameter_SUITE.erl

@@ -19,7 +19,7 @@
 -behaviour(hocon_schema).
 
 %% API
--export([paths/0, api_spec/0, schema/1, namespace/0, fields/1]).
+-export([paths/0, api_spec/0, schema/1, roots/0, namespace/0, fields/1]).
 -export([init_per_suite/1, end_per_suite/1]).
 -export([t_in_path/1, t_in_query/1, t_in_mix/1, t_without_in/1, t_ref/1, t_public_ref/1]).
 -export([t_require/1, t_query_enum/1, t_nullable/1, t_method/1, t_api_spec/1]).
@@ -563,6 +563,7 @@ schema("/method/error") ->
     #{operationId => test, bar => #{200 => <<"ok">>}}.
 
 namespace() -> undefined.
+roots() -> [].
 
 fields(page) ->
     [

apps/emqx_dashboard/test/emqx_swagger_remote_schema.erl

@@ -17,9 +17,10 @@
 
 -include_lib("typerefl/include/types.hrl").
 
--export([roots/0, fields/1]).
+-export([namespace/0, roots/0, fields/1]).
 -import(hoconsc, [mk/2]).
 roots() -> ["root"].
+namespace() -> undefined.
 
 fields("root") ->
     [

apps/emqx_dashboard/test/emqx_swagger_requestBody_SUITE.erl

@@ -813,7 +813,8 @@ to_schema(Body) ->
         post => #{requestBody => Body, responses => #{200 => <<"ok">>}}
     }.
 
-%% Don't warning hocon callback namespace/0 undef.
+roots() -> [].
+
 namespace() -> atom_to_list(?MODULE).
 
 fields(good_ref) ->

apps/emqx_dashboard/test/emqx_swagger_response_SUITE.erl

@@ -680,6 +680,7 @@ to_schema(Object) ->
         post => #{responses => #{200 => Object, 201 => Object}}
     }.
 
+rotos() -> [].
 namespace() -> undefined.
 
 fields(good_ref) ->

apps/emqx_gateway/src/emqx_gateway_api.erl

@@ -36,7 +36,8 @@
 -export([
     api_spec/0,
     paths/0,
-    schema/1
+    schema/1,
+    namespace/0
 ]).
 
 -export([
@@ -59,6 +60,8 @@
 %% minirest behaviour callbacks
 %%--------------------------------------------------------------------
 
+namespace() -> undefined.
+
 api_spec() ->
     emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}).