* ws: remove ws support

Signed-off-by: neo <[email protected]>

Author: neowu

CHANGELOG.md

@@ -6,6 +6,8 @@
 * sse: support @LimitRate on sse connect or class
   > use @LimitRate and http().limitRate().add() to configure rate limit
 * sse: log event count and size on sse:close action
+* ws: remove ws support
+  > websocket is not used anymore, use sse/ajax instead
 
 ### 9.1.7 (2/26/2025 - 3/6/2025)
 

core-ng/src/main/java/core/framework/internal/module/ModuleContext.java

@@ -78,7 +78,7 @@ public void initialize() {
 
     private HTTPServer createHTTPServer() {
         var httpServer = new HTTPServer(logManager);
-        beanFactory.bind(WebContext.class, null, httpServer.handler.webContext);
+        beanFactory.bind(WebContext.class, null, httpServer.httpHandler.webContext);
         beanFactory.bind(SessionContext.class, null, httpServer.siteManager.sessionManager);
         beanFactory.bind(WebDirectory.class, null, httpServer.siteManager.webDirectory);
 
@@ -107,7 +107,7 @@ public final void route(HTTPMethod method, String path, Controller controller, b
         var inspector = new ControllerInspector(controller);
         new ControllerClassValidator(inspector.targetClass, inspector.targetMethod).validate();
         String action = "http:" + ASCII.toLowerCase(method.name()) + ":" + path;
-        httpServer.handler.route.add(method, path, new ControllerHolder(controller, inspector.targetMethod, inspector.controllerInfo, action, skipInterceptor));
+        httpServer.httpHandler.route.add(method, path, new ControllerHolder(controller, inspector.targetMethod, inspector.controllerInfo, action, skipInterceptor));
     }
 
     public <T extends Config> T config(Class<T> configClass, @Nullable String name) {

core-ng/src/main/java/core/framework/internal/web/HTTPHandlerContext.java

@@ -12,8 +12,8 @@ public class HTTPHandlerContext {
     public final RequestParser requestParser = new RequestParser();
     public final RequestBeanReader requestBeanReader = new RequestBeanReader();
     public final ResponseBeanWriter responseBeanWriter = new ResponseBeanWriter();
-    public final RateControl rateControl = new RateControl();
-    public boolean limitRate;   // TODO: simplify this design?
+    @Nullable
+    public RateControl rateControl;
     @Nullable
     public IPv4AccessControl accessControl;
 }

core-ng/src/main/java/core/framework/internal/web/HTTPIOHandler.java

@@ -2,7 +2,6 @@
 
 import core.framework.internal.web.request.RequestBodyReader;
 import core.framework.internal.web.sse.ServerSentEventHandler;
-import core.framework.internal.web.websocket.WebSocketHandler;
 import io.undertow.server.HttpHandler;
 import io.undertow.server.HttpServerExchange;
 import io.undertow.server.handlers.form.FormDataParser;
@@ -24,20 +23,20 @@
 public class HTTPIOHandler implements HttpHandler {
     public static final String HEALTH_CHECK_PATH = "/health-check";
     private final Logger logger = LoggerFactory.getLogger(HTTPIOHandler.class);
+
+    private final HTTPHandler httpHandler;
+    private final ServerSentEventHandler sseHandler;
+    private final ShutdownHandler shutdownHandler;
+
     private final FormParserFactory formParserFactory;
     private final long maxEntitySize;
-    private final HTTPHandler handler;
-    private final ShutdownHandler shutdownHandler;
-    private final ServerSentEventHandler sseHandler;
-    private final WebSocketHandler webSocketHandler;
 
-    HTTPIOHandler(HTTPHandler handler, ShutdownHandler shutdownHandler, long maxEntitySize, ServerSentEventHandler sseHandler, WebSocketHandler webSocketHandler) {
-        this.handler = handler;
+    HTTPIOHandler(HTTPHandler httpHandler, ShutdownHandler shutdownHandler, long maxEntitySize, ServerSentEventHandler sseHandler) {
+        this.httpHandler = httpHandler;
         this.shutdownHandler = shutdownHandler;
         formParserFactory = createFormParserFactory();
         this.maxEntitySize = maxEntitySize;
         this.sseHandler = sseHandler;
-        this.webSocketHandler = webSocketHandler;
     }
 
     private FormParserFactory createFormParserFactory() {
@@ -59,31 +58,26 @@ private FormParserFactory createFormParserFactory() {
     public void handleRequest(HttpServerExchange exchange) throws Exception {
         String path = exchange.getRequestPath();
         if (HEALTH_CHECK_PATH.equals(path)) {      // not treat health-check as action
-            handler.addKeepAliveHeader(exchange);
+            httpHandler.addKeepAliveHeader(exchange);
             exchange.endExchange(); // end exchange will send 200 / content-length=0
             return;
         }
 
         long contentLength = exchange.getRequestContentLength();
         if (!checkContentLength(contentLength, exchange)) return;
 
-        HttpString method = exchange.getRequestMethod();
-        HeaderMap headers = exchange.getRequestHeaders();
-
-        var requestHandler = new Handler(exchange);
-        boolean ws = webSocketHandler != null && webSocketHandler.check(method, headers);   // TODO: retire ws and simplify
-        boolean active = !requestHandler.sse && !ws;
-        boolean shutdown = shutdownHandler.handle(exchange, active);
+        var handler = new Handler(exchange);
+        boolean shutdown = shutdownHandler.handle(exchange, handler.sse);
         if (shutdown) return;
 
-        if (hasBody(contentLength, method)) {    // parse body early, not process until body is read (e.g. for chunked), to save one blocking thread during read
+        if (hasBody(contentLength, exchange.getRequestMethod())) {    // parse body early, not process until body is read (e.g. for chunked), to save one blocking thread during read
             FormDataParser parser = formParserFactory.createParser(exchange);   // no need to close, refer to io.undertow.server.handlers.form.MultiPartParserDefinition.create, it closes on ExchangeCompletionListener
             if (parser != null) {
-                parser.parse(handler);
+                parser.parse(httpHandler);
                 return;
             }
 
-            var reader = new RequestBodyReader(exchange, requestHandler);
+            var reader = new RequestBodyReader(exchange, handler);
             StreamSourceChannel channel = exchange.getRequestChannel();
             reader.read(channel);  // channel will be null if getRequestChannel() is already called, but here should not be that case
             if (!reader.complete()) {
@@ -93,11 +87,7 @@ public void handleRequest(HttpServerExchange exchange) throws Exception {
             }
         }
 
-        if (ws) {
-            exchange.dispatch(webSocketHandler);
-        } else {
-            requestHandler.handle();
-        }
+        handler.handle();
     }
 
     // undertow is not handling max entity size checking correctly, it terminates request directly and bypass exchange.endExchange() in certain cases, and log errors in debug level
@@ -141,7 +131,7 @@ public void handle() {
             if (sse) {
                 sseHandler.handleRequest(exchange); // not dispatch, continue in io thread
             } else {
-                exchange.dispatch(handler);
+                exchange.dispatch(httpHandler);
             }
         }
     }

core-ng/src/main/java/core/framework/internal/web/HTTPServer.java

@@ -4,7 +4,6 @@
 import core.framework.internal.log.LogManager;
 import core.framework.internal.web.site.SiteManager;
 import core.framework.internal.web.sse.ServerSentEventHandler;
-import core.framework.internal.web.websocket.WebSocketHandler;
 import core.framework.util.StopWatch;
 import core.framework.web.Interceptor;
 import io.undertow.Undertow;
@@ -36,22 +35,21 @@ public class HTTPServer {
 
     public final SiteManager siteManager = new SiteManager();
     public final HTTPHandlerContext handlerContext = new HTTPHandlerContext();
-    public final HTTPHandler handler;
+    public final HTTPHandler httpHandler;
     final ShutdownHandler shutdownHandler = new ShutdownHandler();
     private final Logger logger = LoggerFactory.getLogger(HTTPServer.class);
     private final ExecutorService worker = ThreadPools.virtualThreadExecutor("http-handler-");
 
-    public WebSocketHandler webSocketHandler;
     public ServerSentEventHandler sseHandler;
     private Undertow server;
 
     public HTTPServer(LogManager logManager) {
-        handler = new HTTPHandler(logManager, siteManager.sessionManager, siteManager.templateManager, handlerContext);
+        httpHandler = new HTTPHandler(logManager, siteManager.sessionManager, siteManager.templateManager, handlerContext);
     }
 
     public void start(HTTPServerConfig config) {
         var watch = new StopWatch();
-        handler.interceptors = config.interceptors.toArray(new Interceptor[0]);
+        httpHandler.interceptors = config.interceptors.toArray(new Interceptor[0]);
         HTTPHost httpHost = config.httpHost;
         HTTPHost httpsHost = config.httpsHost();
         try {
@@ -92,7 +90,7 @@ public void start(HTTPServerConfig config) {
     }
 
     private HttpHandler handler(HTTPServerConfig config) {
-        HttpHandler handler = new HTTPIOHandler(this.handler, shutdownHandler, config.maxEntitySize, sseHandler, webSocketHandler);
+        HttpHandler handler = new HTTPIOHandler(httpHandler, shutdownHandler, config.maxEntitySize, sseHandler);
         if (config.gzip) {
             // only support gzip, deflate is less popular
             handler = new EncodingHandler(handler, new ContentEncodingRepository()
@@ -105,7 +103,6 @@ public void shutdown() {
         if (server != null) {
             logger.info("shutting down http server");
             shutdownHandler.shutdown();
-            if (webSocketHandler != null) webSocketHandler.shutdown();
             if (sseHandler != null) sseHandler.shutdown();
         }
     }

core-ng/src/main/java/core/framework/internal/web/ShutdownHandler.java

@@ -24,8 +24,8 @@ public class ShutdownHandler implements ExchangeCompletionListener {
 
     private volatile boolean shutdown;
 
-    boolean handle(HttpServerExchange exchange, boolean active) {
-        if (active) { // do not count sse/ws requests
+    boolean handle(HttpServerExchange exchange, boolean sse) {
+        if (!sse) { // do not count sse requests
             activeRequests.increase();
             exchange.addExchangeCompleteListener(this);
         }

core-ng/src/main/java/core/framework/internal/web/bean/ResponseBeanWriter.java

@@ -7,7 +7,6 @@
 import core.framework.internal.web.service.ErrorResponse;
 import core.framework.internal.web.service.InternalErrorResponse;
 import core.framework.util.Maps;
-import core.framework.util.Strings;
 
 import java.lang.reflect.Type;
 import java.util.Map;
@@ -37,17 +36,17 @@ public boolean contains(Class<?> beanClass) {
         return context.containsKey(beanClass);
     }
 
-    public byte[] toJSON(Object bean) {
+    public String toJSON(Object bean) {
         if (bean instanceof Optional<?> optional) {  // only support Optional<T> as response bean type
-            if (optional.isEmpty()) return Strings.bytes("null");
+            if (optional.isEmpty()) return "null";
             Object value = optional.get();
             Context<Object> context = context(this.context, value.getClass());
             context.validator.validate(value, false);
-            return context.writer.toJSON(value);
+            return context.writer.toJSONString(value);
         } else {
             Context<Object> context = context(this.context, bean.getClass());
             context.validator.validate(bean, false);
-            return context.writer.toJSON(bean);
+            return context.writer.toJSONString(bean);
         }
     }
 

core-ng/src/main/java/core/framework/internal/web/response/BeanBody.java

@@ -1,6 +1,6 @@
 package core.framework.internal.web.response;
 
-import core.framework.internal.log.filter.BytesLogParam;
+import core.framework.util.Strings;
 import io.undertow.io.Sender;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -20,9 +20,10 @@ public BeanBody(Object bean) {
 
     @Override
     public long send(Sender sender, ResponseHandlerContext context) {
-        byte[] body = context.writer.toJSON(bean);
-        LOGGER.debug("[response] body={}", new BytesLogParam(body));
-        sender.send(ByteBuffer.wrap(body));
-        return body.length;
+        String body = context.writer.toJSON(bean);
+        LOGGER.debug("[response] body={}", body);
+        byte[] bytes = Strings.bytes(body);
+        sender.send(ByteBuffer.wrap(bytes));
+        return bytes.length;
     }
 }

core-ng/src/main/java/core/framework/internal/web/sse/ChannelImpl.java

@@ -37,7 +37,7 @@ class ChannelImpl<T> implements java.nio.channels.Channel, Channel<T>, Channel.C
     final Deque<byte[]> queue = new ConcurrentLinkedDeque<>();
 
     private final ServerSentEventContextImpl<T> serverSentEventContext;
-    private final ServerSentEventBuilder<T> builder;
+    private final ServerSentEventWriter<T> builder;
 
     private final ReentrantLock lock = new ReentrantLock();
     private final HttpServerExchange exchange;
@@ -53,7 +53,7 @@ class ChannelImpl<T> implements java.nio.channels.Channel, Channel<T>, Channel.C
     String clientIP;
     String traceId;
 
-    ChannelImpl(HttpServerExchange exchange, StreamSinkChannel sink, ServerSentEventContextImpl<T> serverSentEventContext, ServerSentEventBuilder<T> builder, String refId) {
+    ChannelImpl(HttpServerExchange exchange, StreamSinkChannel sink, ServerSentEventContextImpl<T> serverSentEventContext, ServerSentEventWriter<T> builder, String refId) {
         this.exchange = exchange;
         this.sink = sink;
         this.serverSentEventContext = serverSentEventContext;
@@ -63,30 +63,32 @@ class ChannelImpl<T> implements java.nio.channels.Channel, Channel<T>, Channel.C
 
     @Override
     public boolean send(String id, T event) {
-        String data = builder.build(id, event);
-        return sendBytes(Strings.bytes(data));
+        String message = builder.toMessage(id, event);
+        return sendBytes(Strings.bytes(message));
     }
 
     @Override
     public Context context() {
         return this;
     }
 
-    boolean sendBytes(byte[] data) {
+    boolean sendBytes(byte[] event) {
         if (closed) return false;
 
         var watch = new StopWatch();
         try {
-            queue.add(data);
-            lastSentTime = System.nanoTime();
+            queue.add(event);
             sink.getIoThread().execute(() -> writeListener.handleEvent(sink));
+
+            lastSentTime = System.nanoTime();
             eventCount++;
-            eventSize += data.length;
+            eventSize += event.length;
+
             return true;
         } finally {
             long elapsed = watch.elapsed();
-            ActionLogContext.track("sse", elapsed, 0, data.length);
-            LOGGER.debug("send sse data, channel={}, data={}, elapsed={}", id, new BytesLogParam(data), elapsed); // message is not in json format, not masked, assume sse won't send any sensitive data
+            ActionLogContext.track("sse", elapsed, 0, event.length);
+            LOGGER.debug("send sse message, channel={}, message={}, elapsed={}", id, new BytesLogParam(event), elapsed); // message is not in json format, not masked, assume sse won't send any sensitive event
         }
     }
 

core-ng/src/main/java/core/framework/internal/web/sse/ChannelSupport.java

@@ -10,13 +10,13 @@
 class ChannelSupport<T> {
     final ChannelListener<T> listener;
     final ServerSentEventContextImpl<T> context;
-    final ServerSentEventBuilder<T> builder;
+    final ServerSentEventWriter<T> builder;
     final LimitRate limitRate;
 
     ChannelSupport(ChannelListener<T> listener, Class<T> eventClass, ServerSentEventContextImpl<T> context) {
         this.listener = listener;
         this.context = context;
-        builder = new ServerSentEventBuilder<>(eventClass);
+        builder = new ServerSentEventWriter<>(eventClass);
         limitRate = limitRate(listener);
     }
 

core-ng/src/main/java/core/framework/internal/web/sse/ServerSentEventHandler.java

@@ -24,7 +24,6 @@
 import org.xnio.channels.StreamSinkChannel;
 
 import java.io.IOException;
-import java.nio.ByteBuffer;
 import java.time.Duration;
 import java.util.HashMap;
 import java.util.List;
@@ -96,7 +95,7 @@ void handle(HttpServerExchange exchange, StreamSinkChannel sink) {
             ChannelSupport<Object> support = (ChannelSupport<Object>) supports.get(key(request.method().name(), path));   // ServerSentEventHandler.check() ensures path exists
             actionLog.action("sse:" + path + ":connect");
 
-            if (handlerContext.limitRate) {
+            if (handlerContext.rateControl != null) {
                 limitRate(handlerContext.rateControl, support, request.clientIP());
             }
 
@@ -125,8 +124,8 @@ void handle(HttpServerExchange exchange, StreamSinkChannel sink) {
             logManager.logError(e);
 
             if (channel != null) {
-                byte[] error = errorResponse(handlerContext.responseBeanWriter.toJSON(ErrorResponse.errorResponse(e, actionLog.id)));
-                channel.sendBytes(error);
+                String message = errorMessage(handlerContext.responseBeanWriter.toJSON(ErrorResponse.errorResponse(e, actionLog.id)));
+                channel.sendBytes(Strings.bytes(message));
                 channel.close();    // gracefully shutdown connection to make sure retry/error can be sent
             }
         } finally {
@@ -142,12 +141,10 @@ void limitRate(RateControl rateControl, ChannelSupport<Object> support, String c
         }
     }
 
-    byte[] errorResponse(byte[] errorResponse) {
-        ByteBuffer buffer = ByteBuffer.wrap(new byte[errorResponse.length + 38]);
-        buffer.put(Strings.bytes("retry: 86400000\n\nevent: error\ndata: "));   // tell browser retry in 24 hours
-        buffer.put(errorResponse);
-        buffer.put(Strings.bytes("\n\n"));
-        return buffer.array();
+    String errorMessage(String errorResponse) {
+        return "retry: 86400000\n\n" +
+               "event: error\n" +
+               "data: " + errorResponse + "\n\n";
     }
 
     public <T> void add(HTTPMethod method, String path, Class<T> eventClass, ChannelListener<T> listener, ServerSentEventContextImpl<T> context) {

core-ng/src/main/java/core/framework/internal/web/sse/ServerSentEventBuilder.java renamed to core-ng/src/main/java/core/framework/internal/web/sse/ServerSentEventWriter.java

@@ -3,23 +3,23 @@
 import core.framework.internal.json.JSONWriter;
 import core.framework.internal.validate.Validator;
 
-class ServerSentEventBuilder<T> {
+class ServerSentEventWriter<T> {
     private final JSONWriter<T> writer;
     private final Validator<T> validator;
 
-    ServerSentEventBuilder(Class<T> eventClass) {
+    ServerSentEventWriter(Class<T> eventClass) {
         writer = new JSONWriter<>(eventClass);
         validator = Validator.of(eventClass);
     }
 
-    String build(String id, T event) {
+    String toMessage(String id, T event) {
         validator.validate(event, false);
         String data = writer.toJSONString(event);
 
-        return build(id, data);
+        return message(id, data);
     }
 
-    String build(String id, String data) {
+    String message(String id, String data) {
         var builder = new StringBuilder(data.length() + 7 + (id == null ? 0 : id.length() + 4));
         if (id != null) builder.append("id: ").append(id).append('\n');
         builder.append("data: ").append(data).append("\n\n");