fix: call json encoder/decoder for plugin config

apps/emqx_management/src/emqx_mgmt_api_plugins.erl

@@ -176,7 +176,7 @@ schema("/plugins/:name/config") ->
             tags => ?TAGS,
             parameters => [hoconsc:ref(name)],
             responses => #{
-                %% binary avro encoded config
+                %% avro data, json encoded
                 200 => hoconsc:mk(binary()),
                 404 => emqx_dashboard_swagger:error_codes(['NOT_FOUND'], <<"Plugin Not Found">>)
             }
@@ -190,14 +190,10 @@ schema("/plugins/:name/config") ->
             parameters => [hoconsc:ref(name)],
             'requestBody' => #{
                 content => #{
-                    'multipart/form-data' => #{
+                    'application/json' => #{
                         schema => #{
-                            type => object,
-                            properties => #{
-                                ?CONTENT_CONFIG => #{type => string, format => binary}
-                            }
-                        },
-                        encoding => #{?CONTENT_CONFIG => #{'contentType' => 'application/gzip'}}
+                            type => object
+                        }
                     }
                 }
             },
@@ -499,12 +495,14 @@ plugin_config(get, #{bindings := #{name := Name}}) ->
                 message => <<"Failed to get plugin config">>
             }}
     end;
-plugin_config(put, #{bindings := #{name := Name}, body := #{<<"config">> := RawAvro}}) ->
-    case emqx_plugins:decode_plugin_avro_config(Name, RawAvro) of
-        {ok, Config} ->
+plugin_config(put, #{bindings := #{name := Name}, body := AvroJsonMap}) ->
+    AvroJsonBin = emqx_utils_json:encode(AvroJsonMap),
+    case emqx_plugins:decode_plugin_avro_config(Name, AvroJsonBin) of
+        {ok, AvroValueConfig} ->
             Nodes = emqx:running_nodes(),
+            %% cluster call with config in map (binary key-value)
             _Res = emqx_mgmt_api_plugins_proto_v3:update_plugin_config(
-                Nodes, Name, RawAvro, Config
+                Nodes, Name, AvroJsonMap, AvroValueConfig
             ),
             {204};
         {error, Reason} ->
@@ -595,8 +593,9 @@ ensure_action(Name, restart) ->
     ok.
 
 %% for RPC plugin avro encoded config update
-do_update_plugin_config(Name, Avro, PluginConfig) ->
-    emqx_plugins:put_plugin_config(Name, Avro, PluginConfig).
+do_update_plugin_config(Name, AvroJsonMap, PluginConfigMap) ->
+    %% TOOD: maybe use `PluginConfigMap` to validate config
+    emqx_plugins:put_plugin_config(Name, AvroJsonMap, PluginConfigMap).
 
 %%--------------------------------------------------------------------
 %% Helper functions

apps/emqx_management/src/proto/emqx_mgmt_api_plugins_proto_v3.erl

@@ -59,7 +59,11 @@ ensure_action(Name, Action) ->
     map()
 ) ->
     emqx_rpc:multicall_result().
-update_plugin_config(Nodes, Name, RawAvro, PluginConfig) ->
+update_plugin_config(Nodes, Name, AvroJsonMap, PluginConfig) ->
     rpc:multicall(
-        Nodes, emqx_mgmt_api_plugins, do_update_plugin_config, [Name, RawAvro, PluginConfig], 10000
+        Nodes,
+        emqx_mgmt_api_plugins,
+        do_update_plugin_config,
+        [Name, AvroJsonMap, PluginConfig],
+        10000
     ).

apps/emqx_plugins/src/emqx_plugins.erl

@@ -51,7 +51,7 @@
     ensure_stopped/1,
     get_plugin_config/1,
     get_plugin_config/2,
-    put_plugin_config/3,
+    put_plugin_config/4,
     restart/1,
     list/0
 ]).
@@ -256,7 +256,7 @@ get_plugin_config(NameVsn) ->
     | {error, term()}.
 get_plugin_config(NameVsn, #{format := ?CONFIG_FORMAT_AVRO}) ->
     case read_plugin_avro(NameVsn) of
-        {ok, _AvroBin} = Res -> Res;
+        {ok, _AvroJson} = Res -> Res;
         {error, _Reason} = Err -> Err
     end;
 get_plugin_config(NameVsn, #{format := ?CONFIG_FORMAT_MAP}) ->
@@ -265,9 +265,10 @@ get_plugin_config(NameVsn, #{format := ?CONFIG_FORMAT_MAP}) ->
 %% @doc Update plugin's config.
 %% RPC call from Management API or CLI.
 %% the avro binary and plugin config ALWAYS be valid before calling this function.
-put_plugin_config(NameVsn, RawAvro, PluginConfig) ->
-    ok = write_avro_bin(NameVsn, RawAvro),
-    ok = persistent_term:put(?PLUGIN_PERSIS_CONFIG_KEY(NameVsn), PluginConfig),
+put_plugin_config(NameVsn, AvroJsonMap, DecodedPluginConfig) ->
+    AvroJsonBin = emqx_utils_json:encode(AvroJsonMap),
+    ok = write_avro_bin(NameVsn, AvroJsonBin),
+    ok = persistent_term:put(?PLUGIN_PERSIS_CONFIG_KEY(NameVsn), AvroJsonMap),
     ok.
 
 %% @doc Stop and then start the plugin.
@@ -300,9 +301,11 @@ list() ->
 %%--------------------------------------------------------------------
 %% Package utils
 
--spec decode_plugin_avro_config(name_vsn(), binary()) -> {ok, map()} | {error, any()}.
-decode_plugin_avro_config(NameVsn, RawAvro) ->
-    case emqx_plugins_serde:decode(NameVsn, RawAvro) of
+-spec decode_plugin_avro_config(name_vsn(), map() | binary()) -> {ok, map()} | {error, any()}.
+decode_plugin_avro_config(NameVsn, AvroJsonMap) when is_map(AvroJsonMap) ->
+    decode_plugin_avro_config(NameVsn, emqx_utils_json:encode(AvroJsonMap));
+decode_plugin_avro_config(NameVsn, AvroJsonBin) ->
+    case emqx_plugins_serde:decode(NameVsn, AvroJsonBin) of
         {ok, Config} -> {ok, Config};
         {error, ReasonMap} -> {error, ReasonMap}
     end.

apps/emqx_plugins/src/emqx_plugins_serde.erl

@@ -102,14 +102,14 @@ delete_schema(NameVsn) ->
 -spec decode(schema_name(), encoded_data()) -> {ok, decoded_data()} | {error, any()}.
 decode(SerdeName, RawData) ->
     with_serde(
-        "decode_avro_binary",
+        "decode_avro_json",
         eval_serde_fun(?FUNCTION_NAME, "bad_avro_binary", SerdeName, [RawData])
     ).
 
 -spec encode(schema_name(), decoded_data()) -> {ok, encoded_data()} | {error, any()}.
 encode(SerdeName, Data) ->
     with_serde(
-        "encode_avro_data",
+        "encode_avro_json",
         eval_serde_fun(?FUNCTION_NAME, "bad_avro_data", SerdeName, [Data])
     ).
 
@@ -252,10 +252,10 @@ eval_serde_fun(Op, ErrMsg, SerdeName, Args) ->
     end.
 
 eval_serde(decode, #plugin_schema_serde{name = Name, eval_context = Store}, [Data]) ->
-    Opts = avro:make_decoder_options([{map_type, map}, {record_type, map}]),
-    {ok, avro_binary_decoder:decode(Data, Name, Store, Opts)};
+    Opts = avro:make_decoder_options([{map_type, map}, {record_type, map}, {encoding, avro_json}]),
+    {ok, avro_json_decoder:decode_value(Data, Name, Store, Opts)};
 eval_serde(encode, #plugin_schema_serde{name = Name, eval_context = Store}, [Data]) ->
-    {ok, avro_binary_encoder:encode(Store, Name, Data)};
+    {ok, avro_json_encoder:encode(Store, Name, Data)};
 eval_serde(_, _, _) ->
     throw(#{error_msg => "unexpected_plugin_avro_op"}).