Add "user friendly" bytes deserializer (#194)

* Add "user friendly" bytes deserializer

* code cleanup

Author: Crim

CHANGELOG.md

@@ -3,6 +3,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## 2.5.0 (UNRELEASED)
+#### New Features
+- [PR-194](https://github.com/SourceLabOrg/kafka-webview/pull/194) Adds a new built-in deserializer for byte[] that decodes the bytes into HEX values.
+
 #### Internal Dependency Updates
 - Upgrade from SpringBoot 2.0.8 to 2.1.8.
 - org.apache.commons:commons-compress updated from 1.18 to 1.19.

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

@@ -32,6 +32,7 @@
 import org.apache.kafka.common.serialization.LongDeserializer;
 import org.apache.kafka.common.serialization.ShortDeserializer;
 import org.apache.kafka.common.serialization.StringDeserializer;
+import org.sourcelab.kafka.webview.ui.manager.kafka.deserializer.BytesToHexDeserializer;
 import org.sourcelab.kafka.webview.ui.manager.user.UserManager;
 import org.sourcelab.kafka.webview.ui.model.MessageFormat;
 import org.sourcelab.kafka.webview.ui.model.UserRole;
@@ -102,6 +103,7 @@ private void createDefaultMessageFormats() {
         defaultFormats.put("Integer", IntegerDeserializer.class.getName());
         defaultFormats.put("Long", LongDeserializer.class.getName());
         defaultFormats.put("String", StringDeserializer.class.getName());
+        defaultFormats.put("Bytes (Hex Encoded)", BytesToHexDeserializer.class.getName());
 
         // Create if needed.
         for (final Map.Entry<String, String> entry : defaultFormats.entrySet()) {

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/deserializer/BytesToHexDeserializer.java

@@ -0,0 +1,50 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2017, 2018, 2019 SourceLab.org (https://github.com/SourceLabOrg/kafka-webview/)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.sourcelab.kafka.webview.ui.manager.kafka.deserializer;
+
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.tomcat.util.buf.HexUtils;
+
+import java.util.Map;
+
+/**
+ * Deserializes bytes into Hex strings.  Intended to allow for a more user friendly display of bytes.
+ */
+public class BytesToHexDeserializer implements Deserializer<String> {
+
+    @Override
+    public void configure(final Map<String, ?> configs, final boolean isKey) {
+    }
+
+    @Override
+    public String deserialize(final String topic, final byte[] data) {
+        // Convert bytes into Hex.
+        return HexUtils.toHexString(data);
+    }
+
+    @Override
+    public void close() {
+    }
+}

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/plugin/PluginFactory.java

@@ -24,11 +24,11 @@
 
 package org.sourcelab.kafka.webview.ui.manager.plugin;
 
-import java.io.IOException;
 import org.sourcelab.kafka.webview.ui.manager.plugin.exception.LoaderException;
 import org.sourcelab.kafka.webview.ui.manager.plugin.exception.UnableToFindClassException;
 import org.sourcelab.kafka.webview.ui.manager.plugin.exception.WrongImplementationException;
 
+import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
 import java.net.MalformedURLException;
 import java.net.URL;

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/plugin/UploadManager.java

@@ -24,11 +24,11 @@
 
 package org.sourcelab.kafka.webview.ui.manager.plugin;
 
-import java.io.BufferedInputStream;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.web.multipart.MultipartFile;
 
+import java.io.BufferedInputStream;
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;

kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/WebKafkaConsumerFactoryTest.java

@@ -36,7 +36,6 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.sourcelab.kafka.webview.ui.manager.encryption.SecretManager;
-import org.sourcelab.kafka.webview.ui.manager.kafka.config.FilterDefinition;
 import org.sourcelab.kafka.webview.ui.manager.kafka.dto.KafkaResult;
 import org.sourcelab.kafka.webview.ui.manager.kafka.dto.KafkaResults;
 import org.sourcelab.kafka.webview.ui.manager.plugin.PluginFactory;

kafka-webview-ui/src/test/java/org/sourcelab/kafka/webview/ui/manager/kafka/deserializer/BytesToHexDeserializerTest.java

@@ -0,0 +1,60 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2017, 2018, 2019 SourceLab.org (https://github.com/SourceLabOrg/kafka-webview/)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.sourcelab.kafka.webview.ui.manager.kafka.deserializer;
+
+import junitparams.JUnitParamsRunner;
+import junitparams.Parameters;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static org.junit.Assert.assertEquals;
+
+@RunWith(JUnitParamsRunner.class)
+public class BytesToHexDeserializerTest {
+
+    private final Deserializer<String> deserializer = new BytesToHexDeserializer();
+
+    /**
+     * Validate the deserializer works as expected.
+     */
+    @Test
+    @Parameters(method = "provideBytes")
+    public void doTest(final byte[] bytes, final String expectedHexStr) {
+        final String results = deserializer.deserialize("not-relevant", bytes);
+        assertEquals("Strings should match", expectedHexStr, results);
+    }
+
+    public Object[] provideBytes() {
+        return new Object[]{
+            new Object[]{ "blahblahlbha".getBytes(), "626c6168626c61686c626861" },
+            new Object[]{ "blahblahlbhah".getBytes(), "626c6168626c61686c62686168" },
+            new Object[]{ "key1572998885260".getBytes(), "6b657931353732393938383835323630" },
+            new Object[]{ "key1572998885261".getBytes(), "6b657931353732393938383835323631" },
+            new Object[]{ "key1572998885255".getBytes(), "6b657931353732393938383835323535" },
+            new Object[]{ "key1572998885258".getBytes(), "6b657931353732393938383835323538" },
+        };
+    }
+}