yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor(message validation): rename `message_name` to `message_type` 

On Product's behest, to make naming consistent with protobuf nomenclature.

https://protobuf.dev/programming-guides/proto3/#adding-types
This commit is contained in:
Thales Macedo Garitezi 2024-05-08 09:13:40 -03:00
parent 4403b4f5ce
commit 5172606032
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apps/emqx_message_validation/src/emqx_message_validation.erl
View File

@ -247,8 +247,8 @@ evaluate_schema_check(Check, Validation, #message{payload = Data}) ->
#{name := Name} = Validation,
ExtraArgs =
case Check of
#{type := protobuf, message_name := MessageName} ->
[MessageName];
#{type := protobuf, message_type := MessageType} ->
[MessageType];
_ ->
[]
end,

4
apps/emqx_message_validation/src/emqx_message_validation_schema.erl
View File

@ -121,8 +121,8 @@ fields(check_protobuf) ->
[
{type, mk(protobuf, #{default => protobuf, desc => ?DESC("check_protobuf_type")})},
{schema, mk(binary(), #{required => true, desc => ?DESC("check_protobuf_schema")})},
{message_name,
mk(binary(), #{required => true, desc => ?DESC("check_protobuf_message_name")})}
{message_type,
mk(binary(), #{required => true, desc => ?DESC("check_protobuf_message_type")})}
];
fields(check_avro) ->
[

14
apps/emqx_message_validation/test/emqx_message_validation_http_api_SUITE.erl
View File

@ -317,9 +317,9 @@ avro_create_serde(SerdeName) ->
on_exit(fun() -> ok = emqx_schema_registry:delete_schema(SerdeName) end),
ok.
protobuf_valid_payloads(SerdeName, MessageName) ->
protobuf_valid_payloads(SerdeName, MessageType) ->
lists:map(
fun(Payload) -> emqx_schema_registry_serde:encode(SerdeName, Payload, [MessageName]) end,
fun(Payload) -> emqx_schema_registry_serde:encode(SerdeName, Payload, [MessageType]) end,
[
#{<<"name">> => <<"some name">>, <<"id">> => 10, <<"email">> => <<"emqx@emqx.io">>},
#{<<"name">> => <<"some name">>, <<"id">> => 10}
@ -1176,11 +1176,11 @@ t_schema_check_avro(_Config) ->
t_schema_check_protobuf(_Config) ->
SerdeName = <<"myserde">>,
MessageName = <<"Person">>,
MessageType = <<"Person">>,
protobuf_create_serde(SerdeName),
Name1 = <<"foo">>,
Check1 = schema_check(protobuf, SerdeName, #{<<"message_name">> => MessageName}),
Check1 = schema_check(protobuf, SerdeName, #{<<"message_type">> => MessageType}),
Validation1 = validation(Name1, [Check1]),
{201, _} = insert(Validation1),
@ -1192,7 +1192,7 @@ t_schema_check_protobuf(_Config) ->
ok = publish(C, <<"t/1">>, {raw, Payload}),
?assertReceive({publish, _})
end,
protobuf_valid_payloads(SerdeName, MessageName)
protobuf_valid_payloads(SerdeName, MessageType)
),
lists:foreach(
fun(Payload) ->
@ -1203,7 +1203,7 @@ t_schema_check_protobuf(_Config) ->
),
%% Bad config: unknown message name
Check2 = schema_check(protobuf, SerdeName, #{<<"message_name">> => <<"idontexist">>}),
Check2 = schema_check(protobuf, SerdeName, #{<<"message_type">> => <<"idontexist">>}),
Validation2 = validation(Name1, [Check2]),
{200, _} = update(Validation2),
@ -1212,7 +1212,7 @@ t_schema_check_protobuf(_Config) ->
ok = publish(C, <<"t/1">>, {raw, Payload}),
?assertNotReceive({publish, _})
end,
protobuf_valid_payloads(SerdeName, MessageName)
protobuf_valid_payloads(SerdeName, MessageType)
),
ok.

2
apps/emqx_message_validation/test/emqx_message_validation_tests.erl
View File

@ -309,7 +309,7 @@ duplicated_check_test_() ->
schema_check(
protobuf,
<<"a">>,
#{<<"message_name">> => <<"a">>}
#{<<"message_type">> => <<"a">>}
)
])
])

4
rel/i18n/emqx_message_validation_schema.hocon
View File

@ -30,9 +30,9 @@ emqx_message_validation_schema {
check_protobuf_schema.label:
"""Schema name"""
check_protobuf_message_name.desc:
check_protobuf_message_type.desc:
"""Message name to use during check."""
check_protobuf_message_name.label:
check_protobuf_message_type.label:
"""Message name"""
check_sql_type.desc: