Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/jetty-9.4.x-5193-better-websocket-event-logging' into jetty-9.4.x-5193-NullMessage 

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan Roberts 2020-08-31 10:53:26 +10:00
parent 92e5abb1bd 46402bc382
commit cd1edb33f4
6 changed files with 176 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/AbstractEventDriver.java
View File

@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.common.events;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.Objects;
import org.eclipse.jetty.util.BufferUtil;
import org.eclipse.jetty.util.Utf8Appendable.NotUtf8Exception;
@ -42,7 +43,7 @@ import org.eclipse.jetty.websocket.common.message.MessageAppender;
*/
public abstract class AbstractEventDriver extends AbstractLifeCycle implements IncomingFrames, EventDriver
{
private static final Logger LOG = Log.getLogger(AbstractEventDriver.class);
private final Logger logger;
protected final Logger targetLog;
protected WebSocketPolicy policy;
protected final Object websocket;
@ -51,8 +52,9 @@ public abstract class AbstractEventDriver extends AbstractLifeCycle implements I
public AbstractEventDriver(WebSocketPolicy policy, Object websocket)
{
this.logger = Log.getLogger(this.getClass());
this.policy = policy;
this.websocket = websocket;
this.websocket = Objects.requireNonNull(websocket, "WebSocket endpoint may not be null");
this.targetLog = Log.getLogger(websocket.getClass());
}
@ -87,9 +89,9 @@ public abstract class AbstractEventDriver extends AbstractLifeCycle implements I
@Override
public void incomingFrame(Frame frame)
{
if (LOG.isDebugEnabled())
if (logger.isDebugEnabled())
{
LOG.debug("incomingFrame({})", frame);
logger.debug("incomingFrame({})", frame);
}
try
@ -112,9 +114,9 @@ public abstract class AbstractEventDriver extends AbstractLifeCycle implements I
}
case OpCode.PING:
{
if (LOG.isDebugEnabled())
if (logger.isDebugEnabled())
{
LOG.debug("PING: {}", BufferUtil.toDetailString(frame.getPayload()));
logger.debug("PING: {}", BufferUtil.toDetailString(frame.getPayload()));
}
ByteBuffer pongBuf;
if (frame.hasPayload())
@ -133,9 +135,9 @@ public abstract class AbstractEventDriver extends AbstractLifeCycle implements I
}
case OpCode.PONG:
{
if (LOG.isDebugEnabled())
if (logger.isDebugEnabled())
{
LOG.debug("PONG: {}", BufferUtil.toDetailString(frame.getPayload()));
logger.debug("PONG: {}", BufferUtil.toDetailString(frame.getPayload()));
}
onPong(frame.getPayload());
break;
@ -157,8 +159,8 @@ public abstract class AbstractEventDriver extends AbstractLifeCycle implements I
}
default:
{
if (LOG.isDebugEnabled())
LOG.debug("Unhandled OpCode: {}", opcode);
if (logger.isDebugEnabled())
logger.debug("Unhandled OpCode: {}", opcode);
}
}
}
@ -202,10 +204,9 @@ public abstract class AbstractEventDriver extends AbstractLifeCycle implements I
@Override
public void openSession(WebSocketSession session)
{
if (LOG.isDebugEnabled())
if (logger.isDebugEnabled())
{
LOG.debug("openSession({})", session);
LOG.debug("objectFactory={}", session.getContainerScope().getObjectFactory());
logger.debug("openSession({}) objectFactory={}", session, session.getContainerScope().getObjectFactory());
}
this.session = session;
this.session.getContainerScope().getObjectFactory().decorate(this.websocket);

68
jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/JettyAnnotatedEventDriver.java
View File

@ -22,7 +22,9 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.nio.ByteBuffer;
import java.util.Objects;
import org.eclipse.jetty.util.BufferUtil;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.websocket.api.BatchMode;
@ -36,6 +38,7 @@ import org.eclipse.jetty.websocket.common.message.MessageReader;
import org.eclipse.jetty.websocket.common.message.NullMessage;
import org.eclipse.jetty.websocket.common.message.SimpleBinaryMessage;
import org.eclipse.jetty.websocket.common.message.SimpleTextMessage;
import org.eclipse.jetty.websocket.common.util.TextUtil;
/**
* Handler for Annotated User WebSocket objects.
@ -50,7 +53,7 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
public JettyAnnotatedEventDriver(WebSocketPolicy policy, Object websocket, JettyAnnotatedMetadata events)
{
super(policy, websocket);
this.events = events;
this.events = Objects.requireNonNull(events, "JettyAnnotatedMetadata may not be null");
WebSocket anno = websocket.getClass().getAnnotation(WebSocket.class);
// Setup the policy
@ -71,6 +74,11 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
this.policy.setIdleTimeout(anno.maxIdleTime());
}
this.batchMode = anno.batchMode();
if (LOG.isDebugEnabled())
{
LOG.debug("ctor / object={}, policy={}, batchMode={}, events={}", websocket, policy, batchMode, events);
}
}
@Override
@ -82,6 +90,12 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onBinaryFrame(ByteBuffer buffer, boolean fin) throws IOException
{
if (LOG.isDebugEnabled())
{
LOG.debug("onBinaryFrame({}, {}) - events.onBinary={}, activeMessage={}",
BufferUtil.toDetailString(buffer), fin, events.onBinary, activeMessage);
}
if (activeMessage == null)
{
if (events.onBinary == null)
@ -120,6 +134,11 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onBinaryMessage(byte[] data)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onBinaryMessage([{}]) - events.onBinary={}", data.length, events.onBinary);
}
if (events.onBinary != null)
{
events.onBinary.call(websocket, session, data, 0, data.length);
@ -135,6 +154,12 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
return;
}
hasCloseBeenCalled = true;
if (LOG.isDebugEnabled())
{
LOG.debug("onClose({}) - events.onClose={}", close, events.onClose);
}
if (events.onClose != null)
{
events.onClose.call(websocket, session, close.getStatusCode(), close.getReason());
@ -144,6 +169,11 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onConnect()
{
if (LOG.isDebugEnabled())
{
LOG.debug("onConnect() - events.onConnect={}", events.onConnect);
}
if (events.onConnect != null)
{
events.onConnect.call(websocket, session);
@ -153,6 +183,11 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onError(Throwable cause)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onError({}) - events.onError={}", cause.getClass().getName(), events.onError);
}
if (events.onError != null)
{
events.onError.call(websocket, session, cause);
@ -166,6 +201,11 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onFrame(Frame frame)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onFrame({}) - events.onFrame={}", frame, events.onFrame);
}
if (events.onFrame != null)
{
events.onFrame.call(websocket, session, frame);
@ -175,6 +215,13 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onInputStream(InputStream stream)
{
Objects.requireNonNull(stream, "InputStream may not be null");
if (LOG.isDebugEnabled())
{
LOG.debug("onInputStream({}) - events.onBinary={}", stream.getClass().getName(), events.onBinary);
}
if (events.onBinary != null)
{
events.onBinary.call(websocket, session, stream);
@ -184,6 +231,13 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onReader(Reader reader)
{
Objects.requireNonNull(reader, "Reader may not be null");
if (LOG.isDebugEnabled())
{
LOG.debug("onReader({}) - events.onText={}", reader.getClass().getName(), events.onText);
}
if (events.onText != null)
{
events.onText.call(websocket, session, reader);
@ -193,6 +247,12 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onTextFrame(ByteBuffer buffer, boolean fin) throws IOException
{
if (LOG.isDebugEnabled())
{
LOG.debug("onTextFrame({}, {}) - events.onText={}, activeMessage={}",
BufferUtil.toDetailString(buffer), fin, events.onText, activeMessage);
}
if (activeMessage == null)
{
if (events.onText == null)
@ -232,6 +292,12 @@ public class JettyAnnotatedEventDriver extends AbstractEventDriver
@Override
public void onTextMessage(String message)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onTextMessage([{}] \"{}\") - events.onText={}",
message.length(), TextUtil.maxStringLength(60, message), events.onText);
}
if (events.onText != null)
{
events.onText.call(websocket, session, message);

15
jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/JettyAnnotatedMetadata.java
View File

@ -24,27 +24,27 @@ import org.eclipse.jetty.websocket.common.events.annotated.OptionalSessionCallab
public class JettyAnnotatedMetadata
{
/**
* &#064;OnWebSocketConnect ()
* {@code @OnWebSocketConnect ()}
*/
public CallableMethod onConnect;
/**
* &#064;OnWebSocketMessage (byte[], or ByteBuffer, or InputStream)
* {@code @OnWebSocketMessage (byte[], or ByteBuffer, or InputStream)}
*/
public OptionalSessionCallableMethod onBinary;
/**
* &#064;OnWebSocketMessage (String, or Reader)
* {@code @OnWebSocketMessage (String, or Reader)}
*/
public OptionalSessionCallableMethod onText;
/**
* &#064;OnWebSocketFrame (Frame)
* {@code @OnWebSocketFrame (Frame)}
*/
public OptionalSessionCallableMethod onFrame;
/**
* &#064;OnWebSocketError (Throwable)
* {@code @OnWebSocketError (Throwable)}
*/
public OptionalSessionCallableMethod onError;
/**
* &#064;OnWebSocketClose (Frame)
* {@code @OnWebSocketClose (Frame)}
*/
public OptionalSessionCallableMethod onClose;
@ -52,7 +52,8 @@ public class JettyAnnotatedMetadata
public String toString()
{
StringBuilder s = new StringBuilder();
s.append("JettyPojoMetadata[");
s.append(this.getClass().getSimpleName());
s.append("[");
s.append("onConnect=").append(onConnect);
s.append(",onBinary=").append(onBinary);
s.append(",onText=").append(onText);

79
jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/JettyListenerEventDriver.java
View File

@ -22,7 +22,9 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.nio.ByteBuffer;
import java.util.Objects;
import org.eclipse.jetty.util.BufferUtil;
import org.eclipse.jetty.util.Utf8StringBuilder;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
@ -38,6 +40,7 @@ import org.eclipse.jetty.websocket.common.CloseInfo;
import org.eclipse.jetty.websocket.common.frames.ReadOnlyDelegatedFrame;
import org.eclipse.jetty.websocket.common.message.SimpleBinaryMessage;
import org.eclipse.jetty.websocket.common.message.SimpleTextMessage;
import org.eclipse.jetty.websocket.common.util.TextUtil;
/**
* Handler for {@link WebSocketListener} based User WebSocket implementations.
@ -58,12 +61,26 @@ public class JettyListenerEventDriver extends AbstractEventDriver
public JettyListenerEventDriver(WebSocketPolicy policy, WebSocketConnectionListener listener)
{
super(policy, listener);
this.listener = listener;
this.listener = Objects.requireNonNull(listener, "Listener may not be null");
if (LOG.isDebugEnabled())
{
LOG.debug("ctor / listener={}, policy={}", listener.getClass().getName(), policy);
}
}
@Override
public void onBinaryFrame(ByteBuffer buffer, boolean fin) throws IOException
{
if (LOG.isDebugEnabled())
{
LOG.debug("onBinaryFrame({}, {}) - webSocketListener={}, webSocketPartialListener={}, listener={}, activeMessage={}",
BufferUtil.toDetailString(buffer), fin,
(listener instanceof WebSocketListener),
(listener instanceof WebSocketPartialListener),
listener.getClass().getName(),
activeMessage);
}
if (listener instanceof WebSocketListener)
{
if (activeMessage == null)
@ -98,6 +115,14 @@ public class JettyListenerEventDriver extends AbstractEventDriver
@Override
public void onBinaryMessage(byte[] data)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onBinaryMessage([{}]) - webSocketListener={}, listener={}",
data.length,
(listener instanceof WebSocketListener),
this.listener.getClass().getName());
}
if (listener instanceof WebSocketListener)
{
((WebSocketListener)listener).onWebSocketBinary(data, 0, data.length);
@ -116,6 +141,11 @@ public class JettyListenerEventDriver extends AbstractEventDriver
int statusCode = close.getStatusCode();
String reason = close.getReason();
if (LOG.isDebugEnabled())
{
LOG.debug("onClose({},{}) - listener={}", statusCode, reason, this.listener.getClass().getName());
}
listener.onWebSocketClose(statusCode, reason);
}
@ -123,19 +153,34 @@ public class JettyListenerEventDriver extends AbstractEventDriver
public void onConnect()
{
if (LOG.isDebugEnabled())
LOG.debug("onConnect({})", session);
{
LOG.debug("onConnect({}) - listener={}", session, this.listener.getClass().getName());
}
listener.onWebSocketConnect(session);
}
@Override
public void onError(Throwable cause)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onError({}) - listener={}", cause.getClass().getName(), this.listener.getClass().getName());
}
listener.onWebSocketError(cause);
}
@Override
public void onFrame(Frame frame)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onFrame({}) - frameListener={}, pingPongListener={}, listener={}",
frame,
(listener instanceof WebSocketFrameListener),
(listener instanceof WebSocketPingPongListener),
this.listener.getClass().getName());
}
if (listener instanceof WebSocketFrameListener)
{
((WebSocketFrameListener)listener).onWebSocketFrame(new ReadOnlyDelegatedFrame(frame));
@ -169,6 +214,17 @@ public class JettyListenerEventDriver extends AbstractEventDriver
@Override
public void onTextFrame(ByteBuffer buffer, boolean fin) throws IOException
{
if (LOG.isDebugEnabled())
{
LOG.debug("onTextFrame({}, {}) - webSocketListener={}, webSocketPartialListener={}, listener={}, activeMessage={}",
BufferUtil.toDetailString(buffer),
fin,
(listener instanceof WebSocketListener),
(listener instanceof WebSocketPartialListener),
listener.getClass().getName(),
activeMessage);
}
if (listener instanceof WebSocketListener)
{
if (activeMessage == null)
@ -226,6 +282,15 @@ public class JettyListenerEventDriver extends AbstractEventDriver
@Override
public void onTextMessage(String message)
{
if (LOG.isDebugEnabled())
{
LOG.debug("onTextMessage([{}] \"{}\") - webSocketListener={}, listener={}",
message.length(),
TextUtil.maxStringLength(60, message),
(listener instanceof WebSocketListener),
listener.getClass().getName());
}
if (listener instanceof WebSocketListener)
{
((WebSocketListener)listener).onWebSocketText(message);
@ -234,6 +299,16 @@ public class JettyListenerEventDriver extends AbstractEventDriver
public void onContinuationFrame(ByteBuffer buffer, boolean fin) throws IOException
{
if (LOG.isDebugEnabled())
{
LOG.debug("onContinuationFrame({}, {}) - webSocketListener={}, webSocketPartialListener={}, listener={}, activeMessage={}",
BufferUtil.toDetailString(buffer), fin,
(listener instanceof WebSocketListener),
(listener instanceof WebSocketPartialListener),
listener.getClass().getName(),
activeMessage);
}
if (listener instanceof WebSocketPartialListener)
{
switch (partialMode)

5
jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/CallableMethod.java
View File

@ -139,6 +139,9 @@ public class CallableMethod
@Override
public String toString()
{
return String.format("%s[%s]", this.getClass().getSimpleName(), method.toGenericString());
return String.format("%s[pojo=%s,method=%s]",
this.getClass().getSimpleName(),
pojo.getName(),
method.toGenericString());
}
}

7
jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/OptionalSessionCallableMethod.java
View File

@ -86,6 +86,11 @@ public class OptionalSessionCallableMethod extends CallableMethod
@Override
public String toString()
{
return String.format("%s[%s]", this.getClass().getSimpleName(), method.toGenericString());
return String.format("%s[pojo=%s,method=%s,wantsSession=%b,streaming=%s]",
this.getClass().getSimpleName(),
pojo.getName(),
method.toGenericString(),
wantsSession,
streaming);
}
}