Fix BZ 69995: Generate _jspx_dependants.put() calls in deterministic order

Author: jluehe

java/org/apache/jasper/compiler/Generator.java

@@ -552,7 +552,7 @@ private void genPreambleStaticInitializers() {
         if (!dependants.isEmpty()) {
             out.printil("static {");
             out.pushIndent();
-            out.printin("_jspx_dependants = new java.util.HashMap<java.lang.String,java.lang.Long>(");
+            out.printin("_jspx_dependants = new java.util.LinkedHashMap<java.lang.String,java.lang.Long>(");
             out.print("" + dependants.size());
             out.println(");");
             for (Entry<String,Long> entry : dependants.entrySet()) {

java/org/apache/jasper/compiler/PageInfo.java

@@ -21,6 +21,7 @@
 import java.util.Deque;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.LinkedHashMap;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
@@ -111,7 +112,7 @@ public class PageInfo {
         this.jspPrefixMapper = new HashMap<>();
         this.xmlPrefixMapper = new HashMap<>();
         this.nonCustomTagPrefixMap = new HashMap<>();
-        this.dependants = new HashMap<>();
+        this.dependants = new LinkedHashMap<>();
         this.includePrelude = new ArrayList<>();
         this.includeCoda = new ArrayList<>();
         this.pluginDcls = new ArrayList<>();

test/org/apache/jasper/compiler/TestGenerator.java

@@ -22,10 +22,17 @@
 import java.beans.PropertyEditorSupport;
 import java.io.File;
 import java.io.IOException;
+import java.lang.reflect.Field;
 import java.nio.charset.CodingErrorAction;
+import java.util.ArrayList;
 import java.util.Date;
+import java.util.List;
+import java.util.Map;
 import java.util.Scanner;
 
+import org.apache.jasper.compiler.JspRuntimeContext;
+import org.apache.jasper.servlet.JspServlet;
+
 import jakarta.servlet.http.HttpServletResponse;
 import jakarta.servlet.jsp.JspException;
 import jakarta.servlet.jsp.PageContext;
@@ -828,6 +835,44 @@ public void testInclude01() throws Exception {
         doTestJsp("include-01.jsp");
     }
 
+    /*
+     * Verify that _jspx_dependants entries appear in the same order as the
+     * <%@ include file="..." %> directives in the source JSP, ensuring
+     * reproducible builds (LinkedHashMap preserves insertion order).
+     */
+    @Test
+    public void testDependantsOrder() throws Exception {
+        Tomcat tomcat = getTomcatInstanceTestWebapp(false, true);
+
+        ByteChunk body = new ByteChunk();
+        int rc = getUrl("http://localhost:" + getPort() +
+                "/test/jsp/generator/dependants-order.jsp", body, null);
+        Assert.assertEquals(body.toString(), HttpServletResponse.SC_OK, rc);
+
+        // JSP classes are loaded by a per-JSP JasperLoader child classloader,
+        // not by the webapp classloader. Retrieve the dependants map through
+        // the JspServletWrapper, which calls getDependants() on the live
+        // servlet instance via the JspSourceDependent interface.
+        Context ctx = (Context) tomcat.getHost().findChild("/test");
+        Wrapper jspWrapper = (Wrapper) ctx.findChild("jsp");
+        JspServlet jspServlet = (JspServlet) jspWrapper.getServlet();
+        Field rctxtField = JspServlet.class.getDeclaredField("rctxt");
+        rctxtField.setAccessible(true);
+        JspRuntimeContext rctxt = (JspRuntimeContext) rctxtField.get(jspServlet);
+        Map<String,Long> dependants = rctxt.getWrapper(
+                "/jsp/generator/dependants-order.jsp").getDependants();
+
+        // Expect exactly the three fragments, in directive order: a, b, c.
+        List<String> keys = new ArrayList<>(dependants.keySet());
+        Assert.assertEquals(3, keys.size());
+        Assert.assertTrue("a.jspf should precede b.jspf in _jspx_dependants",
+                keys.indexOf("/jsp/generator/dependants-order-a.jspf") <
+                keys.indexOf("/jsp/generator/dependants-order-b.jspf"));
+        Assert.assertTrue("b.jspf should precede c.jspf in _jspx_dependants",
+                keys.indexOf("/jsp/generator/dependants-order-b.jspf") <
+                keys.indexOf("/jsp/generator/dependants-order-c.jspf"));
+    }
+
     @Test
     public void testSetProperty01() throws Exception {
         doTestJsp("setproperty-01.jsp");

test/webapp/jsp/generator/dependants-order-a.jspf

@@ -0,0 +1,17 @@
+<%--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You 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.
+  --%>
+a

test/webapp/jsp/generator/dependants-order-b.jspf

@@ -0,0 +1,17 @@
+<%--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You 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.
+  --%>
+b

test/webapp/jsp/generator/dependants-order-c.jspf

@@ -0,0 +1,17 @@
+<%--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You 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.
+  --%>
+c

test/webapp/jsp/generator/dependants-order.jsp

@@ -0,0 +1,19 @@
+<%--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You 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.
+  --%>
+<%@ include file="dependants-order-a.jspf" %>
+<%@ include file="dependants-order-b.jspf" %>
+<%@ include file="dependants-order-c.jspf" %>