Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

In a reactive web app, SslBundle can no longer open store file locations without using a 'file:' prefix #44535

Open
wants to merge 1 commit into
base: 3.4.x
Choose a base branch
from
+66 −19
Open

In a reactive web app, SslBundle can no longer open store file locations without using a 'file:' prefix #44535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 45 additions & 19 deletions ...ject/spring-boot/src/main/java/org/springframework/boot/io/ApplicationResourceLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -132,8 +132,8 @@ public static ResourceLoader get(ResourceLoader resourceLoader) {
* class loader at the time this call is made.
* @param resourceLoader the delegate resource loader
* @param preferFileResolution if file based resolution is preferred over
* {@code ServletContextResource} or {@link ClassPathResource} when no resource prefix
* is provided.
* {@code ServletContextResource}, {@code FilteredReactiveWebContextResource} or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a look to this and, unfortunately, I don't think that we can use that option as I realize now that it's an implementation detail (package private on top of it). This seems a bit fragile that we rely on this, compared to the standard ServletContextResource. I am still digging what our options are.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resource implementation that replaces the {@link org.springframework.web.context.support.ServletContextResource} in a reactive web application.

org.springframework.boot.web.reactive.context.FilteredReactiveWebContextResource is a
part of Spring Boot codebase, so its ServletContextResource but for Reactive.

This seems a bit fragile that we rely on this, compared to the standard ServletContextResource. I am still digging what our options are.

You're right. Unfortunately, it is. With the introduction of ResourceLoader delegation in #42835, followed by the regression fix in #43274, the ApplicationResourceLoader has become a bit complex and fragile overall.

* {@link ClassPathResource} when no resource prefix is provided.
* @return a {@link ResourceLoader} instance
* @since 3.4.1
*/
Expand Down Expand Up @@ -212,28 +212,31 @@ private static class ProtocolResolvingResourceLoader implements ResourceLoader {

private static final String SERVLET_CONTEXT_RESOURCE_CLASS_NAME = "org.springframework.web.context.support.ServletContextResource";

private static final String FILTERED_REACTIVE_WEB_CONTEXT_RESOURCE_CLASS_NAME = "org.springframework.boot.web.reactive.context.FilteredReactiveWebContextResource";

private final ResourceLoader resourceLoader;

private final List<ProtocolResolver> protocolResolvers;

private final boolean preferFileResolution;

private Class<?> servletContextResourceClass;
private final Class<?> servletContextResourceClass;

private final Class<?> filteredReactiveWebContextResourceClass;

ProtocolResolvingResourceLoader(ResourceLoader resourceLoader, List<ProtocolResolver> protocolResolvers,
boolean preferFileResolution) {
this.resourceLoader = resourceLoader;
this.protocolResolvers = protocolResolvers;
this.preferFileResolution = preferFileResolution;
this.servletContextResourceClass = resolveServletContextResourceClass(
resourceLoader.getClass().getClassLoader());
this.servletContextResourceClass = resolveServletContextResourceClass(resourceLoader);
this.filteredReactiveWebContextResourceClass = resolveFilteredReactiveWebContextResourceClass(
resourceLoader);
}

private static Class<?> resolveServletContextResourceClass(ClassLoader classLoader) {
if (!ClassUtils.isPresent(SERVLET_CONTEXT_RESOURCE_CLASS_NAME, classLoader)) {
return null;
}
return ClassUtils.resolveClassName(SERVLET_CONTEXT_RESOURCE_CLASS_NAME, classLoader);
@Override
public ClassLoader getClassLoader() {
return this.resourceLoader.getClassLoader();
}

@Override
Expand All @@ -247,24 +250,47 @@ public Resource getResource(String location) {
}
}
Resource resource = this.resourceLoader.getResource(location);
if (this.preferFileResolution
&& (isClassPathResourceByPath(location, resource) || isServletResource(resource))) {
resource = new ApplicationResource(location);
if (shouldUseFileResolution(location, resource)) {
return new ApplicationResource(location);
}
return resource;
}

private boolean shouldUseFileResolution(String location, Resource resource) {
if (!this.preferFileResolution) {
return false;
}
return isClassPathResourceByPath(location, resource) || isServletContextResource(resource)
|| isFilteredReactiveWebContextResource(resource);
}

private boolean isClassPathResourceByPath(String location, Resource resource) {
return (resource instanceof ClassPathResource) && !location.startsWith(CLASSPATH_URL_PREFIX);
}

private boolean isServletResource(Resource resource) {
return this.servletContextResourceClass != null && this.servletContextResourceClass.isInstance(resource);
private boolean isServletContextResource(Resource resource) {
return (this.servletContextResourceClass != null) && this.servletContextResourceClass.isInstance(resource);
}

@Override
public ClassLoader getClassLoader() {
return this.resourceLoader.getClassLoader();
private boolean isFilteredReactiveWebContextResource(Resource resource) {
return (this.filteredReactiveWebContextResourceClass != null)
&& this.filteredReactiveWebContextResourceClass.isInstance(resource);
}

private static Class<?> resolveServletContextResourceClass(ResourceLoader resourceLoader) {
return resolveClassName(SERVLET_CONTEXT_RESOURCE_CLASS_NAME, resourceLoader.getClass().getClassLoader());
}

private static Class<?> resolveFilteredReactiveWebContextResourceClass(ResourceLoader resourceLoader) {
return resolveClassName(FILTERED_REACTIVE_WEB_CONTEXT_RESOURCE_CLASS_NAME,
resourceLoader.getClass().getClassLoader());
}

private static Class<?> resolveClassName(String clazz, ClassLoader classLoader) {
if (!ClassUtils.isPresent(clazz, classLoader)) {
return null;
}
return ClassUtils.resolveClassName(clazz, classLoader);
}

}
Expand Down
21 changes: 21 additions & 0 deletions ...spring-boot/src/test/java/org/springframework/boot/io/ApplicationResourceLoaderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@

import org.springframework.boot.testsupport.classpath.resources.ResourcePath;
import org.springframework.boot.testsupport.classpath.resources.WithResource;
import org.springframework.boot.web.reactive.context.AnnotationConfigReactiveWebApplicationContext;
import org.springframework.core.io.ByteArrayResource;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.DefaultResourceLoader;
Expand All @@ -37,6 +38,7 @@
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.io.support.SpringFactoriesLoader;
import org.springframework.mock.web.MockServletContext;
import org.springframework.util.ClassUtils;
import org.springframework.web.context.support.ServletContextResource;
import org.springframework.web.context.support.ServletContextResourceLoader;

Expand Down Expand Up @@ -209,6 +211,25 @@ void getResourceWithPreferFileResolutionWhenPathWithServletContextResource() thr
assertThat(regularLoader.getResource("src/main/resources/a-file")).isInstanceOf(ServletContextResource.class);
}

@Test
void getResourceWhenFilteredReactiveWebContextResourceWithPreferFileResolution() throws Exception {
ResourceLoader resourceLoader = ApplicationResourceLoader
.get(new AnnotationConfigReactiveWebApplicationContext(), true);
Resource resource = resourceLoader.getResource("src/main/resources/a-file");
assertThat(resource).isInstanceOf(FileSystemResource.class);
assertThat(resource.getFile().getAbsoluteFile())
.isEqualTo(new File("src/main/resources/a-file").getAbsoluteFile());
}

@Test
void getResourceWhenFilteredReactiveWebContextResource() {
ResourceLoader resourceLoader = ApplicationResourceLoader
.get(new AnnotationConfigReactiveWebApplicationContext(), false);
Resource resource = resourceLoader.getResource("src/main/resources/a-file");
assertThat(resource).isInstanceOf(ClassUtils.resolveClassName(
"org.springframework.boot.web.reactive.context.FilteredReactiveWebContextResource", null));
}

@Test
void getClassLoaderReturnsDelegateClassLoader() {
ClassLoader classLoader = new TestClassLoader(this::useTestProtocolResolversFactories);
Expand Down