chore: split out exproto gateway

apps/emqx_exproto/.gitignore

@@ -0,0 +1,24 @@
+.rebar3
+_*
+.eunit
+*.o
+*.beam
+*.plt
+*.swp
+*.swo
+.erlang.cookie
+ebin
+log
+erl_crash.dump
+.rebar
+logs
+_build
+.idea
+*.iml
+rebar3.crashdump
+*~
+src/emqx_exproto_pb.erl
+src/emqx_exproto_v_1_connection_adapter_bhvr.erl
+src/emqx_exproto_v_1_connection_adapter_client.erl
+src/emqx_exproto_v_1_connection_handler_bhvr.erl
+src/emqx_exproto_v_1_connection_handler_client.erl

apps/emqx_exproto/LICENSE

@@ -0,0 +1,191 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2023, JianBo He <heeejianbo@gmail.com>.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

apps/emqx_exproto/i18n/emqx_exproto_schema.conf

@@ -0,0 +1,52 @@
+emqx_exproto_schema {
+    exproto {
+        desc {
+            en: """The Extension Protocol configuration"""
+            zh: """ExProto 网关"""
+        }
+    }
+
+    exproto_server {
+        desc {
+            en: """Configurations for starting the <code>ConnectionAdapter</code> service"""
+            zh: """配置 ExProto 网关需要启动的 <code>ConnectionAdapter</code> 服务。
+该服务用于提供客户端的认证、发布、订阅和数据下行等功能。"""
+        }
+    }
+
+    exproto_grpc_server_bind {
+        desc {
+            en: """Listening address and port for the gRPC server."""
+            zh: """服务监听地址和端口。"""
+        }
+    }
+
+    exproto_grpc_server_ssl {
+        desc {
+            en: """SSL configuration for the gRPC server."""
+            zh: """服务 SSL 配置。"""
+        }
+    }
+
+    exproto_handler {
+        desc {
+            en: """Configurations for request to <code>ConnectionHandler</code> service"""
+            zh: """配置 ExProto 网关需要请求的 <code>ConnectionHandler</code> 服务地址。
+该服务用于给 ExProto 提供客户端的 Socket 事件处理、字节解码、订阅消息接收等功能。"""
+        }
+    }
+
+    exproto_grpc_handler_address {
+        desc {
+            en: """gRPC server address."""
+            zh: """对端 gRPC 服务器地址。"""
+        }
+    }
+
+    exproto_grpc_handler_ssl {
+        desc {
+            en: """SSL configuration for the gRPC client."""
+            zh: """gRPC 客户端的 SSL 配置。"""
+        }
+    }
+}

apps/emqx_exproto/rebar.config

@@ -0,0 +1,31 @@
+{erl_opts, [debug_info]}.
+
+{plugins, [
+    {grpc_plugin, {git, "https://github.com/HJianBo/grpc_plugin", {tag, "v0.10.2"}}}
+]}.
+
+{grpc, [
+    {protos, ["priv/protos"]},
+    {out_dir, "src"},
+    {gpb_opts, [
+        {module_name_prefix, "emqx_"},
+        {module_name_suffix, "_pb"}
+    ]}
+]}.
+
+{provider_hooks, [
+    {pre, [
+        {compile, {grpc, gen}},
+        {clean, {grpc, clean}}
+    ]}
+]}.
+
+{xref_ignores, [emqx_exproto_pb]}.
+
+{cover_excl_mods, [
+    emqx_exproto_pb,
+    emqx_exproto_v_1_connection_adapter_client,
+    emqx_exproto_v_1_connection_adapter_bhvr,
+    emqx_exproto_v_1_connection_handler_client,
+    emqx_exproto_v_1_connection_handler_bhvr
+]}.

apps/emqx_exproto/src/emqx_exproto.app.src

@@ -0,0 +1,10 @@
+{application, emqx_exproto, [
+    {description, "ExProto Gateway"},
+    {vsn, "0.1.0"},
+    {registered, []},
+    {applications, [kernel, stdlib, emqx_gateway, grpc]},
+    {env, []},
+    {modules, []},
+    {licenses, ["Apache 2.0"]},
+    {links, []}
+]}.

apps/emqx_gateway/src/exproto/emqx_exproto_impl.erl

@@ -14,12 +14,28 @@
 %% limitations under the License.
 %%--------------------------------------------------------------------
 
-%% @doc The ExProto Gateway Implement interface
--module(emqx_exproto_impl).
+%% @doc The ExProto Gateway implement
+-module(emqx_exproto).
 
+-include_lib("emqx/include/logger.hrl").
+-include_lib("emqx_gateway/include/emqx_gateway.hrl").
+
+%% define a gateway named stomp
+-gateway(#{
+    name => exproto,
+    callback_module => ?MODULE,
+    config_schema_module => emqx_exproto_schema
+}).
+
+%% callback_module must implement the emqx_gateway_impl behaviour
 -behaviour(emqx_gateway_impl).
 
--include_lib("emqx/include/logger.hrl").
+%% callback for emqx_gateway_impl
+-export([
+    on_gateway_load/2,
+    on_gateway_update/3,
+    on_gateway_unload/2
+]).
 
 -import(
     emqx_gateway_utils,
@@ -30,31 +46,8 @@
     ]
 ).
 
-%% APIs
--export([
-    reg/0,
-    unreg/0
-]).
-
--export([
-    on_gateway_load/2,
-    on_gateway_update/3,
-    on_gateway_unload/2
-]).
-
-%%--------------------------------------------------------------------
-%% APIs
-%%--------------------------------------------------------------------
-
-reg() ->
-    RegistryOptions = [{cbkmod, ?MODULE}],
-    emqx_gateway_registry:reg(exproto, RegistryOptions).
-
-unreg() ->
-    emqx_gateway_registry:unreg(exproto).
-
 %%--------------------------------------------------------------------
-%% emqx_gateway_registry callbacks
+%% emqx_gateway_impl callbacks
 %%--------------------------------------------------------------------
 
 on_gateway_load(

apps/emqx_gateway/src/exproto/emqx_exproto_channel.erl

@@ -15,7 +15,8 @@
 %%--------------------------------------------------------------------
 
 -module(emqx_exproto_channel).
--include("src/exproto/include/emqx_exproto.hrl").
+
+-include("emqx_exproto.hrl").
 -include_lib("emqx/include/emqx.hrl").
 -include_lib("emqx/include/emqx_mqtt.hrl").
 -include_lib("emqx/include/types.hrl").

apps/emqx_gateway/src/exproto/emqx_exproto_gsvr.erl

@@ -19,7 +19,7 @@
 
 % -behaviour(emqx_exproto_v_1_connection_adapter_bhvr).
 
--include("src/exproto/include/emqx_exproto.hrl").
+-include("emqx_exproto.hrl").
 -include_lib("emqx/include/logger.hrl").
 
 -define(IS_QOS(X), (X =:= 0 orelse X =:= 1 orelse X =:= 2)).

apps/emqx_exproto/src/emqx_exproto_schema.erl

@@ -0,0 +1,117 @@
+%%--------------------------------------------------------------------
+%% Copyright (c) 2023 EMQ Technologies Co., Ltd. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%--------------------------------------------------------------------
+
+-module(emqx_exproto_schema).
+
+-include_lib("hocon/include/hoconsc.hrl").
+-include_lib("typerefl/include/types.hrl").
+
+-type ip_port() :: tuple() | integer().
+
+-typerefl_from_string({ip_port/0, emqx_schema, to_ip_port}).
+
+-reflect_type([
+    ip_port/0
+]).
+
+%% config schema provides
+-export([fields/1, desc/1]).
+
+fields(exproto) ->
+    [
+        {server,
+            sc(
+                ref(exproto_grpc_server),
+                #{
+                    required => true,
+                    desc => ?DESC(exproto_server)
+                }
+            )},
+        {handler,
+            sc(
+                ref(exproto_grpc_handler),
+                #{
+                    required => true,
+                    desc => ?DESC(exproto_handler)
+                }
+            )},
+        {mountpoint, emqx_gateway_schema:mountpoint()},
+        {listeners,
+            sc(ref(emqx_gateway_schema, tcp_udp_listeners), #{desc => ?DESC(tcp_udp_listeners)})}
+    ] ++ emqx_gateway_schema:gateway_common_options();
+fields(exproto_grpc_server) ->
+    [
+        {bind,
+            sc(
+                hoconsc:union([ip_port(), integer()]),
+                #{
+                    required => true,
+                    desc => ?DESC(exproto_grpc_server_bind)
+                }
+            )},
+        {ssl_options,
+            sc(
+                ref(ssl_server_opts),
+                #{
+                    required => {false, recursively},
+                    desc => ?DESC(exproto_grpc_server_ssl)
+                }
+            )}
+    ];
+fields(exproto_grpc_handler) ->
+    [
+        {address, sc(binary(), #{required => true, desc => ?DESC(exproto_grpc_handler_address)})},
+        {ssl_options,
+            sc(
+                ref(emqx_schema, "ssl_client_opts"),
+                #{
+                    required => {false, recursively},
+                    desc => ?DESC(exproto_grpc_handler_ssl)
+                }
+            )}
+    ];
+fields(ssl_server_opts) ->
+    emqx_schema:server_ssl_opts_schema(
+        #{
+            depth => 10,
+            reuse_sessions => true,
+            versions => tls_all_available
+        },
+        true
+    ).
+
+desc(exproto) ->
+    "Settings for EMQX extension protocol (exproto).";
+desc(exproto_grpc_server) ->
+    "Settings for the exproto gRPC server.";
+desc(exproto_grpc_handler) ->
+    "Settings for the exproto gRPC connection handler.";
+desc(ssl_server_opts) ->
+    "SSL configuration for the server.";
+desc(_) ->
+    undefined.
+
+%%--------------------------------------------------------------------
+%% helpers
+
+sc(Type, Meta) ->
+    hoconsc:mk(Type, Meta).
+
+ref(StructName) ->
+    ref(?MODULE, StructName).
+
+ref(Mod, Field) ->
+    hoconsc:ref(Mod, Field).

apps/emqx_gateway/test/emqx_exproto_SUITE.erl

@@ -76,6 +76,7 @@ metrics() ->
     [tcp, ssl, udp, dtls].
 
 init_per_group(GrpName, Cfg) ->
+    application:load(emqx_exproto),
     put(grpname, GrpName),
     Svrs = emqx_exproto_echo_svr:start(),
     emqx_common_test_helpers:start_apps([emqx_authn, emqx_gateway], fun set_special_cfg/1),

apps/emqx_gateway/.gitignore

@@ -18,8 +18,4 @@ _build
 rebar3.crashdump
 *~
 rebar.lock
-src/exproto/emqx_exproto_pb.erl
-src/exproto/emqx_exproto_v_1_connection_adapter_bhvr.erl
-src/exproto/emqx_exproto_v_1_connection_adapter_client.erl
-src/exproto/emqx_exproto_v_1_connection_handler_bhvr.erl
-src/exproto/emqx_exproto_v_1_connection_handler_client.erl
+

apps/emqx_gateway/Makefile

@@ -1,28 +0,0 @@
-## shallow clone for speed
-
-REBAR_GIT_CLONE_OPTIONS += --depth 1
-export REBAR_GIT_CLONE_OPTIONS
-
-REBAR = rebar3
-all: compile
-
-compile:
-	$(REBAR) compile
-
-clean: distclean
-
-ct:
-	$(REBAR) as test ct -v
-
-eunit:
-	$(REBAR) as test eunit
-
-xref:
-	$(REBAR) xref
-
-cover:
-	$(REBAR) cover
-
-distclean:
-	@rm -rf _build
-	@rm -f data/app.*.config data/vm.*.args rebar.lock

apps/emqx_gateway/i18n/emqx_gateway_schema_i18n.conf

@@ -1,56 +1,5 @@
 emqx_gateway_schema {
 
-    exproto {
-        desc {
-            en: """The Extension Protocol configuration"""
-            zh: """ExProto 网关"""
-        }
-    }
-
-    exproto_server {
-        desc {
-            en: """Configurations for starting the <code>ConnectionAdapter</code> service"""
-            zh: """配置 ExProto 网关需要启动的 <code>ConnectionAdapter</code> 服务。
-该服务用于提供客户端的认证、发布、订阅和数据下行等功能。"""
-        }
-    }
-
-    exproto_grpc_server_bind {
-        desc {
-            en: """Listening address and port for the gRPC server."""
-            zh: """服务监听地址和端口。"""
-        }
-    }
-
-    exproto_grpc_server_ssl {
-        desc {
-            en: """SSL configuration for the gRPC server."""
-            zh: """服务 SSL 配置。"""
-        }
-    }
-
-    exproto_handler {
-        desc {
-            en: """Configurations for request to <code>ConnectionHandler</code> service"""
-            zh: """配置 ExProto 网关需要请求的 <code>ConnectionHandler</code> 服务地址。
-该服务用于给 ExProto 提供客户端的 Socket 事件处理、字节解码、订阅消息接收等功能。"""
-        }
-    }
-
-    exproto_grpc_handler_address {
-        desc {
-            en: """gRPC server address."""
-            zh: """对端 gRPC 服务器地址。"""
-        }
-    }
-
-    exproto_grpc_handler_ssl {
-        desc {
-            en: """SSL configuration for the gRPC client."""
-            zh: """gRPC 客户端的 SSL 配置。"""
-        }
-    }
-
     gateway_common_enable {
         desc {
             en: """Whether to enable this gateway"""

apps/emqx_gateway/rebar.config

@@ -1,38 +1,5 @@
 %% -*- mode: erlang -*-
-
 {erl_opts, [debug_info]}.
 {deps, [
     {emqx, {path, "../emqx"}}
 ]}.
-
-{plugins, [
-    {grpc_plugin, {git, "https://github.com/HJianBo/grpc_plugin", {tag, "v0.10.2"}}}
-]}.
-
-{grpc, [
-    {protos, ["src/exproto/protos"]},
-    {out_dir, "src/exproto/"},
-    {gpb_opts, [
-        {module_name_prefix, "emqx_"},
-        {module_name_suffix, "_pb"}
-    ]}
-]}.
-
-{provider_hooks, [
-    {pre, [
-        {compile, {grpc, gen}},
-        {clean, {grpc, clean}}
-    ]}
-]}.
-
-{xref_ignores, [emqx_exproto_pb]}.
-
-{cover_excl_mods, [
-    emqx_exproto_pb,
-    emqx_exproto_v_1_connection_adapter_client,
-    emqx_exproto_v_1_connection_adapter_bhvr,
-    emqx_exproto_v_1_connection_handler_client,
-    emqx_exproto_v_1_connection_handler_bhvr
-]}.
-
-{project_plugins, [erlfmt]}.

apps/emqx_gateway/src/emqx_gateway.app.src

@@ -4,7 +4,7 @@
     {vsn, "0.1.14"},
     {registered, []},
     {mod, {emqx_gateway_app, []}},
-    {applications, [kernel, stdlib, grpc, emqx, emqx_authn, emqx_ctl]},
+    {applications, [kernel, stdlib, emqx, emqx_authn, emqx_ctl]},
     {env, []},
     {modules, []},
     {licenses, ["Apache 2.0"]},

apps/emqx_gateway/src/emqx_gateway_app.erl

@@ -41,18 +41,11 @@ stop(_State) ->
 %% Internal funcs
 
 load_default_gateway_applications() ->
-    BuiltInGateways = [
-        #{
-            name => exproto,
-            callback_module => emqx_exproto_impl,
-            config_schema_module => emqx_gateway_schema
-        }
-    ],
     lists:foreach(
         fun(Def) ->
             load_gateway_application(Def)
         end,
-        emqx_gateway_utils:find_gateway_definations() ++ BuiltInGateways
+        emqx_gateway_utils:find_gateway_definations()
     ).
 
 load_gateway_application(

apps/emqx_gateway/src/emqx_gateway_schema.erl

@@ -60,79 +60,22 @@ namespace() -> gateway.
 tags() ->
     [<<"Gateway">>].
 
-roots() -> [gateway].
+roots() ->
+    [{gateway, sc(ref(?MODULE, gateway), #{importance => ?IMPORTANCE_HIDDEN})}].
 
 fields(gateway) ->
-    [
-        {exproto,
-            sc(
-                ref(exproto),
-                #{
-                    required => {false, recursively},
-                    desc => ?DESC(exproto)
-                }
-            )}
-    ] ++ gateway_schemas();
-fields(exproto) ->
-    [
-        {server,
-            sc(
-                ref(exproto_grpc_server),
-                #{
-                    required => true,
-                    desc => ?DESC(exproto_server)
-                }
-            )},
-        {handler,
-            sc(
-                ref(exproto_grpc_handler),
-                #{
-                    required => true,
-                    desc => ?DESC(exproto_handler)
-                }
-            )},
-        {mountpoint, mountpoint()},
-        {listeners, sc(ref(tcp_udp_listeners), #{desc => ?DESC(tcp_udp_listeners)})}
-    ] ++ gateway_common_options();
-fields(exproto_grpc_server) ->
-    [
-        {bind,
-            sc(
-                hoconsc:union([ip_port(), integer()]),
-                #{
-                    required => true,
-                    desc => ?DESC(exproto_grpc_server_bind)
-                }
-            )},
-        {ssl_options,
-            sc(
-                ref(ssl_server_opts),
-                #{
-                    required => {false, recursively},
-                    desc => ?DESC(exproto_grpc_server_ssl)
-                }
-            )}
-    ];
-fields(exproto_grpc_handler) ->
-    [
-        {address, sc(binary(), #{required => true, desc => ?DESC(exproto_grpc_handler_address)})},
-        {ssl_options,
-            sc(
-                ref(emqx_schema, "ssl_client_opts"),
-                #{
-                    required => {false, recursively},
-                    desc => ?DESC(exproto_grpc_handler_ssl)
-                }
-            )}
-    ];
-fields(ssl_server_opts) ->
-    emqx_schema:server_ssl_opts_schema(
-        #{
-            depth => 10,
-            reuse_sessions => true,
-            versions => tls_all_available
-        },
-        true
+    lists:map(
+        fun(#{name := Name, config_schema_module := Mod}) ->
+            {Name,
+                sc(
+                    ref(Mod, Name),
+                    #{
+                        required => {false, recursively},
+                        desc => ?DESC(Name)
+                    }
+                )}
+        end,
+        emqx_gateway_utils:find_gateway_definations()
     );
 fields(clientinfo_override) ->
     [
@@ -217,14 +160,6 @@ fields(dtls_opts) ->
 
 desc(gateway) ->
     "EMQX Gateway configuration root.";
-desc(exproto) ->
-    "Settings for EMQX extension protocol (exproto).";
-desc(exproto_grpc_server) ->
-    "Settings for the exproto gRPC server.";
-desc(exproto_grpc_handler) ->
-    "Settings for the exproto gRPC connection handler.";
-desc(ssl_server_opts) ->
-    "SSL configuration for the server.";
 desc(clientinfo_override) ->
     "ClientInfo override.";
 desc(udp_listeners) ->
@@ -391,26 +326,11 @@ proxy_protocol_opts() ->
 %% dynamic schemas
 
 %% FIXME: don't hardcode the gateway names
-gateway_schema(exproto) -> fields(exproto);
 gateway_schema(stomp) -> emqx_stomp_schema:fields(stomp);
 gateway_schema(mqttsn) -> emqx_mqttsn_schema:fields(mqttsn);
 gateway_schema(coap) -> emqx_coap_schema:fields(coap);
-gateway_schema(lwm2m) -> emqx_lwm2m_schema:fields(lwm2m).
-
-gateway_schemas() ->
-    lists:map(
-        fun(#{name := Name, config_schema_module := Mod}) ->
-            {Name,
-                sc(
-                    ref(Mod, Name),
-                    #{
-                        required => {false, recursively},
-                        desc => ?DESC(Name)
-                    }
-                )}
-        end,
-        emqx_gateway_utils:find_gateway_definations()
-    ).
+gateway_schema(lwm2m) -> emqx_lwm2m_schema:fields(lwm2m);
+gateway_schema(exproto) -> emqx_exproto_schema:fields(exproto).
 
 %%--------------------------------------------------------------------
 %% helpers

mix.exs

@@ -285,6 +285,7 @@ defmodule EMQXUmbrella.MixProject do
         emqx_mqttsn: :permanent,
         emqx_coap: :permanent,
         emqx_lwm2m: :permanent,
+        emqx_exproto: :permanent,
         emqx_exhook: :permanent,
         emqx_bridge: :permanent,
         emqx_rule_engine: :permanent,

rebar.config.erl

@@ -393,6 +393,7 @@ relx_apps(ReleaseType, Edition) ->
             emqx_mqttsn,
             emqx_coap,
             emqx_lwm2m,
+            emqx_exproto,
             emqx_exhook,
             emqx_bridge,
             emqx_rule_engine,