emqx/apps/emqx_bridge_rocketmq/src/emqx_bridge_rocketmq.erl

%%--------------------------------------------------------------------
%% Copyright (c) 2022-2024 EMQ Technologies Co., Ltd. All Rights Reserved.
%%--------------------------------------------------------------------
-module(emqx_bridge_rocketmq).

-behaviour(emqx_connector_examples).

-include_lib("typerefl/include/types.hrl").
-include_lib("hocon/include/hoconsc.hrl").
-include_lib("emqx_bridge/include/emqx_bridge.hrl").
-include_lib("emqx_resource/include/emqx_resource.hrl").

-import(hoconsc, [mk/2, enum/1]).

-export([
    namespace/0,
    roots/0,
    fields/1,
    desc/1
]).

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

-define(CONNECTOR_TYPE, rocketmq).
-define(ACTION_TYPE, ?CONNECTOR_TYPE).
-define(DEFAULT_TEMPLATE, <<>>).
-define(DEFFAULT_REQ_TIMEOUT, <<"15s">>).

%% -------------------------------------------------------------------------------------------------
%% api

conn_bridge_examples(Method) ->
    [
        #{
            <<"rocketmq">> => #{
                summary => <<"RocketMQ Bridge">>,
                value => conn_bridge_example_values(Method)
            }
        }
    ].

conn_bridge_example_values(get) ->
    conn_bridge_example_values(post);
conn_bridge_example_values(post) ->
    #{
        enable => true,
        type => rocketmq,
        name => <<"foo">>,
        server => <<"127.0.0.1:9876">>,
        topic => <<"TopicTest">>,
        template => ?DEFAULT_TEMPLATE,
        local_topic => <<"local/topic/#">>,
        resource_opts => #{
            worker_pool_size => 1,
            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
        }
    };
conn_bridge_example_values(put) ->
    conn_bridge_example_values(post).

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

connector_values() ->
    #{
        <<"enable">> => true,
        <<"servers">> => <<"127.0.0.1:9876">>,
        <<"pool_size">> => 8,
        <<"resource_opts">> => #{
            <<"health_check_interval">> => <<"15s">>,
            <<"start_after_created">> => true,
            <<"start_timeout">> => <<"5s">>
        }
    }.

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

action_values() ->
    #{
        <<"parameters">> => #{
            <<"topic">> => <<"TopicTest">>,
            <<"template">> => ?DEFAULT_TEMPLATE,
            <<"refresh_interval">> => <<"3s">>,
            <<"send_buffer">> => <<"1024KB">>,
            <<"sync_timeout">> => <<"3s">>
        }
    }.

%% -------------------------------------------------------------------------------------------------
%% Hocon Schema Definitions

namespace() -> "rocketmq".

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(rocketmq_action));
fields(action) ->
    {?ACTION_TYPE,
        hoconsc:mk(
            hoconsc:map(name, hoconsc:ref(?MODULE, rocketmq_action)),
            #{
                desc => <<"RocketMQ Action Config">>,
                required => false
            }
        )};
fields(rocketmq_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(
                    emqx_schema:template(),
                    #{desc => ?DESC("template"), default => ?DEFAULT_TEMPLATE}
                )},
            {strategy,
                mk(
                    hoconsc:union([roundrobin, binary()]),
                    #{desc => ?DESC("strategy"), default => roundrobin}
                )}
        ] ++ emqx_bridge_rocketmq_connector:fields(config),
    lists:foldl(
        fun(Key, Acc) ->
            proplists:delete(Key, Acc)
        end,
        Parameters,
        [
            servers,
            ssl,
            namespace,
            pool_size,
            auto_reconnect,
            access_key,
            secret_key,
            security_token
        ]
    );
fields("config_connector") ->
    Config =
        emqx_connector_schema:common_fields() ++
            emqx_bridge_rocketmq_connector:fields(config) ++
            emqx_connector_schema:resource_opts_ref(?MODULE, connector_resource_opts),
    lists:foldl(
        fun(Key, Acc) ->
            proplists:delete(Key, Acc)
        end,
        Config,
        [
            topic,
            sync_timeout,
            refresh_interval,
            send_buffer,
            auto_reconnect
        ]
    );
fields(connector_resource_opts) ->
    emqx_connector_schema:resource_opts_fields();
fields("config") ->
    [
        {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
        {template,
            mk(
                emqx_schema:template(),
                #{desc => ?DESC("template"), default => ?DEFAULT_TEMPLATE}
            )},
        {local_topic,
            mk(
                binary(),
                #{desc => ?DESC("local_topic"), required => false}
            )},
        {strategy,
            mk(
                hoconsc:union([roundrobin, binary()]),
                #{desc => ?DESC("strategy"), default => roundrobin}
            )}
    ] ++ emqx_resource_schema:fields("resource_opts") ++
        emqx_bridge_rocketmq_connector:fields(config);
fields("post") ->
    [type_field(), name_field() | fields("config")];
fields("put") ->
    fields("config");
fields("get") ->
    emqx_bridge_schema:status_fields() ++ fields("post").

desc("config") ->
    ?DESC("desc_config");
desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" ->
    ["Configuration for RocketMQ using `", string:to_upper(Method), "` method."];
desc("config_connector") ->
    ?DESC("config_connector");
desc(rocketmq_action) ->
    ?DESC("rocketmq_action");
desc(action_parameters) ->
    ?DESC("action_parameters");
desc(connector_resource_opts) ->
    ?DESC(emqx_resource_schema, "resource_opts");
desc(_) ->
    undefined.

%% -------------------------------------------------------------------------------------------------

type_field() ->
    {type, mk(enum([rocketmq]), #{required => true, desc => ?DESC("desc_type")})}.

name_field() ->
    {name, mk(binary(), #{required => true, desc => ?DESC("desc_name")})}.