Add LiveReload support on watch goal

adrienlauer · adrienlauer · commit 3068b3afdfd4 · 2017-11-21T23:25:26.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Version 2.7.0 (2017-11-31)
 
 * [new] Add watch goal which automatically refreshes the application when a source file change.
+* [new] Support for [LiveReload](http://livereload.com/) on the watch goal.
 
 # Version 2.6.4 (2017-10-19)
 
diff --git a/pom.xml b/pom.xml
@@ -34,11 +34,26 @@
         <bintray.package>seedstack-maven-plugin</bintray.package>
 
         <compatibility.skip>true</compatibility.skip>
+        <jetty-server.version>8.1.8.v20121106</jetty-server.version>
     </properties>
 
     <build>
         <pluginManagement>
             <plugins>
+                <plugin>
+                    <groupId>com.mycila</groupId>
+                    <artifactId>license-maven-plugin</artifactId>
+                    <version>${mycila.license-maven-plugin.version}</version>
+                    <configuration>
+                        <excludes>
+                            <exclude>AUTHORS</exclude>
+                            <exclude>CONTRIBUTORS</exclude>
+                            <exclude>LICENSE</exclude>
+                            <exclude>**/src/license/THIRD-PARTY.properties</exclude>
+                            <exclude>**/src/main/resources/livereload.js</exclude>
+                        </excludes>
+                    </configuration>
+                </plugin>
                 <plugin>
                     <groupId>org.codehaus.mojo</groupId>
                     <artifactId>license-maven-plugin</artifactId>
@@ -61,15 +76,17 @@
                             <licenseMerge>Apache 2|Apache License, Version 2.0</licenseMerge>
                             <licenseMerge>Apache 2|Apache Public License 2.0</licenseMerge>
                             <licenseMerge>Apache 2|Unknown license</licenseMerge>
+                            <licenseMerge>Apache 2|Apache Software License - Version 2.0</licenseMerge>
                             <licenseMerge>BSD|BSD 3-Clause License</licenseMerge>
                             <licenseMerge>BSD|BSD style modified by Coverity</licenseMerge>
                             <licenseMerge>BSD|The BSD License</licenseMerge>
-                            <licenseMerge>CDDL 1.0|COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0
-                            </licenseMerge>
+                            <licenseMerge>CDDL 1.0|COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0</licenseMerge>
                             <licenseMerge>CPL 1.0|Common Public License Version 1.0</licenseMerge>
                             <licenseMerge>EPL 1.0|Eclipse Public License, Version 1.0</licenseMerge>
+                            <licenseMerge>EPL 1.0|Eclipse Public License - Version 1.0</licenseMerge>
                             <licenseMerge>MIT|MIT License</licenseMerge>
                             <licenseMerge>MPL|Mozilla Public License 1.1 (MPL 1.1)</licenseMerge>
+                            <licenseMerge>Public Domain|Public domain (Unlicense)</licenseMerge>
                         </licenseMerges>
                     </configuration>
                 </plugin>
@@ -239,6 +256,21 @@
             <artifactId>asm</artifactId>
             <version>3.3.1</version>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.jetty</groupId>
+            <artifactId>jetty-server</artifactId>
+            <version>${jetty-server.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.jetty</groupId>
+            <artifactId>jetty-websocket</artifactId>
+            <version>${jetty-server.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.googlecode.json-simple</groupId>
+            <artifactId>json-simple</artifactId>
+            <version>1.1.1</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
diff --git a/src/license/THIRD-PARTY.properties b/src/license/THIRD-PARTY.properties
@@ -13,7 +13,7 @@
 # Please fill the missing licenses for dependencies :
 #
 #
-#Tue Nov 21 14:05:44 CET 2017
+#Tue Nov 21 23:24:03 CET 2017
 classworlds--classworlds--1.1-alpha-2=
 commons-collections--commons-collections--3.1=
 dom4j--dom4j--1.6.1=
diff --git a/src/main/java/org/seedstack/maven/WatchMojo.java b/src/main/java/org/seedstack/maven/WatchMojo.java
@@ -41,6 +41,7 @@
 import org.objectweb.asm.FieldVisitor;
 import org.objectweb.asm.MethodVisitor;
 import org.seedstack.maven.classloader.ReloadingClassLoader;
+import org.seedstack.maven.livereload.LRServer;
 import org.seedstack.maven.runnables.DefaultLauncherRunnable;
 import org.seedstack.maven.watcher.AggregatingFileChangeListener;
 import org.seedstack.maven.watcher.DirectoryWatcher;
@@ -53,12 +54,14 @@
         requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME)
 @Execute(phase = LifecyclePhase.PROCESS_CLASSES)
 public class WatchMojo extends AbstractExecutableMojo {
+    public static final int LIVE_RELOAD_PORT = 35729;
     private DirectoryWatcher directoryWatcher;
     private Thread watcherThread;
     private AggregatingFileChangeListener fileChangeListener;
     private List<String> compileSourceRoots;
     private ReloadingClassLoader reloadingClassLoader;
     private DefaultLauncherRunnable launcherRunnable;
+    private LRServer lrServer;
 
     @Override
     public void execute() throws MojoExecutionException, MojoFailureException {
@@ -82,11 +85,11 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             }
         }
 
-        this.watcherThread = new Thread(this.directoryWatcher);
+        this.watcherThread = new Thread(this.directoryWatcher, "watcher");
         this.launcherRunnable = new DefaultLauncherRunnable(getArgs(), getMonitor(), getLog());
         execute(launcherRunnable, false);
 
-        Runtime.getRuntime().addShutdownHook(new Thread() {
+        Runtime.getRuntime().addShutdownHook(new Thread("watcher") {
             @Override
             public void run() {
                 fileChangeListener.stop();
@@ -100,8 +103,26 @@ public void run() {
             }
         });
 
+        // Start live reload server
+        try {
+            getLog().info("Starting LiveReload server on port " + LIVE_RELOAD_PORT);
+            lrServer = new LRServer(LIVE_RELOAD_PORT);
+            lrServer.start();
+        } catch (Exception e) {
+            getLog().error("Unable to start LiveReload server", e);
+        }
+
+        // Start watching sources
         this.watcherThread.start();
         waitForShutdown();
+
+        if (lrServer != null) {
+            try {
+                lrServer.stop();
+            } catch (Exception e) {
+                getLog().error("Unable to stop LiveReload server", e);
+            }
+        }
     }
 
     @Override
@@ -136,6 +157,10 @@ public void onAggregatedChanges(Set<FileEvent> fileEvents) {
                     removeFiles(compiledFilesToRemove);
                     recompile();
                     launcherRunnable.refresh();
+                    if (lrServer != null) {
+                        getLog().info("Triggering LiveReload");
+                        lrServer.notifyChange("/");
+                    }
                 }
             } catch (Exception e) {
                 Throwable toLog = e.getCause();
diff --git a/src/main/java/org/seedstack/maven/livereload/LRProtocol.java b/src/main/java/org/seedstack/maven/livereload/LRProtocol.java
@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+package org.seedstack.maven.livereload;
+
+import java.util.LinkedHashMap;
+import java.util.LinkedList;
+import java.util.Map;
+import org.json.simple.JSONValue;
+
+/**
+ * Modified from: https://github.com/davidB/livereload-jvm
+ * @author dwayne
+ */
+class LRProtocol {
+    String hello() {
+        LinkedList<String> protocols = new LinkedList<String>();
+        protocols.add("http://livereload.com/protocols/official-7");
+
+        LinkedHashMap<String, Object> obj = new LinkedHashMap<String, Object>();
+        obj.put("command", "hello");
+        obj.put("protocols", protocols);
+        obj.put("serverName", "livereload-jvm");
+        return JSONValue.toJSONString(obj);
+    }
+
+    String alert(String msg) throws Exception {
+        LinkedHashMap<String, Object> obj = new LinkedHashMap<String, Object>();
+        obj.put("command", "alert");
+        obj.put("message", msg);
+        return JSONValue.toJSONString(obj);
+    }
+
+    String reload(String path) throws Exception {
+        LinkedHashMap<String, Object> obj = new LinkedHashMap<String, Object>();
+        obj.put("command", "reload");
+        obj.put("path", path);
+        obj.put("liveCSS", true);
+        return JSONValue.toJSONString(obj);
+    }
+
+    @SuppressWarnings("unchecked")
+    boolean isHello(String data) throws Exception {
+        Object obj = JSONValue.parse(data);
+        boolean back = obj instanceof Map;
+        back = back && "hello".equals(((Map<Object, Object>) obj).get("command"));
+        return back;
+    }
+}
diff --git a/src/main/java/org/seedstack/maven/livereload/LRServer.java b/src/main/java/org/seedstack/maven/livereload/LRServer.java
@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+package org.seedstack.maven.livereload;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.server.handler.ResourceHandler;
+import org.eclipse.jetty.server.nio.SelectChannelConnector;
+import org.eclipse.jetty.util.resource.Resource;
+
+/**
+ * Modified from: https://github.com/davidB/livereload-jvm
+ */
+public class LRServer {
+    private final int _port;
+    private Server _server;
+    private LRWebSocketHandler _wsHandler;
+
+    public LRServer(int port) {
+        this._port = port;
+    }
+
+    private void init() throws Exception {
+        SelectChannelConnector connector = new SelectChannelConnector();
+        connector.setPort(_port);
+
+        ResourceHandler rHandler = new ResourceHandler() {
+            @Override
+            public Resource getResource(String path) throws MalformedURLException {
+                if ("/livereload.js".equals(path)) {
+                    try {
+                        return Resource.newResource(LRServer.class.getResource(path));
+                    } catch (IOException e) {
+                        throw new RuntimeException(e);
+                    }
+                }
+                return null;
+            }
+        };
+
+        _wsHandler = new LRWebSocketHandler();
+        _wsHandler.setHandler(rHandler);
+
+        _server = new Server();
+        _server.setHandler(_wsHandler);
+        _server.addConnector(connector);
+    }
+
+    public void start() throws Exception {
+        this.init();
+        _server.start();
+    }
+
+    public void stop() throws Exception {
+        _server.stop();
+    }
+
+    public void notifyChange(String path) throws Exception {
+        _wsHandler.notifyChange(path);
+    }
+}
diff --git a/src/main/java/org/seedstack/maven/livereload/LRWebSocketHandler.java b/src/main/java/org/seedstack/maven/livereload/LRWebSocketHandler.java
@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+package org.seedstack.maven.livereload;
+
+import java.io.IOException;
+import java.util.concurrent.ConcurrentLinkedQueue;
+import javax.servlet.http.HttpServletRequest;
+import org.eclipse.jetty.websocket.WebSocket;
+import org.eclipse.jetty.websocket.WebSocketHandler;
+
+/**
+ * Modified from: https://github.com/davidB/livereload-jvm
+ */
+class LRWebSocketHandler extends WebSocketHandler {
+    private final ConcurrentLinkedQueue<LRWebSocket> _broadcast = new ConcurrentLinkedQueue<LRWebSocket>();
+    private final LRProtocol _protocol = new LRProtocol();
+
+    @Override
+    public WebSocket doWebSocketConnect(HttpServletRequest request, String protocol) {
+        if ("/livereload".equals(request.getPathInfo())) {
+            return new LRWebSocket();
+        }
+        return new WebSocket() {
+            @Override
+            public void onOpen(Connection connection) {
+                connection.close();
+            }
+
+            @Override
+            public void onClose(int code, String msg) {
+            }
+        };
+    }
+
+    void notifyChange(String path) throws Exception {
+        String msg = _protocol.reload(path);
+        for (LRWebSocket ws : _broadcast) {
+            try {
+                ws._connection.sendMessage(msg);
+            } catch (IOException e) {
+                _broadcast.remove(ws);
+                e.printStackTrace();
+            }
+        }
+    }
+
+    class LRWebSocket implements WebSocket.OnTextMessage {
+        Connection _connection;
+
+        @Override
+        public void onOpen(Connection connection) {
+            _connection = connection;
+            _broadcast.add(this);
+        }
+
+        @Override
+        public void onClose(int code, String message) {
+            _broadcast.remove(this);
+        }
+
+        @Override
+        public void onMessage(final String data) {
+            try {
+                if (_protocol.isHello(data)) {
+                    _connection.sendMessage(_protocol.hello());
+                }
+            } catch (Exception exc) {
+                exc.printStackTrace();
+            }
+        }
+    }
+}
diff --git a/src/main/java/org/seedstack/maven/watcher/AggregatingFileChangeListener.java b/src/main/java/org/seedstack/maven/watcher/AggregatingFileChangeListener.java
@@ -42,7 +42,9 @@ public void run() {
 
     public void stop() {
         stop = true;
-        timer.cancel();
+        if (timer != null) {
+            timer.cancel();
+        }
     }
 
     protected abstract void onAggregatedChanges(Set<FileEvent> fileEvents);
diff --git a/src/main/resources/livereload.js b/src/main/resources/livereload.js

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`# Please fill the missing licenses for dependencies :`
`14`	`14`	`#`
`15`	`15`	`#`
`16`		`-#Tue Nov 21 14:05:44 CET 2017`
	`16`	`+#Tue Nov 21 23:24:03 CET 2017`
`17`	`17`	`classworlds--classworlds--1.1-alpha-2=`
`18`	`18`	`commons-collections--commons-collections--3.1=`
`19`	`19`	`dom4j--dom4j--1.6.1=`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,9 @@ public void run() {`
`42`	`42`
`43`	`43`	`public void stop() {`
`44`	`44`	`stop = true;`
`45`		`- timer.cancel();`
	`45`	`+ if (timer != null) {`
	`46`	`+ timer.cancel();`
	`47`	`+ }`
`46`	`48`	`}`
`47`	`49`
`48`	`50`	`protected abstract void onAggregatedChanges(Set<FileEvent> fileEvents);`