Adds protocol buffer support to Jackson via 3rd party module (#112)

* Add test case for what happens if jackson is unable to deserialize an instance

* Clean up

* Register protocol buffer module for jackson

* exclude non-required and outdated dependency

* add exclusions to make synk happy

* add exclusions to make synk happy

* code cleanup

* Update changelog

Author: Crim

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 #### Bug fixes
 - Topics shown on brokers now include "internal" topics.
 - Generated consumer client.id shortened.
+- [#111](https://github.com/SourceLabOrg/kafka-webview/issues/111) Add ProtocolBuffer support to Jackson via third party module.
 
 #### Internal Dependency Updates
 - Upgrade from Spring Boot 2.0.5 to 2.0.7

kafka-webview-ui/pom.xml

@@ -134,6 +134,38 @@
             <optional>true</optional>
         </dependency>
 
+        <!-- Jackson support for protocol buffers -->
+        <dependency>
+            <groupId>com.hubspot.jackson</groupId>
+            <artifactId>jackson-datatype-protobuf</artifactId>
+            <version>0.9.10-jackson2.9-proto3</version>
+            <exclusions>
+                <!-- exclude out-dated dependency -->
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-annotations</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-databind</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-core</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.google.guava</groupId>
+                    <artifactId>guava</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <!-- Explicitly include updated guava version for jackson protobuf module -->
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>27.0.1-jre</version>
+        </dependency>
+
         <!-- For tests -->
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -179,6 +211,14 @@
             <scope>test</scope>
         </dependency>
 
+        <!-- Test case for validating protocol buffer support in Jackson -->
+        <dependency>
+            <groupId>com.google.protobuf</groupId>
+            <artifactId>protobuf-java</artifactId>
+            <version>3.6.1</version>
+            <scope>test</scope>
+        </dependency>
+
         <!-- Embedded LDAP server for tests -->
         <dependency>
             <groupId>org.zapodot</groupId>

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/configuration/PluginConfig.java

@@ -24,6 +24,7 @@
 
 package org.sourcelab.kafka.webview.ui.configuration;
 
+import com.hubspot.jackson.datatype.protobuf.ProtobufModule;
 import org.apache.kafka.common.serialization.Deserializer;
 import org.sourcelab.kafka.webview.ui.manager.encryption.SecretManager;
 import org.sourcelab.kafka.webview.ui.manager.kafka.KafkaAdminFactory;
@@ -33,6 +34,7 @@
 import org.sourcelab.kafka.webview.ui.manager.plugin.PluginFactory;
 import org.sourcelab.kafka.webview.ui.manager.plugin.UploadManager;
 import org.sourcelab.kafka.webview.ui.plugin.filter.RecordFilter;
+import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.stereotype.Component;
 
@@ -112,6 +114,18 @@ public KafkaOperationsFactory getKafkaOperationsFactory(final AppProperties appP
         );
     }
 
+    /**
+     * Customize the jackson object map builder.
+     * @return Jackson2ObjectMapperBuilderCustomizer instance.
+     */
+    @Bean
+    public Jackson2ObjectMapperBuilderCustomizer addCustomBigDecimalDeserialization() {
+        return jacksonObjectMapperBuilder -> {
+            // Register custom protocol buffer serializer as protocol buffers is a common serialization format.
+            jacksonObjectMapperBuilder.modulesToInstall(new ProtobufModule());
+        };
+    }
+    
     /**
      * For creating instances of AdminClient.
      */

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/dto/ToStringSerializer.java

@@ -32,7 +32,7 @@
 import java.io.IOException;
 
 /**
- * Uses object's toString() method to serialize.
+ * Attempts to serialize using Jackson, if that fails, falls back to using toString.
  */
 public class ToStringSerializer extends JsonSerializer<Object> {
     @Override
@@ -52,8 +52,6 @@ public void serialize(
             serializer.serialize(value, gen, serializers);
             return;
         }
-
-        // Fall back to using toString()
         gen.writeString(value.toString());
     }
 }