Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: refactor DynamoDB bridge to connector and action #12543

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/emqx_bridge/src/emqx_action_info.erl
Expand Up @@ -88,6 +88,7 @@ hard_coded_action_info_modules_ee() ->
[
emqx_bridge_azure_event_hub_action_info,
emqx_bridge_confluent_producer_action_info,
emqx_bridge_dynamo_action_info,
emqx_bridge_gcp_pubsub_consumer_action_info,
emqx_bridge_gcp_pubsub_producer_action_info,
emqx_bridge_kafka_action_info,
Expand Down
2 changes: 1 addition & 1 deletion apps/emqx_bridge_dynamo/src/emqx_bridge_dynamo.app.src
Expand Up @@ -8,7 +8,7 @@
emqx_resource,
erlcloud
]},
{env, []},
{env, [{emqx_action_info_modules, [emqx_bridge_dynamo_action_info]}]},
{modules, []},
{links, []}
]}.
141 changes: 139 additions & 2 deletions apps/emqx_bridge_dynamo/src/emqx_bridge_dynamo.erl
Expand Up @@ -11,7 +11,6 @@
-import(hoconsc, [mk/2, enum/1, ref/2]).

-export([
conn_bridge_examples/1,
values/1
]).

Expand All @@ -22,6 +21,14 @@
desc/1
]).

-export([
bridge_v2_examples/1,
connector_examples/1,
conn_bridge_examples/1
]).

-define(CONNECTOR_TYPE, dynamo).
-define(ACTION_TYPE, ?CONNECTOR_TYPE).
-define(DEFAULT_TEMPLATE, <<>>).

%% -------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -59,12 +66,134 @@ values(_Method) ->
}
}.

connector_examples(Method) ->
[
#{
<<"dynamo">> =>
#{
summary => <<"DynamoDB Connector">>,
value => emqx_connector_schema:connector_values(
Method, ?CONNECTOR_TYPE, connector_values()
)
}
}
].

connector_values() ->
#{
<<"enable">> => true,
<<"url">> => <<"http://127.0.0.1:8000">>,
<<"aws_access_key_id">> => <<"root">>,
<<"aws_secret_access_key">> => <<"******">>,
<<"pool_size">> => 8,
<<"resource_opts">> =>
#{
<<"health_check_interval">> => <<"15s">>,
<<"start_timeout">> => <<"5s">>
}
}.

bridge_v2_examples(Method) ->
[
#{
<<"dynamo">> =>
#{
summary => <<"DynamoDB Action">>,
value => emqx_bridge_v2_schema:action_values(
Method, ?ACTION_TYPE, ?CONNECTOR_TYPE, action_values()
)
}
}
].

action_values() ->
#{
<<"parameters">> =>
#{
<<"table">> => <<"mqtt_msg">>,
<<"template">> => ?DEFAULT_TEMPLATE
}
}.

%% -------------------------------------------------------------------------------------------------
%% Hocon Schema Definitions
namespace() -> "bridge_dynamo".

roots() -> [].

fields(Field) when
Field == "get_connector";
Field == "put_connector";
Field == "post_connector"
->
emqx_connector_schema:api_fields(
Field,
?CONNECTOR_TYPE,
fields("config_connector") -- emqx_connector_schema:common_fields()
);
fields(Field) when
Field == "get_bridge_v2";
Field == "post_bridge_v2";
Field == "put_bridge_v2"
->
emqx_bridge_v2_schema:api_fields(Field, ?ACTION_TYPE, fields(dynamo_action));
fields(action) ->
{?ACTION_TYPE,
hoconsc:mk(
hoconsc:map(name, hoconsc:ref(?MODULE, dynamo_action)),
#{
desc => <<"DynamoDB Action Config">>,
required => false
}
)};
fields(dynamo_action) ->
emqx_bridge_v2_schema:make_producer_action_schema(
hoconsc:mk(
hoconsc:ref(?MODULE, action_parameters),
#{
required => true,
desc => ?DESC("action_parameters")
}
)
);
fields(action_parameters) ->
Parameters =
[
{template,
mk(
binary(),
#{desc => ?DESC("template"), default => ?DEFAULT_TEMPLATE}
)}
] ++ emqx_bridge_dynamo_connector:fields(config),
lists:foldl(
fun(Key, Acc) ->
proplists:delete(Key, Acc)
end,
Parameters,
[
url,
aws_access_key_id,
aws_secret_access_key,
pool_size,
auto_reconnect
]
);
fields("config_connector") ->
Config =
emqx_connector_schema:common_fields() ++
emqx_bridge_dynamo_connector:fields(config) ++
emqx_connector_schema:resource_opts_ref(?MODULE, connector_resource_opts),
lists:foldl(
fun(Key, Acc) ->
proplists:delete(Key, Acc)
end,
Config,
[
table
]
);
fields(connector_resource_opts) ->
emqx_connector_schema:resource_opts_fields();
fields("config") ->
[
{enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
Expand Down Expand Up @@ -102,9 +231,17 @@ fields("get") ->
desc("config") ->
?DESC("desc_config");
desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" ->
["Configuration for PostgreSQL using `", string:to_upper(Method), "` method."];
["Configuration for DynamoDB using `", string:to_upper(Method), "` method."];
desc("creation_opts" = Name) ->
emqx_resource_schema:desc(Name);
desc("config_connector") ->
?DESC("config_connector");
desc(dynamo_action) ->
?DESC("dynamo_action");
desc(action_parameters) ->
?DESC("action_parameters");
desc(connector_resource_opts) ->
?DESC(emqx_resource_schema, "resource_opts");
desc(_) ->
undefined.

Expand Down
22 changes: 22 additions & 0 deletions apps/emqx_bridge_dynamo/src/emqx_bridge_dynamo_action_info.erl
@@ -0,0 +1,22 @@
%%--------------------------------------------------------------------
%% Copyright (c) 2022-2024 EMQ Technologies Co., Ltd. All Rights Reserved.
%%--------------------------------------------------------------------

-module(emqx_bridge_dynamo_action_info).

-behaviour(emqx_action_info).

-export([
bridge_v1_type_name/0,
action_type_name/0,
connector_type_name/0,
schema_module/0
]).

bridge_v1_type_name() -> dynamo.

action_type_name() -> dynamo.

connector_type_name() -> dynamo.

schema_module() -> emqx_bridge_dynamo.