fix: use ResourceProvider to search for frontend resources (#22627)

mcollovati · web-flow · commit 02f8ee38849e · 2025-11-03T14:39:35.000+02:00
Using resource provider to search for frontend resources prevents potential issues with environment that use multiple classloaders, like Quarkus. Every environment can provide its own resource provider implementation that uses the best approach for loading resources from classpath. Fixes #22617
diff --git a/vaadin-dev-server/src/main/java/com/vaadin/base/devserver/startup/DevModeInitializer.java b/vaadin-dev-server/src/main/java/com/vaadin/base/devserver/startup/DevModeInitializer.java
@@ -25,6 +25,7 @@
 import java.lang.annotation.Annotation;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.net.URI;
 import java.net.URL;
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
@@ -33,7 +34,6 @@
 import java.nio.file.Paths;
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.Enumeration;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
@@ -61,6 +61,7 @@
 import com.vaadin.base.devserver.viteproxy.ViteWebsocketEndpoint;
 import com.vaadin.experimental.FeatureFlags;
 import com.vaadin.flow.di.Lookup;
+import com.vaadin.flow.di.ResourceProvider;
 import com.vaadin.flow.internal.DevModeHandler;
 import com.vaadin.flow.server.Constants;
 import com.vaadin.flow.server.ExecutionFailedException;
@@ -244,8 +245,10 @@ public static DevModeHandler initDevModeHandler(Set<Class<?>> classes,
             options.createMissingPackageJson(true);
         }
 
-        Set<File> frontendLocations = getFrontendLocationsFromClassloader(
-                DevModeStartupListener.class.getClassLoader());
+        ResourceProvider resourceProvider = lookup
+                .lookup(ResourceProvider.class);
+        Set<File> frontendLocations = getFrontendLocationsFromResourceProvider(
+                resourceProvider);
 
         boolean useByteCodeScanner = config.getBooleanProperty(
                 SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE,
@@ -358,15 +361,17 @@ private static Logger log() {
      * META-INF/resources/frontend and META-INF/resources/themes folder. We
      * don't use URLClassLoader because will fail in Java 9+
      */
-    static Set<File> getFrontendLocationsFromClassloader(
-            ClassLoader classLoader) throws VaadinInitializerException {
+    static Set<File> getFrontendLocationsFromResourceProvider(
+            ResourceProvider resourceProvider)
+            throws VaadinInitializerException {
         Set<File> frontendFiles = new HashSet<>();
-        frontendFiles.addAll(getFrontendLocationsFromClassloader(classLoader,
-                Constants.RESOURCES_FRONTEND_DEFAULT));
-        frontendFiles.addAll(getFrontendLocationsFromClassloader(classLoader,
-                Constants.COMPATIBILITY_RESOURCES_FRONTEND_DEFAULT));
-        frontendFiles.addAll(getFrontendLocationsFromClassloader(classLoader,
-                Constants.RESOURCES_THEME_JAR_DEFAULT));
+        frontendFiles.addAll(getFrontendLocationsFromResourceProvider(
+                resourceProvider, Constants.RESOURCES_FRONTEND_DEFAULT));
+        frontendFiles.addAll(
+                getFrontendLocationsFromResourceProvider(resourceProvider,
+                        Constants.COMPATIBILITY_RESOURCES_FRONTEND_DEFAULT));
+        frontendFiles.addAll(getFrontendLocationsFromResourceProvider(
+                resourceProvider, Constants.RESOURCES_THEME_JAR_DEFAULT));
         return frontendFiles;
     }
 
@@ -381,22 +386,22 @@ private static void runNodeTasks(NodeTasks tasks) {
         }
     }
 
-    private static Set<File> getFrontendLocationsFromClassloader(
-            ClassLoader classLoader, String resourcesFolder)
+    private static Set<File> getFrontendLocationsFromResourceProvider(
+            ResourceProvider resourceProvider, String resourcesFolder)
             throws VaadinInitializerException {
         Set<File> frontendFiles = new HashSet<>();
         try {
-            Enumeration<URL> en = classLoader.getResources(resourcesFolder);
+            List<URL> en = resourceProvider
+                    .getApplicationResources(resourcesFolder);
             if (en == null) {
                 return frontendFiles;
             }
             Set<String> vfsJars = new HashSet<>();
-            while (en.hasMoreElements()) {
-                URL url = en.nextElement();
+            for (URL url : en) {
                 String urlString = url.toString();
 
                 String path = URLDecoder.decode(url.getPath(),
-                        StandardCharsets.UTF_8.name());
+                        StandardCharsets.UTF_8);
                 Matcher jarMatcher = JAR_FILE_REGEX.matcher(path);
                 Matcher zipProtocolJarMatcher = ZIP_PROTOCOL_JAR_FILE_REGEX
                         .matcher(path);
@@ -410,12 +415,14 @@ private static Set<File> getFrontendLocationsFromClassloader(
                 if (jarVfsMatcher.find()) {
                     String vfsJar = jarVfsMatcher.group(1);
                     if (vfsJars.add(vfsJar)) { // NOSONAR
-                        frontendFiles.add(
-                                getPhysicalFileOfJBossVfsJar(new URL(vfsJar)));
+                        frontendFiles.add(getPhysicalFileOfJBossVfsJar(
+                                URI.create(vfsJar).toURL()));
                     }
                 } else if (dirVfsMatcher.find()) {
-                    URL vfsDirUrl = new URL(urlString.substring(0,
-                            urlString.lastIndexOf(resourcesFolder)));
+                    URL vfsDirUrl = URI
+                            .create(urlString.substring(0,
+                                    urlString.lastIndexOf(resourcesFolder)))
+                            .toURL();
                     frontendFiles
                             .add(getPhysicalFileOfJBossVfsDirectory(vfsDirUrl));
                 } else if (jarMatcher.find()) {
@@ -447,7 +454,7 @@ private static File getPhysicalFileOfJBossVfsDirectory(URL url)
             throws IOException, VaadinInitializerException {
         try {
             Object virtualFile = url.openConnection().getContent();
-            Class virtualFileClass = virtualFile.getClass();
+            Class<?> virtualFileClass = virtualFile.getClass();
 
             // Reflection as we cannot afford a dependency to
             // WildFly or JBoss
@@ -463,7 +470,7 @@ private static File getPhysicalFileOfJBossVfsDirectory(URL url)
             // are created. Later, these physical files are scanned
             // to collect
             // their resources.
-            List virtualFiles = (List) getChildrenRecursivelyMethod
+            List<?> virtualFiles = (List<?>) getChildrenRecursivelyMethod
                     .invoke(virtualFile);
             File rootDirectory = (File) getPhysicalFileMethod
                     .invoke(virtualFile);
@@ -510,15 +517,15 @@ private static void generateJarFromJBossVfsFolder(Object jarVirtualFile,
         // We should use reflection to use JBoss VFS API as we cannot
         // afford a
         // dependency to WildFly or JBoss
-        Class virtualFileClass = jarVirtualFile.getClass();
+        Class<?> virtualFileClass = jarVirtualFile.getClass();
         Method getChildrenRecursivelyMethod = virtualFileClass
                 .getMethod("getChildrenRecursively");
         Method openStreamMethod = virtualFileClass.getMethod("openStream");
         Method isFileMethod = virtualFileClass.getMethod("isFile");
         Method getPathNameRelativeToMethod = virtualFileClass
                 .getMethod("getPathNameRelativeTo", virtualFileClass);
 
-        List jarVirtualChildren = (List) getChildrenRecursivelyMethod
+        List<?> jarVirtualChildren = (List<?>) getChildrenRecursivelyMethod
                 .invoke(jarVirtualFile);
         try (ZipOutputStream zipOutputStream = new ZipOutputStream(
                 Files.newOutputStream(tempJar))) {
diff --git a/vaadin-dev-server/src/test/java/com/vaadin/base/devserver/startup/DevModeInitializerTest.java b/vaadin-dev-server/src/test/java/com/vaadin/base/devserver/startup/DevModeInitializerTest.java
@@ -52,6 +52,7 @@
 import com.vaadin.flow.component.dependency.JsModule;
 import com.vaadin.flow.component.page.AppShellConfigurator;
 import com.vaadin.flow.di.Lookup;
+import com.vaadin.flow.di.ResourceProvider;
 import com.vaadin.flow.router.Route;
 import com.vaadin.flow.server.InitParameters;
 import com.vaadin.flow.server.LoadDependenciesOnStartup;
@@ -626,14 +627,17 @@ private void loadingJarsWithProtocol_allFilesExist(String resourcesFolder,
         List<URL> urls = new ArrayList<>();
         urls.add(jar);
 
-        // Create mock loader with the single jar to be found
-        ClassLoader classLoader = Mockito.mock(ClassLoader.class);
-        Mockito.when(classLoader.getResources(resourcesFolder))
-                .thenReturn(Collections.enumeration(urls));
+        // Create mock resource provider with the single jar to be found
+        ResourceProvider resourceProvider = Mockito
+                .mock(ResourceProvider.class);
+        Mockito.when(lookup.lookup(ResourceProvider.class))
+                .thenReturn(resourceProvider);
+        Mockito.when(resourceProvider.getApplicationResources(resourcesFolder))
+                .thenReturn(urls);
 
         // load jars from classloader
         List<File> jarFilesFromClassloader = new ArrayList<>(DevModeInitializer
-                .getFrontendLocationsFromClassloader(classLoader));
+                .getFrontendLocationsFromResourceProvider(resourceProvider));
 
         // Assert that jar was found and accepted
         assertEquals("One jar should have been found and added as a File", 1,
@@ -655,14 +659,18 @@ private void loadingFsResources_allFilesExist(String resourcesRoot,
     private void loadingFsResources_allFilesExist(Collection<URL> urls,
             String resourcesFolder)
             throws IOException, VaadinInitializerException {
-        // Create mock loader with the single jar to be found
-        ClassLoader classLoader = Mockito.mock(ClassLoader.class);
-        Mockito.when(classLoader.getResources(resourcesFolder))
-                .thenReturn(Collections.enumeration(urls));
+
+        // Create mock resource provider with the single jar to be found
+        ResourceProvider resourceProvider = Mockito
+                .mock(ResourceProvider.class);
+        Mockito.when(lookup.lookup(ResourceProvider.class))
+                .thenReturn(resourceProvider);
+        Mockito.when(resourceProvider.getApplicationResources(resourcesFolder))
+                .thenReturn(List.copyOf(urls));
 
         // load jars from classloader
         List<File> locations = new ArrayList<>(DevModeInitializer
-                .getFrontendLocationsFromClassloader(classLoader));
+                .getFrontendLocationsFromResourceProvider(resourceProvider));
 
         // Assert that resource was found and accepted
         assertEquals("One resource should have been found and added as a File",
