Skip to content

Test for JSP recompilation #8236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
labkey-adam merged 1 commit into from
Oct 27, 2026
Merged

Test for JSP recompilation #8236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions api/src/org/labkey/api/ApiModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@
import org.labkey.api.exp.property.DomainTemplateGroup;
import org.labkey.api.files.FileSystemWatcherImpl;
import org.labkey.api.iterator.MarkableIterator;
import org.labkey.api.jsp.RecompilingJspClassLoader;
import org.labkey.api.mbean.LabKeyManagement;
import org.labkey.api.mbean.OperationsMXBean;
import org.labkey.api.module.CodeOnlyModule;
Expand Down Expand Up @@ -483,6 +484,7 @@ public void registerServlets(ServletContext servletCtx)
Query.TestCase.class,
QueryProfiler.TestCase.class,
RReport.TestCase.class,
RecompilingJspClassLoader.TestCase.class,
RemoveDuplicatesDataIterator.DeDuplicateTestCase.class,
RepeatedCommitTaskMonitor.TestCase.class,
ReplacedRunFilter.TestCase.class,
Expand Down
82 changes: 59 additions & 23 deletions api/src/org/labkey/api/jsp/RecompilingJspClassLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
import org.apache.logging.log4j.Logger;
import org.apache.tomcat.JarScanner;
import org.apache.tomcat.util.scan.StandardJarScanner;
import org.junit.Assert;
import org.junit.Test;
import org.labkey.api.annotations.JavaRuntimeVersion;
import org.labkey.api.module.ModuleLoader;
import org.labkey.api.module.ResourceFinder;
Expand All @@ -37,9 +39,11 @@
import javax.tools.ToolProvider;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.file.Files;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
Expand Down Expand Up @@ -86,6 +90,33 @@ public Class<?> loadClass(ServletContext context, String jspFilename) throws Cla


@JavaRuntimeVersion // Change CompilerTargetVM and CompilerSourceVM settings below
private static JspC createJspC(String uriRoot, String outputDir, String jspFile, String classPath)
{
JspC jasper = new JspC() {
// This override eliminates unnecessary TLD scanning during recompile
@Override
protected TldScanner newTldScanner(JspCServletContext context, boolean namespaceAware, boolean validate, boolean blockExternal)
{
StandardJarScanner scanner = new StandardJarScanner();
scanner.setJarScanFilter((_, _) -> false);
context.setAttribute(JarScanner.class.getName(), scanner);
return super.newTldScanner(context, namespaceAware, validate, blockExternal);
}
};
jasper.setUriroot(uriRoot);
jasper.setOutputDir(outputDir);
jasper.setPackage(JSP_PACKAGE);
jasper.setCompilerTargetVM("25");
jasper.setCompilerSourceVM("25");
jasper.setCompile(false);
jasper.setListErrors(true);
jasper.setJspFiles(jspFile);
jasper.setClassPath(classPath);

return jasper;
}


private Class<?> getCompiledClassFile(File classFile, File jspJavaFileBuildDirectory, File jspClassesFileBuildDir, ResourceFinder finder, String jspFileName)
{
String relativePath = getSourceJspPath(jspFileName);
Expand Down Expand Up @@ -123,30 +154,9 @@ private Class<?> getCompiledClassFile(File classFile, File jspJavaFileBuildDirec
cp.addDirectory(getModulesApiLib());

// Compile the .jsp file
JspC jasper = new JspC() {
// This override eliminates unnecessary TLD scanning during recompile
@Override
protected TldScanner newTldScanner(JspCServletContext context, boolean namespaceAware, boolean validate, boolean blockExternal)
{
StandardJarScanner scanner = new StandardJarScanner();
scanner.setJarScanFilter((jarScanType, s) -> false);
context.setAttribute(JarScanner.class.getName(), scanner);
return super.newTldScanner(context, namespaceAware, validate, blockExternal);
}
};
jasper.setUriroot(jspJavaFileBuildDirectory.getParentFile().getParent() + "/jspWebappDir/webapp/");
jasper.setOutputDir(jspJavaFileBuildDirectory.getAbsolutePath());
jasper.setPackage("org.labkey.jsp.compiled");
jasper.setCompilerTargetVM("25");
jasper.setCompilerSourceVM("25");
jasper.setCompile(false);
jasper.setListErrors(true);

if (relativePath.startsWith("/"))
relativePath = relativePath.substring(1);
jasper.setJspFiles(relativePath);
jasper.setClassPath(cp.getPath());
jasper.execute();
createJspC(jspJavaFileBuildDirectory.getParentFile().getParent() + "/jspWebappDir/webapp/", jspJavaFileBuildDirectory.getAbsolutePath(), relativePath, cp.getPath()).execute();

// Compile the _jsp.java file
String stagingJava = classFile.getAbsolutePath()
Expand Down Expand Up @@ -249,7 +259,7 @@ public void printStackTrace(PrintWriter pw)

private static class ClassPath
{
private final String SEP = System.getProperty("path.separator");
private final String SEP = File.pathSeparator;
private final StringBuilder _path = new StringBuilder();

private void addFile(String filePath)
Expand Down Expand Up @@ -293,4 +303,30 @@ private String getTomcatClassesDir()
{
return AppProps.getInstance().getProjectRoot() + "/build/jspRecompiling";
}

public static class TestCase extends Assert
{
// Catches Tomcat upgrades that make JspC reference Ant classes missing from our bootstrap stubs
@Test
public void testJspC() throws IOException
{
File root = Files.createTempDirectory("jspcTest").toFile();

try
{
File webapp = FileUtil.appendName(root, "webapp");
assertTrue(webapp.mkdir());
Files.writeString(FileUtil.appendName(webapp, "test.jsp").toPath(), "<%@ page contentType=\"text/html\" %>Hello <%= 1 + 1 %>");
File output = FileUtil.appendName(root, "output");

createJspC(webapp.getAbsolutePath() + "/", output.getAbsolutePath(), "test.jsp", "").execute();

assertTrue(FileUtil.appendPath(output, Path.parse(JSP_PACKAGE_PATH + "/test_jsp.java")).isFile());
}
finally
{
FileUtil.deleteDir(root);
}
}
}
}
Loading