MacOS AWT integration error with quarkus-pdfbox in native image build

[SzymonBartkowiak43]

Describe the bug

When trying to build a native image with quarkus-pdfbox extension on macOS, the build fails with an AWT integration error during native test execution.

Actual behavior

Native image build fails with the following exception:

 What went wrong:
Execution failed for task ':quarkusAppPartsBuild'.
> There was a failure while executing work items
   > A failure occurred while executing io.quarkus.gradle.tasks.worker.BuildWorker
      > io.quarkus.builder.BuildException: Build failure: Build failed due to errors
                [error]: Build step io.quarkus.deployment.pkg.steps.NativeImageBuildStep#build threw an exception: java.lang.RuntimeException: Failed to build native image
                at io.quarkus.deployment.pkg.steps.NativeImageBuildStep.build(NativeImageBuildStep.java:331)
                at java.base/java.lang.invoke.MethodHandle.invokeWithArguments(MethodHandle.java:733)
                at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:856)
                at io.quarkus.builder.BuildContext.run(BuildContext.java:255)
                at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
                at org.jboss.threads.EnhancedQueueExecutor$Task.doRunWith(EnhancedQueueExecutor.java:2651)
                at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2630)
                at org.jboss.threads.EnhancedQueueExecutor.runThreadBody(EnhancedQueueExecutor.java:1622)
                at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1589)
                at java.base/java.lang.Thread.run(Thread.java:1583)
                at org.jboss.threads.JBossThread.run(JBossThread.java:501)
        Caused by: java.lang.UnsupportedOperationException: MacOS AWT integration is not ready in Quarkus native-image and would result in java.lang.UnsatisfiedLinkError: Can't load library: awt | java.library.path = [.].
                at io.quarkus.deployment.pkg.steps.NativeImageBuildStep$NativeImageInvokerInfo$Builder.build(NativeImageBuildStep.java:1041)
                at io.quarkus.deployment.pkg.steps.NativeImageBuildStep.build(NativeImageBuildStep.java:279)

How to Reproduce?

https://github.com/SzymonBartkowiak43/awt-reproducer

1. Clone the reproducer repository
2. Run: ./gradlew clean testNative
3. The build fails with the AWT error shown above

• OS: macOS
• Java: Oracle GraalVM 21.0.5
• GraalVM Native Image: 21.0.5
• Build Tool: Gradle
• Quarkus PDFBox Extension: 1.1.0

[quarkus-bot]

/cc @Karm (native-image), @galderz (native-image), @zakkak (native-image)

[melloware]

Can you open this ticket on the PDFBox extension not here?

https://github.com/quarkiverse/quarkus-pdfbox

[melloware]

Cc @gastaldi

[gastaldi]

AFAIR AWT isn't supported in MacOS. You need to use Liberica NIK instead

[gastaldi]

MacOS AWT support was dropped here: #46731

/cc @Karm

EDIT: Not actually dropped, checked, because I think that AWT never worked in MacOS before, even with Liberica NIK

[zakkak]

This is a known GraalVM issue, see oracle/graal#4124

I am afraid we can't do anything about it at this stage.

Using Liberica NIK doesn't seem to fix the issue according to oracle/graal#4124 (comment) but YMMV.

MacOS AWT support was dropped here: #46731

This is "GraalVM for JDK 24" specific. It doesn't apply to any other version.

[Karm]

Hello, @SzymonBartkowiak43

the error you posted literally says:

UnsupportedOperationException:
MacOS AWT integration is not ready in Quarkus native-image and 
would result in java.lang.UnsatisfiedLinkError: Can't load library: awt

I can eventually explore porting the extension to MacOS, but it cannot work as is, because the JNI code paths diverge for Linux and MacOS. If it's an important integration for you, you are welcome to open a Feature Request for AWT extension on MacOS.

I think it would be a cleaner way than doing it in PDFBox specifically as that could lead to strange errors or even crashes when an unexpected code path is taken, e.g. a TIFF image instead of BMP/JPEG etc.