Support multiple nesting of JAR files #293

dmlloyd · 2024-03-25T14:47:29Z

Make sure that jar:file:///... are properly formed (the sub-URL must have a scheme of file)
When there is no ! in the JAR URL, treat the file as a JAR and process its root path
Otherwise recursively resolve each segment which is !-terminated

Fixes #289

dmlloyd · 2024-03-25T14:54:33Z

One thing I am unsure of is whether it is correct to treat URLs of form jar:file:///some/path/something.jar as valid (current behavior) or invalid.

magicprinc · 2024-03-25T15:06:59Z

TestApp still fails 😭
https://github.com/magicprinc/SmallRyeConfig-SpringBoot/tree/fix2

I have put your classes inside the app and removed jar with original classes from dependencies.
You can debug and see details.

Exception in thread "main" java.lang.reflect.InvocationTargetException
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.springframework.boot.loader.MainMethodRunner.run(MainMethodRunner.java:49)
	at org.springframework.boot.loader.Launcher.launch(Launcher.java:108)
	at org.springframework.boot.loader.Launcher.launch(Launcher.java:58)
	at org.springframework.boot.loader.JarLauncher.main(JarLauncher.java:65)
Caused by: java.lang.ExceptionInInitializerError
	at fink.demo.smallryeconfigspringboot.ExampleApplication.main(ExampleApplication.java:13)
	... 8 more
Caused by: java.nio.file.ProviderNotFoundException: Provider not found
	at java.base/java.nio.file.FileSystems.newFileSystem(FileSystems.java:545)
	at java.base/java.nio.file.FileSystems.newFileSystem(FileSystems.java:400)
	at io.smallrye.common.classloader.ClassPathUtils.processAsJarPath(ClassPathUtils.java:163)
	at io.smallrye.common.classloader.ClassPathUtils.processAsJarPath(ClassPathUtils.java:169)
	at io.smallrye.common.classloader.ClassPathUtils.processAsPath(ClassPathUtils.java:149)
	at io.smallrye.common.classloader.ClassPathUtils.consumeAsPath(ClassPathUtils.java:102)
	at io.smallrye.common.classloader.ClassPathUtils.consumeAsPaths(ClassPathUtils.java:86)
	at io.smallrye.config.AbstractLocationConfigSourceLoader.tryClassPath(AbstractLocationConfigSourceLoader.java:141)
	at io.smallrye.config.AbstractLocationConfigSourceLoader.loadConfigSources(AbstractLocationConfigSourceLoader.java:104)
	at io.smallrye.config.AbstractLocationConfigSourceLoader.loadConfigSources(AbstractLocationConfigSourceLoader.java:87)
	at io.smallrye.config.PropertiesConfigSourceProvider.<init>(PropertiesConfigSourceProvider.java:37)
	at fink.config.spring.SmallRyeConfigAutoConf.<clinit>(SmallRyeConfigAutoConf.java:75)
	... 9 more

FAILURE: Build failed with an exception.

dmlloyd · 2024-03-25T15:10:21Z

Do you know what URL was input into the method?

magicprinc · 2024-03-25T15:13:23Z

jar:file:/D:/TEMP/SmallRyeConfig-SpringBoot/build/libs/SmallRyeConfig-SpringBoot-1.0.jar!/BOOT-INF/classes!/application.properties

BTW if you simply replace lastIndexOf with indexOf - everything works (spring magic 🤷‍♀️)

dmlloyd · 2024-03-25T15:15:30Z

Well, at least I was correct about it being a two-level nesting. I have an idea for a fix, but I'm going to add some additional unit tests first.

magicprinc · 2024-03-25T15:18:04Z

With IntelliJ IDEA you can debug jar file: you build spring jar with gradle bootJar, then you add Run/Debug configuration - JAR Application with path to your jar (e.g. D:/TEMP/SmallRyeConfig-SpringBoot/build/libs/SmallRyeConfig-SpringBoot-1.0.jar)

magicprinc · 2024-03-25T15:23:55Z

https://github.com/magicprinc/SmallRyeConfig-SpringBoot/tree/fixBundled

url: jar:file:/D:/TEMP/SmallRyeConfig-SpringBoot/build/libs/SmallRyeConfig-SpringBoot-1.0.jar!/BOOT-INF/classes!/application.properties

file: file:/D:/TEMP/SmallRyeConfig-SpringBoot/build/libs/SmallRyeConfig-SpringBoot-1.0.jar!/BOOT-INF/classes!/application.properties

jar: D:\TEMP\SmallRyeConfig-SpringBoot\build\libs\SmallRyeConfig-SpringBoot-1.0.jar

localPath: /BOOT-INF/classes!/application.properties

io.smallrye.common.classloader.ClassPathUtils#readStream

url: jar:file:///D:/TEMP/SmallRyeConfig-SpringBoot/build/libs/SmallRyeConfig-SpringBoot-1.0.jar!/BOOT-INF/classes!/application.properties

can be read

LOG
[main] DEBUG io.smallrye.config - SRCFG01006: Loaded ConfigSource PropertiesConfigSource[source=jar:file:///D:/TEMP/SmallRyeConfig-SpringBoot/build/libs/SmallRyeConfig-SpringBoot-1.0.jar!/BOOT-INF/classes!/application.properties] with ordinal 100

dmlloyd · 2024-03-25T15:46:16Z

Can you determine whether the sub-entry /BOOT-INF/classes inside of file:///D:/TEMP/SmallRyeConfig-SpringBoot/build/libs/SmallRyeConfig-SpringBoot-1.0.jar is a JAR directory, or is it a nested JAR file? I am assuming that ! means to treat that entry as a JAR file but Spring Boot might not agree with that, but this would be an easy way to check.

magicprinc · 2024-03-25T15:49:13Z

Usual jar/zip directory

magicprinc · 2024-03-25T15:49:43Z

original/as-is dependency jars in a usual jar/zip directory

magicprinc · 2024-03-25T15:53:44Z

META-INF has an extra folder for itself :-)

- "dependencies":
  - "BOOT-INF/lib/"
- "spring-boot-loader":
  - "org/"
- "snapshot-dependencies":
- "application":
  - "BOOT-INF/classes/"
  - "BOOT-INF/classpath.idx"
  - "BOOT-INF/layers.idx"
  - "META-INF/"

dmlloyd · 2024-03-25T16:46:57Z

OK, this version should be able to detect whether a nested entry is a JAR or a directory and act accordingly.

* Make sure that `jar:file:///...` are properly formed (the sub-URL must have a scheme of `file`) * When there is no `!` in the JAR URL, treat the file as a JAR and process its root path * Otherwise recursively resolve each segment which is `!`-terminated

dmlloyd · 2024-03-25T16:48:43Z

One more fix to prevent wrong path lookups if the ! is followed by a /.

magicprinc · 2024-03-25T16:59:24Z

Works!

jarPath: D:\TEMP\SmallRyeConfig-SpringBoot\build\libs\SmallRyeConfig-SpringBoot-1.0.jar
path: /BOOT-INF/classes!/application.properties
→
localPath: /BOOT-INF/classes
path: /BOOT-INF/classes!/application.properties

The code is quite complicated, so I hope you would have enough unit tests 😅

magicprinc · 2024-03-26T16:32:39Z

BTW, sorry for a noob question...
Why do you need such heavy machinery (FileSystems, path parsing)
As far as I know Spring uses only ClassLoader.getResources, .getResourceAsStream, etc

E.g.
https://github.com/spring-projects/spring-framework/blob/main/spring-core/src/main/java/org/springframework/core/io/ClassPathResource.java

dmlloyd · 2024-03-26T16:46:25Z

That's a more complex question than it seems to be ;)

There are several answers though:

Sometimes there is no class loader for the target path
Sometimes the class loader does not have the necessary capabilities
Sometimes you are using an API that is based on Path
Probably more cases I'm not thinking of right now

magicprinc · 2024-03-26T21:11:32Z

When is it possible to have snapshot/RC version in maven repo? 😥🙏

PS: IDEA recommends flipping couple of .equals
→ p -> "jar".equals(p.getScheme())
→ "file".equals(fileUrl.getProtocol()

dmlloyd · 2024-04-02T16:07:18Z

I'm just doing some final testing with Quarkus to make sure nothing has broken.

dmlloyd · 2024-04-02T16:48:36Z

Looks good.

dmlloyd force-pushed the jar branch 2 times, most recently from d13bd26 to fc407ab Compare March 25, 2024 14:59

dmlloyd mentioned this pull request Mar 25, 2024

Doesn't work in Spring Boot jar #289

Closed

magicprinc added a commit to magicprinc/SmallRyeConfig-SpringBoot that referenced this pull request Mar 25, 2024

test smallrye/smallrye-common#293

01fd7f0

dmlloyd force-pushed the jar branch from fc407ab to e4c711e Compare March 25, 2024 16:34

dmlloyd force-pushed the jar branch from e4c711e to 02a63ff Compare March 25, 2024 16:48

dmlloyd merged commit 9a34989 into smallrye:main Apr 2, 2024
4 checks passed

dmlloyd deleted the jar branch April 2, 2024 16:48

github-actions bot added this to the 2.3.1 milestone Apr 2, 2024

gaol mentioned this pull request Aug 6, 2024

Quarkus 3.13 app fails to start inside folder with special symbols in name quarkusio/quarkus#42248

Closed

rsvoboda mentioned this pull request Sep 13, 2024

Quarkus application build fails inside a folder that ends with ! quarkusio/quarkus#43273

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support multiple nesting of JAR files #293

Support multiple nesting of JAR files #293

dmlloyd commented Mar 25, 2024

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 •

edited

Loading

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 •

edited

Loading

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024

magicprinc commented Mar 25, 2024 •

edited

Loading

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

dmlloyd commented Mar 25, 2024

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 26, 2024 •

edited

Loading

dmlloyd commented Mar 26, 2024

magicprinc commented Mar 26, 2024 •

edited

Loading

dmlloyd commented Apr 2, 2024

dmlloyd commented Apr 2, 2024

Support multiple nesting of JAR files #293

Support multiple nesting of JAR files #293

Conversation

dmlloyd commented Mar 25, 2024

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 • edited Loading

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 • edited Loading

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024

magicprinc commented Mar 25, 2024 • edited Loading

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 • edited Loading

magicprinc commented Mar 25, 2024 • edited Loading

magicprinc commented Mar 25, 2024 • edited Loading

dmlloyd commented Mar 25, 2024

dmlloyd commented Mar 25, 2024

magicprinc commented Mar 25, 2024 • edited Loading

magicprinc commented Mar 26, 2024 • edited Loading

dmlloyd commented Mar 26, 2024

magicprinc commented Mar 26, 2024 • edited Loading

dmlloyd commented Apr 2, 2024

dmlloyd commented Apr 2, 2024

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 25, 2024 •

edited

Loading

magicprinc commented Mar 26, 2024 •

edited

Loading

magicprinc commented Mar 26, 2024 •

edited

Loading