feat: add vite watchdog (#12230)

Add watchdog to stop vite when java handler exits or crashes. Fixes #12060
vaadin · Nov 2, 2021 · e68e335 · e68e335
1 parent 2acef65
commit e68e335
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 7 deletions.
diff --git a/flow-server/src/main/resources/vite.generated.ts b/flow-server/src/main/resources/vite.generated.ts
@@ -5,6 +5,7 @@
  * This file will be overwritten on every run. Any custom changes should be made to vite.config.ts
  */
 import path from 'path';
+import * as net from 'net';
 
 import { processThemeResources } from '@vaadin/application-theme-plugin/theme-handle.js';
 import settings from '#settingsImport#';
@@ -53,7 +54,29 @@ function updateTheme(contextPath: string) {
   }
 }
 
-export const vaadinConfig:UserConfigFn = (env) => ({
+function runWatchDog(watchDogPort) {
+  const client = net.Socket();
+  client.setEncoding('utf8');
+  client.on('error', function () {
+    console.log("Watchdog connection error. Terminating vite process...");
+    client.destroy();
+    process.exit(0);
+  });
+  client.on('close', function () {
+    client.destroy();
+    runWatchDog(watchDogPort);
+  });
+
+  client.connect(watchDogPort, 'localhost');
+}
+
+export const vaadinConfig:UserConfigFn = (env) => {
+  if (env.mode === 'development' && process.env.watchDogPort) {
+    // Open a connection with the Java dev-mode handler in order to finish
+    // vite when it exits or crashes.
+    runWatchDog(process.env.watchDogPort);
+  }
+  return ({
     root: 'frontend',
     base: env.mode === 'production' ? '' : '/VAADIN/',
     resolve: {
@@ -87,7 +110,8 @@ export const vaadinConfig:UserConfigFn = (env) => ({
         }
       }
     ]
-  });
+  })
+};
 
 
 export const overrideVaadinConfig = (customConfig:UserConfigFn) => {

diff --git a/vaadin-dev-server/src/main/java/com/vaadin/base/devserver/AbstractDevServerRunner.java b/vaadin-dev-server/src/main/java/com/vaadin/base/devserver/AbstractDevServerRunner.java
@@ -342,6 +342,8 @@ protected Process doStartDevServer() {
         }
 
         processBuilder.command(command);
+        processBuilder.environment().put("watchDogPort",
+                Integer.toString(getWatchDog().getWatchDogPort()));
 
         try {
             Process process = processBuilder.redirectErrorStream(true).start();

diff --git a/vaadin-dev-server/src/main/java/com/vaadin/base/devserver/WebpackHandler.java b/vaadin-dev-server/src/main/java/com/vaadin/base/devserver/WebpackHandler.java
@@ -173,8 +173,7 @@ protected List<String> getServerStartupCommand(String nodeExec) {
         command.add(String.valueOf(getPort()));
         command.add("--watch-options-stdin"); // Tell wds to stop even if
                                               // watchDog fail
-        command.add("--env");
-        command.add("watchDogPort=" + getWatchDog().getWatchDogPort());
+
         String customParameters = getApplicationConfiguration()
                 .getStringProperty(
                         InitParameters.SERVLET_PARAMETER_DEVMODE_WEBPACK_OPTIONS,

diff --git a/vaadin-dev-server/src/test/java/com/vaadin/base/devserver/startup/AbstractDevModeTest.java b/vaadin-dev-server/src/test/java/com/vaadin/base/devserver/startup/AbstractDevModeTest.java
@@ -12,7 +12,6 @@
 import com.vaadin.base.devserver.AbstractDevServerRunner;
 import com.vaadin.base.devserver.DevModeHandlerManagerImpl;
 import com.vaadin.base.devserver.MockDeploymentConfiguration;
-import com.vaadin.base.devserver.WebpackHandler;
 import com.vaadin.flow.di.Lookup;
 import com.vaadin.flow.di.ResourceProvider;
 import com.vaadin.flow.function.DeploymentConfiguration;
@@ -137,7 +136,7 @@ protected DevModeHandler getDevModeHandler() {
     }
 
     protected int getDevServerPort() {
-        return ((WebpackHandler) handler).getPort();
+        return ((AbstractDevServerRunner) handler).getPort();
     }
 
     protected void waitForDevServer() {
@@ -155,7 +154,7 @@ protected WebpackHandler startWebpack(int port) {
 
     protected static void waitForDevServer(DevModeHandler devModeHandler) {
         Assert.assertNotNull(devModeHandler);
-        ((WebpackHandler) (devModeHandler)).waitForDevServer();
+        ((AbstractDevServerRunner) (devModeHandler)).waitForDevServer();
     }
 
     protected static boolean hasDevServerProcess(