[UNDERTOW-2536] Fix include parameters on error and add rudimentary test

servlet/src/main/java/io/undertow/servlet/spec/RequestDispatcherImpl.java

@@ -401,6 +401,13 @@ private void error(ServletRequestContext servletRequestContext, final ServletReq
         final ServletRequest oldRequest = servletRequestContext.getServletRequest();
         final ServletResponse oldResponse = servletRequestContext.getServletResponse();
 
+        request.removeAttribute(INCLUDE_REQUEST_URI);
+        request.removeAttribute(INCLUDE_CONTEXT_PATH);
+        request.removeAttribute(INCLUDE_SERVLET_PATH);
+        request.removeAttribute(INCLUDE_PATH_INFO);
+        request.removeAttribute(INCLUDE_QUERY_STRING);
+        request.removeAttribute(INCLUDE_MAPPING);
+
         ServletPathMatch pathMatch;
         try {
             pathMatch = DispatchUtils.dispatchError(path, servletName, exception, message, requestImpl, responseImpl, servletContext);

servlet/src/test/java/io/undertow/servlet/test/dispatcher/attributes/AttributeComparisonTestBase.java

@@ -0,0 +1,51 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2025 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * 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.
+ */
+package io.undertow.servlet.test.dispatcher.attributes;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.TreeMap;
+
+public abstract class AttributeComparisonTestBase {
+
+    protected void testAttributes(final Map<String, String> expected, final String incoming) throws RuntimeException {
+
+        final Map<String, String> incomingParameters = new TreeMap<String, String>();
+        final Map<String, String> expectedParameters = new TreeMap<String, String>();
+        expectedParameters.putAll(expected);
+        System.err.println("INCOMING: "+incoming);
+        final String[] array = incoming.split("\n");
+        System.err.println("INCOMING: "+Arrays.toString(array));
+        for (String kvp : array) {
+            // this might not be best way, but...
+            final String[] split = kvp.split(";");
+            final String splitValue = split.length == 2 ? split[1] : ""; //thats empty string.
+            // sanity check
+            final String errorIfNotNull = incomingParameters.put(split[0], splitValue);
+            // should not happen?
+            assertNull("Doubled value of key[" + split[0] + "] = [" + errorIfNotNull + "," + splitValue + "]", errorIfNotNull);
+            assertTrue("Expected parameters does not contain '" + split[0] + "'", expectedParameters.containsKey(split[0]));
+            assertEquals(expectedParameters.remove(split[0]), splitValue);
+        }
+        assertTrue("Too many expected parameters: " + expectedParameters, expectedParameters.size() == 0);
+    }
+}

servlet/src/test/java/io/undertow/servlet/test/dispatcher/attributes/DispatcherErrorForwardServletTestCase.java

@@ -0,0 +1,165 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2025 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * 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.
+ */
+
+package io.undertow.servlet.test.dispatcher.attributes;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import java.io.IOException;
+import java.util.Map;
+import java.util.TreeMap;
+
+import org.apache.http.HttpResponse;
+import org.apache.http.client.methods.HttpGet;
+import org.junit.Assume;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import io.undertow.server.handlers.PathHandler;
+import io.undertow.servlet.api.DeploymentInfo;
+import io.undertow.servlet.api.DeploymentManager;
+import io.undertow.servlet.api.ErrorPage;
+import io.undertow.servlet.api.ServletContainer;
+import io.undertow.servlet.api.ServletInfo;
+import io.undertow.servlet.test.SimpleServletTestCase;
+import io.undertow.servlet.test.util.TestClassIntrospector;
+import io.undertow.servlet.test.util.TestResourceLoader;
+import io.undertow.testutils.DefaultServer;
+import io.undertow.testutils.HttpClientUtils;
+import io.undertow.testutils.ProxyIgnore;
+import io.undertow.testutils.TestHttpClient;
+import io.undertow.util.StatusCodes;
+import jakarta.servlet.ServletException;
+
+/**
+ * @author baranowb
+ */
+@RunWith(DefaultServer.class)
+@ProxyIgnore
+public class DispatcherErrorForwardServletTestCase extends AttributeComparisonTestBase {
+
+    static final String TARGET = "";
+    @BeforeClass
+    public static void setup() throws ServletException {
+        //we don't run this test on h2 upgrade, as if it is run with the original request
+        //the protocols will not match
+        Assume.assumeFalse(DefaultServer.isH2upgrade());
+        final PathHandler root = new PathHandler();
+        final ServletContainer container = ServletContainer.Factory.newInstance();
+
+        DeploymentInfo builder = new DeploymentInfo()
+                //no idea why...
+                .setClassLoader(SimpleServletTestCase.class.getClassLoader())
+                .setContextPath("/servletContext")
+                .setClassIntrospecter(TestClassIntrospector.INSTANCE)
+                .setDeploymentName("servletContext.war")
+                .setResourceManager(new TestResourceLoader(DispatcherErrorForwardServletTestCase.class))
+                //test servlet, we need info from it
+                .addServlet(new ServletInfo("error", ErrorHandlingServlet.class)
+                        .addMapping("/error"))
+                //return handler, which should send us stuff
+                .addServlet(new ServletInfo("target", ErrorSpewServlet.class)
+                .addMapping("/target"))
+                //fwd
+                .addServlet(new ServletInfo("fwd", ForwardServlet.class)
+                .addMapping("/forward"))
+                //error mapge mapping to servlet
+                .addErrorPage(new ErrorPage("/error"));
+
+        DeploymentManager manager = container.addDeployment(builder);
+        manager.deploy();
+        root.addPrefixPath(builder.getContextPath(), manager.start());
+        DefaultServer.setRootHandler(root);
+    }
+
+    @Test
+    public void testSimpleForwardWithError() throws IOException, InterruptedException {
+        //Expected params:
+        final Map<String, String> expectedParams = new TreeMap();
+        //        jakarta.servlet.async.mapping
+        //        jakarta.servlet.async.request_uri
+        //        jakarta.servlet.async.context_path
+        //        jakarta.servlet.async.servlet_path
+        //        jakarta.servlet.async.path_info
+        //        jakarta.servlet.async.query_string
+        expectedParams.put("jakarta.servlet.forward.request_uri", "/servletContext/forward");
+        expectedParams.put("jakarta.servlet.forward.servlet_path", "/forward");
+        expectedParams.put("jakarta.servlet.forward.context_path", "/servletContext");
+        expectedParams.put("jakarta.servlet.forward.mapping",
+                "match_value=forward,pattern=/forward,servlet_name=fwd,mapping_match=EXACT");
+        //https://jakarta.ee/specifications/servlet/5.0/jakarta-servlet-spec-5.0#request-attributes
+        //        jakarta.servlet.error.request_uri
+        //        jakarta.servlet.error.servlet_name
+        //        jakarta.servlet.error.exception_type
+        //        jakarta.servlet.error.exception
+        //        jakarta.servlet.error.message
+        //        jakarta.servlet.error.status_code
+        expectedParams.put("jakarta.servlet.error.request_uri", "/servletContext/forward");
+        expectedParams.put("jakarta.servlet.error.servlet_name", "fwd");
+        expectedParams.put("jakarta.servlet.error.exception_type", "class jakarta.servlet.ServletException");
+        expectedParams.put("jakarta.servlet.error.exception", "jakarta.servlet.ServletException: HEY");
+        expectedParams.put("jakarta.servlet.error.message", "HEY");
+        expectedParams.put("jakarta.servlet.error.status_code", "500");
+        TestHttpClient client = new TestHttpClient();
+        try {
+            HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/forward");
+            get.setHeader("forward", "/target");
+            get.setHeader("throw", "true");
+            HttpResponse result = client.execute(get);
+            assertEquals(StatusCodes.OK, result.getStatusLine().getStatusCode());
+            final String response = HttpClientUtils.readResponse(result);
+            assertNotNull(response);
+            super.testAttributes(expectedParams, response);
+        } finally {
+            client.getConnectionManager().shutdown();
+        }
+    }
+
+    @Test
+    public void testSimpleForwardWithNoError() throws IOException, InterruptedException {
+        //Expected params:
+        //https://jakarta.ee/specifications/servlet/5.0/jakarta-servlet-spec-5.0#forwarded-request-parameters
+        //Some are missing, since null == omission.
+        //        jakarta.servlet.forward.mapping
+        //        jakarta.servlet.forward.request_uri
+        //        jakarta.servlet.forward.context_path
+        //        jakarta.servlet.forward.servlet_path
+        //        jakarta.servlet.forward.path_info
+        //        jakarta.servlet.forward.query_string
+        final Map<String, String> expectedParams = new TreeMap();
+        expectedParams.put("jakarta.servlet.forward.request_uri", "/servletContext/forward");
+        expectedParams.put("jakarta.servlet.forward.servlet_path", "/forward");
+        expectedParams.put("jakarta.servlet.forward.mapping",
+                "match_value=forward,pattern=/forward,servlet_name=fwd,mapping_match=EXACT");
+        expectedParams.put("jakarta.servlet.forward.context_path", "/servletContext");
+        TestHttpClient client = new TestHttpClient();
+        try {
+            HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/forward");
+            get.setHeader("forward", "/target");
+            HttpResponse result = client.execute(get);
+            assertEquals(StatusCodes.OK, result.getStatusLine().getStatusCode());
+            final String response = HttpClientUtils.readResponse(result);
+            assertNotNull(response);
+            super.testAttributes(expectedParams, response);
+        } finally {
+            client.getConnectionManager().shutdown();
+        }
+    }
+}

servlet/src/test/java/io/undertow/servlet/test/dispatcher/attributes/DispatcherErrorIncludeServletTestCase.java

@@ -0,0 +1,164 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2025 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * 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.
+ */
+
+package io.undertow.servlet.test.dispatcher.attributes;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import java.io.IOException;
+import java.util.Map;
+import java.util.TreeMap;
+
+import org.apache.http.HttpResponse;
+import org.apache.http.client.methods.HttpGet;
+import org.junit.Assume;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import io.undertow.server.handlers.PathHandler;
+import io.undertow.servlet.api.DeploymentInfo;
+import io.undertow.servlet.api.DeploymentManager;
+import io.undertow.servlet.api.ErrorPage;
+import io.undertow.servlet.api.ServletContainer;
+import io.undertow.servlet.api.ServletInfo;
+import io.undertow.servlet.test.SimpleServletTestCase;
+import io.undertow.servlet.test.util.TestClassIntrospector;
+import io.undertow.servlet.test.util.TestResourceLoader;
+import io.undertow.testutils.DefaultServer;
+import io.undertow.testutils.HttpClientUtils;
+import io.undertow.testutils.ProxyIgnore;
+import io.undertow.testutils.TestHttpClient;
+import io.undertow.util.StatusCodes;
+import jakarta.servlet.ServletException;
+
+/**
+ * @author baranowb
+ */
+@RunWith(DefaultServer.class)
+@ProxyIgnore
+public class DispatcherErrorIncludeServletTestCase extends AttributeComparisonTestBase {
+
+    static final String TARGET = "/target";
+    @BeforeClass
+    public static void setup() throws ServletException {
+        //we don't run this test on h2 upgrade, as if it is run with the original request
+        //the protocols will not match
+        Assume.assumeFalse(DefaultServer.isH2upgrade());
+        final PathHandler root = new PathHandler();
+        final ServletContainer container = ServletContainer.Factory.newInstance();
+
+        DeploymentInfo builder = new DeploymentInfo()
+                //no idea why...
+                .setClassLoader(SimpleServletTestCase.class.getClassLoader())
+                .setContextPath("/servletContext")
+                .setClassIntrospecter(TestClassIntrospector.INSTANCE)
+                .setDeploymentName("servletContext.war")
+                .setResourceManager(new TestResourceLoader(DispatcherErrorIncludeServletTestCase.class))
+                //test servlet, we need info from it
+                .addServlet(new ServletInfo("error", ErrorHandlingServlet.class)
+                        .addMapping("/error"))
+                //return handler, which should send us stuff
+                .addServlet(new ServletInfo("target", ErrorSpewServlet.class)
+                .addMapping(TARGET))
+                //fwd
+                .addServlet(new ServletInfo("inc", IncludeServlet.class)
+                .addMapping("/include"))
+                //error mapge mapping to servlet
+                .addErrorPage(new ErrorPage("/error"));
+
+        DeploymentManager manager = container.addDeployment(builder);
+        manager.deploy();
+        root.addPrefixPath(builder.getContextPath(), manager.start());
+        DefaultServer.setRootHandler(root);
+    }
+
+    @Test
+    public void testSimpleIncludeWithError() throws IOException, InterruptedException {
+        final Map<String, String> expectedParams = new TreeMap();
+        //        jakarta.servlet.async.mapping
+        //        jakarta.servlet.async.request_uri
+        //        jakarta.servlet.async.context_path
+        //        jakarta.servlet.async.servlet_path
+        //        jakarta.servlet.async.path_info
+        //        jakarta.servlet.async.query_string
+
+        expectedParams.put("jakarta.servlet.forward.request_uri", "/servletContext/include");
+        expectedParams.put("jakarta.servlet.forward.servlet_path", "/include");
+        expectedParams.put("jakarta.servlet.error.servlet_name", "inc");
+        expectedParams.put("jakarta.servlet.forward.mapping",
+                "match_value=include,pattern=/include,servlet_name=inc,mapping_match=EXACT");
+        expectedParams.put("jakarta.servlet.forward.context_path", "/servletContext");
+        //https://jakarta.ee/specifications/servlet/5.0/jakarta-servlet-spec-5.0#request-attributes
+        //        jakarta.servlet.error.request_uri
+        //        jakarta.servlet.error.servlet_name
+        //        jakarta.servlet.error.exception_type
+        //        jakarta.servlet.error.exception
+        //        jakarta.servlet.error.message
+        //        jakarta.servlet.error.status_code
+        expectedParams.put("jakarta.servlet.error.request_uri", "/servletContext/include");
+        expectedParams.put("jakarta.servlet.error.exception_type", "class jakarta.servlet.ServletException");
+        expectedParams.put("jakarta.servlet.error.exception", "jakarta.servlet.ServletException: HEY");
+        expectedParams.put("jakarta.servlet.error.message", "HEY");
+        expectedParams.put("jakarta.servlet.error.status_code", "500");
+        TestHttpClient client = new TestHttpClient();
+        try {
+            HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/include");
+            get.setHeader("include", TARGET);
+            get.setHeader("throw", "true");
+            HttpResponse result = client.execute(get);
+            assertEquals(StatusCodes.OK, result.getStatusLine().getStatusCode());
+            final String response = HttpClientUtils.readResponse(result);
+            assertNotNull(response);
+            super.testAttributes(expectedParams, response);
+        } finally {
+            client.getConnectionManager().shutdown();
+        }
+    }
+
+    @Test
+    public void testSimpleIncludeWithNoError() throws IOException, InterruptedException {
+        //https://jakarta.ee/specifications/servlet/5.0/jakarta-servlet-spec-5.0#included-request-parameters
+        //        jakarta.servlet.include.request_uri
+        //        jakarta.servlet.include.context_path
+        //        jakarta.servlet.include.query_string
+        //        jakarta.servlet.include.servlet_path
+        //        jakarta.servlet.include.mapping
+        //        jakarta.servlet.include.path_info
+        final Map<String, String> expectedParams = new TreeMap();
+        expectedParams.put("jakarta.servlet.include.request_uri", "/servletContext/target");
+        expectedParams.put("jakarta.servlet.include.context_path", "/servletContext");
+        expectedParams.put("jakarta.servlet.include.query_string", "");
+        expectedParams.put("jakarta.servlet.include.servlet_path", TARGET);
+        expectedParams.put("jakarta.servlet.include.mapping",
+                "match_value=include,pattern=/include,servlet_name=inc,mapping_match=EXACT");
+        TestHttpClient client = new TestHttpClient();
+        try {
+            HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/include");
+            get.setHeader("include", TARGET);
+            HttpResponse result = client.execute(get);
+            assertEquals(StatusCodes.OK, result.getStatusLine().getStatusCode());
+            final String response = HttpClientUtils.readResponse(result);
+            assertNotNull(response);
+            super.testAttributes(expectedParams, response);
+        } finally {
+            client.getConnectionManager().shutdown();
+        }
+    }
+}