Catch `Throwable` when using the AWT classes #425

gastaldi · 2023-02-04T14:41:02Z

ERROR: java.lang.UnsatisfiedLinkError: no awt in java.library.path is thrown when attempting to build a native image that depends on AWT on macOS.

See the following issue for more details:

macOS: no awt in java.library.path oracle/graal#4124

`ERROR: java.lang.UnsatisfiedLinkError: no awt in java.library.path` is thrown when attempting to build a native image that depends on AWT on macOS. See the following issue for more details: - oracle/graal#4124

pjfanning · 2023-02-04T15:06:27Z

poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java

@@ -63,7 +63,7 @@ protected SXSSFSheet(SXSSFWorkbook workbook, XSSFSheet xSheet, int randomAccessW
        setRandomAccessWindowSize(randomAccessWindowSize);
        try {
            _autoSizeColumnTracker = new AutoSizeColumnTracker(this);
-        } catch (InternalError e) {
+        } catch (Throwable e) {


this code should not affect poi-scratchpad - but I agree that Throwable is a safer type to catch here

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1907308 13f79535-47bb-0310-9956-ffa450edef68

pjfanning · 2023-02-04T15:13:56Z

Can you close this? - I committed 040181c and there are a few more similar cases in the code that should probably be changed

pjfanning · 2023-02-04T15:22:26Z

The catch you modified - that was only added recently and no release has ever included it. Are you sure that InternalError catch was not enough?

gastaldi · 2023-02-04T15:24:12Z

Thanks, I noticed that SheetUtil also uses some AWT code in org.apache.poi.ss.util.SheetUtil.getCellWidth that could use this try-catch as well

pjfanning · 2023-02-04T15:24:53Z

Can you share the stack traces you are getting? I'd prefer not to be catch Throwables all over the place.

gastaldi · 2023-02-04T15:27:41Z

The catch you modified - that was only added recently and no release has ever included it. Are you sure that InternalError catch was not enough?

Yes, I am sure. The thrown exception is java.lang.UnsatisfiedLinkError. Let me get the full stacktrace

gastaldi · 2023-02-04T15:29:22Z

Here is the stacktrace without the system property set:

Caused by: java.lang.UnsatisfiedLinkError: no awt in java.library.path
	at org.graalvm.nativeimage.builder/com.oracle.svm.core.jdk.NativeLibrarySupport.loadLibraryRelative(NativeLibrarySupport.java:120)
	at java.base@17.0.5/java.lang.ClassLoader.loadLibrary(ClassLoader.java:50)
	at java.base@17.0.5/java.lang.Runtime.loadLibrary0(Runtime.java:818)
	at java.base@17.0.5/java.lang.System.loadLibrary(System.java:1989)
	at java.desktop@17.0.5/java.awt.Toolkit$2.run(Toolkit.java:1388)
	at java.desktop@17.0.5/java.awt.Toolkit$2.run(Toolkit.java:1386)
	at java.base@17.0.5/java.security.AccessController.executePrivileged(AccessController.java:168)
	at java.base@17.0.5/java.security.AccessController.doPrivileged(AccessController.java:318)
	at java.desktop@17.0.5/java.awt.Toolkit.loadLibraries(Toolkit.java:1385)
	at java.desktop@17.0.5/java.awt.Toolkit.initStatic(Toolkit.java:1423)
	at java.desktop@17.0.5/java.awt.Toolkit.<clinit>(Toolkit.java:1397)
	at java.desktop@17.0.5/java.awt.Font.<clinit>(Font.java:288)
	at java.desktop@17.0.5/java.awt.font.TextLayout.singleFont(TextLayout.java:468)
	at java.desktop@17.0.5/java.awt.font.TextLayout.<init>(TextLayout.java:530)
	at org.apache.poi.ss.util.SheetUtil.getDefaultCharWidth(SheetUtil.java:301)
	at org.apache.poi.xssf.streaming.AutoSizeColumnTracker.<init>(AutoSizeColumnTracker.java:117)
	at org.apache.poi.xssf.streaming.SXSSFSheet.<init>(SXSSFSheet.java:95)
	at org.apache.poi.xssf.streaming.SXSSFWorkbook.createAndRegisterSXSSFSheet(SXSSFWorkbook.java:726)
	at org.apache.poi.xssf.streaming.SXSSFWorkbook.createSheet(SXSSFWorkbook.java:720)

pjfanning · 2023-02-04T15:30:09Z

Thanks - the exception name is enough for me - so UnsatisfiedLinkError is the issue

gastaldi · 2023-02-04T15:30:51Z

Thanks - the exception name is enough for me - so UnsatisfiedLinkError is the issue

Yes, as I mentioned in the first comment of this PR 😄

pjfanning · 2023-02-04T15:32:02Z

So I updated SheetUtil in 040181c - is that enough? That code had already been modified to catch UnsatisfiedLinkError (in April 2022).

gastaldi · 2023-02-04T15:32:22Z

This is the stacktrace when the org.apache.poi.ss.ignoreMissingFontSystem is set to true:

Caused by: java.lang.NoClassDefFoundError: Could not initialize class java.awt.Font
	at java.desktop@17.0.5/java.awt.font.TextLayout.singleFont(TextLayout.java:468)
	at java.desktop@17.0.5/java.awt.font.TextLayout.<init>(TextLayout.java:530)
	at org.apache.poi.ss.util.SheetUtil.getCellWidth(SheetUtil.java:224)
	at org.apache.poi.ss.util.SheetUtil.getCellWidth(SheetUtil.java:185)
	at org.apache.poi.ss.util.SheetUtil.getColumnWidthForRow(SheetUtil.java:336)
	at org.apache.poi.ss.util.SheetUtil.getColumnWidth(SheetUtil.java:280)
	at org.apache.poi.ss.util.SheetUtil.getColumnWidth(SheetUtil.java:257)
	at org.apache.poi.xssf.streaming.SXSSFSheet.autoSizeColumn(SXSSFSheet.java:1621)
	at org.apache.poi.xssf.streaming.SXSSFSheet.autoSizeColumn(SXSSFSheet.java:1567)

gastaldi · 2023-02-04T15:33:55Z

So I updated SheetUtil in 040181c - is that enough?

I think you also need to add catch any AWT operations in it, like Font defaultFont = wb.getFontAt( 0); in the public static int getDefaultCharWidth(final Workbook wb) method

pjfanning · 2023-02-04T15:39:14Z

Can you provide a stack trace where getFontAt fails? If that is failing, I think there will be loads of changes needed.

Would it not be easier to install fonts yourself?

gastaldi · 2023-02-04T15:45:17Z

The problem is that AWT is not available in a GraalVM native image built in MacOS because of oracle/graal#4124, so I get NoClassDefFoundErrors and the java.lang.UnsatisfiedLinkError above. I don't get any of these errors when running in JVM mode

xzel23 · 2023-02-04T20:15:18Z

Wouldn't it be better to guard awt calls by checking for headless mode instead of catching UnsatisfiedLinkError?

pjfanning · 2023-02-05T19:25:41Z

@xzel23 this issue is hard to test. I ran the SXSSF tests with GraalVM on my Mac and had no issues (with and without this code change).

We have no POI road map for a POI 6 release that would allow us some latitude to refactor some code. Right now, we are sort of stuck with putting sticky plasters on the existing code base. In the end of the day catching Throwable instead of specific Errors means we are less likely to have someone with a different funky setup come along and say they have a different special Error happening. Since Errors are not declared in throws declarations, I think it is risky to depend on catching precise Errors.

For me, SXSSFWorkbook should never have had a hard dependency on java.awt code. The auto column sizing feature should have been something that users should have had to enable explicitly. But introducing new API methods has its own problems. Stackoverflow questions for POI indicate a very large proportion of the user base are using very old versions of the libs.

xzel23 · 2023-02-05T19:40:25Z

@pjfanning I see this as rather a GraalVM problem than a POI one. If you couldn't reproduce the problem on your Mac (the GraalVM issue has already been fixed on Windows but not on MacOS), it's probably because you used another GraalVM distribution. AFAIK, Bellsoft's has some support for AWT and this should work.

If OP could confirm this works using Bellsoft's NIK (their GraalVM distribution), I would rather recommend not making these changes in POI.

GraalVM folks seem to be working on fixing this in the original distribution, but so far it's not know what release it might get in.

gastaldi · 2023-02-05T20:28:47Z

I managed to bypass the AWT issues by replacing the methods in the classes that use it.

See https://github.com/quarkiverse/quarkus-poi

pjfanning · 2023-02-05T21:19:19Z

I reverted the bulk of my recent changes with 43551ba - the new code still treats UnsatisfiedLinkError as meaning AWT is not set up - as well as the pre-existing InternalError check.

Catch Throwable when using the AWT classes

5d0f31e

`ERROR: java.lang.UnsatisfiedLinkError: no awt in java.library.path` is thrown when attempting to build a native image that depends on AWT on macOS. See the following issue for more details: - oracle/graal#4124

gastaldi mentioned this pull request Feb 4, 2023

Added scratchpad to support old office formats quarkiverse/quarkus-poi#5

Merged

pjfanning reviewed Feb 4, 2023

View reviewed changes

asfgit pushed a commit that referenced this pull request Feb 4, 2023

[bug-65260] catch Throwable instead of error - see #425

040181c

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1907308 13f79535-47bb-0310-9956-ffa450edef68

gastaldi closed this Feb 4, 2023

gastaldi deleted the throwable branch February 4, 2023 15:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Catch `Throwable` when using the AWT classes #425

Catch `Throwable` when using the AWT classes #425

gastaldi commented Feb 4, 2023

pjfanning Feb 4, 2023

pjfanning commented Feb 4, 2023

pjfanning commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023 •

edited

gastaldi commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023 •

edited

gastaldi commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023

gastaldi commented Feb 4, 2023

xzel23 commented Feb 4, 2023

pjfanning commented Feb 5, 2023

xzel23 commented Feb 5, 2023

gastaldi commented Feb 5, 2023

pjfanning commented Feb 5, 2023

Catch Throwable when using the AWT classes #425

Catch Throwable when using the AWT classes #425

Conversation

gastaldi commented Feb 4, 2023

pjfanning Feb 4, 2023

Choose a reason for hiding this comment

pjfanning commented Feb 4, 2023

pjfanning commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023 • edited

gastaldi commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023 • edited

gastaldi commented Feb 4, 2023

gastaldi commented Feb 4, 2023

pjfanning commented Feb 4, 2023

gastaldi commented Feb 4, 2023

xzel23 commented Feb 4, 2023

pjfanning commented Feb 5, 2023

xzel23 commented Feb 5, 2023

gastaldi commented Feb 5, 2023

pjfanning commented Feb 5, 2023

Catch `Throwable` when using the AWT classes #425

Catch `Throwable` when using the AWT classes #425

pjfanning commented Feb 4, 2023 •

edited

pjfanning commented Feb 4, 2023 •

edited