feat(tdengine): improve the TDengine bridge to v2 style

apps/emqx_bridge/src/emqx_action_info.erl

@@ -102,7 +102,8 @@ hard_coded_action_info_modules_ee() ->
         emqx_bridge_iotdb_action_info,
         emqx_bridge_es_action_info,
         emqx_bridge_opents_action_info,
-        emqx_bridge_greptimedb_action_info
+        emqx_bridge_greptimedb_action_info,
+        emqx_bridge_tdengine_action_info
     ].
 -else.
 hard_coded_action_info_modules_ee() ->

apps/emqx_bridge_opents/src/emqx_bridge_opents_connector.erl

@@ -74,7 +74,7 @@ desc(connector_resource_opts) ->
 desc("config_connector") ->
     ?DESC("desc_config");
 desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" ->
-    ["Configuration for IoTDB using `", string:to_upper(Method), "` method."];
+    ["Configuration for OpenTSDB using `", string:to_upper(Method), "` method."];
 desc(_) ->
     undefined.
 

apps/emqx_bridge_tdengine/src/emqx_bridge_tdengine.app.src

@@ -1,6 +1,6 @@
 {application, emqx_bridge_tdengine, [
     {description, "EMQX Enterprise TDEngine Bridge"},
-    {vsn, "0.1.6"},
+    {vsn, "0.1.7"},
     {registered, []},
     {applications, [
         kernel,

apps/emqx_bridge_tdengine/src/emqx_bridge_tdengine.erl

@@ -9,35 +9,21 @@
 
 -import(hoconsc, [mk/2, enum/1, ref/2]).
 
--export([
-    conn_bridge_examples/1,
-    values/1
-]).
-
--export([
-    namespace/0,
-    roots/0,
-    fields/1,
-    desc/1
-]).
+-export([conn_bridge_examples/1, values/1, bridge_v2_examples/1]).
+-export([namespace/0, roots/0, fields/1, desc/1]).
 
 -define(DEFAULT_SQL, <<
-    "insert into t_mqtt_msg(ts, msgid, mqtt_topic, qos, payload, arrived) "
-    "values (${ts}, '${id}', '${topic}', ${qos}, '${payload}', ${timestamp})"
+    "insert into t_mqtt_msg(ts, msgid, mqtt_topic, qos, payload, "
+    "arrived) values (${ts}, '${id}', '${topic}', ${qos}, '${payload}', "
+    "${timestamp})"
 >>).
+-define(CONNECTOR_TYPE, tdengine).
+-define(ACTION_TYPE, ?CONNECTOR_TYPE).
 
 %% -------------------------------------------------------------------------------------------------
-%% api
-
+%% v1 examples
 conn_bridge_examples(Method) ->
-    [
-        #{
-            <<"tdengine">> => #{
-                summary => <<"TDengine Bridge">>,
-                value => values(Method)
-            }
-        }
-    ].
+    [#{<<"tdengine">> => #{summary => <<"TDengine Bridge">>, value => values(Method)}}].
 
 values(_Method) ->
     #{
@@ -51,46 +37,115 @@ values(_Method) ->
         password => <<"******">>,
         sql => ?DEFAULT_SQL,
         local_topic => <<"local/topic/#">>,
-        resource_opts => #{
-            worker_pool_size => 8,
-            health_check_interval => ?HEALTHCHECK_INTERVAL_RAW,
-            batch_size => ?DEFAULT_BATCH_SIZE,
-            batch_time => ?DEFAULT_BATCH_TIME,
-            query_mode => sync,
-            max_buffer_bytes => ?DEFAULT_BUFFER_BYTES
+        resource_opts =>
+            #{
+                worker_pool_size => 8,
+                health_check_interval => ?HEALTHCHECK_INTERVAL_RAW,
+                batch_size => ?DEFAULT_BATCH_SIZE,
+                batch_time => ?DEFAULT_BATCH_TIME,
+                query_mode => sync,
+                max_buffer_bytes => ?DEFAULT_BUFFER_BYTES
+            }
+    }.
+
+%% -------------------------------------------------------------------------------------------------
+%% v2 examples
+bridge_v2_examples(Method) ->
+    [
+        #{
+            <<"tdengine">> => #{
+                summary => <<"TDengine Action">>,
+                value => emqx_bridge_v2_schema:action_values(
+                    Method, ?ACTION_TYPE, ?CONNECTOR_TYPE, action_values()
+                )
+            }
+        }
+    ].
+
+action_values() ->
+    #{
+        parameters => #{
+            database => <<"mqtt">>,
+            sql => ?DEFAULT_SQL
         }
     }.
 
 %% -------------------------------------------------------------------------------------------------
-%% Hocon Schema Definitions
-namespace() -> "bridge_tdengine".
+%% v1 Hocon Schema Definitions
+namespace() ->
+    "bridge_tdengine".
 
-roots() -> [].
+roots() ->
+    [].
 
 fields("config") ->
     [
         {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
         {sql,
             mk(
                 binary(),
-                #{desc => ?DESC("sql_template"), default => ?DEFAULT_SQL, format => <<"sql">>}
+                #{
+                    desc => ?DESC("sql_template"),
+                    default => ?DEFAULT_SQL,
+                    format => <<"sql">>
+                }
             )},
-        {local_topic,
-            mk(
-                binary(),
-                #{desc => ?DESC("local_topic"), default => undefined}
-            )}
-    ] ++ emqx_resource_schema:fields("resource_opts") ++
+        {local_topic, mk(binary(), #{desc => ?DESC("local_topic"), default => undefined})}
+    ] ++
+        emqx_resource_schema:fields("resource_opts") ++
         emqx_bridge_tdengine_connector:fields(config);
 fields("post") ->
     [type_field(), name_field() | fields("config")];
 fields("put") ->
     fields("config");
 fields("get") ->
-    emqx_bridge_schema:status_fields() ++ fields("post").
+    emqx_bridge_schema:status_fields() ++ fields("post");
+%% -------------------------------------------------------------------------------------------------
+%% v2 Hocon Schema Definitions
+fields(action) ->
+    {tdengine,
+        mk(
+            hoconsc:map(name, ref(?MODULE, action_config)),
+            #{
+                desc => <<"TDengine Action Config">>,
+                required => false
+            }
+        )};
+fields(action_config) ->
+    emqx_bridge_v2_schema:make_producer_action_schema(
+        mk(
+            ref(?MODULE, action_parameters),
+            #{
+                required => true, desc => ?DESC("action_parameters")
+            }
+        )
+    );
+fields(action_parameters) ->
+    [
+        {database, fun emqx_connector_schema_lib:database/1},
+        {sql,
+            mk(
+                binary(),
+                #{
+                    desc => ?DESC("sql_template"),
+                    default => ?DEFAULT_SQL,
+                    format => <<"sql">>
+                }
+            )}
+    ];
+fields("post_bridge_v2") ->
+    emqx_bridge_schema:type_and_name_fields(enum([tdengine])) ++ fields(action_config);
+fields("put_bridge_v2") ->
+    fields(action_config);
+fields("get_bridge_v2") ->
+    emqx_bridge_schema:status_fields() ++ fields("post_bridge_v2").
 
 desc("config") ->
     ?DESC("desc_config");
+desc(action_config) ->
+    ?DESC("desc_config");
+desc(action_parameters) ->
+    ?DESC("action_parameters");
 desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" ->
     ["Configuration for TDengine using `", string:to_upper(Method), "` method."];
 desc(_) ->

apps/emqx_bridge_tdengine/src/emqx_bridge_tdengine_action_info.erl

@@ -0,0 +1,71 @@
+%%--------------------------------------------------------------------
+%% Copyright (c) 2023-2024 EMQ Technologies Co., Ltd. All Rights Reserved.
+%%--------------------------------------------------------------------
+-module(emqx_bridge_tdengine_action_info).
+
+-behaviour(emqx_action_info).
+
+-elvis([{elvis_style, invalid_dynamic_call, disable}]).
+
+%% behaviour callbacks
+-export([
+    action_type_name/0,
+    bridge_v1_config_to_action_config/2,
+    bridge_v1_config_to_connector_config/1,
+    bridge_v1_type_name/0,
+    connector_action_config_to_bridge_v1_config/2,
+    connector_type_name/0,
+    schema_module/0
+]).
+
+-import(emqx_utils_conv, [bin/1]).
+
+-define(ACTION_TYPE, tdengine).
+-define(SCHEMA_MODULE, emqx_bridge_tdengine).
+
+action_type_name() -> ?ACTION_TYPE.
+bridge_v1_type_name() -> ?ACTION_TYPE.
+connector_type_name() -> ?ACTION_TYPE.
+
+schema_module() -> ?SCHEMA_MODULE.
+
+connector_action_config_to_bridge_v1_config(ConnectorConfig, ActionConfig) ->
+    MergedConfig =
+        emqx_utils_maps:deep_merge(
+            maps:without(
+                [<<"description">>, <<"local_topic">>, <<"connector">>, <<"data">>],
+                emqx_utils_maps:unindent(<<"parameters">>, ActionConfig)
+            ),
+            ConnectorConfig
+        ),
+    BridgeV1Keys = schema_keys("config"),
+    maps:with(BridgeV1Keys, MergedConfig).
+
+bridge_v1_config_to_action_config(BridgeV1Config, ConnectorName) ->
+    ActionTopLevelKeys = schema_keys(action_config),
+    ActionParametersKeys = schema_keys(action_parameters),
+    ActionKeys = ActionTopLevelKeys ++ ActionParametersKeys,
+    ActionConfig = make_config_map(ActionKeys, ActionParametersKeys, BridgeV1Config),
+    emqx_utils_maps:update_if_present(
+        <<"resource_opts">>,
+        fun emqx_bridge_v2_schema:project_to_actions_resource_opts/1,
+        ActionConfig#{<<"connector">> => ConnectorName}
+    ).
+
+bridge_v1_config_to_connector_config(BridgeV1Config) ->
+    ConnectorKeys = schema_keys(emqx_bridge_tdengine_connector, "config_connector"),
+    emqx_utils_maps:update_if_present(
+        <<"resource_opts">>,
+        fun emqx_connector_schema:project_to_connector_resource_opts/1,
+        maps:with(ConnectorKeys, BridgeV1Config)
+    ).
+
+make_config_map(PickKeys, IndentKeys, Config) ->
+    Conf0 = maps:with(PickKeys, Config),
+    emqx_utils_maps:indent(<<"parameters">>, IndentKeys, Conf0).
+
+schema_keys(Name) ->
+    schema_keys(?SCHEMA_MODULE, Name).
+
+schema_keys(Mod, Name) ->
+    [bin(Key) || Key <- proplists:get_keys(Mod:fields(Name))].