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

improve performance of alias checking #8433

Merged
merged 2 commits into from
Aug 15, 2022
Merged

improve performance of alias checking #8433

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4eff1a9
improve performance of alias checking
lachlan-roberts Aug 8, 2022
5b52570
use CopyOnWriteArrayList for AliasCheck list
lachlan-roberts Aug 9, 2022
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
4 changes: 2 additions & 2 deletions jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ private enum ProtectedTargetType
private final List<ContextScopeListener> _contextListeners = new CopyOnWriteArrayList<>();
private final Set<EventListener> _durableListeners = new HashSet<>();
private Index<ProtectedTargetType> _protectedTargets = Index.empty(false);
private final List<AliasCheck> _aliasChecks = new CopyOnWriteArrayList<>();
private final List<AliasCheck> _aliasChecks = new ArrayList<>();

public enum Availability
{
Expand Down Expand Up @@ -1967,7 +1967,7 @@ public boolean checkAlias(String path, Resource resource)
LOG.debug("Aliased resource: {}~={}", resource, resource.getAlias());

// alias checks
for (AliasCheck check : getAliasChecks())
Copy link
Contributor

Choose a reason for hiding this comment

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

The reason this existed this way was to support folks that wanted to have adjustable (at runtime) list of alias checks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm I thought alias checks could only be added before start but looks like that is not the case.

So maybe we do still need the CopyOnWriteArrayList, but we don't need to use getAliasChecks() for the unmodifiable list here.

Copy link
Contributor

@joakime joakime Aug 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I don't have a strong opinion on the solution you are working towards.
Just explaining the history of why things are the way they are in Jetty 11 and earlier.
Up to you to decide if this behavior is worth keeping around or changing for Jetty 12 tho.

In regards to Jetty 12 effort though ...
To add to this, there once was a desire to have different Alias checks depending on url-pattern.
So that you could reject aliases for say /archives/* and allow aliases for /avatars/*.

Frankly, only the Jetty 12 ResourceService should have the alias check lists, as that's where all of our serve-static-content lies now (for all EE levels). The uses of say ServletContext.getResource(String) should allow anything that is requested from it as that's programmatic from Servlet APIs, not something that a user request can trigger. It's up to the webapp developer to decide how to sanitize / evaluate if sane the user request before they call ServletContext.getResource(String). (Example: Jersey and Spring serve static content themselves, not via the DefaultServlet / ResourceHandler. But spark uses the ResourceHandler.)

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not convinced we need to allow getAliasChecks to be overridable, as I don't really see the use-case for a dynamic list, nor is there any context passed on which to make that choice. So I'm OK with this change..... but equally we could assign a single immutable list as a field and return that.

for (AliasCheck check : _aliasChecks)
{
if (check.check(path, resource))
{
Expand Down