Issue #12990 - Introduce static-deploy module

jetty-core/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentScanner.java

@@ -33,6 +33,8 @@
 import java.util.Set;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.function.Predicate;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -127,6 +129,33 @@ public class DeploymentScanner extends ContainerLifeCycle implements Scanner.Bul
     // old attributes prefix, now stripped.
     private static final String ATTRIBUTE_PREFIX = "jetty.deploy.attribute.";
 
+    private static final Pattern EE_ENVIRONMENT_NAME_PATTERN = Pattern.compile("ee(\\d+)");
+
+    /**
+     * A comparator that ranks names matching EE_ENVIRONMENT_NAME_PATTERN higher than other names,
+     * EE names are compared by EE number, otherwise simple name comparison is used.
+     */
+    protected static final Comparator<String> ENVIRONMENT_COMPARATOR = (e1, e2) ->
+    {
+        Matcher m1 = EE_ENVIRONMENT_NAME_PATTERN.matcher(e1);
+        Matcher m2 = EE_ENVIRONMENT_NAME_PATTERN.matcher(e2);
+
+        if (m1.matches())
+        {
+            if (m2.matches())
+            {
+                int n1 = Integer.parseInt(m1.group(1));
+                int n2 = Integer.parseInt(m2.group(1));
+                return Integer.compare(n2, n1);
+            }
+            return -1;
+        }
+        if (m2.matches())
+            return 1;
+
+        return e1.compareTo(e2);
+    };
+
     private final Server server;
     private final FilenameFilter filenameFilter;
     private final List<Path> monitoredDirs = new CopyOnWriteArrayList<>();
@@ -292,7 +321,12 @@ void addScannerListener(Scanner.Listener listener)
      */
     public EnvironmentConfig configureEnvironment(String name)
     {
-        return new EnvironmentConfig(Environment.get(name));
+        Environment environment = Environment.get(name);
+        // Check to make sure that the Environment was created before jetty-deploy is involved.
+        // This is to ensure that the Environment ClassLoader is setup properly.
+        if (environment == null)
+            throw new IllegalStateException("Environment [" + name + "] does not exist.");
+        return new EnvironmentConfig(environment);
     }
 
     /**
@@ -314,7 +348,7 @@ public void setActionComparator(Comparator<DeployAction> actionComparator)
      *
      * <p>
      * Falls back to {@link Environment#getAll()} list, and returns
-     * the first name returned after sorting with {@link Deployable#ENVIRONMENT_COMPARATOR}
+     * the first name returned after sorting.
      * </p>
      *
      * @return the default environment name.
@@ -325,7 +359,7 @@ public String getDefaultEnvironmentName()
         {
             return Environment.getAll().stream()
                 .map(Environment::getName)
-                .max(Deployable.ENVIRONMENT_COMPARATOR)
+                .min(ENVIRONMENT_COMPARATOR)
                 .orElse(null);
         }
         return defaultEnvironmentName;

jetty-core/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/DeploymentScannerRuntimeUpdatesTest.java

@@ -171,8 +171,8 @@ public void testRedeployViaNewEmptyProperties(WorkDir workDir) throws Exception
         startJetty();
 
         Path webappsDir = jetty.getJettyBasePath().resolve("webapps");
-        Files.createDirectory(webappsDir.resolve("simple"));
-        Files.writeString(webappsDir.resolve("simple/simple.txt"), "Simple Contents");
+        FS.ensureDirExists(webappsDir.resolve("simple/static"));
+        Files.writeString(webappsDir.resolve("simple/static/simple.txt"), "Simple Contents");
         waitForDirectoryScan();
         jetty.assertContextHandlerExists("/simple");
         ContextHandler contextHandler = jetty.getContextHandler("/simple");

jetty-core/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/DeploymentScannerTest.java

@@ -21,17 +21,22 @@
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
+import java.util.stream.Stream;
 
 import org.eclipse.jetty.deploy.DeploymentScanner.DeployAction;
 import org.eclipse.jetty.deploy.DeploymentScanner.PathsApp;
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.server.handler.ContextHandlerCollection;
+import org.eclipse.jetty.toolchain.test.ExtraMatchers;
 import org.eclipse.jetty.toolchain.test.jupiter.WorkDir;
 import org.eclipse.jetty.toolchain.test.jupiter.WorkDirExtension;
 import org.eclipse.jetty.util.Scanner;
 import org.hamcrest.Matchers;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -364,4 +369,24 @@ public void testActionListXmlAndWarWithXmlRemoved() throws IOException
 
         deploymentScanner.pathsChanged(changeSet);
     }
+
+    public static Stream<Arguments> envNameSorting()
+    {
+        return Stream.of(
+            Arguments.of(List.of("static", "core"), List.of("core", "static")),
+            Arguments.of(List.of("core", "static"), List.of("core", "static")),
+            Arguments.of(List.of("core", "ee11"), List.of("ee11", "core")),
+            Arguments.of(List.of("core", "ee11", "ee9", "ee10"), List.of("ee11", "ee10", "ee9", "core"))
+        );
+    }
+
+    @ParameterizedTest
+    @MethodSource("envNameSorting")
+    public void testEnvironmentNameSorting(List<String> input, List<String> expected)
+    {
+        List<String> sorted = input.stream()
+            .sorted(DeploymentScanner.ENVIRONMENT_COMPARATOR)
+            .toList();
+        assertThat(sorted, ExtraMatchers.ordered(expected));
+    }
 }

jetty-core/jetty-server/src/main/config/etc/jetty-static-deploy.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?><!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "https://jetty.org/configure_10_0.dtd">
+
+<!-- =============================================================== -->
+<!-- Configure the "static" environment deployment defaults          -->
+<!-- =============================================================== -->
+<Configure>
+  <Ref refid="deploymentScanner">
+    <Call name="configureEnvironment">
+      <Arg>static</Arg>
+      <Set name="contextHandlerClass">
+        <Property name="contextHandlerClass" default="org.eclipse.jetty.server.handler.StaticContextHandler" />
+      </Set>
+    </Call>
+  </Ref>
+</Configure>

jetty-core/jetty-server/src/main/config/modules/static-deploy.mod

@@ -0,0 +1,20 @@
+[description]
+# tag::description[]
+Scans and deploys `static` contexts from `$JETTY_BASE/webapps/` directory.
+# end::description[]
+
+[tags]
+deployment
+
+[environment]
+static
+
+[depend]
+deployment-scanner
+
+[xml]
+etc/jetty-static-deploy.xml
+
+[ini-template]
+## Default ContextHandler class for "static" environment deployments
+# contextHandlerClass=org.eclipse.jetty.server.handler.StaticContextHandler

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/Deployable.java

@@ -14,9 +14,6 @@
 package org.eclipse.jetty.server;
 
 import java.io.File;
-import java.util.Comparator;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 import org.eclipse.jetty.server.handler.ContextHandler;
 import org.eclipse.jetty.util.Attributes;
@@ -28,33 +25,6 @@
  */
 public interface Deployable
 {
-    Pattern EE_ENVIRONMENT_NAME_PATTERN = Pattern.compile("ee(\\d+)");
-
-    /**
-     * A comparator that ranks names matching EE_ENVIRONMENT_NAME_PATTERN higher than other names,
-     * EE names are compared by EE number, otherwise simple name comparison is used.
-     */
-    Comparator<String> ENVIRONMENT_COMPARATOR = (e1, e2) ->
-    {
-        Matcher m1 = EE_ENVIRONMENT_NAME_PATTERN.matcher(e1);
-        Matcher m2 = EE_ENVIRONMENT_NAME_PATTERN.matcher(e2);
-
-        if (m1.matches())
-        {
-            if (m2.matches())
-            {
-                int n1 = Integer.parseInt(m1.group(1));
-                int n2 = Integer.parseInt(m2.group(1));
-                return Integer.compare(n1, n2);
-            }
-            return 1;
-        }
-        if (m2.matches())
-            return -1;
-
-        return e1.compareTo(e2);
-    };
-
     /**
      * <p>Attribute key name: Temp Directory for context.</p>
      *

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/Server.java

@@ -195,7 +195,7 @@ public String getServerInfo()
      */
     public void setTempDirectory(String temp)
     {
-        setTempDirectory(new File(temp));
+        setTempDirectory(IO.asFile(temp));
     }
 
     /**

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java

@@ -40,6 +40,7 @@
 import org.eclipse.jetty.server.AliasCheck;
 import org.eclipse.jetty.server.Connector;
 import org.eclipse.jetty.server.Context;
+import org.eclipse.jetty.server.Deployable;
 import org.eclipse.jetty.server.Handler;
 import org.eclipse.jetty.server.NetworkConnector;
 import org.eclipse.jetty.server.Request;
@@ -71,7 +72,7 @@
  * A {@link Handler} that scopes a request to a specific {@link Context}.
  */
 @ManagedObject
-public class ContextHandler extends Handler.Wrapper implements Attributes, AliasCheck
+public class ContextHandler extends Handler.Wrapper implements Attributes, AliasCheck, Deployable
 {
     private static final Logger LOG = LoggerFactory.getLogger(ContextHandler.class);
     private static final ThreadLocal<Context> __context = new ThreadLocal<>();
@@ -136,6 +137,7 @@ public static ContextHandler getContextHandler(Request request)
 
     private String _displayName;
     private String _contextPath = "/";
+    private boolean _defaultContextPath = true;
     private boolean _rootContext = true;
     private Resource _baseResource;
     private ClassLoader _classLoader;
@@ -616,6 +618,46 @@ public boolean removeEventListener(EventListener listener)
         return false;
     }
 
+    @Override
+    public void initializeDefaults(Attributes attributes)
+    {
+        for (String keyName : attributes.getAttributeNameSet())
+        {
+            Object value = attributes.getAttribute(keyName);
+            if (LOG.isDebugEnabled())
+                LOG.debug("init {}: {}", keyName, value);
+
+            switch (keyName)
+            {
+                case Deployable.TEMP_DIR -> setTempDirectory(IO.asFile(value));
+                case Deployable.CONTEXT_PATH -> setContextPath((String)value);
+                case Deployable.DEFAULT_CONTEXT_PATH -> setDefaultContextPath((String)value);
+                default -> initializeDefault(keyName, value);
+            }
+        }
+        initializeDefaultComplete();
+    }
+
+    /**
+     * Called for each attribute key encountered during the
+     * {@link Deployable#initializeDefaults(Attributes)} processing.
+     *
+     * @param keyName the key name
+     * @param value the value
+     */
+    protected void initializeDefault(String keyName, Object value)
+    {
+    }
+
+    /**
+     * Called after all attributes are processed via
+     * {@link Deployable#initializeDefaults(Attributes)}, to allow
+     * any kind of extra processing of the configuration.
+     */
+    protected void initializeDefaultComplete()
+    {
+    }
+
     protected ClassLoader enterScope(Request contextRequest)
     {
         ClassLoader lastLoader = Thread.currentThread().getContextClassLoader();
@@ -1122,6 +1164,22 @@ public void setContextPath(String contextPath)
             throw new IllegalStateException(getState());
         _contextPath = URIUtil.canonicalPath(Objects.requireNonNull(contextPath));
         _rootContext = "/".equals(contextPath);
+        _defaultContextPath = false;
+    }
+
+    public void setDefaultContextPath(String contextPath)
+    {
+        // Don't set default context path, if context-path is set before init (like from XML)
+        if (isContextPathDefault())
+        {
+            setContextPath(contextPath);
+            _defaultContextPath = true;
+        }
+    }
+
+    public boolean isContextPathDefault()
+    {
+        return _defaultContextPath;
     }
 
     /**