Replace the GWT client engine with a TypeScript implementation

flow-client/eslint.config.js → flow-client/eslint.config.mjs

@@ -12,7 +12,11 @@ export default [
     languageOptions: {
       parserOptions: {
         projectService: {
-          allowDefaultProject: ['src/test/frontend/*']
+          allowDefaultProject: ['src/test/frontend/*'],
+          // The migration adds a *Tests.ts per converted module; raise the
+          // default-project cap (default 8) so linting keeps working as the
+          // test suite grows.
+          maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING: 100
         }
       }
     },
@@ -28,6 +32,17 @@ export default [
       '@typescript-eslint/no-use-before-define': 'off',
     }
   },
+  {
+    // Engine code must log through internal/Console, which suppresses browser
+    // logging in production mode (unless the vaadin.browserLog localStorage flag
+    // is set). Calling `console` directly bypasses that, so it is an error here;
+    // the few deliberately ungated sites carry an inline disable comment.
+    files: ['src/main/frontend/internal/**/*.ts'],
+    ignores: ['src/main/frontend/internal/Console.ts'],
+    rules: {
+      'no-console': 'error'
+    }
+  },
   {
     files: ['src/**/frontend/**/*'],
     languageOptions: {

flow-client/pom.xml

@@ -12,10 +12,6 @@
   <description>${project.name}</description>
 
   <properties>
-    <gwt.module>com.vaadin.ClientEngine</gwt.module>
-    <gwt.module.output>${project.build.outputDirectory}/META-INF/resources/VAADIN/static/</gwt.module.output>
-    <gwt.module.style>OBF</gwt.module.style>
-    <gwt.sdm.bindAddress>0.0.0.0</gwt.sdm.bindAddress>
     <skipTsTests>${skipTests}</skipTsTests>
     <org.eclipse.equinox.common.version>3.19.100</org.eclipse.equinox.common.version>
     <org.eclipse.core.runtime.version>3.31.100</org.eclipse.core.runtime.version>
@@ -28,13 +24,6 @@
 
   <dependencyManagement>
     <dependencies>
-      <dependency>
-        <groupId>com.google.gwt</groupId>
-        <artifactId>gwt</artifactId>
-        <version>${gwt.version}</version>
-        <type>pom</type>
-        <scope>import</scope>
-      </dependency>
       <dependency>
         <groupId>org.eclipse.platform</groupId>
         <artifactId>org.eclipse.equinox.common</artifactId>
@@ -96,21 +85,6 @@
       <version>1.22.1</version>
       <scope>provided</scope>
     </dependency>
-    <dependency>
-      <groupId>com.google.gwt</groupId>
-      <artifactId>gwt-user</artifactId>
-      <scope>provided</scope>
-    </dependency>
-    <dependency>
-      <groupId>com.google.gwt</groupId>
-      <artifactId>gwt-dev</artifactId>
-      <scope>provided</scope>
-    </dependency>
-    <dependency>
-      <groupId>com.google.gwt</groupId>
-      <artifactId>gwt-elemental</artifactId>
-      <scope>provided</scope>
-    </dependency>
     <dependency>
       <groupId>org.ow2.asm</groupId>
       <artifactId>asm</artifactId>
@@ -196,9 +170,6 @@
       </resource>
     </resources>
 
-    <!-- Output classes directly into the webapp, so that IDEs and "mvn
-            process-classes" update them in DevMode -->
-    <!-- <outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory> -->
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -225,9 +196,6 @@
         <artifactId>maven-surefire-plugin</artifactId>
         <version>${maven.surefire.plugin.version}</version>
         <configuration>
-          <excludes>
-            <exclude>**/Gwt*.java</exclude>
-          </excludes>
           <enableAssertions>true</enableAssertions>
         </configuration>
       </plugin>
@@ -243,91 +211,12 @@
           </execution>
         </executions>
       </plugin>
-
-      <!-- GWT Maven Plugin -->
-      <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>gwt-maven-plugin</artifactId>
-        <version>${gwt.version}</version>
-        <configuration>
-          <!-- Assertions should be disabled once we introduce
-                        a separate production build -->
-          <enableAssertions>true</enableAssertions>
-          <failOnError>true</failOnError>
-          <gwtSdkFirstInClasspath/>
-          <persistentunitcache>false</persistentunitcache>
-          <webappDirectory>${gwt.module.output}</webappDirectory>
-          <launcherDir>${gwt.module.output}</launcherDir>
-          <compileReport>true</compileReport>
-          <bindAddress>${gwt.sdm.bindAddress}</bindAddress>
-          <modules>
-            <module>${gwt.module}</module>
-          </modules>
-          <webMode>true</webMode>
-          <style>${gwt.module.style}</style>
-          <htmlunit>FF38</htmlunit>
-          <testTimeOut>300</testTimeOut>
-          <extraJvmArgs>-Xmx512m -Dvaadin.frontend.hotdeploy=false</extraJvmArgs>
-          <includes>${gwt.test.pattern}</includes>
-        </configuration>
-
-        <executions>
-          <execution>
-            <goals>
-              <goal>compile</goal>
-              <goal>generateAsync</goal>
-            </goals>
-            <phase>compile</phase>
-          </execution>
-          <execution>
-            <id>gwt-test</id>
-            <goals>
-              <goal>test</goal>
-            </goals>
-            <phase>test</phase>
-          </execution>
-        </executions>
-      </plugin>
-
-      <!-- Include separate source dir for GWT tests -->
-      <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>build-helper-maven-plugin</artifactId>
-        <dependencies>
-          <dependency>
-            <groupId>com.vaadin</groupId>
-            <artifactId>vaadin-testbench-core</artifactId>
-            <version>${testbench.version}</version>
-          </dependency>
-        </dependencies>
-        <executions>
-          <execution>
-            <id>add-gwt-test-sources-as-test-sources</id>
-            <goals>
-              <goal>add-test-source</goal>
-            </goals>
-            <phase>generate-test-sources</phase>
-            <configuration>
-              <sources>
-                <source>src/test-gwt/java</source>
-              </sources>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <groupId>com.diffplug.spotless</groupId>
         <artifactId>spotless-maven-plugin</artifactId>
         <configuration>
-          <java>
-            <excludes>
-              <exclude>src/main/java/com/vaadin/client/gwt/**</exclude>
-            </excludes>
-          </java>
           <typescript>
             <excludes>
-              <exclude>src/main/java/com/vaadin/client/gwt</exclude>
-              <exclude>src/main/resources/com/vaadin/flow/linker/ClientEngineSingleScriptTemplate.js</exclude>
               <exclude>src/main/frontend/FlowClient.js</exclude>
             </excludes>
           </typescript>
@@ -397,18 +286,11 @@
     </plugins>
   </build>
   <profiles>
-    <profile>
-      <id>sdm</id>
-      <properties>
-        <gwt.module>com.vaadin.ClientEngineXSI</gwt.module>
-      </properties>
-    </profile>
     <profile>
       <id>slow-tests</id>
       <properties>
-        <!-- There are no slowTests in this module, we disable surefire, gwt and Ts -->
+        <!-- There are no slowTests in this module, we disable surefire and Ts -->
         <groups>none</groups>
-        <gwt.test.pattern>none</gwt.test.pattern>
         <skipTsTests>true</skipTsTests>
       </properties>
     </profile>

flow-client/scripts/client.js

@@ -16,22 +16,21 @@
 
 const fs = require('fs');
 
-const fromDir = 'target/classes/META-INF/resources/VAADIN/static/client/';
-const fromFileRegex = /^client-.*\.cache\.js$/u;
-
 const sourceDir = 'src/main/frontend/';
 const targetDir = 'target/classes/META-INF/frontend/';
 const toFile = 'FlowClient.js';
 
-const fromFileName = fs.readdirSync(fromDir).find((filename) => fromFileRegex.exec(filename));
-
-// Read from target
-let clientSource = fs.readFileSync(fromDir + fromFileName, 'utf8');
-
-// Wrap with ES module export
-clientSource = `export function init() {
-${clientSource}
-};`;
+// FlowClient.init() is the client entry point that Flow.ts imports and calls. It
+// runs the TypeScript bootstrap (onModuleLoad): it registers the widgetset start
+// callback so the server bootstrap can start the application, which assembles and
+// starts the TypeScript engine (ApplicationConnection). This replaces the former
+// GWT engine bundle that used to be inlined here.
+const clientSource = `import { onModuleLoad } from './internal/Bootstrapper';
+
+export function init() {
+  onModuleLoad();
+}
+`;
 
 // Write to source
 fs.writeFileSync(sourceDir + toFile, clientSource, 'utf8');