resolve excluded prefixes

Author: ibodrov

server/impl/src/main/java/com/walmartlabs/concord/server/boot/HttpServer.java

@@ -20,7 +20,7 @@
  * =====
  */
 
-import com.walmartlabs.concord.server.boot.resteasy.ApiDescriptor;
+import com.walmartlabs.concord.server.sdk.rest.ApiDescriptor;
 import com.walmartlabs.concord.server.cfg.ServerConfiguration;
 import org.eclipse.jetty.ee8.nested.SessionHandler;
 import org.eclipse.jetty.ee8.servlet.FilterHolder;

server/impl/src/main/java/com/walmartlabs/concord/server/boot/resteasy/ConcordApiDescriptor.java

@@ -20,6 +20,8 @@
  * =====
  */
 
+import com.walmartlabs.concord.server.sdk.rest.ApiDescriptor;
+
 public class ConcordApiDescriptor implements ApiDescriptor {
 
     @Override

server/impl/src/main/java/com/walmartlabs/concord/server/boot/resteasy/ResteasyModule.java

@@ -22,6 +22,7 @@
 
 import com.google.inject.Binder;
 import com.google.inject.Module;
+import com.walmartlabs.concord.server.sdk.rest.ApiDescriptor;
 import com.walmartlabs.concord.server.sdk.rest.Component;
 
 import javax.servlet.ServletContextListener;

server/plugins/webapp/pom.xml

@@ -16,6 +16,11 @@
     <packaging>jar</packaging>
 
     <dependencies>
+        <dependency>
+            <groupId>com.walmartlabs.concord.server</groupId>
+            <artifactId>concord-server-sdk</artifactId>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>javax.inject</groupId>
             <artifactId>javax.inject</artifactId>

server/plugins/webapp/src/main/java/ca/ibodrov/concord/webapp/ExcludedPrefixes.java

@@ -0,0 +1,80 @@
+package ca.ibodrov.concord.webapp;
+
+/*-
+ * *****
+ * Concord
+ * -----
+ * Copyright (C) 2017 - 2025 Walmart Inc.
+ * -----
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =====
+ */
+
+import com.walmartlabs.concord.server.sdk.rest.ApiDescriptor;
+import org.eclipse.jetty.ee8.servlet.ServletHolder;
+
+import javax.inject.Inject;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+import java.util.stream.Stream;
+
+import static java.util.Comparator.reverseOrder;
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Collects all URI prefixes that should NOT be handled by {@link WebappFilter}.
+ */
+public class ExcludedPrefixes {
+
+    private final List<String> prefixes;
+
+    @Inject
+    public ExcludedPrefixes(Set<ApiDescriptor> apiDescriptors,
+                            Set<HttpServlet> servlets,
+                            Set<ServletHolder> servletHolders) {
+
+        var apiPrefixes = requireNonNull(apiDescriptors).stream()
+                .flatMap(descriptor -> Arrays.stream(descriptor.paths()));
+
+        var servletPrefixes = webServletAnnotated(requireNonNull(servlets));
+
+        var servletHolderPrefixes = webServletAnnotated(requireNonNull(servletHolders));
+
+        this.prefixes = Stream.of(apiPrefixes, servletPrefixes, servletHolderPrefixes)
+                .flatMap(p -> p)
+                .map(prefix -> {
+                    if (prefix.endsWith("/*")) {
+                        return prefix.substring(0, prefix.length() - 1);
+                    }
+                    return prefix;
+                })
+                .sorted(reverseOrder())
+                .toList();
+    }
+
+    public boolean matches(String path) {
+        return prefixes.stream().anyMatch(path::startsWith);
+    }
+
+    private static Stream<String> webServletAnnotated(Set<?> instances) {
+        return instances.stream()
+                .flatMap(i -> Stream.ofNullable(i.getClass().getAnnotation(WebServlet.class)))
+                .flatMap(a -> Arrays.stream(Optional.ofNullable(a.value())
+                        .filter(values -> values.length != 0)
+                        .orElse(a.urlPatterns())));
+    }
+}

server/plugins/webapp/src/main/java/ca/ibodrov/concord/webapp/WebappFilter.java

@@ -9,9 +9,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -26,6 +26,7 @@
 import com.google.common.collect.ImmutableMap;
 
 import javax.annotation.Priority;
+import javax.inject.Inject;
 import javax.servlet.FilterChain;
 import javax.servlet.ServletException;
 import javax.servlet.annotation.WebFilter;
@@ -41,6 +42,7 @@
 import java.util.stream.Stream;
 
 import static java.util.Comparator.comparing;
+import static java.util.Objects.requireNonNull;
 import static javax.ws.rs.core.Response.Status.INTERNAL_SERVER_ERROR;
 
 /**
@@ -51,17 +53,20 @@
 public class WebappFilter extends HttpFilter {
 
     private final WebappCollection webapps;
+    private final ExcludedPrefixes excludedPrefixes;
 
-    public WebappFilter() {
+    @Inject
+    public WebappFilter(ExcludedPrefixes excludedPrefixes) {
         this.webapps = loadWebapps();
+        this.excludedPrefixes = requireNonNull(excludedPrefixes);
     }
 
     @Override
     protected void doFilter(HttpServletRequest req, HttpServletResponse resp, FilterChain chain)
             throws ServletException, IOException {
 
         var uri = req.getRequestURI();
-        if (uri.startsWith("/api")) {
+        if (excludedPrefixes.matches(uri)) {
             chain.doFilter(req, resp);
             return;
         }

server/plugins/webapp/src/main/java/ca/ibodrov/concord/webapp/WebappPluginModule.java

@@ -22,9 +22,12 @@
 
 import com.google.inject.Binder;
 import com.google.inject.Module;
+import com.walmartlabs.concord.server.sdk.rest.ApiDescriptor;
+import org.eclipse.jetty.ee8.servlet.ServletHolder;
 
 import javax.inject.Named;
 import javax.servlet.Filter;
+import javax.servlet.http.HttpServlet;
 
 import static com.google.inject.multibindings.Multibinder.newSetBinder;
 
@@ -33,6 +36,10 @@ public class WebappPluginModule implements Module {
 
     @Override
     public void configure(Binder binder) {
+        newSetBinder(binder, ApiDescriptor.class);
+        newSetBinder(binder, HttpServlet.class);
+        newSetBinder(binder, ServletHolder.class);
+
         newSetBinder(binder, Filter.class).addBinding().to(WebappFilter.class);
     }
 }

server/impl/src/main/java/com/walmartlabs/concord/server/boot/resteasy/ApiDescriptor.java renamed to server/sdk/src/main/java/com/walmartlabs/concord/server/sdk/rest/ApiDescriptor.java

@@ -1,4 +1,4 @@
-package com.walmartlabs.concord.server.boot.resteasy;
+package com.walmartlabs.concord.server.sdk.rest;
 
 /*-
  * *****
@@ -21,7 +21,7 @@
  */
 
 /**
- * Declares an API.
+ * Declares a list of prefixes that should be served as JAX-RS resources.
  */
 public interface ApiDescriptor {