imp: webjar priority of local file

Author: fdaugan

bootstrap-plugin/src/main/java/org/ligoj/bootstrap/resource/system/plugin/WebjarsServlet.java

@@ -3,21 +3,20 @@
  */
 package org.ligoj.bootstrap.resource.system.plugin;
 
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URL;
-import java.nio.file.Paths;
-import java.util.HashMap;
-import java.util.Map;
-
 import jakarta.activation.FileTypeMap;
 import jakarta.servlet.http.HttpServlet;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
-
+import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.io.FilenameUtils;
 
-import lombok.extern.slf4j.Slf4j;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Paths;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * <p>
@@ -54,12 +53,20 @@ public WebjarsServlet() {
 		mimeTypes.put("otf", "application/x-font-opentype");
 	}
 
+	protected boolean hasMorePriority(URL url) {
+		return url.toString().startsWith("file:");
+	}
+
+	protected Enumeration<URL> getResources(String webjarsResourceURI) throws IOException {
+		return Thread.currentThread().getContextClassLoader().getResources(webjarsResourceURI);
+	}
+
 	@Override
 	protected void doGet(final HttpServletRequest request, final HttpServletResponse response)
 			throws IOException {
 		final var webjarsResourceURI = "META-INF/resources"
 				+ request.getRequestURI().replaceFirst(request.getContextPath(), "");
-		log.debug("Webjars resource requested: {}", webjarsResourceURI);
+		log.debug("Webjars requested resource: {}", webjarsResourceURI);
 
 		if (isDirectoryRequest(webjarsResourceURI)) {
 			// Directory listing is forbidden, but act as a 404 for security purpose.
@@ -68,11 +75,19 @@ protected void doGet(final HttpServletRequest request, final HttpServletResponse
 		}
 
 		// Regular file, use the last resource instead of the first found
-		final var resources = Thread.currentThread().getContextClassLoader().getResources(webjarsResourceURI);
+		final var resources = getResources(webjarsResourceURI);
 		URL webjarsResourceURL = null;
 		if (resources.hasMoreElements()) {
 			webjarsResourceURL = resources.nextElement();
 		}
+		if (resources.hasMoreElements()) {
+			var webjarsResourceFileUrl = resources.nextElement();
+			if (hasMorePriority(webjarsResourceFileUrl)) {
+				// Highest priority for local files
+				webjarsResourceURL = webjarsResourceFileUrl;
+			}
+		}
+
 		if (webjarsResourceURL == null) {
 			// File not found --> 404
 			response.sendError(HttpServletResponse.SC_NOT_FOUND);

bootstrap-plugin/src/test/java/org/ligoj/bootstrap/resource/system/plugin/WebjarsServletTest.java

@@ -3,20 +3,11 @@
  */
 package org.ligoj.bootstrap.resource.system.plugin;
 
-import java.io.ByteArrayInputStream;
-import java.io.ByteArrayOutputStream;
-import java.io.InputStream;
-import java.net.URL;
-import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.Collections;
-
 import jakarta.servlet.ServletConfig;
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
-
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
@@ -26,6 +17,17 @@
 import org.mockito.Mockito;
 import org.springframework.mock.web.DelegatingServletOutputStream;
 
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.List;
+
 /**
  * Test class of {@link WebjarsServlet}
  */
@@ -68,24 +70,21 @@ void fileNotFound() throws Exception {
 
 	@Test
 	void downloadFile() throws Exception {
+		final var webjarResource = "META-INF/resources/webjars/image.png";
 		final var request = defaultRequest();
 		final var response = Mockito.mock(HttpServletResponse.class);
 
-		final var classLoader = Mockito.mock(ClassLoader.class);
 		final var baos = new ByteArrayOutputStream();
 		final var out = new DelegatingServletOutputStream(baos);
 		Mockito.when(response.getOutputStream()).thenReturn(out);
-		final var urlsAsList = new ArrayList<URL>();
-		final var url = Thread.currentThread().getContextClassLoader()
-				.getResource("META-INF/resources/webjars/image.png");
-		urlsAsList.add(url);
-		urlsAsList.add(url);
-		final var urls = Collections.enumeration(urlsAsList);
-		Mockito.when(classLoader.getResources("META-INF/resources/webjars/image.png")).thenReturn(urls);
-		Thread.currentThread().setContextClassLoader(classLoader);
-		getServlet("false").doGet(request, response);
+		final var urls = new ArrayList<URL>();
+		final var url = Thread.currentThread().getContextClassLoader().getResource(webjarResource);
+		urls.add(url);
+		urls.add(url);
+		getServlet("false", true, urls).doGet(request, response);
 		Assertions.assertEquals("image-content", baos.toString(StandardCharsets.UTF_8));
 		Mockito.verify(response).setContentType("image/x-png");
+		getServlet("false", false, urls).doGet(request, response);
 		Mockito.verify(response, Mockito.never()).setStatus(ArgumentMatchers.anyInt());
 		Mockito.verify(response, Mockito.never()).sendError(ArgumentMatchers.anyInt());
 	}
@@ -138,7 +137,12 @@ private HttpServletRequest defaultRequest(final String file) {
 	}
 
 	private WebjarsServlet getServlet(final String disableCache) throws ServletException {
-		final var servlet = new WebjarsServlet();
+		return getServlet(disableCache, true, null);
+	}
+
+
+	private WebjarsServlet getServlet(final String disableCache, boolean fileHasMorePriority, List<URL> urls) throws ServletException {
+		final var servlet = new MyWebjarsServlet(fileHasMorePriority, urls);
 		final var servletConfig = Mockito.mock(ServletConfig.class);
 		final var servletContext = Mockito.mock(ServletContext.class);
 		Mockito.when(servletConfig.getInitParameter("disableCache")).thenReturn(disableCache);
@@ -147,4 +151,25 @@ private WebjarsServlet getServlet(final String disableCache) throws ServletExcep
 		servlet.init(servletConfig);
 		return servlet;
 	}
+
+	private static class MyWebjarsServlet extends WebjarsServlet {
+
+		private final boolean fileHasMorePriority;
+		private final List<URL> urls;
+
+		public MyWebjarsServlet(boolean fileHasMorePriority, List<URL> urls) {
+			this.fileHasMorePriority = fileHasMorePriority;
+			this.urls = urls;
+		}
+
+		@Override
+		protected boolean hasMorePriority(URL url) {
+			return fileHasMorePriority && super.hasMorePriority(url);
+		}
+
+		@Override
+		protected Enumeration<URL> getResources(String webjarsResourceURI) throws IOException {
+			return urls == null ? super.getResources(webjarsResourceURI) : Collections.enumeration(urls);
+		}
+	}
 }