EagerContentHandler. #9051 #12077

gregw · 2024-07-23T06:56:29Z

Fix #9051 with EagerContentHandler to replace DelayedHandler

The make the EagerContentHandler.RetainedContentLoader work efficiently this PR adjusted the buffering strategy of h1, h2 and h3 to keep and reuse a retained buffer until it is mostly full.

Also fixed several bugs in XmlConfiguration:

A Set could not be used with a builder style method (kind of missing feature more than a bug)
If a property element was used in a Set it could only be a string and the type element was ignored.
When trying to find a native match, the vClass local variable was overwritten with the native TYPE being tried. This affected subsequent match attempts using the wrong vClass

gregw · 2024-07-23T06:58:21Z

@sbordet @lorban Your thoughts on doing this? If you think it is a good idea, can you contribute the h2 and h3 delayed dispatch handling to this branch.
I will then change the DelayedHandler to only be for delaying to read the entire content (buffering to disk or parsing multi-part or form content).

lorban · 2024-07-23T09:49:21Z

Implementation-wise, this looks alright assuming the same logic can be replicated in H2/H3 (but I doubt this is going to be troublesome).

But could you summarize what benefits/drawbacks this has over the existing DelayedHandler both for clarity and posterity?

gregw · 2024-07-23T14:50:54Z

@lorban wrote:

could you summarize what benefits/drawbacks this has over the existing DelayedHandler both for clarity and posterity?

The DelayedHandler is not able to truly delay the dispatch to the next handler without an execute. This is because, unlike the handle call, the demand callback is serialized with other demand/write callbacks. So if a demand callback is used to call the next handler handle method, it can dead lock if blocks waiting on a demand/write callback. Thus we need to dispatch, which kind of defeats the whole purpose of avoiding scheduling delays on the initial dispatch without content.

gregw · 2024-07-26T22:19:46Z

@sbordet @lorban Can you take this one on

gregw · 2024-08-06T07:15:24Z

I've also taken the opportunity to cleanup lots of deprecation and TODOs in HttpConnection

gregw · 2024-08-07T01:59:38Z

@lachlan-roberts Can you take over the handling of delayed multipart in this PR?

…tty-12.1.x/delayedDispatch

Signed-off-by: Lachlan Roberts <[email protected]>

…ispatch' into experiment/jetty-12.1.x/delayedDispatch

jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/MultiPartFormData.java

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java

gregw · 2024-08-23T01:58:38Z

@sbordet can you do the h2 handling for this
@lorban can you do the h3 handling for this

…tty-12.1.x/delayedDispatch # Conflicts: # jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/internal/HttpConnection.java # jetty-core/jetty-tests/jetty-test-client-transports/src/test/java/org/eclipse/jetty/test/client/transport/AbstractTest.java # jetty-ee10/jetty-ee10-servlet/src/test/java/org/eclipse/jetty/ee10/servlet/ServletTest.java # jetty-ee11/jetty-ee11-servlet/src/test/java/org/eclipse/jetty/ee11/servlet/ServletTest.java # jetty-ee9/jetty-ee9-servlet/src/test/java/org/eclipse/jetty/ee9/servlet/ServletTest.java

gregw · 2024-09-15T23:26:11Z

@sbordet can you do the h2 handling for this
@lorban can you do the h3 handling for this

jetty-core/jetty-io/src/main/java/org/eclipse/jetty/io/AbstractConnection.java

jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/MultiPartFormData.java

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/HttpConnectionFactory.java

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/internal/HttpConnection.java

jetty-ee10/jetty-ee10-servlet/src/test/java/org/eclipse/jetty/ee10/servlet/ServletTest.java

jetty-ee11/jetty-ee11-servlet/src/test/java/org/eclipse/jetty/ee11/servlet/ServletTest.java

jetty-ee9/jetty-ee9-servlet/src/test/java/org/eclipse/jetty/ee9/servlet/ServletTest.java

jetty-core/jetty-server/src/main/config/etc/jetty-delayed.xml

jetty-core/jetty-server/src/main/config/modules/delay-until-content.mod

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java

...re/jetty-http2/jetty-http2-common/src/main/java/org/eclipse/jetty/http2/HTTP2Connection.java

+ rename save to hold + added "Bytes" to configuration

gregw · 2024-11-08T21:20:20Z

The HTTP/3 implementation is to be done.

@lorban I've implemented for H3, but I don't know if it needs the same holdBuffer logic as h2. Do you think there is a release race? We will see from tests I guess....

...re/jetty-http2/jetty-http2-common/src/main/java/org/eclipse/jetty/http2/HTTP2Connection.java

...ransports/src/test/java/org/eclipse/jetty/test/client/transport/ServerRetainContentTest.java

...ty-http3/jetty-http3-common/src/main/java/org/eclipse/jetty/http3/HTTP3StreamConnection.java

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java

sbordet

Not another configuration parameter, see comment.

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java

gregw · 2024-11-12T06:32:26Z

@sbordet I ended up making it extensible, with a EagerContentHandler containing map of mime type to ContentLoaderFactory, each which can create a ContentLoader instance.
This allows configuration that is specific to a particular ContentLoader to be configured on its factory rather than on the Handler. The Handler now has not configuration other than the factories.

I've not yet finished the modules and xml, but I've started, so you can see how this design makes that configuration make more sense (note that I'll be putting the optional non default MultiPartConfig in its own module).

…tty-12.1.x/delayedDispatch # Conflicts: # jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/FormFields.java

lorban

I quite like this new EagerContentHandler, the way its implemented and made configurable.

Besides that new helper in the MultiPartConfig builder which I find its implemented wrong, this LGTM.

jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/MultiPartConfig.java

…e used for setters with properties

gregw · 2024-11-12T22:22:31Z

I found several bugs in XmlConfiguration that prevented it being used with a Builder pattern. This PR now fixes them so we can build a MultiPartConfig in XML. Adding @lachlan-roberts to reviewers so he can check that.

jetty-core/jetty-server/src/main/config/etc/jetty-eager-multipart-content.xml

jetty-core/jetty-server/src/main/java/module-info.java

lachlan-roberts · 2024-11-13T06:07:58Z

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/FormFields.java

-     * @param maxFields The maximum number of fields to accept
-     * @param maxLength The maximum length of fields
+     * @param maxFields The maximum number of fields to accept; or -1 for a default
+     * @param maxLength The maximum length of fields; or -1 for a default


This is a bit misleading in a way, I think it was clearer before.

Because you can configure these to be -1 for no limit on the length.

So now if the context attribute of MAX_LENGTH_ATTRIBUTE was set to -1, then it is unlimited, but if you call this method with -1 it is limited to MAX_LENGTH_DEFAULT.

I agree it is a bit confusing, but I need a way to pass in "use default value", otherwise we end up encoding default values in XML (see jetty-eager-content.xml) and in java. Do you have an alternative suggestion?

It's also an issue if you want to use the default for maxFields, but pass in a maxLength value. With the current API, once you choose to pass in values, you have to pass in both and cannot access the default.

I just tried added a <Default> element to the XML to get the constants from Java, but the <Arg> element doesn't allow a <Default> element :(

@lachlan-roberts and finally... the other API is deprecated, so it will soon go away. You can pass in MAX_VALUE for unlimited.

jetty-core/jetty-xml/src/main/java/org/eclipse/jetty/xml/XmlConfiguration.java

…e used for setters with properties

sbordet

I like this approach much better.

Mostly nits, but few more important ones.

Documentation and DistributionTests are missing, but I can add them.

sbordet · 2024-11-13T08:49:46Z

jetty-core/jetty-server/src/main/config/etc/jetty-eager-content.xml

+            <Item>
+              <New class="org.eclipse.jetty.server.handler.EagerContentHandler$RetainedContentLoaderFactory">
+                <Arg type="int"><Property name="jetty.eager.retained.maxRetainedBytes" default="-1"/></Arg>
+                <Arg type="int"><Property name="jetty.eager.retained.frameOverhead" default="-1"/></Arg>


Suggested change

<Arg type="int"><Property name="jetty.eager.retained.frameOverhead" default="-1"/></Arg>

<Arg type="int"><Property name="jetty.eager.retained.framingOverhead" default="-1"/></Arg>

sbordet · 2024-11-13T08:50:37Z

jetty-core/jetty-server/src/main/config/etc/jetty-eager-content.xml

+              <New class="org.eclipse.jetty.server.handler.EagerContentHandler$RetainedContentLoaderFactory">
+                <Arg type="int"><Property name="jetty.eager.retained.maxRetainedBytes" default="-1"/></Arg>
+                <Arg type="int"><Property name="jetty.eager.retained.frameOverhead" default="-1"/></Arg>
+                <Arg type="boolean"><Property name="jetty.eager.retained.reject" default="false"/></Arg>


Suggested change

<Arg type="boolean"><Property name="jetty.eager.retained.reject" default="false"/></Arg>

<Arg type="boolean"><Property name="jetty.eager.retained.rejectWhenExceeded" default="false"/></Arg>

sbordet · 2024-11-13T08:51:31Z

jetty-core/jetty-server/src/main/config/etc/jetty-eager-multipart-content.xml

+    </Arg>
+  </Call>
+
+  <!-- TODO fields -->


What fields?

sbordet · 2024-11-13T08:52:55Z

jetty-core/jetty-server/src/main/config/modules/eager-content.mod

@@ -0,0 +1,43 @@
+


Remove empty line.

sbordet · 2024-11-13T08:54:04Z

jetty-core/jetty-server/src/main/config/modules/eager-content.mod

+# jetty.eager.retained.maxRetainedBytes=-1
+
+## The frame overhead to use when calculating the retained bytes or -1 for a default
+# jetty.eager.retained.frameOverhead=-1


Suggested change

# jetty.eager.retained.frameOverhead=-1

# jetty.eager.retained.framingOverhead=-1

sbordet · 2024-11-13T09:18:20Z

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/EagerContentHandler.java

+                Response.writeError(getRequest(), getResponse(), getCallback(), t);
+            }
+            // return false to indicate the passed request/response/callback were not used.
+            return false;


Cannot return false here, because in all cases the response is generated and the callback completed.

This return value is only used in RetainedContentLoader.doHandle() to release the chunks, but since the callback is invoked in all cases, they will be released already.

Perhaps we do not need a boolean return type, just void.

sbordet · 2024-11-13T09:19:32Z

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/EagerContentHandler.java

+                {
+                    release();
+                    _callback.succeeded();
+                }


Override failed(Throwable) to release the chunks in case an error response fails.

sbordet · 2024-11-13T09:19:56Z

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/EagerContentHandler.java

+        {
+            private final Deque<Content.Chunk> _chunks = new ArrayDeque<>();
+            private final long _maxRetainedBytes;
+            private final int _chunkOverhead;


Suggested change

private final int _chunkOverhead;

private final int _framingOverhead;

sbordet · 2024-11-13T09:20:17Z

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/EagerContentHandler.java

+             * @param frameOverhead The bytes to account for per chunk when calculating the size; or -1 for a heuristic.
+             * @param reject If {@code true} then requests are rejected if the content is not complete before maxRetainedBytes.
+             */
+            public RetainedContentLoader(Handler handler, Request request, Response response, Callback callback, long maxRetainedBytes, int frameOverhead, boolean reject)


Suggested change

public RetainedContentLoader(Handler handler, Request request, Response response, Callback callback, long maxRetainedBytes, int frameOverhead, boolean reject)

public RetainedContentLoader(Handler handler, Request request, Response response, Callback callback, long maxRetainedBytes, int framingOverhead, boolean rejectWhenExceeded)

sbordet · 2024-11-13T09:23:33Z

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/EagerContentHandler.java

+                    ? Math.max(1, request.getConnectionMetaData().getConnector().getConnectionFactory(HttpConnectionFactory.class).getInputBufferSize() - 1500)
+                    : maxRetainedBytes;
+                _chunkOverhead = frameOverhead < 0
+                    ? (request.getConnectionMetaData().getHttpVersion() == HttpVersion.HTTP_2 ? 9 : 8)


Also for HTTP/3, the framing depends on the content size, but it can only be at most 9 bytes.

So perhaps:

Suggested change

? (request.getConnectionMetaData().getHttpVersion() == HttpVersion.HTTP_2 ? 9 : 8)

? (request.getConnectionMetaData().getHttpVersion().getVersion() <= HttpVersion.HTTP_1_1.getVersion() ? 8 : 9)

Revert delayed dispatch handling to the connections.

5d1a9f6

gregw requested review from lorban, sbordet and lachlan-roberts July 23, 2024 06:56

Revert delayed dispatch handling to the connections.

8c07278

gregw assigned sbordet and lorban Jul 26, 2024

Cleanup of HttpConnection

548770c

Delay until MultiPartFormData

ec0d325

gregw assigned lachlan-roberts Aug 7, 2024

gregw and others added 6 commits August 7, 2024 12:38

Merge remote-tracking branch 'origin/jetty-12.1.x' into experiment/je…

fb85057

…tty-12.1.x/delayedDispatch

Wait for release

da5f09f

fixed removal of deprecated methods

5993364

fixed no mimeType

3ef3d6e

PR #12077 - add test for DelayedHandler with multipart

5ede88a

Signed-off-by: Lachlan Roberts <[email protected]>

Merge remote-tracking branch 'origin/experiment/jetty-12.1.x/delayedD…

e8ab483

…ispatch' into experiment/jetty-12.1.x/delayedDispatch

lachlan-roberts previously requested changes Aug 8, 2024

View reviewed changes

jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/MultiPartFormData.java Outdated Show resolved Hide resolved

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java Outdated Show resolved Hide resolved

gregw added 2 commits August 22, 2024 16:24

updates from review

9e1f431

fixed test

e0f5b7e

gregw requested a review from lachlan-roberts August 23, 2024 01:57

sbordet previously requested changes Sep 17, 2024

View reviewed changes

gregw added 2 commits November 8, 2024 08:53

Fix test leaks

1f89ff5

Fix test leaks

18f655c

sbordet requested changes Nov 8, 2024

View reviewed changes

updates from review

73e21e7

+ rename save to hold + added "Bytes" to configuration

gregw changed the title ~~Cleanup DelayedDispatch handling. #9051~~ Improve DelayedHandler. #9051 Nov 8, 2024

gregw requested a review from sbordet November 8, 2024 21:19

Implemented for H3

278e925

sbordet requested changes Nov 9, 2024

View reviewed changes

Updates from review

4685621

sbordet requested changes Nov 10, 2024

View reviewed changes

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java Outdated Show resolved Hide resolved

jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/DelayedHandler.java Outdated Show resolved Hide resolved

Configurable chunk overhead

4a0e1c1

sbordet requested changes Nov 11, 2024

View reviewed changes

gregw requested a review from sbordet November 11, 2024 21:01

sbordet requested changes Nov 11, 2024

View reviewed changes

gregw added 2 commits November 12, 2024 16:13

Updates after review

9a23ecc

deprecated DelayedHandler

2f06d2f

gregw changed the title ~~Improve DelayedHandler. #9051~~ EagerContentHandler. #9051 Nov 12, 2024

Merge remote-tracking branch 'origin/jetty-12.1.x' into experiment/je…

db9f4d6

…tty-12.1.x/delayedDispatch # Conflicts: # jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/FormFields.java

lorban requested changes Nov 12, 2024

View reviewed changes

jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/MultiPartConfig.java Show resolved Hide resolved

Fixed several XmlConfiguration issues so that a Builder pattern can b…

50265b4

…e used for setters with properties

gregw requested review from sbordet, joakime and lorban November 12, 2024 22:22

lachlan-roberts requested changes Nov 13, 2024

View reviewed changes

Fixed several XmlConfiguration issues so that a Builder pattern can b…

2b0fe1b

…e used for setters with properties

gregw requested a review from lachlan-roberts November 13, 2024 07:20

sbordet reviewed Nov 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EagerContentHandler. #9051 #12077

EagerContentHandler. #9051 #12077

gregw commented Jul 23, 2024 •

edited

Loading

gregw commented Jul 23, 2024

lorban commented Jul 23, 2024

gregw commented Jul 23, 2024 •

edited

Loading

gregw commented Jul 26, 2024

gregw commented Aug 6, 2024

gregw commented Aug 7, 2024

gregw commented Aug 23, 2024

gregw commented Sep 15, 2024

gregw commented Nov 8, 2024 •

edited

Loading

sbordet left a comment

gregw commented Nov 12, 2024

lorban left a comment

gregw commented Nov 12, 2024

lachlan-roberts Nov 13, 2024

gregw Nov 13, 2024

gregw Nov 13, 2024

gregw Nov 13, 2024

gregw Nov 13, 2024

sbordet left a comment

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

sbordet Nov 13, 2024

	<Arg type="int"><Property name="jetty.eager.retained.frameOverhead" default="-1"/></Arg>
	<Arg type="int"><Property name="jetty.eager.retained.framingOverhead" default="-1"/></Arg>

	<Arg type="boolean"><Property name="jetty.eager.retained.reject" default="false"/></Arg>
	<Arg type="boolean"><Property name="jetty.eager.retained.rejectWhenExceeded" default="false"/></Arg>

	# jetty.eager.retained.frameOverhead=-1
	# jetty.eager.retained.framingOverhead=-1

	private final int _chunkOverhead;
	private final int _framingOverhead;

	public RetainedContentLoader(Handler handler, Request request, Response response, Callback callback, long maxRetainedBytes, int frameOverhead, boolean reject)
	public RetainedContentLoader(Handler handler, Request request, Response response, Callback callback, long maxRetainedBytes, int framingOverhead, boolean rejectWhenExceeded)

	? (request.getConnectionMetaData().getHttpVersion() == HttpVersion.HTTP_2 ? 9 : 8)
	? (request.getConnectionMetaData().getHttpVersion().getVersion() <= HttpVersion.HTTP_1_1.getVersion() ? 8 : 9)

EagerContentHandler. #9051 #12077

Are you sure you want to change the base?

EagerContentHandler. #9051 #12077

Conversation

gregw commented Jul 23, 2024 • edited Loading

gregw commented Jul 23, 2024

lorban commented Jul 23, 2024

gregw commented Jul 23, 2024 • edited Loading

gregw commented Jul 26, 2024

gregw commented Aug 6, 2024

gregw commented Aug 7, 2024

gregw commented Aug 23, 2024

gregw commented Sep 15, 2024

gregw commented Nov 8, 2024 • edited Loading

sbordet left a comment

Choose a reason for hiding this comment

gregw commented Nov 12, 2024

lorban left a comment

Choose a reason for hiding this comment

gregw commented Nov 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbordet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gregw commented Jul 23, 2024 •

edited

Loading

gregw commented Jul 23, 2024 •

edited

Loading

gregw commented Nov 8, 2024 •

edited

Loading