Skip to content

Stabilize asciidoctorPdf task #5132

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

Jump to bottom
Merged
merged 2 commits into from
Nov 2, 2025
Merged

Stabilize asciidoctorPdf task #5132

merged 2 commits into from
Nov 2, 2025
+7 −3

Conversation

@TWiStErRob
Copy link
Contributor

@TWiStErRob TWiStErRob commented Nov 2, 2025 •
edited
Loading

gradlew ascPdf never completed for me on main, due to OOM:

(unrelated warnings trimmed, e.g. #5131)

> Task :documentation:asciidoctorPdf
Picked up JAVA_TOOL_OPTIONS: -Xms32M -Xmx256M -XX:+UseG1GC -D-XX:+PrintCommandLineFlags
...
Nov 02, 2025 12:31:10 PM uri:classloader:/gems/asciidoctor-pdf-2.3.23/lib/asciidoctor/pdf/converter.rb convert_code
...
Exception in thread "main" org.asciidoctor.gradle.remote.AsciidoctorRemoteExecutionException: Error running Asciidoctor whilst attempting to process P:\projects\contrib\github-junit-jupiter\documentation\src\
docs\asciidoc\user-guide\index.adoc using backend pdf
        at org.asciidoctor.gradle.remote.AsciidoctorJavaExec$_convertFiles_closure4.doCall(AsciidoctorJavaExec.groovy:91)
        at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104)
        at java.base/java.lang.reflect.Method.invoke(Method.java:565)
        at org.codehaus.groovy.reflection.CachedMethod.invoke(CachedMethod.java:343)
        at groovy.lang.MetaMethod.doMethodInvoke(MetaMethod.java:328)
        at org.codehaus.groovy.runtime.metaclass.ClosureMetaClass.invokeMethod(ClosureMetaClass.java:280)
        at groovy.lang.MetaClassImpl.invokeMethod(MetaClassImpl.java:1007)
        at groovy.lang.Closure.call(Closure.java:433)
        at groovy.lang.Closure.call(Closure.java:422)
        at org.codehaus.groovy.runtime.DefaultGroovyMethods.each(DefaultGroovyMethods.java:2394)
        at org.codehaus.groovy.runtime.DefaultGroovyMethods.each(DefaultGroovyMethods.java:2379)
        at org.codehaus.groovy.runtime.DefaultGroovyMethods.each(DefaultGroovyMethods.java:2432)
        at org.asciidoctor.gradle.remote.AsciidoctorJavaExec.convertFiles(AsciidoctorJavaExec.groovy:82)
        at org.asciidoctor.gradle.remote.AsciidoctorJavaExec.access$0(AsciidoctorJavaExec.groovy)
        at org.asciidoctor.gradle.remote.AsciidoctorJavaExec$_run_closure3.doCall(AsciidoctorJavaExec.groovy:73)
        at org.asciidoctor.gradle.remote.AsciidoctorJavaExec$_run_closure3.call(AsciidoctorJavaExec.groovy)
        at org.codehaus.groovy.runtime.DefaultGroovyMethods.each(DefaultGroovyMethods.java:2394)
        at org.codehaus.groovy.runtime.DefaultGroovyMethods.each(DefaultGroovyMethods.java:2379)
        at org.codehaus.groovy.runtime.DefaultGroovyMethods.each(DefaultGroovyMethods.java:2420)
        at org.asciidoctor.gradle.remote.AsciidoctorJavaExec.run(AsciidoctorJavaExec.groovy:68)
        at org.asciidoctor.gradle.remote.AsciidoctorJavaExec.main(AsciidoctorJavaExec.groovy:49)
Caused by: java.lang.OutOfMemoryError: Java heap space
        at org.jruby.ext.zlib.JZlibInflate.run(JZlibInflate.java:263)
        at org.jruby.ext.zlib.JZlibInflate.internalFinish(JZlibInflate.java:310)
        at org.jruby.ext.zlib.ZStream.finish(ZStream.java:136)
        at org.jruby.ext.zlib.JZlibInflate.s_inflate(JZlibInflate.java:68)
        at org.jruby.ext.zlib.JZlibInflate$INVOKER$s$1$0$s_inflate.call(JZlibInflate$INVOKER$s$1$0$s_inflate.gen)
        at org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:242)
        at org.jruby.ir.interpreter.InterpreterEngine.processCall(InterpreterEngine.java:314)
        at org.jruby.ir.interpreter.StartupInterpreterEngine.interpret(StartupInterpreterEngine.java:66)
        at org.jruby.ir.interpreter.InterpreterEngine.interpret(InterpreterEngine.java:82)
        at org.jruby.internal.runtime.methods.MixedModeIRMethod.INTERPRET_METHOD(MixedModeIRMethod.java:201)
        at org.jruby.internal.runtime.methods.MixedModeIRMethod.call(MixedModeIRMethod.java:188)
        at org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:257)
        at org.jruby.RubyClass.newInstance(RubyClass.java:923)
        at org.jruby.RubyClass$INVOKER$i$newInstance.call(RubyClass$INVOKER$i$newInstance.gen)
        at org.jruby.internal.runtime.methods.JavaMethod$JavaMethodZeroOrOneOrNBlock.call(JavaMethod.java:355)
        at org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:242)
        at org.jruby.ir.interpreter.InterpreterEngine.processCall(InterpreterEngine.java:314)
        at org.jruby.ir.interpreter.StartupInterpreterEngine.interpret(StartupInterpreterEngine.java:66)
        at org.jruby.ir.interpreter.InterpreterEngine.interpret(InterpreterEngine.java:82)
        at org.jruby.internal.runtime.methods.MixedModeIRMethod.INTERPRET_METHOD(MixedModeIRMethod.java:201)
        at org.jruby.internal.runtime.methods.MixedModeIRMethod.call(MixedModeIRMethod.java:188)
        at org.jruby.internal.runtime.methods.DynamicMethod.call(DynamicMethod.java:220)
        at org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:242)
        at org.jruby.ir.interpreter.InterpreterEngine.processCall(InterpreterEngine.java:314)
        at org.jruby.ir.interpreter.StartupInterpreterEngine.interpret(StartupInterpreterEngine.java:66)
        at org.jruby.ir.interpreter.Interpreter.INTERPRET_BLOCK(Interpreter.java:118)
        at org.jruby.runtime.MixedModeIRBlockBody.commonYieldPath(MixedModeIRBlockBody.java:136)
        at org.jruby.runtime.IRBlockBody.doYield(IRBlockBody.java:169)
        at org.jruby.runtime.BlockBody.yield(BlockBody.java:108)
        at org.jruby.runtime.Block.yield(Block.java:189)
        at org.jruby.RubyIO.ensureYieldClose(RubyIO.java:1204)
        at org.jruby.RubyIO.open(RubyIO.java:1198)

> Task :documentation:asciidoctorPdf FAILED

BUILD FAILED in 52s
107 actionable tasks: 18 executed, 1 from cache, 88 up-to-date

This is due to not having a specific memory allocation for this Java process. The default is 1/4 of total RAM, so I have to set JAVA_TOOL_OPTIONS locally to avoid huge heaps (I have 96GB). But 256M is not enough for this process. I explicitly hardcoded a value that makes the task complete, here's the effect of it (gradlew :ascPdf --info):

image

512M is arbitrary, I tested with 10G as well, just to make sure it's not too low. No significant difference in runtime.

While figuring out what's wrong, I also noticed that the metaspace workaround is no longer necessary.

I hereby agree to the terms of the JUnit Contributor License Agreement.

Definition of Done

@TWiStErRob
Fix specific heap requirement of :documentation:asciidoctorPdf
4e49f52 
Avoids JAVA_TOOL_OPTIONS from overriding -Xmx
and therefore not letting the task complete.
@TWiStErRob
Remove outdated metaspace workaround for Asciidoctor/JRuby
4cfad9d 
Original workaround was introduced by
00f5e85,
but later obsoleted by
52497df
marcphilipp
marcphilipp approved these changes Nov 2, 2025
View reviewed changes
Copy link
Member

@marcphilipp marcphilipp left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You got an OOM because it had too much memory? 🤔 Nevermind, I reread your comment now.

gradle.properties

# We need more metaspace due to apparent memory leak in Asciidoctor/JRuby
org.gradle.jvmargs=-Xmx1g -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError
org.gradle.jvmargs=-Xmx1g -XX:+HeapDumpOnOutOfMemoryError
Copy link
Member

@marcphilipp marcphilipp Nov 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sure the workaround was only needed for asciidoctorPdf and not for asciidoctor (HTML) as well but I guess we'll find out. 😅

Copy link
Contributor Author

@TWiStErRob TWiStErRob Nov 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, good point, we'll see. Hopefully it's been a while and things have been fixed. Btw, if metaspace needs a bump, it's not necessarily a leak, it's just huge JARs with too many classes on the classpath.

@marcphilipp marcphilipp merged commit 3636301 into junit-team:main Nov 2, 2025
18 checks passed
@marcphilipp
Copy link
Member

marcphilipp commented Nov 2, 2025

Thanks, @TWiStErRob! 👍

@TWiStErRob TWiStErRob deleted the pdf_mem branch November 2, 2025 15:29
@TWiStErRob
Copy link
Contributor Author

TWiStErRob commented Nov 2, 2025

You got an OOM because it had too much memory? 🤔 Nevermind, I reread your comment now.

But, yes, technically, yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@marcphilipp marcphilipp marcphilipp approved these changes

Assignees

No one assigned

Labels

theme: documentation type: enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@TWiStErRob @marcphilipp