refactor(bridge): update config struct for mqtt bridge

apps/emqx_bridge/etc/emqx_bridge.conf

@@ -3,74 +3,50 @@
 ##--------------------------------------------------------------------
 
 ## MQTT bridges to/from another MQTT broker
-#bridges.mqtt.my_mqtt_bridge_from_aws {
+bridges.mqtt.my_mqtt_bridge_to_aws {
-#    server = "127.0.0.1:1883"
+    server = "127.0.0.1:1883"
-#    proto_ver = "v4"
+    proto_ver = "v4"
-#    clientid = "my_mqtt_bridge_from_aws"
+    clientid = "my_mqtt_bridge_to_aws"
-#    username = "username1"
+    username = "username1"
-#    password = ""
+    password = ""
-#    clean_start = true
+    clean_start = true
-#    keepalive = 300
+    keepalive = 300
-#    retry_interval = "30s"
+    retry_interval = "30s"
-#    max_inflight = 32
+    max_inflight = 32
-#    reconnect_interval = "30s"
+    reconnect_interval = "30s"
-#    bridge_mode = true
+    bridge_mode = true
-#    replayq {
+    replayq {
-#        dir = "{{ platform_data_dir }}/replayq/bridge_mqtt/"
+        dir = "{{ platform_data_dir }}/replayq/bridge_mqtt/"
-#        seg_bytes = "100MB"
+        seg_bytes = "100MB"
-#        offload = false
+        offload = false
-#        max_total_bytes = "1GB"
+        max_total_bytes = "1GB"
-#    }
+    }
-#    ssl {
+    ssl {
-#        enable = false
+        enable = false
-#        keyfile = "{{ platform_etc_dir }}/certs/client-key.pem"
+        keyfile = "{{ platform_etc_dir }}/certs/client-key.pem"
-#        certfile = "{{ platform_etc_dir }}/certs/client-cert.pem"
+        certfile = "{{ platform_etc_dir }}/certs/client-cert.pem"
-#        cacertfile = "{{ platform_etc_dir }}/certs/cacert.pem"
+        cacertfile = "{{ platform_etc_dir }}/certs/cacert.pem"
-#    }
+    }
-#
+
-#    ## topic mappings for this bridge
+    ## topic mappings for this bridge
-#    direction = in
+    ingress {
-#    from_remote_topic = "aws/#"
+        from_remote_topic = "aws/#"
-#    subscribe_qos = 1
+        subscribe_qos = 1
-#    to_local_topic = "from_aws/${topic}"
+        to_local_topic = "from_aws/${topic}"
-#    payload = "${payload}"
+        payload = "${payload}"
-#    qos = "${qos}"
+        qos = "${qos}"
-#    retain = "${retain}"
+        retain = "${retain}"
-#}
+    }
-#
+
-#bridges.mqtt.my_mqtt_bridge_to_aws {
+    egress {
-#    server = "127.0.0.1:1883"
+        from_local_topic = "emqx/#"
-#    proto_ver = "v4"
+        to_remote_topic = "from_emqx/${topic}"
-#    clientid = "my_mqtt_bridge_to_aws"
+        payload = "${payload}"
-#    username = "username1"
+        qos = 1
-#    password = ""
+        retain = false
-#    clean_start = true
+    }
-#    keepalive = 300
+
-#    retry_interval = "30s"
+}
-#    max_inflight = 32
-#    reconnect_interval = "30s"
-#    bridge_mode = true
-#    replayq {
-#        dir = "{{ platform_data_dir }}/replayq/bridge_mqtt/"
-#        seg_bytes = "100MB"
-#        offload = false
-#        max_total_bytes = "1GB"
-#    }
-#    ssl {
-#        enable = false
-#        keyfile = "{{ platform_etc_dir }}/certs/client-key.pem"
-#        certfile = "{{ platform_etc_dir }}/certs/client-cert.pem"
-#        cacertfile = "{{ platform_etc_dir }}/certs/cacert.pem"
-#    }
-#
-#    ## topic mappings for this bridge
-#    direction = out
-#    from_local_topic = "emqx/#"
-#    to_remote_topic = "from_emqx/${topic}"
-#    payload = "${payload}"
-#    qos = 1
-#    retain = false
-#}
 
 ## HTTP bridges to an HTTP server
 bridges.http.my_http_bridge {

apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl

@@ -26,53 +26,81 @@
 -import(emqx_schema, [mk_duration/2]).
 
 roots() ->
-    [{config, #{type => hoconsc:ref(?MODULE, "config")}}].
+    fields("config").
 
 fields("config") ->
-    [ {server, hoconsc:mk(emqx_schema:ip_port(), #{default => "127.0.0.1:1883"})}
+    [ {server,
+        sc(emqx_schema:ip_port(),
+           #{ default => "127.0.0.1:1883"
+            , desc => "The host and port of the remote MQTT broker"
+            })}
     , {reconnect_interval, mk_duration("reconnect interval", #{default => "30s"})}
-    , {proto_ver, fun proto_ver/1}
+    , {proto_ver,
-    , {bridge_mode, hoconsc:mk(boolean(), #{default => true})}
+        sc(hoconsc:enum([v3, v4, v5]),
-    , {username, hoconsc:mk(string())}
+           #{ default => v4
-    , {password, hoconsc:mk(string())}
+            , desc => "The MQTT protocol version"
-    , {clean_start, hoconsc:mk(boolean(), #{default => true})}
+            })}
+    , {bridge_mode,
+        sc(boolean(),
+           #{ default => true
+            , desc => "The bridge mode of the MQTT protocol"
+            })}
+    , {username,
+        sc(binary(),
+           #{ default => "emqx"
+            , desc => "The username of the MQTT protocol"
+            })}
+    , {password,
+        sc(binary(),
+           #{ default => "emqx"
+            , desc => "The password of the MQTT protocol"
+            })}
+    , {clientid,
+        sc(binary(),
+           #{ default => "emqx_${nodename}"
+            , desc => "The clientid of the MQTT protocol"
+            })}
+    , {clean_start,
+        sc(boolean(),
+           #{ default => true
+            , desc => "The clean-start or the clean-session of the MQTT protocol"
+            })}
     , {keepalive, mk_duration("keepalive", #{default => "300s"})}
     , {retry_interval, mk_duration("retry interval", #{default => "30s"})}
-    , {max_inflight, hoconsc:mk(integer(), #{default => 32})}
+    , {max_inflight, sc(integer(), #{default => 32})}
-    , {replayq, hoconsc:mk(hoconsc:ref(?MODULE, "replayq"))}
+    , {replayq, sc(ref("replayq"))}
-    , {ingress_channels, hoconsc:mk(hoconsc:map(id, hoconsc:ref(?MODULE, "ingress_channels")), #{default => []})}
+    , {ingress_channels, sc(hoconsc:map(id, ref("ingress_channels")), #{default => []})}
-    , {egress_channels, hoconsc:mk(hoconsc:map(id, hoconsc:ref(?MODULE, "egress_channels")), #{default => []})}
+    , {egress_channels, sc(hoconsc:map(id, ref("egress_channels")), #{default => []})}
     ] ++ emqx_connector_schema_lib:ssl_fields();
 
 fields("ingress_channels") ->
     %% the message maybe subscribed by rules, in this case 'local_topic' is not necessary
-    [ {subscribe_remote_topic, hoconsc:mk(binary(), #{nullable => false})}
+    [ {subscribe_remote_topic, sc(binary(), #{nullable => false})}
-    , {local_topic, hoconsc:mk(binary())}
+    , {local_topic, sc(binary())}
-    , {subscribe_qos, hoconsc:mk(qos(), #{default => 1})}
+    , {subscribe_qos, sc(qos(), #{default => 1})}
     ] ++ common_inout_confs();
 
 fields("egress_channels") ->
     %% the message maybe sent from rules, in this case 'subscribe_local_topic' is not necessary
-    [ {subscribe_local_topic, hoconsc:mk(binary())}
+    [ {subscribe_local_topic, sc(binary())}
-    , {remote_topic, hoconsc:mk(binary(), #{default => <<"${topic}">>})}
+    , {remote_topic, sc(binary(), #{default => <<"${topic}">>})}
     ] ++ common_inout_confs();
 
 fields("replayq") ->
     [ {dir, hoconsc:union([boolean(), string()])}
-    , {seg_bytes, hoconsc:mk(emqx_schema:bytesize(), #{default => "100MB"})}
+    , {seg_bytes, sc(emqx_schema:bytesize(), #{default => "100MB"})}
-    , {offload, hoconsc:mk(boolean(), #{default => false})}
+    , {offload, sc(boolean(), #{default => false})}
-    , {max_total_bytes, hoconsc:mk(emqx_schema:bytesize(), #{default => "1024MB"})}
+    , {max_total_bytes, sc(emqx_schema:bytesize(), #{default => "1024MB"})}
     ].
 
 common_inout_confs() ->
-    [ {qos, hoconsc:mk(qos(), #{default => <<"${qos}">>})}
+    [ {qos, sc(qos(), #{default => <<"${qos}">>})}
-    , {retain, hoconsc:mk(hoconsc:union([boolean(), binary()]), #{default => <<"${retain}">>})}
+    , {retain, sc(hoconsc:union([boolean(), binary()]), #{default => <<"${retain}">>})}
-    , {payload, hoconsc:mk(binary(), #{default => <<"${payload}">>})}
+    , {payload, sc(binary(), #{default => <<"${payload}">>})}
     ].
 
 qos() ->
     hoconsc:union([typerefl:integer(0), typerefl:integer(1), typerefl:integer(2), binary()]).
 
-proto_ver(type) -> hoconsc:enum([v3, v4, v5]);
+sc(Type, Meta) -> hoconsc:mk(Type, Meta).
-proto_ver(default) -> v4;
+ref(Field) -> hoconsc:ref(?MODULE, Field).
-proto_ver(_) -> undefined.