Issue #6328 - avoid binding WebSocket MethodHandles

Signed-off-by: Lachlan Roberts <lachlan.p.roberts@gmail.com>
jetty · Aug 21, 2024 · e11120c · e11120c
1 parent 2ba2250
commit e11120c
Show file tree

Hide file tree

Showing 81 changed files with 1,573 additions and 891 deletions.
diff --git a/...e-common/src/main/java/org/eclipse/jetty/websocket/core/messages/AbstractMessageSink.java b/...e-common/src/main/java/org/eclipse/jetty/websocket/core/messages/AbstractMessageSink.java
@@ -13,10 +13,10 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
 import java.util.Objects;
 
 import org.eclipse.jetty.websocket.core.CoreSession;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 /**
  * <p>Abstract implementation of {@link MessageSink}.</p>
@@ -42,21 +42,21 @@
 public abstract class AbstractMessageSink implements MessageSink
 {
     private final CoreSession session;
-    private final MethodHandle methodHandle;
+    private final MethodHolder methodHandle;
     private final boolean autoDemand;
 
     /**
      * Creates a new {@link MessageSink}.
      *
      * @param session the WebSocket session
-     * @param methodHandle the application function to invoke
+     * @param methodHolder the application function to invoke
      * @param autoDemand whether this {@link MessageSink} manages demand automatically
      * as explained in {@link AbstractMessageSink}
      */
-    public AbstractMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public AbstractMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
         this.session = Objects.requireNonNull(session, "CoreSession");
-        this.methodHandle = Objects.requireNonNull(methodHandle, "MethodHandle");
+        this.methodHandle = Objects.requireNonNull(methodHolder, "MethodHolder");
         this.autoDemand = autoDemand;
     }
 
@@ -73,7 +73,7 @@ public CoreSession getCoreSession()
      * Get the application function.
      * @return the application function
      */
-    public MethodHandle getMethodHandle()
+    public MethodHolder getMethodHolder()
     {
         return methodHandle;
     }

diff --git a/...-common/src/main/java/org/eclipse/jetty/websocket/core/messages/ByteArrayMessageSink.java b/...-common/src/main/java/org/eclipse/jetty/websocket/core/messages/ByteArrayMessageSink.java
@@ -13,17 +13,15 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
-import java.lang.invoke.MethodType;
 import java.nio.ByteBuffer;
 
 import org.eclipse.jetty.io.RetainableByteBuffer;
 import org.eclipse.jetty.util.BufferUtil;
 import org.eclipse.jetty.util.Callback;
 import org.eclipse.jetty.websocket.core.CoreSession;
 import org.eclipse.jetty.websocket.core.Frame;
-import org.eclipse.jetty.websocket.core.exception.InvalidSignatureException;
 import org.eclipse.jetty.websocket.core.exception.MessageTooLargeException;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 /**
  * <p>A {@link MessageSink} implementation that accumulates BINARY frames
@@ -38,17 +36,12 @@ public class ByteArrayMessageSink extends AbstractMessageSink
      * Creates a new {@link ByteArrayMessageSink}.
      *
      * @param session the WebSocket session
-     * @param methodHandle the application function to invoke when a new message has been assembled
+     * @param methodHolder the application function to invoke when a new message has been assembled
      * @param autoDemand whether this {@link MessageSink} manages demand automatically
      */
-    public ByteArrayMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public ByteArrayMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        super(session, methodHandle, autoDemand);
-        // This uses the offset length byte array signature not supported by jakarta websocket.
-        // The jakarta layer instead uses decoders for whole byte array messages instead of this message sink.
-        MethodType onMessageType = MethodType.methodType(Void.TYPE, byte[].class, int.class, int.class);
-        if (methodHandle.type().changeReturnType(void.class) != onMessageType.changeReturnType(void.class))
-            throw InvalidSignatureException.build(onMessageType, methodHandle.type());
+        super(session, methodHolder, autoDemand);
     }
 
     @Override
@@ -70,7 +63,7 @@ public void accept(Frame frame, Callback callback)
             if (frame.isFin() && (accumulator == null || accumulator.isEmpty()))
             {
                 byte[] buf = BufferUtil.toArray(payload);
-                getMethodHandle().invoke(buf, 0, buf.length);
+                getMethodHolder().invoke(buf, 0, buf.length);
                 callback.succeeded();
                 autoDemand();
                 return;
@@ -93,7 +86,7 @@ public void accept(Frame frame, Callback callback)
                 callback = Callback.NOOP;
                 int length = accumulator.remaining();
                 byte[] buf = accumulator.takeByteArray();
-                getMethodHandle().invoke(buf, 0, length);
+                getMethodHolder().invoke(buf, 0, length);
                 autoDemand();
             }
             else

diff --git a/...common/src/main/java/org/eclipse/jetty/websocket/core/messages/ByteBufferMessageSink.java b/...common/src/main/java/org/eclipse/jetty/websocket/core/messages/ByteBufferMessageSink.java
@@ -13,8 +13,6 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
-import java.lang.invoke.MethodType;
 import java.nio.ByteBuffer;
 
 import org.eclipse.jetty.io.ByteBufferCallbackAccumulator;
@@ -23,8 +21,8 @@
 import org.eclipse.jetty.util.Callback;
 import org.eclipse.jetty.websocket.core.CoreSession;
 import org.eclipse.jetty.websocket.core.Frame;
-import org.eclipse.jetty.websocket.core.exception.InvalidSignatureException;
 import org.eclipse.jetty.websocket.core.exception.MessageTooLargeException;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 /**
  * <p>A {@link MessageSink} implementation that accumulates BINARY frames
@@ -39,24 +37,12 @@ public class ByteBufferMessageSink extends AbstractMessageSink
      * Creates a new {@link ByteBufferMessageSink}.
      *
      * @param session the WebSocket session
-     * @param methodHandle the application function to invoke when a new message has been assembled
+     * @param methodHolder the application function to invoke when a new message has been assembled
      * @param autoDemand whether this {@link MessageSink} manages demand automatically
      */
-    public ByteBufferMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public ByteBufferMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        this(session, methodHandle, autoDemand, true);
-    }
-
-    protected ByteBufferMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand, boolean validateSignature)
-    {
-        super(session, methodHandle, autoDemand);
-
-        if (validateSignature)
-        {
-            MethodType onMessageType = MethodType.methodType(Void.TYPE, ByteBuffer.class);
-            if (methodHandle.type() != onMessageType)
-                throw InvalidSignatureException.build(onMessageType, methodHandle.type());
-        }
+        super(session, methodHolder, autoDemand);
     }
 
     @Override
@@ -76,7 +62,7 @@ public void accept(Frame frame, Callback callback)
             // created or used, then we don't need to aggregate.
             if (frame.isFin() && (accumulator == null || accumulator.getLength() == 0))
             {
-                invoke(getMethodHandle(), frame.getPayload(), callback);
+                invoke(getMethodHolder(), frame.getPayload(), callback);
                 autoDemand();
                 return;
             }
@@ -99,7 +85,7 @@ public void accept(Frame frame, Callback callback)
                 ByteBuffer byteBuffer = buffer.getByteBuffer();
                 accumulator.writeTo(byteBuffer);
                 callback = Callback.from(buffer::release);
-                invoke(getMethodHandle(), byteBuffer, callback);
+                invoke(getMethodHolder(), byteBuffer, callback);
                 autoDemand();
             }
             else
@@ -122,9 +108,9 @@ public void fail(Throwable failure)
             accumulator.fail(failure);
     }
 
-    protected void invoke(MethodHandle methodHandle, ByteBuffer byteBuffer, Callback callback) throws Throwable
+    protected void invoke(MethodHolder methodHolder, ByteBuffer byteBuffer, Callback callback) throws Throwable
     {
-        methodHandle.invoke(byteBuffer);
+        methodHolder.invoke(byteBuffer);
         callback.succeeded();
     }
 }
diff --git a/...common/src/main/java/org/eclipse/jetty/websocket/core/messages/DispatchedMessageSink.java b/...common/src/main/java/org/eclipse/jetty/websocket/core/messages/DispatchedMessageSink.java
@@ -16,7 +16,6 @@
 import java.io.Closeable;
 import java.io.InputStream;
 import java.io.Reader;
-import java.lang.invoke.MethodHandle;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
 import java.util.concurrent.Executor;
@@ -26,6 +25,7 @@
 import org.eclipse.jetty.websocket.core.CloseStatus;
 import org.eclipse.jetty.websocket.core.CoreSession;
 import org.eclipse.jetty.websocket.core.Frame;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 /**
  * <p>A partial implementation of {@link MessageSink} for methods that consume WebSocket
@@ -51,9 +51,9 @@ public abstract class DispatchedMessageSink extends AbstractMessageSink
     private volatile CompletableFuture<Void> dispatchComplete;
     private MessageSink typeSink;
 
-    public DispatchedMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public DispatchedMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        super(session, methodHandle, autoDemand);
+        super(session, methodHolder, autoDemand);
         if (!autoDemand)
             throw new IllegalArgumentException("%s must be auto-demanding".formatted(getClass().getSimpleName()));
         executor = session.getWebSocketComponents().getExecutor();
@@ -74,7 +74,7 @@ public void accept(Frame frame, final Callback callback)
             {
                 try
                 {
-                    getMethodHandle().invoke(typeSink);
+                    getMethodHolder().invoke(typeSink);
                     if (typeSink instanceof Closeable closeable)
                         IO.close(closeable);
                     dispatchComplete.complete(null);

diff --git a/...ommon/src/main/java/org/eclipse/jetty/websocket/core/messages/InputStreamMessageSink.java b/...ommon/src/main/java/org/eclipse/jetty/websocket/core/messages/InputStreamMessageSink.java
@@ -13,15 +13,14 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
-
 import org.eclipse.jetty.websocket.core.CoreSession;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 public class InputStreamMessageSink extends DispatchedMessageSink
 {
-    public InputStreamMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public InputStreamMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        super(session, methodHandle, autoDemand);
+        super(session, methodHolder, autoDemand);
     }
 
     @Override

diff --git a/.../src/main/java/org/eclipse/jetty/websocket/core/messages/PartialByteArrayMessageSink.java b/.../src/main/java/org/eclipse/jetty/websocket/core/messages/PartialByteArrayMessageSink.java
@@ -13,12 +13,11 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
-
 import org.eclipse.jetty.util.BufferUtil;
 import org.eclipse.jetty.util.Callback;
 import org.eclipse.jetty.websocket.core.CoreSession;
 import org.eclipse.jetty.websocket.core.Frame;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 /**
  * <p>A {@link MessageSink} implementation that delivers BINARY frames
@@ -31,12 +30,12 @@ public class PartialByteArrayMessageSink extends AbstractMessageSink
      * Creates a new {@link PartialByteArrayMessageSink}.
      *
      * @param session the WebSocket session
-     * @param methodHandle the application function to invoke when a new frame has arrived
+     * @param methodHolder the application function to invoke when a new frame has arrived
      * @param autoDemand whether this {@link MessageSink} manages demand automatically
      */
-    public PartialByteArrayMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public PartialByteArrayMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        super(session, methodHandle, autoDemand);
+        super(session, methodHolder, autoDemand);
     }
 
     @Override
@@ -47,7 +46,7 @@ public void accept(Frame frame, Callback callback)
             if (frame.hasPayload() || frame.isFin())
             {
                 byte[] buffer = BufferUtil.toArray(frame.getPayload());
-                getMethodHandle().invoke(buffer, frame.isFin());
+                getMethodHolder().invoke(buffer, frame.isFin());
                 callback.succeeded();
                 autoDemand();
             }

diff --git a/...src/main/java/org/eclipse/jetty/websocket/core/messages/PartialByteBufferMessageSink.java b/...src/main/java/org/eclipse/jetty/websocket/core/messages/PartialByteBufferMessageSink.java
@@ -13,12 +13,12 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
 import java.nio.ByteBuffer;
 
 import org.eclipse.jetty.util.Callback;
 import org.eclipse.jetty.websocket.core.CoreSession;
 import org.eclipse.jetty.websocket.core.Frame;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 /**
  * <p>A {@link MessageSink} implementation that delivers BINARY frames
@@ -31,12 +31,12 @@ public class PartialByteBufferMessageSink extends AbstractMessageSink
      * Creates a new {@link PartialByteBufferMessageSink}.
      *
      * @param session the WebSocket session
-     * @param methodHandle the application function to invoke when a new frame has arrived
+     * @param methodHolder the application function to invoke when a new frame has arrived
      * @param autoDemand whether this {@link MessageSink} manages demand automatically
      */
-    public PartialByteBufferMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public PartialByteBufferMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        super(session, methodHandle, autoDemand);
+        super(session, methodHolder, autoDemand);
     }
 
     @Override
@@ -46,7 +46,7 @@ public void accept(Frame frame, Callback callback)
         {
             if (frame.hasPayload() || frame.isFin())
             {
-                invoke(getMethodHandle(), frame.getPayload(), frame.isFin(), callback);
+                invoke(getMethodHolder(), frame.getPayload(), frame.isFin(), callback);
                 autoDemand();
             }
             else
@@ -61,9 +61,9 @@ public void accept(Frame frame, Callback callback)
         }
     }
 
-    protected void invoke(MethodHandle methodHandle, ByteBuffer byteBuffer, boolean fin, Callback callback) throws Throwable
+    protected void invoke(MethodHolder methodHolder, ByteBuffer byteBuffer, boolean fin, Callback callback) throws Throwable
     {
-        methodHandle.invoke(byteBuffer, fin);
+        methodHolder.invoke(byteBuffer, fin);
         callback.succeeded();
     }
 }
diff --git a/...mon/src/main/java/org/eclipse/jetty/websocket/core/messages/PartialStringMessageSink.java b/...mon/src/main/java/org/eclipse/jetty/websocket/core/messages/PartialStringMessageSink.java
@@ -13,13 +13,12 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
-
 import org.eclipse.jetty.util.Callback;
 import org.eclipse.jetty.util.Utf8StringBuilder;
 import org.eclipse.jetty.websocket.core.CoreSession;
 import org.eclipse.jetty.websocket.core.Frame;
 import org.eclipse.jetty.websocket.core.exception.BadPayloadException;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 /**
  * <p>A {@link MessageSink} implementation that delivers TEXT frames
@@ -34,12 +33,12 @@ public class PartialStringMessageSink extends AbstractMessageSink
      * Creates a new {@link PartialStringMessageSink}.
      *
      * @param session the WebSocket session
-     * @param methodHandle the application function to invoke when a new frame has arrived
+     * @param methodHolder the application function to invoke when a new frame has arrived
      * @param autoDemand whether this {@link MessageSink} manages demand automatically
      */
-    public PartialStringMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public PartialStringMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        super(session, methodHandle, autoDemand);
+        super(session, methodHolder, autoDemand);
     }
 
     @Override
@@ -55,12 +54,12 @@ public void accept(Frame frame, Callback callback)
             if (frame.isFin())
             {
                 String complete = accumulator.takeCompleteString(BadPayloadException.InvalidUtf8::new);
-                getMethodHandle().invoke(complete, true);
+                getMethodHolder().invoke(complete, true);
             }
             else
             {
                 String partial = accumulator.takePartialString(BadPayloadException.InvalidUtf8::new);
-                getMethodHandle().invoke(partial, false);
+                getMethodHolder().invoke(partial, false);
             }
 
             callback.succeeded();

diff --git a/...ore-common/src/main/java/org/eclipse/jetty/websocket/core/messages/ReaderMessageSink.java b/...ore-common/src/main/java/org/eclipse/jetty/websocket/core/messages/ReaderMessageSink.java
@@ -13,15 +13,14 @@
 
 package org.eclipse.jetty.websocket.core.messages;
 
-import java.lang.invoke.MethodHandle;
-
 import org.eclipse.jetty.websocket.core.CoreSession;
+import org.eclipse.jetty.websocket.core.util.MethodHolder;
 
 public class ReaderMessageSink extends DispatchedMessageSink
 {
-    public ReaderMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)
+    public ReaderMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)
     {
-        super(session, methodHandle, autoDemand);
+        super(session, methodHolder, autoDemand);
     }
 
     @Override