feat(topicdata): support fully-qualified name only for `key-message-t…

…ype` and `value-message-type` (#823) close #822
tchiotludo · Oct 24, 2021 · 9dc047d · 9dc047d
1 parent 8ed9673
commit 9dc047d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -312,7 +312,8 @@ for each `topic-regex` you can specify `descriptor-file-base64` (descriptor file
 or you can put descriptor files in `descriptors-folder` and specify `descriptor-file` name,
 also specify corresponding message types for keys and values.
 If, for example, keys are not in Protobuf format, `key-message-type` can be omitted,
-the same for `value-message-type`.
+the same for `value-message-type`. . It's important to keep in mind that both `key-message-type` and `value-message-type`
+require a fully-qualified name.
 This configuration can be specified for each Kafka cluster.
 
 Example configuration can look like as follows:
@@ -329,14 +330,14 @@ akhq:
           topics-mapping:
             - topic-regex: "album.*"
               descriptor-file-base64: "Cs4BCgthbGJ1bS5wcm90bxIXY29tLm5ldGNyYWNrZXIucHJvdG9idWYidwoFQWxidW0SFAoFdGl0bGUYASABKAlSBXRpdGxlEhYKBmFydGlzdBgCIAMoCVIGYXJ0aXN0EiEKDHJlbGVhc2VfeWVhchgDIAEoBVILcmVsZWFzZVllYXISHQoKc29uZ190aXRsZRgEIAMoCVIJc29uZ1RpdGxlQiUKF2NvbS5uZXRjcmFja2VyLnByb3RvYnVmQgpBbGJ1bVByb3RvYgZwcm90bzM="
-              value-message-type: "Album"
+              value-message-type: "org.akhq.utils.Album"
             - topic-regex: "film.*"
               descriptor-file-base64: "CuEBCgpmaWxtLnByb3RvEhRjb20uY29tcGFueS5wcm90b2J1ZiKRAQoERmlsbRISCgRuYW1lGAEgASgJUgRuYW1lEhoKCHByb2R1Y2VyGAIgASgJUghwcm9kdWNlchIhCgxyZWxlYXNlX3llYXIYAyABKAVSC3JlbGVhc2VZZWFyEhoKCGR1cmF0aW9uGAQgASgFUghkdXJhdGlvbhIaCghzdGFycmluZxgFIAMoCVIIc3RhcnJpbmdCIQoUY29tLmNvbXBhbnkucHJvdG9idWZCCUZpbG1Qcm90b2IGcHJvdG8z"
-              value-message-type: "Film"
+              value-message-type: "org.akhq.utils.Film"
             - topic-regex: "test.*"
               descriptor-file: "other.desc"
-              key-message-type: "Row"
-              value-message-type: "Envelope"
+              key-message-type: "org.akhq.utils.Row"
+              value-message-type: "org.akhq.utils.Envelope"
 ```
 
 More examples about Protobuf deserialization can be found in [tests](./src/test/java/org/akhq/utils).

diff --git a/application.example.yml b/application.example.yml
@@ -88,14 +88,14 @@ akhq:
           topics-mapping:
             - topic-regex: "album.*"
               descriptor-file-base64: "Cs4BCgthbGJ1bS5wcm90bxIXY29tLm5ldGNyYWNrZXIucHJvdG9idWYidwoFQWxidW0SFAoFdGl0bGUYASABKAlSBXRpdGxlEhYKBmFydGlzdBgCIAMoCVIGYXJ0aXN0EiEKDHJlbGVhc2VfeWVhchgDIAEoBVILcmVsZWFzZVllYXISHQoKc29uZ190aXRsZRgEIAMoCVIJc29uZ1RpdGxlQiUKF2NvbS5uZXRjcmFja2VyLnByb3RvYnVmQgpBbGJ1bVByb3RvYgZwcm90bzM="
-              value-message-type: "Album"
+              value-message-type: "org.akhq.utils.Album"
             - topic-regex: "film.*"
               descriptor-file-base64: "CuEBCgpmaWxtLnByb3RvEhRjb20uY29tcGFueS5wcm90b2J1ZiKRAQoERmlsbRISCgRuYW1lGAEgASgJUgRuYW1lEhoKCHByb2R1Y2VyGAIgASgJUghwcm9kdWNlchIhCgxyZWxlYXNlX3llYXIYAyABKAVSC3JlbGVhc2VZZWFyEhoKCGR1cmF0aW9uGAQgASgFUghkdXJhdGlvbhIaCghzdGFycmluZxgFIAMoCVIIc3RhcnJpbmdCIQoUY29tLmNvbXBhbnkucHJvdG9idWZCCUZpbG1Qcm90b2IGcHJvdG8z"
-              value-message-type: "Film"
+              value-message-type: "org.akhq.utils.Film"
             - topic-regex: "test.*"
               descriptor-file: "other.desc"
-              key-message-type: "Row"
-              value-message-type: "Envelope"
+              key-message-type: "org.akhq.utils.Row"
+              value-message-type: "org.akhq.utils.Envelope"
       # Ui Cluster Options (optional)
       ui-options:
         topic:

diff --git a/src/main/java/org/akhq/utils/ProtobufToJsonDeserializer.java b/src/main/java/org/akhq/utils/ProtobufToJsonDeserializer.java
@@ -158,7 +158,7 @@ private String tryToDeserializeWithMessageType(byte[] buffer, String topicRegex,
         List<Descriptor> descriptorsWithDependencies = this.descriptors.get(topicRegex);
         List<Descriptor> descriptorsForConfiguredMessageTypes =
                 descriptorsWithDependencies.stream()
-                        .filter(mp -> messageType.equals(mp.getName()))
+                        .filter(mp -> messageType.equals(mp.getFullName()))
                         .collect(Collectors.toList());
 
         if (descriptorsForConfiguredMessageTypes.isEmpty()) {

diff --git a/src/test/java/org/akhq/utils/ProtobufToJsonDeserializerTest.java b/src/test/java/org/akhq/utils/ProtobufToJsonDeserializerTest.java
@@ -47,13 +47,13 @@ private void createTopicProtobufDeserializationMapping() throws URISyntaxExcepti
         TopicsMapping albumTopicsMapping = new TopicsMapping();
         albumTopicsMapping.setTopicRegex("album.*");
         albumTopicsMapping.setDescriptorFile("album.desc");
-        albumTopicsMapping.setValueMessageType("Album");
+        albumTopicsMapping.setValueMessageType("org.akhq.utils.Album");
 
         TopicsMapping filmTopicsMapping = new TopicsMapping();
         filmTopicsMapping.setTopicRegex("film.*");
         String base64FilmDescriptor = encodeDescriptorFileToBase64("film.desc");
         filmTopicsMapping.setDescriptorFileBase64(base64FilmDescriptor);
-        filmTopicsMapping.setValueMessageType("Film");
+        filmTopicsMapping.setValueMessageType("org.akhq.utils.Film");
 
         // Do not specify message type neither for a key, nor for a value
         TopicsMapping incorrectTopicsMapping = new TopicsMapping();
@@ -64,7 +64,7 @@ private void createTopicProtobufDeserializationMapping() throws URISyntaxExcepti
         TopicsMapping complexObjectTopicsMapping = new TopicsMapping();
         complexObjectTopicsMapping.setTopicRegex("complex.*");
         complexObjectTopicsMapping.setDescriptorFile("complex.desc");
-        complexObjectTopicsMapping.setValueMessageType("Complex");
+        complexObjectTopicsMapping.setValueMessageType("org.akhq.utils.Complex");
 
         protobufDeserializationTopicsMapping.setTopicsMapping(
                 Arrays.asList(albumTopicsMapping, filmTopicsMapping, complexObjectTopicsMapping, incorrectTopicsMapping));