Use Vaadin 8, fix static resource fetching (#166)

tsuoanttila · hesara · commit 49efce25c2af · 2016-12-16T16:24:42.000+02:00
* Switch version to 2.0-SNAPSHOT, use vaadin 8.0-SNAPSHOT * Fix for new static resource handling in Vaadin 8 * Upgrade all spring dependencies to latest versions; Web tests for static resources handling. * Update Travis configuration Fixes vaadin/framework8-issues#445 Addresses vaadin/framework8-issues#454
diff --git a/.travis.before_install.sh b/.travis.before_install.sh
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Disable all Travis default repositories 
+sed -i "s/activeByDefault>true</activeByDefault>false</g"  ~/.m2/settings.xml
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,8 @@
 language: java
-jdk: oraclejdk7
+jdk: oraclejdk8
 sudo: required
 dist: trusty
+before_install: "./.travis.before_install.sh"
 branches:
   only:
   - master
diff --git a/checkstyle/vaadin-checkstyle.xml b/checkstyle/vaadin-checkstyle.xml
@@ -27,7 +27,6 @@
     • LineLenght (the default value is 80 which is also used in formatter, but
     i.e. member declarations are not wrapped onto next line)
     • RedundantModifier (i.e. using public in interface method declarations)
-    • RedundantThrows (causes unnecessary fails when can't get class information)
     • MethodLength (default maxLength is 150)
     • ParameterNumber (default maxLength is 7)
     • EmptyBlock (if-else statements have some blocks if x -> no action)
@@ -216,9 +215,6 @@
             <property name="severity" value="ignore" />
         </module>
         <module name="MissingSwitchDefault" />
-        <module name="RedundantThrows">
-            <property name="severity" value="warning" />
-        </module>
         <module name="SimplifyBooleanExpression" />
         <module name="SimplifyBooleanReturn" />
 
diff --git a/pom.xml b/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <parent>
@@ -11,7 +11,7 @@
 
     <groupId>com.vaadin</groupId>
     <artifactId>vaadin-spring-parent</artifactId>
-    <version>1.1-SNAPSHOT</version>
+    <version>2.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>vaadin-spring-parent</name>
@@ -78,14 +78,14 @@
             <email>petter@vaadin.com</email>
         </developer>
     </developers>
-
+    
     <properties>
-        <project.build.encoding>UTF-8</project.build.encoding>
-        <project.build.target>1.6</project.build.target>
-        <project.build.source>1.6</project.build.source>
-
+        <encoding>UTF-8</encoding>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
+        
         <!-- These are typically overridden with BOMs -->
-        <vaadin.version>7.7.3</vaadin.version>
+        <vaadin.version>8.0-SNAPSHOT</vaadin.version>
         <spring.version>4.3.3.RELEASE</spring.version>
         <spring.boot.version>1.4.1.RELEASE</spring.boot.version>
 
@@ -99,20 +99,10 @@
 
     <build>
         <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.1</version>
-                <configuration>
-                    <encoding>${project.build.encoding}</encoding>
-                    <target>${project.build.target}</target>
-                    <source>${project.build.source}</source>
-                </configuration>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
-                <version>2.14</version>
+                <version>2.17</version>
                 <configuration>
                     <enableRulesSummary>false</enableRulesSummary>
                     <includeTestSourceDirectory>true</includeTestSourceDirectory>
@@ -202,4 +192,16 @@
         <module>vaadin-spring-boot</module>
         <module>vaadin-spring-boot-starter</module>
     </modules>
+    <repositories>
+        <repository>
+            <id>vaadin-snapshots</id>
+            <url>https://oss.sonatype.org/content/repositories/vaadin-snapshots/</url>
+            <releases>
+                <enabled>false</enabled>
+            </releases>
+            <snapshots>
+                <enabled>true</enabled>
+            </snapshots>
+        </repository>
+    </repositories>
 </project>
diff --git a/vaadin-spring-boot-starter/pom.xml b/vaadin-spring-boot-starter/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.vaadin</groupId>
         <artifactId>vaadin-spring-parent</artifactId>
-        <version>1.1-SNAPSHOT</version>
+        <version>2.0-SNAPSHOT</version>
     </parent>
 
     <name>vaadin-spring-boot-starter</name>
@@ -38,6 +38,25 @@
             <artifactId>vaadin-client-compiled</artifactId>
             <version>${vaadin.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>${spring.boot.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>net.sourceforge.htmlunit</groupId>
+            <artifactId>htmlunit</artifactId>
+            <version>2.23</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.vaadin</groupId>
+            <artifactId>vaadin-server</artifactId>
+            <version>8.0-SNAPSHOT</version>
+            <scope>test</scope>
+        </dependency>
+
     </dependencies>
 
 </project>
diff --git a/vaadin-spring-boot-starter/src/test/java/com/vaadin/spring/web/TestStaticHttp.java b/vaadin-spring-boot-starter/src/test/java/com/vaadin/spring/web/TestStaticHttp.java
@@ -0,0 +1,80 @@
+/*
+ * Copyright 2015-2016 The original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.vaadin.spring.web;
+
+import com.gargoylesoftware.htmlunit.WebClient;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.spring.annotation.SpringUI;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.Notification;
+import com.vaadin.ui.UI;
+import com.vaadin.ui.VerticalLayout;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.embedded.LocalServerPort;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Bean;
+import org.springframework.test.context.junit4.SpringRunner;
+
+/**
+ * Web based test {@link com.vaadin.spring.server.SpringVaadinServlet} static resource handling
+ *
+ * @author Vaadin Ltd
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+public class TestStaticHttp {
+    private static final String MANDATORY_BOOTSTRAP_PART = "log('Vaadin bootstrap loaded');";
+    @Autowired
+    private WebClient webClient;
+
+    @LocalServerPort
+    private int port;
+
+    @Test
+    public void testExample() throws Exception {
+        String javaScriptUrl = "http://localhost:" + port + "/VAADIN/vaadinBootstrap.js?v=8.0-SNAPSHOT";
+        String content = this.webClient.getPage(javaScriptUrl).getWebResponse().getContentAsString();
+        Assert.assertTrue("Mandatory part of bootstrap is not found",
+                content.contains(MANDATORY_BOOTSTRAP_PART));
+    }
+
+    @SpringUI
+    public static class MyUI extends UI {
+        @Override
+        protected void init(VaadinRequest vaadinRequest) {
+            setContent(
+                    new VerticalLayout(
+                            new Button("Click me", event -> Notification.show("Thanks"))));
+        }
+    }
+
+    @SpringBootApplication
+    public static class MyConfig {
+        @Bean
+        public MyUI createUI() {
+            return new MyUI();
+        }
+
+        @Bean
+        public WebClient createWebClient() {
+            return new WebClient();
+        }
+    }
+}
diff --git a/vaadin-spring-boot/pom.xml b/vaadin-spring-boot/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.vaadin</groupId>
         <artifactId>vaadin-spring-parent</artifactId>
-        <version>1.1-SNAPSHOT</version>
+        <version>2.0-SNAPSHOT</version>
     </parent>
 
     <name>vaadin-spring-boot</name>
diff --git a/vaadin-spring/pom.xml b/vaadin-spring/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.vaadin</groupId>
         <artifactId>vaadin-spring-parent</artifactId>
-        <version>1.1-SNAPSHOT</version>
+        <version>2.0-SNAPSHOT</version>
     </parent>
 
     <name>vaadin-spring</name>
diff --git a/vaadin-spring/src/main/java/com/vaadin/spring/server/SpringVaadinServlet.java b/vaadin-spring/src/main/java/com/vaadin/spring/server/SpringVaadinServlet.java
@@ -15,6 +15,9 @@
  */
 package com.vaadin.spring.server;
 
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -145,4 +148,45 @@ protected VaadinServletRequest createVaadinRequest(
         }
     }
 
+    /**
+     * Check if this is a request for a static resource and, if it is, return the
+     * resource path.
+     *
+     * @param request http client request
+     * @return static file path or null if the request is not for a static resource.
+     *
+     */
+    @Override
+    protected String getStaticFilePath(HttpServletRequest request) {
+    /*
+      Under spring environment, all requests are intercepted with DispatcherServlet, and then mapped to
+      SpringVaadinServlet with VaadinServletConfiguration, and a static resource prefix (/VAADIN) is not present nor in
+      getPathInfo(), nor in getServletPath() after that. Here request URL is manually decoded to detect the prefix and
+      handle static resources properly.
+
+      This method is a copy of a hack from VaadinServlet.java of version 7 to support static resource handling in any case.
+      TODO fix static resource request mapping for spring application
+    */
+        String staticFilePath = super.getStaticFilePath(request);
+        if (staticFilePath == null) {
+
+            try {
+                String decodedRequestURI = URLDecoder.decode(
+                        request.getRequestURI(), StandardCharsets.UTF_8.name());
+                if (decodedRequestURI.startsWith("/VAADIN/")) {
+                    return decodedRequestURI;
+                }
+
+                String decodedContextPath = URLDecoder.decode(
+                        request.getContextPath(), StandardCharsets.UTF_8.name());
+                if (decodedRequestURI.startsWith(decodedContextPath + "/VAADIN/")) {
+                    return decodedRequestURI.substring(decodedContextPath.length());
+                }
+            } catch (UnsupportedEncodingException exception) {
+                // cannot happen since UTF8 is always supported
+                throw new RuntimeException(exception);
+            }
+        }
+        return staticFilePath;
+    }
 }
diff --git a/vaadin-spring/src/test/java/com/vaadin/spring/server/SpringVaadinServletTest.java b/vaadin-spring/src/test/java/com/vaadin/spring/server/SpringVaadinServletTest.java
