Merge pull request #257 from SourceLabOrg/spp/sbUpgrade

Upgrade from Springboot 2.1 to 2.6

Author: Crim

CHANGELOG.md

@@ -2,6 +2,10 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.9.0 (UNRELEASED)
+#### Internal Dependency Updates
+- Upgrade from SpringBoot 2.1.18 to 2.6.1.
+
 ## 2.8.2 (12/19/2021)
 #### Bug Fixes
 - Disable flyway migration validation due to botched update of existing migration file, which prevented startup when updating from older versions.

dev-cluster/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <artifactId>kafka-webview</artifactId>
         <groupId>org.sourcelab</groupId>
-        <version>2.8.2</version>
+        <version>2.9.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>dev-cluster</artifactId>
-    <version>2.8.2</version>
+    <version>2.9.0-SNAPSHOT</version>
 
     <!-- Require Maven 3.3.9 -->
     <prerequisites>

kafka-webview-plugin/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.sourcelab</groupId>
         <artifactId>kafka-webview</artifactId>
-        <version>2.8.2</version>
+        <version>2.9.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>kafka-webview-plugin</artifactId>

kafka-webview-ui/pom.xml

@@ -5,11 +5,11 @@
     <parent>
         <artifactId>kafka-webview</artifactId>
         <groupId>org.sourcelab</groupId>
-        <version>2.8.2</version>
+        <version>2.9.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>kafka-webview-ui</artifactId>
-    <version>2.8.2</version>
+    <version>2.9.0-SNAPSHOT</version>
 
     <!-- Module Description and Ownership -->
     <name>Kafka WebView UI</name>
@@ -62,7 +62,7 @@
         </dependency>
         <dependency>
             <groupId>org.thymeleaf</groupId>
-            <artifactId>thymeleaf-spring4</artifactId>
+            <artifactId>thymeleaf-spring5</artifactId>
             <version>${thymeleaf.version}</version>
         </dependency>
         <dependency>
@@ -73,7 +73,7 @@
         <dependency>
             <groupId>nz.net.ultraq.thymeleaf</groupId>
             <artifactId>thymeleaf-layout-dialect</artifactId>
-            <version>2.5.3</version>
+            <version>3.0.0</version>
         </dependency>
         <dependency>
             <groupId>org.thymeleaf.extras</groupId>
@@ -125,6 +125,13 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
+
+        <!-- Validation Framework and annotations -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+
         <!-- Micrometer Prometheus registry  -->
         <dependency>
             <groupId>io.micrometer</groupId>
@@ -140,7 +147,7 @@
         <dependency>
             <groupId>javax.xml.bind</groupId>
             <artifactId>jaxb-api</artifactId>
-            <version>2.3.0</version>
+            <version>2.3.1</version>
         </dependency>
 
         <!-- Allows for auto-reloading resources -->
@@ -201,14 +208,13 @@
                 </exclusion>
             </exclusions>
         </dependency>
-        <!-- Explicitly include updated version -->
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-compress</artifactId>
-            <version>1.21</version>
-        </dependency>
 
         <!-- For tests -->
+        <dependency>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>

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

@@ -41,7 +41,6 @@
 import org.sourcelab.kafka.webview.ui.manager.plugin.UploadManager;
 import org.sourcelab.kafka.webview.ui.manager.sasl.SaslUtility;
 import org.sourcelab.kafka.webview.ui.plugin.filter.RecordFilter;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.stereotype.Component;
@@ -104,7 +103,11 @@ public SecretManager getSecretManager(final AppProperties appProperties) {
      * @return Web Kafka Consumer Factory instance.
      */
     @Bean
-    public WebKafkaConsumerFactory getWebKafkaConsumerFactory(final AppProperties appProperties, final KafkaClientConfigUtil configUtil) {
+    public WebKafkaConsumerFactory getWebKafkaConsumerFactory(
+        final AppProperties appProperties,
+        final KafkaClientConfigUtil configUtil,
+        final SecretManager secretManager
+    ) {
         final ExecutorService executorService;
 
         // If we have multi-threaded consumer option enabled
@@ -126,22 +129,22 @@ public WebKafkaConsumerFactory getWebKafkaConsumerFactory(final AppProperties ap
         return new WebKafkaConsumerFactory(
             getDeserializerPluginFactory(appProperties),
             getRecordFilterPluginFactory(appProperties),
-            getSecretManager(appProperties),
+            secretManager,
             getKafkaConsumerFactory(configUtil),
             executorService
         );
     }
 
     /**
      * For creating Kafka operational consumers.
-     * @param appProperties Definition of app properties.
      * @param configUtil Utility for configuring kafka clients.
+     * @param secretManager For managing secrets.
      * @return Web Kafka Operations Client Factory instance.
      */
     @Bean
-    public KafkaOperationsFactory getKafkaOperationsFactory(final AppProperties appProperties, final KafkaClientConfigUtil configUtil) {
+    public KafkaOperationsFactory getKafkaOperationsFactory(final KafkaClientConfigUtil configUtil, final SecretManager secretManager) {
         return new KafkaOperationsFactory(
-            getSecretManager(appProperties),
+            secretManager,
             getKafkaAdminFactory(configUtil)
         );
     }
@@ -158,11 +161,6 @@ public Jackson2ObjectMapperBuilderCustomizer registerJacksonProtobufModule() {
         };
     }
 
-    @Autowired(required = true)
-    public void configureJackson(ObjectMapper jackson2ObjectMapper) {
-        jackson2ObjectMapper.registerModule(new ProtobufModule());
-    }
-    
     /**
      * For creating instances of AdminClient.
      */

kafka-webview-ui/src/main/resources/config/base.yml

@@ -60,8 +60,12 @@ management:
   metrics:
     tags:
       application: ${spring.application.name}
-  ## Disable LDAP by default
   health:
+    ## Enable probes to get liveness and readiness checks for kubernetes
+    ## See https://spring.io/blog/2020/03/25/liveness-and-readiness-probes-with-spring-boot
+    probes:
+      enabled: false
+    ## Disable LDAP by default
     ldap:
       enabled: false
 
@@ -81,8 +85,10 @@ app:
   consumerIdPrefix: "KafkaWebViewConsumer"
   requireSsl: true
   user:
+    ## By default, require user authentication.
     enabled: true
-    ## Ldap auth settings
+
+    ## Example Ldap auth settings, disabled by default.
     ldap:
       enabled: false
       userDnPattern: "uid={0},ou=people"

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

@@ -92,11 +92,16 @@ public void testBuilder() {
 
     /**
      * Validates the object serializes to json correctly.
+     *
+     * NOTE: Not exactly the best test, it appears as tho the serialization order of the properties isn't exactly
+     * deterministic... so we jump thru some hoops here for the validation assertion.
      */
     @Test
     public void testSerialization() throws JsonProcessingException {
         // Define our expected output.
-        final String expectedResult = "{\"consumerId\":\"MyConsumerId\",\"topics\":[{\"topic\":\"topic-a\",\"partitions\":[0,1],\"offsets\":[{\"partition\":0,\"offset\":0},{\"partition\":1,\"offset\":1}]},{\"topic\":\"topic-b\",\"partitions\":[0,1],\"offsets\":[{\"partition\":0,\"offset\":2},{\"partition\":1,\"offset\":3}]}],\"topicNames\":[\"topic-a\",\"topic-b\"]}";
+        // Looks like the order of properties is undetermined... so to avoid flapping test lets check each possible variation... :/
+        final String expectedResult1 = "{\"consumerId\":\"MyConsumerId\",\"topics\":[{\"topic\":\"topic-a\",\"partitions\":[0,1],\"offsets\":[{\"partition\":0,\"offset\":0},{\"partition\":1,\"offset\":1}]},{\"topic\":\"topic-b\",\"partitions\":[0,1],\"offsets\":[{\"partition\":0,\"offset\":2},{\"partition\":1,\"offset\":3}]}],\"topicNames\":[\"topic-a\",\"topic-b\"]}";
+        final String expectedResult2 = "{\"consumerId\":\"MyConsumerId\",\"topics\":[{\"topic\":\"topic-a\",\"offsets\":[{\"partition\":0,\"offset\":0},{\"partition\":1,\"offset\":1}],\"partitions\":[0,1]},{\"topic\":\"topic-b\",\"offsets\":[{\"partition\":0,\"offset\":2},{\"partition\":1,\"offset\":3}],\"partitions\":[0,1]}],\"topicNames\":[\"topic-a\",\"topic-b\"]}";
 
         final ConsumerGroupOffsets offsets = ConsumerGroupOffsets.newBuilder()
             .withConsumerId("MyConsumerId")
@@ -113,6 +118,14 @@ public void testSerialization() throws JsonProcessingException {
         final String result = objectMapper.writeValueAsString(offsets);
 
         // Validate
-        assertEquals("Should have expected serialized value", expectedResult, result);
+        if (expectedResult1.equals(result)) {
+            assertEquals("Should have expected serialized value", expectedResult1, result);
+        } else if (expectedResult2.equals(result)) {
+            assertEquals("Should have expected serialized value", expectedResult2, result);
+        } else {
+            // This will fail.....
+            System.out.println("Got:" + result);
+            assertEquals("Should have expected serialized value", expectedResult1, result);
+        }
     }
 }

pom.xml

@@ -7,7 +7,7 @@
     <groupId>org.sourcelab</groupId>
     <artifactId>kafka-webview</artifactId>
     <packaging>pom</packaging>
-    <version>2.8.2</version>
+    <version>2.9.0-SNAPSHOT</version>
 
     <!-- Define submodules -->
     <modules>
@@ -57,17 +57,10 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <java.version>1.8</java.version>
 
-        <!-- Override logback version for security fix -->
+        <!-- Override versions for security fixes -->
         <!-- https://github.com/spring-projects/spring-boot/issues/8635 -->
         <logback.version>1.2.8</logback.version>
-
-        <!-- Override versions for security fixes -->
-        <!-- To be removed when upgrading to newer springboot releases -->
-        <jackson.version>2.13.0</jackson.version>
-        <hibernate.version>5.3.24.Final</hibernate.version>
         <tomcat.version>9.0.56</tomcat.version>
-        <snakeyaml.version>1.29</snakeyaml.version>
-        <groovy.version>2.5.15</groovy.version>
 
         <!-- test toggling -->
         <skipTests>false</skipTests>
@@ -80,7 +73,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.1.18.RELEASE</version>
+        <version>2.6.1</version>
     </parent>
 
     <dependencies>