Merge pull request #12991 from thalesmg/refactor-mv-message-type-r57-20240508

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

apps/emqx_message_validation/src/emqx_message_validation.erl

@@ -259,8 +259,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,

apps/emqx_message_validation/src/emqx_message_validation_schema.erl

@@ -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) ->
     [

apps/emqx_message_validation/test/emqx_message_validation_http_api_SUITE.erl

@@ -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.

apps/emqx_message_validation/test/emqx_message_validation_tests.erl

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

rel/i18n/emqx_message_validation_schema.hocon

@@ -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: