From c6d7c57bbd3358f984b202a6b1b617951ddd5cb9 Mon Sep 17 00:00:00 2001
From: Kjell Winblad <kjellwinblad@gmail.com>
Date: Wed, 20 Mar 2024 10:59:58 +0100
Subject: [PATCH] refactor(clickhouse connector): to use emqx_connector_info

This commit refactors the clickhouse connector to use the
`emqx_connector_info` behavior.
---
 .../src/emqx_bridge_clickhouse.app.src        |  5 ++-
 .../emqx_bridge_clickhouse_connector_info.erl | 42 +++++++++++++++++++
 .../src/emqx_connector_info.erl               |  3 +-
 .../src/schema/emqx_connector_ee_schema.erl   | 12 ------
 .../src/schema/emqx_connector_schema.erl      |  2 -
 5 files changed, 48 insertions(+), 16 deletions(-)
 create mode 100644 apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse_connector_info.erl

diff --git a/apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse.app.src b/apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse.app.src
index d96d06375..b0fc2698c 100644
--- a/apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse.app.src
+++ b/apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse.app.src
@@ -8,7 +8,10 @@
         emqx_resource,
         clickhouse
     ]},
-    {env, [{emqx_action_info_modules, [emqx_bridge_clickhouse_action_info]}]},
+    {env, [
+        {emqx_action_info_modules, [emqx_bridge_clickhouse_action_info]},
+        {emqx_connector_info_modules, [emqx_bridge_clickhouse_connector_info]}
+    ]},
     {modules, []},
     {links, []}
 ]}.
diff --git a/apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse_connector_info.erl b/apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse_connector_info.erl
new file mode 100644
index 000000000..8aa03b27e
--- /dev/null
+++ b/apps/emqx_bridge_clickhouse/src/emqx_bridge_clickhouse_connector_info.erl
@@ -0,0 +1,42 @@
+%%--------------------------------------------------------------------
+%% Copyright (c) 2024 EMQ Technologies Co., Ltd. All Rights Reserved.
+%%--------------------------------------------------------------------
+-module(emqx_bridge_clickhouse_connector_info).
+
+-behaviour(emqx_connector_info).
+
+-export([
+    type_name/0,
+    bridge_types/0,
+    resource_callback_module/0,
+    config_schema/0,
+    schema_module/0,
+    api_schema/1
+]).
+
+type_name() ->
+    clickhouse.
+
+bridge_types() ->
+    [clickhouse].
+
+resource_callback_module() ->
+    emqx_bridge_clickhouse_connector.
+
+config_schema() ->
+    {clickhouse,
+        hoconsc:mk(
+            hoconsc:map(name, hoconsc:ref(emqx_bridge_clickhouse, "config_connector")),
+            #{
+                desc => <<"ClickHouse Connector Config">>,
+                required => false
+            }
+        )}.
+
+schema_module() ->
+    emqx_bridge_clickhouse.
+
+api_schema(Method) ->
+    emqx_connector_schema:api_ref(
+        emqx_bridge_clickhouse, <<"clickhouse">>, Method ++ "_connector"
+    ).
diff --git a/apps/emqx_connector/src/emqx_connector_info.erl b/apps/emqx_connector/src/emqx_connector_info.erl
index 568c66ec4..2ff4191fa 100644
--- a/apps/emqx_connector/src/emqx_connector_info.erl
+++ b/apps/emqx_connector/src/emqx_connector_info.erl
@@ -71,7 +71,8 @@ hard_coded_connector_info_modules_ee() ->
         emqx_bridge_mongodb_connector_info,
         emqx_bridge_oracle_connector_info,
         emqx_bridge_influxdb_connector_info,
-        emqx_bridge_cassandra_connector_info
+        emqx_bridge_cassandra_connector_info,
+        emqx_bridge_clickhouse_connector_info
     ].
 -else.
 hard_coded_connector_info_modules_ee() ->
diff --git a/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl b/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl
index 98b55606d..aed05d96a 100644
--- a/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl
+++ b/apps/emqx_connector/src/schema/emqx_connector_ee_schema.erl
@@ -21,8 +21,6 @@
 
 resource_type(Type) when is_binary(Type) ->
     resource_type(binary_to_atom(Type, utf8));
-resource_type(clickhouse) ->
-    emqx_bridge_clickhouse_connector;
 resource_type(mysql) ->
     emqx_bridge_mysql_connector;
 resource_type(syskeeper_forwarder) ->
@@ -79,14 +77,6 @@ fields(connectors) ->
 
 connector_structs() ->
     [
-        {clickhouse,
-            mk(
-                hoconsc:map(name, ref(emqx_bridge_clickhouse, "config_connector")),
-                #{
-                    desc => <<"ClickHouse Connector Config">>,
-                    required => false
-                }
-            )},
         {mysql,
             mk(
                 hoconsc:map(name, ref(emqx_bridge_mysql, "config_connector")),
@@ -203,7 +193,6 @@ connector_structs() ->
 
 schema_modules() ->
     [
-        emqx_bridge_clickhouse,
         emqx_bridge_mysql,
         emqx_bridge_syskeeper_connector,
         emqx_bridge_syskeeper_proxy,
@@ -225,7 +214,6 @@ api_schemas(Method) ->
     [
         %% We need to map the `type' field of a request (binary) to a
         %% connector schema module.
-        api_ref(emqx_bridge_clickhouse, <<"clickhouse">>, Method ++ "_connector"),
         api_ref(emqx_bridge_mysql, <<"mysql">>, Method ++ "_connector"),
         api_ref(emqx_bridge_syskeeper_connector, <<"syskeeper_forwarder">>, Method),
         api_ref(emqx_bridge_syskeeper_proxy, <<"syskeeper_proxy">>, Method),
diff --git a/apps/emqx_connector/src/schema/emqx_connector_schema.erl b/apps/emqx_connector/src/schema/emqx_connector_schema.erl
index 8236f57aa..fabbad32b 100644
--- a/apps/emqx_connector/src/schema/emqx_connector_schema.erl
+++ b/apps/emqx_connector/src/schema/emqx_connector_schema.erl
@@ -127,8 +127,6 @@ connector_info_schema_modules() ->
 
 %% @doc Return old bridge(v1) and/or connector(v2) type
 %% from the latest connector type name.
-connector_type_to_bridge_types(clickhouse) ->
-    [clickhouse];
 connector_type_to_bridge_types(mysql) ->
     [mysql];
 connector_type_to_bridge_types(mqtt) ->