Avoid locking JARs on Windows when opening input streams (#2049)

* Avoid locking JARs on Windows when opening input streams * Use ClassPathUtils from smallrye-common, consolidate static model method --------- Signed-off-by: Michael Edgar <michael@xlate.io> Co-authored-by: Michael Edgar <michael@xlate.io>
smallrye · Oct 30, 2024 · 5f830ff · 5f830ff
1 parent 61225d8
commit 5f830ff
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 42 deletions.
diff --git a/core/pom.xml b/core/pom.xml
@@ -58,6 +58,10 @@
             <groupId>io.smallrye</groupId>
             <artifactId>jandex</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.smallrye.common</groupId>
+            <artifactId>smallrye-common-classloader</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.jboss.logging</groupId>
             <artifactId>jboss-logging</artifactId>

diff --git a/core/src/main/java/io/smallrye/openapi/api/SmallRyeOpenAPI.java b/core/src/main/java/io/smallrye/openapi/api/SmallRyeOpenAPI.java
@@ -31,6 +31,7 @@
 import org.jboss.jandex.Indexer;
 import org.jboss.jandex.Type;
 
+import io.smallrye.common.classloader.ClassPathUtils;
 import io.smallrye.openapi.api.util.MergeUtil;
 import io.smallrye.openapi.runtime.OpenApiProcessor;
 import io.smallrye.openapi.runtime.OpenApiRuntimeException;
@@ -563,34 +564,34 @@ protected <V, A extends V, O extends V, AB, OB> void buildStaticModel(BuildConte
                             return ctx.appClassLoader.getResource(loadPath.toString());
                         });
 
-                ctx.staticModel = OpenApiProcessor.loadOpenApiStaticFiles(loadFn)
-                        .stream()
-                        .map(file -> {
-                            try (Reader reader = new InputStreamReader(file.getContent())) {
-                                V dom = ctx.modelIO.jsonIO().fromReader(reader, file.getFormat());
-                                OpenAPI fileModel = ctx.modelIO.readValue(dom);
-                                debugModel("static file", fileModel);
-                                return fileModel;
-                            } catch (IOException e) {
-                                throw new OpenApiRuntimeException("IOException reading " + file.getFormat() + " static file",
-                                        e);
-                            }
-                        })
-                        .reduce(MergeUtil::merge)
-                        .orElse(null);
+                for (URL staticFile : OpenApiProcessor.locateStaticFiles(loadFn)) {
+                    String source = "static file " + staticFile;
+                    try {
+                        ClassPathUtils.consumeStream(staticFile, stream -> addStaticModel(ctx, stream, source));
+                    } catch (IOException e) {
+                        String msg = "IOException reading " + source;
+                        throw new OpenApiRuntimeException(msg, e);
+                    }
+                }
             }
 
             InputStream customFile = customStaticFile.get();
 
             if (customFile != null) {
-                try (Reader reader = new InputStreamReader(customFile)) {
-                    V dom = ctx.modelIO.jsonIO().fromReader(reader);
-                    OpenAPI customStaticModel = ctx.modelIO.readValue(dom);
-                    debugModel("static file", customStaticModel);
-                    ctx.staticModel = MergeUtil.merge(customStaticModel, ctx.staticModel);
-                } catch (IOException e) {
-                    throw new OpenApiRuntimeException("IOException reading custom static file", e);
-                }
+                addStaticModel(ctx, customFile, "custom static file");
+            }
+        }
+
+        private <V, A extends V, O extends V, AB, OB> void addStaticModel(BuildContext<V, A, O, AB, OB> ctx, InputStream stream,
+                String source) {
+            try (Reader reader = new InputStreamReader(stream)) {
+                V dom = ctx.modelIO.jsonIO().fromReader(reader);
+                OpenAPI fileModel = ctx.modelIO.readValue(dom);
+                debugModel(source, fileModel);
+                ctx.staticModel = MergeUtil.merge(fileModel, ctx.staticModel);
+            } catch (IOException e) {
+                String msg = "IOException reading " + source;
+                throw new OpenApiRuntimeException(msg, e);
             }
         }
 

diff --git a/core/src/main/java/io/smallrye/openapi/runtime/OpenApiProcessor.java b/core/src/main/java/io/smallrye/openapi/runtime/OpenApiProcessor.java
@@ -287,32 +287,35 @@ private static <T> T uncheckedCall(Callable<T> callable) {
         }
     }
 
-    public static List<OpenApiStaticFile> loadOpenApiStaticFiles(Function<String, URL> loadFunction) {
-        List<OpenApiStaticFile> apiStaticFiles = new ArrayList<>();
+    public static List<URL> locateStaticFiles(Function<String, URL> loadFunction) {
+        List<URL> apiStaticFiles = new ArrayList<>();
 
-        loadOpenApiStaticFile(apiStaticFiles, loadFunction, "/META-INF/openapi.yaml", Format.YAML);
-        loadOpenApiStaticFile(apiStaticFiles, loadFunction, "/WEB-INF/classes/META-INF/openapi.yaml", Format.YAML);
-        loadOpenApiStaticFile(apiStaticFiles, loadFunction, "/META-INF/openapi.yml", Format.YAML);
-        loadOpenApiStaticFile(apiStaticFiles, loadFunction, "/WEB-INF/classes/META-INF/openapi.yml", Format.YAML);
-        loadOpenApiStaticFile(apiStaticFiles, loadFunction, "/META-INF/openapi.json", Format.JSON);
-        loadOpenApiStaticFile(apiStaticFiles, loadFunction, "/WEB-INF/classes/META-INF/openapi.json", Format.JSON);
+        locateStaticFile(apiStaticFiles, loadFunction, "/META-INF/openapi.yaml");
+        locateStaticFile(apiStaticFiles, loadFunction, "/WEB-INF/classes/META-INF/openapi.yaml");
+        locateStaticFile(apiStaticFiles, loadFunction, "/META-INF/openapi.yml");
+        locateStaticFile(apiStaticFiles, loadFunction, "/WEB-INF/classes/META-INF/openapi.yml");
+        locateStaticFile(apiStaticFiles, loadFunction, "/META-INF/openapi.json");
+        locateStaticFile(apiStaticFiles, loadFunction, "/WEB-INF/classes/META-INF/openapi.json");
 
         return apiStaticFiles;
     }
 
-    private static List<OpenApiStaticFile> loadOpenApiStaticFile(List<OpenApiStaticFile> apiStaticFiles,
-            Function<String, URL> loadFunction, String path, Format format) {
+    public static List<OpenApiStaticFile> loadOpenApiStaticFiles(Function<String, URL> loadFunction) {
+        List<OpenApiStaticFile> apiStaticFiles = new ArrayList<>();
 
-        Optional.ofNullable(loadFunction.apply(path))
-                .map(locator -> {
-                    try {
-                        return new OpenApiStaticFile(locator, locator.openStream(), format);
-                    } catch (IOException e) {
-                        throw new UncheckedIOException(e);
-                    }
-                })
-                .ifPresent(apiStaticFiles::add);
+        locateStaticFiles(loadFunction).forEach(locator -> {
+            try {
+                Format format = locator.toString().endsWith(".json") ? Format.JSON : Format.YAML;
+                apiStaticFiles.add(new OpenApiStaticFile(locator, locator.openStream(), format));
+            } catch (IOException e) {
+                throw new UncheckedIOException(e);
+            }
+        });
 
         return apiStaticFiles;
     }
+
+    private static void locateStaticFile(List<URL> apiStaticFiles, Function<String, URL> loadFunction, String path) {
+        Optional.ofNullable(loadFunction.apply(path)).ifPresent(apiStaticFiles::add);
+    }
 }
diff --git a/pom.xml b/pom.xml
@@ -123,6 +123,11 @@
                 <artifactId>jandex</artifactId>
                 <version>${version.io.smallrye.jandex}</version>
             </dependency>
+            <dependency>
+                <groupId>io.smallrye.common</groupId>
+                <artifactId>smallrye-common-classloader</artifactId>
+                <version>2.8.0</version>
+            </dependency>
             <dependency>
                 <groupId>io.smallrye.config</groupId>
                 <artifactId>smallrye-config</artifactId>