From e7ced477a9dcbb096046c7cc1d326607fa067d1a Mon Sep 17 00:00:00 2001
From: Shawn <506895667@qq.com>
Date: Wed, 28 Jul 2021 14:07:43 +0800
Subject: [PATCH] feat(config): read schemas for apps from file at build time

---
 apps/emqx/src/emqx_schema.erl | 30 +++++++++++++-----------------
 extension_schemas.config      | 17 +++++++++++++++++
 rebar.config.erl              |  5 +++++
 3 files changed, 35 insertions(+), 17 deletions(-)
 create mode 100644 extension_schemas.config

diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
index d0bbe820d..bcd78ec5f 100644
--- a/apps/emqx/src/emqx_schema.erl
+++ b/apps/emqx/src/emqx_schema.erl
@@ -79,22 +79,11 @@ structs() -> ["cluster", "node", "rpc", "log", "lager",
               "plugins", "sysmon", "alarm"]
              ++ ?MODULE:includes().
 
--ifdef(TEST).
-includes() ->[].
+-ifndef(EMQX_EXT_SCHEMAS).
+includes() -> [].
 -else.
 includes() ->
-    [ "emqx_data_bridge"
-    , "emqx_retainer"
-    , "emqx_statsd"
-    , "emqx_authn"
-    , "emqx_authz"
-    , "emqx_bridge_mqtt"
-    , "emqx_modules"
-    , "emqx_management"
-    , "emqx_dashboard"
-    , "emqx_gateway"
-    , "emqx_prometheus"
-    ].
+    [FieldName || {FieldName, _SchemaMod} <- ?EMQX_EXT_SCHEMAS].
 -endif.
 
 fields("cluster") ->
@@ -525,9 +514,16 @@ fields("alarm") ->
     , {"validity_period", t(duration(), undefined, "24h")}
     ];
 
-fields(ExtraField) ->
-    Mod = to_atom(ExtraField++"_schema"),
-    Mod:fields(ExtraField).
+fields(FieldName) ->
+    extra_schema_fields(FieldName).
+
+-ifndef(EMQX_EXT_SCHEMAS).
+extra_schema_fields(FieldName) -> error({unknown_field, FieldName}).
+-else.
+extra_schema_fields(FieldName) ->
+    {_, Mod} = lists:keyfind(FieldName, 1, ?EMQX_EXT_SCHEMAS),
+    Mod:fields(FieldName).
+-endif.
 
 mqtt_listener() ->
     base_listener() ++
diff --git a/extension_schemas.config b/extension_schemas.config
new file mode 100644
index 000000000..cfac81b30
--- /dev/null
+++ b/extension_schemas.config
@@ -0,0 +1,17 @@
+%% -*-: erlang -*-
+%% This file lists all the hocon schemas other than the `emqx_schema`.
+%% Each element is a two-element tuple where the first element is the field name,
+%% and the second element is the schema module name.
+%%
+[ {"emqx_data_bridge", emqx_data_bridge_schema}
+, {"emqx_retainer", emqx_retainer_schema}
+, {"emqx_statsd", emqx_statsd_schema}
+, {"emqx_authn", emqx_authn_schema}
+, {"emqx_authz", emqx_authz_schema}
+, {"emqx_bridge_mqtt", emqx_bridge_mqtt_schema}
+, {"emqx_modules", emqx_modules_schema}
+, {"emqx_management", emqx_management_schema}
+, {"emqx_dashboard", emqx_dashboard_schema}
+, {"emqx_gateway", emqx_gateway_schema}
+, {"emqx_prometheus", emqx_prometheus_schema}
+].
diff --git a/rebar.config.erl b/rebar.config.erl
index 6364c369b..a73f384b3 100644
--- a/rebar.config.erl
+++ b/rebar.config.erl
@@ -79,6 +79,10 @@ is_cover_enabled() ->
 is_enterprise() ->
     filelib:is_regular("EMQX_ENTERPRISE").
 
+emqx_ext_schemas() ->
+    {ok, Schemas} = file:script("extension_schemas.config"),
+    Schemas.
+
 is_quicer_supported() ->
     not (false =/= os:getenv("BUILD_WITHOUT_QUIC") orelse
          is_win32() orelse is_centos_6()
@@ -134,6 +138,7 @@ common_compile_opts() ->
     , {d, snk_kind, msg}
     ] ++
     [{d, 'EMQX_ENTERPRISE'} || is_enterprise()] ++
+    [{d, 'EMQX_EXT_SCHEMAS', emqx_ext_schemas()}] ++
     [{d, 'EMQX_BENCHMARK'} || os:getenv("EMQX_BENCHMARK") =:= "1" ].
 
 prod_compile_opts() ->