feat: add endpoint detection

packages/java/endpoint/src/main/java/com/vaadin/hilla/InternalBrowserCallable.java

@@ -0,0 +1,23 @@
+package com.vaadin.hilla;
+
+import com.vaadin.flow.server.frontend.EndpointUsageDetector;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marker interface to be used by {@link EndpointUsageDetector} for detecting
+ * framework's internal {@link BrowserCallable} and {@link Endpoint} endpoints
+ * that shouldn't start the endpoint generator per se.
+ * <p>
+ * For internal use only. May be renamed or removed in a future release.
+ *
+ * @author Vaadin Ltd
+ * @since 24.7
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface InternalBrowserCallable {
+}

packages/java/endpoint/src/main/java/com/vaadin/hilla/signals/handler/SignalsHandler.java

@@ -20,6 +20,7 @@
 import com.vaadin.flow.server.auth.AnonymousAllowed;
 import com.vaadin.hilla.BrowserCallable;
 import com.vaadin.hilla.EndpointInvocationException;
+import com.vaadin.hilla.InternalBrowserCallable;
 import com.vaadin.hilla.signals.core.event.ListStateEvent;
 import com.vaadin.hilla.signals.core.registry.SecureSignalsRegistry;
 import jakarta.annotation.Nullable;
@@ -30,6 +31,7 @@
  */
 @AnonymousAllowed
 @BrowserCallable
+@InternalBrowserCallable
 public class SignalsHandler {
 
     private static final String FEATURE_FLAG_ERROR_MESSAGE = """

packages/java/endpoint/src/main/java/com/vaadin/hilla/startup/EndpointUsageDetectorImpl.java

@@ -0,0 +1,29 @@
+package com.vaadin.hilla.startup;
+
+import java.util.stream.Stream;
+
+import com.vaadin.flow.server.frontend.EndpointUsageDetector;
+import com.vaadin.flow.server.frontend.Options;
+import com.vaadin.flow.server.frontend.scanner.ClassFinder;
+import com.vaadin.hilla.BrowserCallable;
+import com.vaadin.hilla.Endpoint;
+import com.vaadin.hilla.InternalBrowserCallable;
+
+/**
+ * Implementation of EndpointUsageDetector which determines if the endpoint
+ * generator task needs to be run.
+ */
+public class EndpointUsageDetectorImpl implements EndpointUsageDetector {
+
+    @Override
+    public boolean areEndpointsUsed(Options options) {
+        ClassFinder classFinder = options.getClassFinder();
+
+        return Stream.concat(
+                classFinder.getAnnotatedClasses(Endpoint.class).stream(),
+                classFinder.getAnnotatedClasses(BrowserCallable.class).stream())
+                .anyMatch(annotatedClass -> !annotatedClass
+                        .isAnnotationPresent(InternalBrowserCallable.class));
+    }
+
+}

packages/java/endpoint/src/main/resources/META-INF/services/com.vaadin.flow.server.frontend.EndpointUsageDetector

@@ -0,0 +1 @@
+com.vaadin.hilla.startup.EndpointUsageDetectorImpl

packages/java/engine-runtime/src/test/java/com/vaadin/hilla/internal/NodeTasksEndpointTest.java

@@ -17,6 +17,7 @@
 
 import com.vaadin.flow.di.Lookup;
 import com.vaadin.flow.server.frontend.EndpointGeneratorTaskFactory;
+import com.vaadin.flow.server.frontend.EndpointUsageDetector;
 import com.vaadin.flow.server.frontend.NodeTasks;
 import com.vaadin.flow.server.frontend.Options;
 import com.vaadin.flow.server.frontend.scanner.ClassFinder;
@@ -34,6 +35,12 @@ public static class ConnectEndpointsForTesting {
     public void setUp()
             throws IOException, NoSuchFieldException, IllegalAccessException {
         Lookup mockLookup = Mockito.mock(Lookup.class);
+        EndpointUsageDetector endpointUsageDetector = Mockito
+                .mock(EndpointUsageDetector.class);
+        Mockito.when(endpointUsageDetector
+                .areEndpointsUsed(Mockito.any(Options.class))).thenReturn(true);
+        Mockito.doReturn(endpointUsageDetector).when(mockLookup)
+                .lookup(EndpointUsageDetector.class);
         Mockito.doReturn(new EndpointGeneratorTaskFactoryImpl())
                 .when(mockLookup).lookup(EndpointGeneratorTaskFactory.class);
         Mockito.doReturn(new DefaultClassFinder(Set.of(

packages/java/hilla/pom.xml

@@ -32,6 +32,17 @@
             <artifactId>hilla-engine-runtime</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.reflections</groupId>
+            <artifactId>reflections</artifactId>
+            <version>0.10.2</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

packages/java/hilla/src/test/java/com/vaadin/hilla/InternalBrowserCallableTest.java

@@ -0,0 +1,54 @@
+package com.vaadin.hilla;
+
+import java.util.Set;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.reflections.Reflections;
+import org.reflections.scanners.Scanners;
+
+/**
+ * Validates that all endpoint classes in sources are annotated with
+ * {@link InternalBrowserCallable} to not trigger endpoint generator if
+ * endpoints are not actually used.
+ */
+public class InternalBrowserCallableTest {
+
+    private static final String BASE_PACKAGE = "com.vaadin";
+
+    @Test
+    public void testBrowserCallableAndEndpointAnnotationsMarkedAsInternal() {
+        Reflections reflections = new Reflections(BASE_PACKAGE,
+                Scanners.TypesAnnotated);
+        Set<Class<?>> annotatedClasses = reflections
+                .getTypesAnnotatedWith(BrowserCallable.class);
+        Set<Class<?>> endpointClasses = reflections
+                .getTypesAnnotatedWith(Endpoint.class);
+        annotatedClasses.addAll(endpointClasses);
+
+        for (Class<?> clazz : annotatedClasses) {
+            if (!clazz.getName().contains(".test.") && !clazz
+                    .isAnnotationPresent(InternalBrowserCallable.class)) {
+                Assertions.fail("Class " + clazz.getName()
+                        + " is annotated with @BrowserCallable or @Endpoint, but missing @InternalBrowserCallable.");
+            }
+        }
+    }
+
+    @Test
+    public void testInternalBrowserCallableHasBrowserCallableOrEndpoint()
+            throws Exception {
+        Reflections reflections = new Reflections(BASE_PACKAGE,
+                Scanners.TypesAnnotated);
+        Set<Class<?>> annotatedClasses = reflections
+                .getTypesAnnotatedWith(InternalBrowserCallable.class);
+
+        for (Class<?> clazz : annotatedClasses) {
+            if (!clazz.isAnnotationPresent(BrowserCallable.class)
+                    && !clazz.isAnnotationPresent(Endpoint.class)) {
+                Assertions.fail("Class " + clazz.getName()
+                        + " is annotated with @InternalBrowserCallable and must be annotated with @BrowserCallable or @Endpoint.");
+            }
+        }
+    }
+}

packages/java/tests/spring/no-endpoints/pom.xml

@@ -0,0 +1,64 @@
+<?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">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.vaadin</groupId>
+        <artifactId>tests-spring</artifactId>
+        <version>24.6-SNAPSHOT</version>
+    </parent>
+    <artifactId>tests-spring-no-endpoints</artifactId>
+    <name>ITs for No Endpoints cases</name>
+    <packaging>jar</packaging>
+
+    <properties>
+        <maven.deploy.skip>true</maven.deploy.skip>
+        <formatter.basedir>${project.parent.parent.parent.basedir}</formatter.basedir>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.vaadin</groupId>
+            <artifactId>hilla</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>com.vaadin</groupId>
+                <artifactId>hilla-maven-plugin</artifactId>
+                <configuration>
+                    <parser>
+                        <packages>
+                            <package>com.example.application</package>
+                        </packages>
+                    </parser>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <!-- The test here assumes the build creates frontend files -->
+                            <goal>build-frontend</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                    <includeSystemScope>true</includeSystemScope>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

packages/java/tests/spring/no-endpoints/src/main/java/com/example/application/Application.java

@@ -0,0 +1,16 @@
+package com.example.application;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * The entry point of the Spring Boot application.
+ */
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}

packages/java/tests/spring/no-endpoints/src/main/java/com/example/application/InternalBrowserCallableExample.java

@@ -0,0 +1,12 @@
+package com.example.application;
+
+import com.vaadin.hilla.Endpoint;
+import com.vaadin.hilla.InternalBrowserCallable;
+
+@Endpoint
+@InternalBrowserCallable
+public class InternalBrowserCallableExample {
+    public String exampleMethod() {
+        return null;
+    }
+}

packages/java/tests/spring/no-endpoints/src/main/java/com/example/application/InternalEndpointExample.java

@@ -0,0 +1,12 @@
+package com.example.application;
+
+import com.vaadin.hilla.Endpoint;
+import com.vaadin.hilla.InternalBrowserCallable;
+
+@Endpoint
+@InternalBrowserCallable
+public class InternalEndpointExample {
+    public String exampleMethod() {
+        return null;
+    }
+}

packages/java/tests/spring/no-endpoints/src/main/resources/application.properties

@@ -0,0 +1,3 @@
+server.port=8888
+vaadin.devmode.liveReload.enabled=false
+logging.level.org.atmosphere = warn

packages/java/tests/spring/no-endpoints/src/test/java/com/example/application/InternalEndpointIT.java

@@ -0,0 +1,26 @@
+package com.example.application;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.junit.Test;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class InternalEndpointIT {
+    Path frontendDir = Paths.get("frontend", "generated");
+
+    @Test
+    public void shouldNotRunEndpointGeneratorForOnlyInternalEndpointsPresent() {
+        assertFalse(Files.exists(frontendDir.resolve("InternalBrowserCallableExample.ts")));
+        assertFalse(Files.exists(frontendDir.resolve("InternalEndpointExample.ts")));
+        assertFalse(Files.exists(frontendDir
+                .resolve("com/example/application/InternalBrowserCallableExample.ts")));
+        assertFalse(Files.exists(frontendDir
+            .resolve("com/example/application/InternalEndpointExample.ts")));
+    }
+
+
+}