Fix AsyncProfiler.isSupported, fixes #5

Author: parttimenerd

README.md

@@ -4,7 +4,7 @@ Loader for AsyncProfiler
 [![Maven Central](https://img.shields.io/maven-central/v/me.bechberger/ap-loader-all)](https://search.maven.org/search?q=ap-loader) [![GitHub](https://img.shields.io/github/license/jvm-profiling-tools/ap-loader)](https://github.com/jvm-profiling-tools/ap-loader/blob/main/LICENSE)
 
 Packages [async-profiler](https://github.com/jvm-profiling-tools/async-profiler) releases in a JAR
-with an `AsyncProfilerLoader` (version 2+) that loads the suitable native library for the current platform.
+with an `AsyncProfilerLoader` (version 2.*) that loads the suitable native library for the current platform.
 
 This is usable as a java agent (same arguments as the async-profiler agent) and as the basis for other libraries.
 The real rationale behind this library is that the async-profiler is a nice tool, but it cannot be easily integrated
@@ -42,7 +42,7 @@ Or you can depend on the artifacts from maven central, they should be slightly m
 <dependency>
     <groupId>me.bechberger</groupId>
     <artifactId>ap-loader-all</artifactId>
-    <version>2.9-3</version>
+    <version>2.9-4</version>
 </dependency>
 ```
 
@@ -195,7 +195,7 @@ The latest `all` version can be added via:
 <dependency>
   <groupId>me.bechberger</groupId>
   <artifactId>ap-loader-all</artifactId>
-  <version>2.9-3</version>
+  <version>2.9-4</version>
 </dependency>
 ```
 
@@ -215,7 +215,7 @@ For example for the `all` variant of version 2.9:
 <dependency>
     <groupId>me.bechberger</groupId>
     <artifactId>ap-loader-all</artifactId>
-    <version>2.9-3-SNAPSHOT</version>
+    <version>2.9-4-SNAPSHOT</version>
 </dependency>
 ```
 
@@ -252,11 +252,11 @@ python3 ./bin/releaser.py download 2.9
 # build the JAR for the release
 # maven might throw warnings, related to the project version setting,
 # but the alternative solutions don't work, so we ignore the warning for now
-mvn -Dproject.vversion=2.9 -Dproject.subrelease=3 -Dproject.platform=macos package assembly:single
+mvn -Dproject.vversion=2.9 -Dproject.subrelease=4 -Dproject.platform=macos package assembly:single
 # use it
-java -jar target/ap-loader-macos-2.9-3-full.jar ...
+java -jar target/ap-loader-macos-2.9-4-full.jar ...
 # build the all JAR
-mvn -Dproject.vversion=2.9 -Dproject.subrelease=3 -Dproject.platform=all package assembly:single
+mvn -Dproject.vversion=2.9 -Dproject.subrelease=4 -Dproject.platform=all package assembly:single
 ```
 
 Development
@@ -301,6 +301,10 @@ And the following for a new async-profiler release:
 Changelog
 ---------
 
+### v4
+
+- `AsyncProfiler.isSupported()` now returns `false` if the OS is not supported by any async-profiler binary, fixes #5
+
 ### v3
 
 - Create specific artifacts for each platform fixing previous issues with maven version updates (issue #4, thanks @ginkel for reporting it)

bin/releaser.py

@@ -17,8 +17,8 @@
 from typing import Any, Dict, List, Union, Tuple, Optional
 from urllib import request
 
-SUB_VERSION = 3
-RELEASE_NOTES = """- Create specific artifacts for each platform fixing previous issues with maven version updates (issue #4, thanks @ginkel for reporting it)"""
+SUB_VERSION = 4
+RELEASE_NOTES = """- `AsyncProfiler.isSupported()` now returns `false` if the OS is not supported by any async-profiler binary, fixes #5"""
 
 HELP = """
 Usage:

src/main/java/one/profiler/AsyncProfilerLoader.java

@@ -44,6 +44,12 @@
  */
 public final class AsyncProfilerLoader {
 
+  private static class OSNotSupportedException extends Exception {
+    OSNotSupportedException(String message) {
+      super(message);
+    }
+  }
+
   private static final String EXTRACTION_PROPERTY_NAME = "ap_loader_extraction_dir";
   private static String librarySuffix;
   private static Path extractedAsyncProfiler;
@@ -130,7 +136,7 @@ public static Path getExtractionDirectory() throws IOException {
   /**
    * @throws IllegalStateException if OS or Arch not supported
    */
-  private static String getLibrarySuffix() {
+  private static String getLibrarySuffix() throws OSNotSupportedException {
     if (librarySuffix == null) {
       String version = getVersion();
       String os = System.getProperty("os.name").toLowerCase();
@@ -145,12 +151,12 @@ private static String getLibrarySuffix() {
             librarySuffix = version + "-linux-x64.so";
           }
         } else {
-          throw new IllegalStateException("Async-profiler does not work on Linux " + arch);
+          throw new OSNotSupportedException("Async-profiler does not work on Linux " + arch);
         }
       } else if (os.startsWith("macosx") || os.startsWith("mac os x")) {
         librarySuffix = version + "-macos.so";
       } else {
-        throw new IllegalStateException("Async-profiler does not work on " + os);
+        throw new OSNotSupportedException("Async-profiler does not work on " + os);
       }
     }
     return librarySuffix;
@@ -210,11 +216,11 @@ private static boolean isOnMusl() {
     }
   }
 
-  private static String getAsyncProfilerFileName() {
+  private static String getAsyncProfilerFileName() throws OSNotSupportedException {
     return "libasyncProfiler-" + getLibrarySuffix();
   }
 
-  private static String getJattachFileName() {
+  private static String getJattachFileName() throws OSNotSupportedException {
     return "jattach-" + getLibrarySuffix().replace(".so", "");
   }
 
@@ -253,7 +259,11 @@ private static URL getUrl(String fileName) {
    * @return true if a library is available, false otherwise
    */
   public static boolean isSupported() {
-    return hasFileInResources(getAsyncProfilerFileName());
+    try {
+      return hasFileInResources(getAsyncProfilerFileName());
+    } catch (OSNotSupportedException e) {
+      return false;
+    }
   }
 
   /** Copy from resources if needed */
@@ -287,8 +297,12 @@ private static Path copyFromResources(String fileName, Path destination) throws
    */
   public static Path getJattachPath() throws IOException {
     if (extractedJattach == null) {
-      Path path =
-          copyFromResources(getJattachFileName(), getExtractionDirectory().resolve("jattach"));
+      Path path = null;
+      try {
+        path = copyFromResources(getJattachFileName(), getExtractionDirectory().resolve("jattach"));
+      } catch (OSNotSupportedException e) {
+        throw new IllegalStateException(e.getMessage());
+      }
       if (!path.toFile().setExecutable(true)) {
         throw new IOException("Could not make jattach (" + path + ") executable");
       }
@@ -325,9 +339,13 @@ private static Path getProfilerPath() throws IOException {
    */
   public static Path getAsyncProfilerPath() throws IOException {
     if (extractedAsyncProfiler == null) {
-      extractedAsyncProfiler =
-          copyFromResources(
-              getAsyncProfilerFileName(), getExtractionDirectory().resolve("libasyncProfiler.so"));
+      try {
+        extractedAsyncProfiler =
+            copyFromResources(
+                getAsyncProfilerFileName(), getExtractionDirectory().resolve("libasyncProfiler.so"));
+      } catch (OSNotSupportedException e) {
+        throw new IllegalStateException(e.getMessage());
+      }
     }
     return extractedAsyncProfiler;
   }